Create A Customer

Create a customer

POST/customers

Use it in a workflow

Add a step and choose the Chargebee connector.
Pick the Create A Customer action (under Chargebee API).
Fill in the fields below, then reference the result from later steps as {{createACustomer.response.data}}.

Request

Headers

chargebee-request-origin-devicestring

The device from which the customer has made the request

chargebee-request-origin-userstring (email)

The email address of your customer/user. Use this when the email address has only ASCII characters.

chargebee-request-origin-user-encodedstring (email)

The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.

chargebee-request-origin-ipstring

The IP address of the customer where the request originated

chargebee-event-actionsstring

skip all actions to be done on the events

One ofall-disabled

chargebee-event-emailstring

skip only emails

One ofall-disabled

chargebee-event-webhookstring

skip only webhooks

One ofall-disabled

chargebee-business-entity-idstring

If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.

Request body

Enter the body as JSON in the step's Body field.

idstring

Id for the new customer. If not given, this will be auto-generated.

first_namestring

First name of the customer.

last_namestring

Last name of the customer.

emailstring (email)

Email address of the customer. Configured email notifications are sent to this email address. Invalid email address will result in an error.

preferred_currency_codestring

The currency code (in [ISO 4217 format](https://www.iso.org/iso-4217-currency-codes.html)) of the customer.

phonestring

Phone number of the customer.

companystring

Company name of the customer.

auto_collectionstring

Whether payments needs to be collected automatically for this customer. \* on - Whenever an invoice is created, an automatic attempt to charge the customer's payment method is made. \* off - Automatic collection of charges will not be made. All payments must be recorded offline.

One ofonoffDefault "on"

net_term_daysinteger (int32)

The number of days from <a href="/docs/api/invoices/invoice-object#date" class="text-blue-600 hover:text-blue-800 underline"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">invoice.date</code></a> until payment for the invoice is due.

Default 0

allow_direct_debitboolean

Whether the customer can pay via Direct Debit.

Default false

vat_numberstring

The VAT/tax registration number for the customer. For customers with <code><a href="/docs/api/customers/customer-object#billing_address">billing_address</a></code> <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">country</code> as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">XI</code> (which is United Kingdom - Northern Ireland ), the first two characters of the <a href="https://en.wikipedia.org/wiki/VAT_identification_number" target="_blank">full VAT number</a> can be overridden by setting <code><a href="/docs/api/customers/customer-object#vat_number_prefix">vat_number_prefix</a></code> .

vat_number_prefixstring

An overridden value for the first two characters of the <a href="https://en.wikipedia.org/wiki/VAT_identification_number" target="_blank">full VAT number</a>. Only applicable specifically for customers with <code><a href="/docs/api/customers/customer-object#billing_address">billing_address</a></code> <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">country</code> as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">XI</code> (which is United Kingdom - Northern Ireland ). When you have enabled <a href="https://www.chargebee.com/docs/eu-vat.html" target="_blank">EU VAT</a> in 2021 or have <a href="https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee" target="_blank">manually enabled</a> the Brexit configuration, you have the option of setting <code><a href="/docs/api/customers/customer-object#billing_address">billing_address</a></code> <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">country</code> as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">XI</code>. That's the code for United Kingdom - Northern Ireland. The first two characters of the VAT number in such a case is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">XI</code> by default. However, if the VAT number was registered in UK, the value should be <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">GB</code>. Set <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">vat_number_prefix</code> to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">GB</code> for such cases.

entity_identifier_schemestring

The Peppol BIS scheme associated with the <code><a href="/docs/api/customers/customer-object#vat_number">vat_number</a></code> of the customer. This helps identify the specific type of customer entity. For example, <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">DE:VAT</code> is used for a German business entity while <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">DE:LWID45</code> is used for a German government entity. The value must be from the list of possible values and must correspond to the country provided under <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">billing_address.country</code>. See <a href="https://www.chargebee.com/docs/e-invoicing.html#supported-countries" target="_blank" rel="noopener noreferrer">list of possible values</a> . <div class="alert alert-info">Tip:If there are additional entity identifiers for the customer not associated with the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">vat_number</code>, they can be provided as the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_identifiers[]</code> array.</div>

entity_identifier_standardstring

The standard used for specifying the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_identifier_scheme</code>. Currently only <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">iso6523-actorid-upis</code> is supported and is used by default when not provided. <div class="alert alert-info">Tip:If there are additional entity identifiers for the customer not associated with the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">vat_number</code>, they can be provided as the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_identifiers[]</code> array.</div>

Default "iso6523-actorid-upis"

registered_for_gstboolean

Confirms that a customer is registered under GST. If set to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">true</code> then the <a href="https://www.chargebee.com/docs/australian-gst.html#reverse-charge-mechanism" target="_blank" rel="noopener noreferrer">Reverse Charge Mechanism</a> is applicable. This field is applicable only when Australian GST is configured for your site.

is_einvoice_enabledboolean

Determines whether the customer is e-invoiced. When set to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">true</code> or not set to any value, the customer is e-invoiced so long as e-invoicing is enabled for their country (<code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">billing_address.country</code> ). When set to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">false</code> , the customer is not e-invoiced even if e-invoicing is enabled for their country. <div class="alert alert-info">Tip:It is possible to set a value for this flag even when E-Invoicing is disabled. However, it comes into effect only when E-Invoicing is enabled.</div>

einvoicing_methodstring

Determines whether to send an e-invoice manually or automatic. \* automatic - Use this value to send e-invoice every time an invoice or credit note is created. \* manual - When manual is selected the automatic e-invoice sending is disabled. Use this value to send e-invoice manually through UI or API. \* site_default - The default value of the site which can be overridden at the customer level.

One ofautomaticmanualsite_default

taxabilitystring

Specifies if the customer is liable for tax. * taxable - Computes tax for the customer based on the <a href="https://www.chargebee.com/docs/tax.html" target="_blank" rel="noopener noreferrer">site configuration</a>. In some cases, depending on the region, shipping_address is needed. If not provided, then billing_address is used to compute tax. If that's not available either, the tax is taken as zero. * exempt - <ul class="list-disc list-outside ml-6 my-4 space-y-2"> <li class="text-base leading-relaxed">Customer is exempted from tax. When using Chargebee's native <a href="https://www.chargebee.com/docs/tax.html" target="_blank" rel="noopener noreferrer">Taxes</a> feature or when using the <a href="https://www.chargebee.com/docs/taxjar.html" target="_blank" rel="noopener noreferrer">TaxJar integration</a>, no other action is needed.</li> <li class="text-base leading-relaxed">However, when using our <a href="https://www.chargebee.com/docs/avalara.html" target="_blank" rel="noopener noreferrer">Avalara integration</a>, optionally, specify <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_code</code> or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">exempt_number</code> attributes if you use Chargebee's <a href="https://www.chargebee.com/docs/avalara.html#configuring-tax-exemption" target="_blank">AvaTax for Sales</a> or specify <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">exemption_details</code> attribute if you use <a href="https://www.chargebee.com/docs/avatax-for-communication.html" target="_blank" rel="noopener noreferrer">Chargebee's AvaTax for Communications</a> integration. Tax may still be applied by Avalara for certain values of <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_code</code>/<code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">exempt_number</code>/<code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">exemption_details</code> based on the state/region/province of the taxable address.</li> </ul>

One oftaxableexemptDefault "taxable"

exemption_detailsarray<any>

Indicates the exemption information. You can customize customer exemption based on specific Location, Tax level (Federal, State, County and Local), Category of Tax or specific Tax Name. This is applicable only if you use [Chargebee's AvaTax for Communications](https://www.chargebee.com/docs/avatax-for-communication.html) integration. To know more about what values you need to provide, refer to this [Avalara's API document](https://developer.avalara.com/communications/dev-guide_rest_v2/customizing-transactions/sample-transactions/exemption/) .

customer_typestring

Indicates the type of the customer. This is applicable only if you use [Chargebee's AvaTax for Communications](https://www.chargebee.com/docs/avatax-for-communication.html) integration. \* industrial - When the purchase is made by an industrial business \* residential - When the purchase is made by a customer for home use \* senior_citizen - When the purchase is made by a customer who meets the jurisdiction requirements to be considered a senior citizen and qualifies for senior citizen tax breaks \* business - When the purchase is made at a place of business

One ofresidentialbusinesssenior_citizenindustrial

client_profile_idstring

Indicates the Client profile id for the customer. This is applicable only if you use [Chargebee's AvaTax for Communications](https://www.chargebee.com/docs/avatax-for-communication.html) integration.

taxjar_exemption_categorystring

Indicates the exemption type of the customer. This is applicable only if you use Chargebee's TaxJar integration. \* other - Other \* government - Government \* wholesale - Whole-sale

One ofwholesalegovernmentother

business_customer_without_vat_numberboolean

Confirms that a customer is a valid business without an EU/UK VAT number.

localestring

Determines which region-specific language Chargebee uses to communicate with the customer. Use the <a href="https://www.chargebee.com/docs/billing/2.0/customers/configure-multiple-languages#step-2-download-the-language-pack-and-provide-the-translations" target="_blank" rel="noopener noreferrer" class="text-blue-600 hover:text-blue-800 underline">language pack</a> to customize the translations for each locale. <div class="alert alert-info">Default behavior<ul class="list-disc list-outside ml-6 my-4 space-y-2"> <li class="text-base leading-relaxed">If you don't pass <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">locale</code>, or if you pass it but it is not added and activated in Chargebee, then the <a href="https://www.chargebee.com/docs/billing/2.0/customers/configure-multiple-languages#primary-language-of-your-chargebee-site" target="_blank" rel="noopener noreferrer" class="text-blue-600 hover:text-blue-800 underline">primary language</a> for customers would be used.</li> </ul></div>

entity_codestring

The exemption category of the customer, for USA and Canada. Applicable if you use Chargebee's [AvaTax for Sales integration](https://www.chargebee.com/docs/avalara.html#configuring-tax-exemption) . \* l - Other or custom \* m - Educational organization \* n - Local government \* h - Commercial agricultural production \* i - Industrial production/manufacturer \* j - Direct pay permit \* k - Direct mail \* p - Commercial aquaculture \* q - Commercial Fishery \* r - Non-resident \* d - Foreign diplomat \* e - Charitable or benevolent organization \* f - Religious organization \* g - Resale \* a - Federal government \* b - State government \* c - Tribe/Status Indian/Indian Band \* med2 - US Medical Device Excise Tax with taxable sales tax \* med1 - US Medical Device Excise Tax with exempt sales tax

One ofabcdefghijklmnpqrmed1med2

exempt_numberstring

Any string value that will cause the sale to be exempted. Use this if your finance team manually verifies and tracks exemption certificates. Applicable if you use Chargebee's [AvaTax for Sales integration](https://www.chargebee.com/docs/avalara.html#configuring-tax-exemption) .

meta_dataobject

A collection of key-value pairs that provides extra information about the customer. \*\*Note:\*\* There's a character limit of 65,535. \[Learn more\](/docs/api/advanced-features) .

offline_payment_methodstring

The preferred offline payment method for the customer. \* sepa_credit - SEPA Credit \* cash - Cash \* no_preference - No Preference \* bank_transfer - Bank Transfer \* check - Check \* eu_automated_bank_transfer - EU Automated Bank Transfer \* jp_automated_bank_transfer - JP Automated Bank Transfer \* uk_automated_bank_transfer - UK Automated Bank Transfer \* custom - Custom \* boleto - Boleto \* mx_automated_bank_transfer - MX Automated Bank Transfer \* us_automated_bank_transfer - US Automated Bank Transfer \* ach_credit - ACH Credit

One ofno_preferencecashcheckbank_transferach_creditsepa_creditboletous_automated_bank_transfereu_automated_bank_transferuk_automated_bank_transferjp_automated_bank_transfermx_automated_bank_transfercustom

auto_close_invoicesboolean

Override for this customer, the [site-level setting](https://www.chargebee.com/docs/billing/2.0/usage-based-billing/metered_billing#configuring-metered-billing) for auto-closing invoices. Only applicable when auto-closing invoices has been enabled for the site. This attribute is also available at the [subscription level](/docs/api/subscriptions/subscription-object#auto_close_invoices) which takes precedence.

consolidated_invoicingboolean

Indicates whether invoices raised on the same day for the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">customer</code> are consolidated. When provided, this overrides the default configuration at the <a href="https://www.chargebee.com/docs/consolidated-invoicing.html#configuring-consolidated-invoicing" target="_blank">site-level</a>. This parameter can be provided only when <a href="https://www.chargebee.com/docs/consolidated-invoicing.html" target="_blank">Consolidated Invoicing</a> is enabled. <div class="alert alert-info">Note:Any invoices raised when a subscription activates from <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">in_trial</code> or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">future</code> <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">status</code>, are not consolidated by default. <a href="https://www.chargebee.com/docs/billing/2.0/kb/getting-started/how-to-contact-chargebees-support-team?utm_source=docs_api&utm_medium=content&utm_campaign=support" target="_blank" rel="noopener noreferrer" class="text-blue-600 hover:text-blue-800 underline">Contact Support</a> to enable consolidation for such invoices.</div> .

token_idstring

The Chargebee payment token generated by <a href="https://www.chargebee.com/checkout-portal-docs/3ds-helper-overview.html#using-gateway-s-hosted-fields">Chargebee JS</a>. <div class="alert alert-info">Note: The payment token created via Chargebee JS uses the gateway selected through <a href="https://www.chargebee.com/docs/payments/2.0/payment-gateways-and-configuration/gateway_settings#smart-routing">Smart Routing</a>. Explicitly passing a <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">gateway_id</code> in this API call will not override the gateway associated with the token.</div>

business_entity_idstring

The unique ID of the [business entity](/docs/api/advanced-features) this customer should be [linked](/docs/api/advanced-features) to. An alternative way of passing this parameter is by means of a [custom HTTP header](/docs/api/advanced-features). **Default behavior** * When not provided, the customer is linked to the [default business entity](/docs/api/advanced-features) defined for the site.

invoice_notesstring

A customer-facing note added to all invoices associated with this API resource. This note becomes one among [all the notes](/docs/api/invoices/invoice-object#notes) displayed on the invoice PDF.

cardobject

Parameters for card. Use this parameter to pass raw card details. Passing raw card data via API involves PCI liability at your end due to the sensitivity of the data.

gateway_account_idstring

The gateway account in which these card details are stored. <div class="alert alert-info">Required when<ul class="list-disc list-outside ml-6 my-4 space-y-2"> <li class="text-base leading-relaxed">All of the following conditions are met together:</li> <li class="text-base leading-relaxed">Passing <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">card</code> parameter.</li> <li class="text-base leading-relaxed">There are multiple <a href="https://www.chargebee.com/docs/payments/2.0/payment-gateways-and-configuration/gateway_settings" target="_blank" rel="noopener noreferrer" class="text-blue-600 hover:text-blue-800 underline">payment gateway</a> accounts configured for the site.</li> <li class="text-base leading-relaxed"><a href="https://www.chargebee.com/docs/payments/2.0/payment-gateways-and-configuration/gateway_settings#smart-routing" target="_blank" rel="noopener noreferrer" class="text-blue-600 hover:text-blue-800 underline">Smart Routing</a> is not configured for card payments.</li> </ul></div>

first_namestring

Cardholder's first name

last_namestring

Cardholder's last name

numberstring

The 16 digit credit card number. If you are using [Braintree.js](https://developer.paypal.com/braintree/docs/guides/client-sdk/setup/javascript/v2#getting-braintree.js), you can specify the Braintree encrypted card number here.

expiry_monthinteger (int32)

Card expiry month.

expiry_yearinteger (int32)

Card expiry year.

cvvstring

The card verification value (CVV). If you are using [Braintree.js](https://developer.paypal.com/braintree/docs/guides/client-sdk/setup/javascript/v2#getting-braintree.js) , you can specify the Braintree encrypted CVV here.

preferred_schemestring

The customer's preferred card scheme for co-branded cards. **Note**: Currently, this parameter is only supported for Stripe. \* cartes_bancaires - A Cartes Bancaires card scheme. \* mastercard - A MasterCard scheme. \* visa - A Visa card scheme.

One ofcartes_bancairesmastercardvisa

billing_addr1string

Address line 1, as available in card billing address.

billing_addr2string

Address line 2, as available in card billing address.

billing_citystring

City, as available in card billing address.

billing_state_codestring

The <a href="https://www.iso.org/obp/ui/#search/code" target="_blank">ISO 3166-2 state/province code</a> without the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">state_code</code> as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">AZ</code> (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">US-AZ</code> ). For Tamil Nadu (India), set as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">TN</code> (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">IN-TN</code> ). For British Columbia (Canada), set as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">BC</code> (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">CA-BC</code> ).

billing_statestring

The state/province name. Is set by Chargebee automatically for US, Canada and India If <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">state_code</code> is provided.

billing_zipstring

Postal or Zip code, as available in card billing address.

billing_countrystring

The billing address country of the customer. Must be one of <a href="https://www.iso.org/iso-3166-country-codes.html" target="_blank" rel="noopener noreferrer">ISO 3166 alpha-2 country code</a> . Note: If you enter an invalid country code, the system will return an error. <div class="alert alert-info">BrexitIf you have enabled <a href="https://www.chargebee.com/docs/eu-vat.html" target="_blank" rel="noopener noreferrer">EU VAT</a> in 2021 or later, or have <a href="https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee" target="_blank" rel="noopener noreferrer">manually enable</a> the Brexit configuration, then <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">XI</code> (the code for United Kingdom - Northern Ireland) is available as an option.</div>

additional_informationobject

<ul class="list-disc list-outside ml-6 my-4 space-y-2"> <li class="text-base leading-relaxed"> <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">checkout_com</code>: While adding a new payment method using <a href="/docs/api/payment_sources/create-using-permanent-token">permanent token</a> or passing raw card details to Checkout.com, <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">document</code> ID and <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">country_of_residence</code> are required to support payments through <a href="https://www.checkout.com/docs/previous/payments/payment-methods/cards/dlocal" target="_blank">dLocal</a>. <ul class="list-disc list-outside ml-6 my-4 space-y-2"> <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">payer</code>: User related information. <ul class="list-disc list-outside ml-6 my-4 space-y-2"> <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">country_of_residence</code>: This is required since the billing country associated with the user's payment method may not be the same as their country of residence. Hence the user's country of residence needs to be specified. The country code should be a <a href="https://docs.checkout.com/resources/codes/country-codes" target="_blank">two-character ISO code</a>.</li> <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">document</code>: Document ID is the user's <a href="https://docs.dlocal.com/api-documentation/payins-api-reference/country-reference#documents" target="_blank">identification number</a> based on their country.</li> </ul> </li> </ul> </li> <li class="text-base leading-relaxed"> <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">bluesnap</code>: While passing raw card details to BlueSnap, if <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_session_id</code> is added, <a href="https://developers.bluesnap.com/docs/fraud-prevention" target="_blank">additional validation</a> is performed to avoid fraudulent transactions. <ul class="list-disc list-outside ml-6 my-4 space-y-2"> <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud</code>: Fraud identification related information. <ul class="list-disc list-outside ml-6 my-4 space-y-2"> <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_session_id</code>: Your <a href="https://developers.bluesnap.com/docs/fraud-prevention#section-implementing-device-data-collector" target="_blank">BlueSnap fraud session ID</a> required to perform anti-fraud validation.</li> </ul> </li> </ul> </li> <li class="text-base leading-relaxed"> <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">braintree</code>: While passing raw card details to Braintree, your <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_merchant_id</code> and the user's <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code> can be added to perform <a href="https://developers.braintreepayments.com/guides/premium-fraud-management-tools/device-data-collection/javascript/v3#collecting-device-data" target="_blank">additional validation</a> and avoid fraudulent transactions. <ul class="list-disc list-outside ml-6 my-4 space-y-2"> <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud</code>: Fraud identification related information. <ul class="list-disc list-outside ml-6 my-4 space-y-2"> <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code>: Session ID associated with the user's device.</li> <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_merchant_id</code>: Your <a href="https://developers.braintreepayments.com/guides/premium-fraud-management-tools/device-data-collection/javascript/v3#collecting-device-data" target="_blank">merchant ID</a> for fraud detection.</li> </ul> </li> </ul> </li> <li class="text-base leading-relaxed"> <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">chargebee_payments</code>: While passing raw card details to Chargebee Payments, if <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_session_id</code> is added, additional validation is performed to avoid fraudulent transactions. <ul class="list-disc list-outside ml-6 my-4 space-y-2"> <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud</code>: Fraud identification related information. <ul class="list-disc list-outside ml-6 my-4 space-y-2"> <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud_session_id</code>: Your Chargebee Payments fraud session ID required to perform anti-fraud validation.</li> </ul> </li> </ul> </li> <li class="text-base leading-relaxed"> <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">bank_of_america</code>: While passing raw card details to Bank of America, your user's <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code> can be added to perform additional validation and avoid fraudulent transactions. <ul class="list-disc list-outside ml-6 my-4 space-y-2"> <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud</code>: Fraud identification related information. <ul class="list-disc list-outside ml-6 my-4 space-y-2"> <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code>: Session ID associated with the user's device.</li> </ul> </li> </ul> </li> <li class="text-base leading-relaxed"> <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">ecentric</code>: This parameter is used to verify and process payment method details in Ecentric. If the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">merchant_id</code> parameter is included, Chargebee will vault it / perform a lookup and verification against this <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">merchant_id</code>, overriding the one configured in Chargebee. If tokens and processing occur in the same Merchant GUID, you can just skip this part. <ul class="list-disc list-outside ml-6 my-4 space-y-2"> <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">merchant_id</code>: Merchant GUID where the card is vaulted or need to be vaulted.</li> </ul> </li> <li class="text-base leading-relaxed"> <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">ebanx</code>: While passing raw card details to EBANX, the user's <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">document</code> is required for some countries and <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code> can be added to perform <a href="https://developer.ebanx.com/docs/payments/guides/features/device-fingerprint#device-fingerprint" target="_blank">additional validation</a> and avoid fraudulent transactions. <ul class="list-disc list-outside ml-6 my-4 space-y-2"> <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">payer</code>: User related information. <ul class="list-disc list-outside ml-6 my-4 space-y-2"> <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">document</code>: Document is the user's identification number based on their country.</li> </ul> </li> <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fraud</code>: Fraud identification related information. <ul class="list-disc list-outside ml-6 my-4 space-y-2"> <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">device_session_id</code>: Session ID associated with the user's device</li> </ul> </li> </ul> </li> </ul>

bank_accountobject

Parameters for bank_account

gateway_account_idstring

The gateway account in which this payment source is stored. <div class="alert alert-info">Required when<ul class="list-disc list-outside ml-6 my-4 space-y-2"> <li class="text-base leading-relaxed">All of the following conditions are met together:</li> <li class="text-base leading-relaxed">Passing <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">bank_account</code> parameter.</li> <li class="text-base leading-relaxed">There are multiple <a href="https://www.chargebee.com/docs/payments/2.0/payment-gateways-and-configuration/gateway_settings" target="_blank" rel="noopener noreferrer" class="text-blue-600 hover:text-blue-800 underline">payment gateway</a> accounts configured for the site.</li> <li class="text-base leading-relaxed"><a href="https://www.chargebee.com/docs/payments/2.0/payment-gateways-and-configuration/gateway_settings#smart-routing" target="_blank" rel="noopener noreferrer" class="text-blue-600 hover:text-blue-800 underline">Smart Routing</a> is not configured for bank account payments.</li> </ul></div>

ibanstring

Account holder's International Bank Account Number. For the [GoCardless](https://www.chargebee.com/docs/gocardless.html) platform, this can be the [local bank details](https://developer.gocardless.com/api-reference/#appendix-local-bank-details)

first_namestring

Account holder's first name as per bank account. If not passed, details from customer details will be considered.

last_namestring

Account holder's last name as per bank account. If not passed, details from customer details will be considered.

companystring

Account holder's company name as per bank account. If not passed, details from customer details will be considered.

emailstring (email)

Account holder's email address. If not passed, details from customer details will be considered. All Direct Debit compliant emails will be sent to this email address.

phonestring

Phone number of the account holder that is linked to the bank account.

bank_namestring

Name of account holder's bank.

account_numberstring

Account holder's bank account number.

routing_numberstring

Bank account routing number.

bank_codestring

Indicates the bank code.

account_typestring

Represents the account type used to create a payment source. Available for [Authorize.net](https://www.authorize.net/) ACH and Razorpay NetBanking users only. If not passed, account type is taken as null. \* checking - Checking Account \* business_checking - Business Checking Account \* savings - Savings Account \* current - Current Account

One ofcheckingsavingsbusiness_checkingcurrent

account_holder_typestring

For Stripe ACH users only. Indicates the account holder type. \* individual - Individual Account. \* company - Company Account.

One ofindividualcompany

echeck_typestring

For Authorize.net ACH users only. Indicates the type of eCheck. \* ppd - Payment Authorization is prearranged between the customer and the merchant. \* ccd - Payment Authorization agreement from the corporate customer is required. Applicable for business_checking account_type. \* web - Payment Authorization obtained from the customer via the internet.

One ofwebppdccd

issuing_countrystring

[two-letter(alpha2)](https://www.iso.org/iso-3166-country-codes.html) ISO country code. Required when local bank details are provided, and not IBAN.

swedish_identity_numberstring

For GoCardless Autogiro users only. The civic/company number (personnummer, samordningsnummer, or organisationsnummer) of the customer. Must be supplied if the customer's bank account is denominated in Swedish krona (SEK). This field cannot be changed once it has been set.

billing_addressobject

The billing address associated with the bank account. The value is a JSON object with the following keys and their values:- <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">first_name</code>:(string, max chars=150) The first name of the contact. <ul class="list-disc list-outside ml-6 my-4 space-y-2"> <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">last_name</code>:(string, max chars=150) The last name of the contact.</li> <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">company_name</code>:(string, max chars=250) The company name for the address.</li> <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">line1</code>:(string, max chars=180) The first line of the address.</li> <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">line2</code>:(string, max chars=180) The second line of the address.</li> <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">country</code>:(string) The name of the country for the address.</li> <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">country_code</code>:(string, max chars=50) The two-letter, <a href="https://www.iso.org/iso-3166-country-codes.html">ISO 3166 alpha-2</a> country code for the address.</li> <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">state</code>:(string, max chars=50) The name of the state or province for the address. When not provided, this is set automatically for US, Canada, and India.</li> <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">state_code</code>:(string, max chars=50) The <a href="https://www.iso.org/obp/ui/#search/code/">ISO 3166-2 state/province code</a> without the country prefix. This is supported for USA, Canada, and India. For instance, for Arizona (USA), set state_code as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">AZ</code> (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">US-AZ</code>). For Tamil Nadu (India), set as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">TN</code> (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">IN-TN</code>). For British Columbia (Canada), set as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">BC</code> (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">CA-BC)</code>.</li> <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">city</code>:(string, max chars=50) The city name for the address.</li> <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">postal_code</code>:(string, max chars=20) The postal or ZIP code for the address.</li> <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">phone</code>:(string, max chars=50) The contact phone number for the address.</li> <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">email</code>:(string, max chars=70) The contact email address for the address.</li> </ul>

payment_methodobject

Parameters for payment_method

typestring

The type of payment method. For more details refer [Update payment method for a customer](/docs/api/customers/update-payment-method-for-a-customer) API under Customer resource. \* grab_pay - Payments made via GrabPay \* go_pay - Payments made via GoPay \* google_pay - Payments made via Google Pay. \* after_pay - Payments made via Afterpay \* pix - Payments made via Pix \* pay_by_bank - Pay By Bank \* sofort - Payments made via Sofort. \* twint - Payments made via Twint \* netbanking_emandates - Netbanking (eMandates) Payments. \* apple_pay - Payments made via Apple Pay. \* unionpay - Payments made via UnionPay. \* giropay - Payments made via giropay. \* direct_debit - Represents bank account for which the direct debit or ACH agreement/mandate is created. \* paypay - \* south_korean_cards - \* bancontact - Payments made via Bancontact Card. \* upi - UPI Payments. \* revolut_pay - Payments made via Revolut Pay. \* stablecoin - Payments made via Stablecoin. \* alipay - Payments made via Alipay. This payment source is deprecated. \* payme - Payments made via PayMe \* pay_to - Payments made via PayTo \* pay_co - Payments made via PayCo \* kakao_pay - Payments made via Kakao Pay. \* wechat_pay - Payments made via WeChat Pay. This payment source is deprecated. \* sepa_instant_transfer - Payments made via Sepa Instant Transfer \* dotpay - Payments made via Dotpay. \* klarna - Payments made via Klarna. \* paypal_express_checkout - Payments made via PayPal Express Checkout. \* ideal - Payments made via iDEAL. \* electronic_payment_standard - Electronic Payment Standard \* generic - Payments made via Generic Payment Method. \* klarna_pay_now - Payments made via Klarna Pay Now \* faster_payments - Payments made via Faster Payments \* swish - Payments made via Swish \* venmo - Payments made via Venmo \* payconiq_by_bancontact - Payments made via Payconiq by Bancontact. \* naver_pay - Payments made via Naver Pay. \* automated_bank_transfer - Represents virtual bank account using which the payment will be done. \* amazon_payments - Payments made via Amazon Payments. \* gcash - \* card - Card based payment including credit cards and debit cards. Details about the card can be obtained from the card resource. \* online_banking_poland - Payments made via Online Banking Poland \* trustly - Trustly \* kbc_payment_button - KBC Payment Button \* alipay_hk - \* cash_app_pay - Payments made via Cash App Pay.

One ofcardpaypal_express_checkoutamazon_paymentsdirect_debitgenericalipayunionpayapple_paywechat_payidealgoogle_paysofortbancontactgiropaydotpayupinetbanking_emandatesvenmopay_tofaster_paymentssepa_instant_transferautomated_bank_transferklarna_pay_nowonline_banking_polandpayconiq_by_bancontactelectronic_payment_standardkbc_payment_buttonpay_by_banktrustlystablecoinkakao_paynaver_payrevolut_paycash_app_paytwintgo_paygrab_paypay_coafter_payswish

gateway_account_idstring

The gateway account in which this payment source is stored.

reference_idstring

The reference id. In the case of Amazon and PayPal this will be the *billing agreement id* . For GoCardless direct debit this will be 'mandate id'. In the case of card this will be the identifier provided by the gateway/card vault for the specific payment method resource. **Note:** This is not the one-time temporary token provided by gateways like Stripe. For more details refer [Update payment method for a customer](/docs/api/customers/update-payment-method-for-a-customer) API under Customer resource.

tmp_tokenstring

Single-use tokens created by payment gateways. In Stripe, a single-use token is created for Apple Pay Wallet, card details or direct debit. In Braintree, a nonce is created for Apple Pay Wallet, PayPal, or card details. In Authorize.Net, a nonce is created for card details. In Adyen, an encrypted data is created from the card details.

issuing_countrystring

<a href="https://www.iso.org/iso-3166-country-codes.html" target="_blank">ISO 3166 alpha-2 country code</a> . Note: If you enter an invalid country code, the system will return an error. If you have enabled <a href="https://www.chargebee.com/docs/eu-vat.html" target="_blank">EU VAT</a> in 2021 or have <a href="https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee" target="_blank">manually enabled</a> the Brexit configuration, then <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">XI</code> (the code for United Kingdom - Northern Ireland ) is available as an option.

additional_informationobject

payment_intentobject

Parameters for payment_intent

idstring

Identifier for the <a href="/docs/api/payment_intents" class="text-blue-600 hover:text-blue-800 underline"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">payment_intent</code></a> resource. If you provide this parameter, you do not need to pass other <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">payment_intent</code> parameters.

gateway_account_idstring

The gateway account used for performing the 3DS flow.

gw_tokenstring

Identifier for 3DS transaction/verification object at the gateway. Can be passed only after successfully completing the 3DS flow. Refer [3DS implementation in Chargebee](/docs/api/3ds_card_payments) to find out the gateway-specific gw_token format. Applicable when you are using gateway APIs directly for completing the 3DS flow.

payment_method_typestring

The payment method type. <div class="alert alert-info">Default value<ul class="list-disc list-outside ml-6 my-4 space-y-2"> <li class="text-base leading-relaxed"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">card</code></li> </ul></div> * card - card * twint - Payments made via Twint * dotpay - dotpay * faster_payments - Faster Payments * upi - upi * kbc_payment_button - KBC Payment Button * klarna - Payments made via Klarna. * payme - Payments made via PayMe * google_pay - google_pay * paypal_express_checkout - paypal_express_checkout * pix - Pix * klarna_pay_now - Klarna Pay Now * ideal - ideal * boleto - boleto * wechat_pay - Payments made via WeChat Pay. * after_pay - Payments made via Afterpay * grab_pay - Payments made via GrabPay * direct_debit - direct_debit * sepa_instant_transfer - Sepa Instant Transfer * bancontact - bancontact * kakao_pay - Payments made via Kakao Pay. * south_korean_cards - * swish - Payments made via Swish * go_pay - Payments made via GoPay * trustly - Trustly * naver_pay - Payments made via Naver Pay. * stablecoin - Payments made via Stablecoin. * venmo - Venmo * alipay - Payments made via Alipay. * pay_to - PayTo * pay_co - Payments made via PayCo * cash_app_pay - Payments made via Cash App Pay. * alipay_hk - * netbanking_emandates - netbanking_emandates * paypay - * payconiq_by_bancontact - Payments made via Payconiq by Bancontact. * electronic_payment_standard - Electronic Payment Standard * pay_by_bank - Pay By Bank * apple_pay - apple_pay * online_banking_poland - Online Banking Poland * gcash - * giropay - giropay * sofort - sofort * amazon_payments - Amazon Payments * revolut_pay - Payments made via Revolut Pay.

One ofcardidealsofortbancontactgoogle_paydotpaygiropayapple_payupinetbanking_emandatespaypal_express_checkoutdirect_debitboletovenmoamazon_paymentspay_tofaster_paymentssepa_instant_transferklarna_pay_nowonline_banking_polandpayconiq_by_bancontactelectronic_payment_standardkbc_payment_buttonpay_by_banktrustlystablecoinkakao_paynaver_payrevolut_paycash_app_paywechat_payalipaytwintgo_paygrab_paypay_coafter_payswishpaymepix

reference_idstring

Identifier for Braintree permanent token. Applicable when you are using Braintree APIs for completing the 3DS flow.

additional_informationobject

billing_addressobject

Parameters for billing_address

first_namestring

The first name of the billing contact.

last_namestring

The last name of the billing contact.

emailstring (email)

The email address.

companystring

The company name.

phonestring

The phone number.

line1string

Address line 1

line2string

Address line 2

line3string

Address line 3

citystring

The name of the city.

state_codestring

statestring

zipstring

Zip or postal code. The number of characters is validated according to the rules [specified here](https://chromium-i18n.appspot.com/ssl-address) .

countrystring

The billing address country of the customer. Must be one of <a href="https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements" target="_blank" rel="noopener noreferrer">ISO 3166 alpha-2 country code</a> . <div class="alert alert-info">BrexitIf you have enabled <a href="https://www.chargebee.com/docs/eu-vat.html" target="_blank" rel="noopener noreferrer">EU VAT</a> in 2021 or later, or have <a href="https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee" target="_blank" rel="noopener noreferrer">manually enable</a> the Brexit configuration, then <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">XI</code> (the code for United Kingdom - Northern Ireland) is available as an option.</div>

validation_statusstring

The address verification status. \* valid - Address was validated successfully. \* partially_valid - The address is valid for taxability but has not been validated for shipping. \* invalid - Address is invalid. \* not_validated - Address is not yet validated.

One ofnot_validatedvalidpartially_validinvalidDefault "not_validated"

entity_identifiersobject

Parameters for entity_identifiers

idarray<string>

The unique id for the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_identifier</code> in Chargebee. When not provided, it is autogenerated.

schemearray<string>

The Peppol BIS scheme associated with the <code><a href="/docs/api/customers/customer-object#vat_number">vat_number</a></code> of the customer. This helps identify the specific type of customer entity. For example, <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">DE:VAT</code> is used for a German business entity while <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">DE:LWID45</code> is used for a German government entity. The value must be from the list of possible values and must correspond to the country provided under <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">billing_address.country</code>. See <a href="https://www.chargebee.com/docs/e-invoicing.html#supported-countries" target="_blank" rel="noopener noreferrer">list of possible values</a> . <div class="alert alert-info">Tip:If there is only one entity identifier for the customer and the value is the same as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">vat_number</code>, then there is no need to provide the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_identifiers[]</code> array. See <a href="/docs/api/customers/customer-object#entity_identifiers">description for <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_identifiers[]</code></a>.</div>

valuearray<string>

The value of the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_identifier</code>. This identifies the customer entity on the Peppol network. For example: <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">10101010-STO-10</code> . <div class="alert alert-info">Tip:If there is only one entity identifier for the customer and the value is the same as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">vat_number</code>, then there is no need to provide the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_identifiers[]</code> array. See <a href="/docs/api/customers/customer-object#entity_identifiers">description for <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_identifiers[]</code></a>.</div>

standardarray<string>

The standard used for specifying the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_identifier</code> <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">scheme</code>. Currently, only <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">iso6523-actorid-upis</code> is supported and is used by default when not provided. <div class="alert alert-info">Tip:If there is only one entity identifier for the customer and the value is the same as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">vat_number</code>, then there is no need to provide the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_identifiers[]</code> array. See <a href="/docs/api/customers/customer-object#entity_identifiers">description for <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_identifiers[]</code></a>.</div>

tax_providers_fieldsobject

Parameters for tax_providers_fields

provider_namearray<string>

Name of the tax provider.

field_idarray<string>

Field id of the attribute which tax vendor has provided while getting onboarded with Chargebee.

field_valuearray<string>

The value of the related tax field

json

{
  "id": null,
  "first_name": null,
  "last_name": null,
  "email": null,
  "preferred_currency_code": null,
  "phone": null,
  "company": null,
  "auto_collection": null,
  "net_term_days": null,
  "allow_direct_debit": null,
  "vat_number": null,
  "vat_number_prefix": null
}

Response

Returns 200 with an object. Read it in later steps with {{createACustomer.response.data.<field>}}.

customerobject

<div class="api-description">Represents a customer, which can be an individual or organization that subscribes to your products or services. The customer resource associates with <a href="/docs/api/subscriptions/subscription-object">subscriptions</a>, <a href="/docs/api/cards/card-object">card information</a>, and billing addresses. The customer details include their ID, name, contact information, and any <a href="/docs/api/advanced-features">custom attributes</a> you'd like to associate with them.<div class="warning alert alert-warning">Breaking Change:<ul class="list-disc list-outside ml-6 my-4 space-y-2"> <li class="text-base leading-relaxed"><a href="https://www.chargebee.com/docs/2.0/sites-intro.html" target="_blank">Sites</a> created before March 1, 2014: <a href="/docs/api/cards/update-card-for-a-customer">updating the card</a> deletes the customer's <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">billing_address</code> and <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">vat_number</code> and replaces them with values from the request.</li> <li class="text-base leading-relaxed">Sites created on or after March 1, 2014: updating the card doesn't change the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">billing_address</code> and <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">vat_number</code>.</li> </ul></div></div>

idstringrequired

The unique identifier of the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">customer</code> resource. You have the option to specify this value when creating a customer. If not specified, Chargebee automatically generates a unique identifier. <div class="alert alert-info">Tip When the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">customer</code> resource is <a href="/docs/api/business_entities/transfer-resources-to-another-business-entity">transferred</a> to a different <code><a href="/docs/api/business_entities">business_entity</a></code>, Chargebee assigns a new random identifier to the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">id</code> attribute. The original identifier is preserved for the transferred copy of the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">customer</code> resource. (See also: <a href="/docs/api/business_entities">Mechanics of business entity transfer</a>.)</div>

first_namestring

First name of the customer

last_namestring

Last name of the customer

emailstring (email)

Email of the customer. Configured email notifications will be sent to this email.

phonestring

Phone number of the customer

companystring

Company name of the customer.

vat_numberstring

auto_collectionstringrequired

When the customer has a <code><a href="/docs/api/customers/customer-object#payment_method">payment_method</a></code> of <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">type</code> <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">card</code> , this attribute determines whether to automatically charge the card whenever an invoice <code><a href="/docs/api/invoices/invoice-object#status">status</a></code> is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">payment_due</code> . <div class="alert alert-info">Note This setting can be <a href="/docs/api/subscriptions/create-subscription-for-items#auto_collection">overridden</a> for individual subscriptions of the customer.</div> * on - Chargebee automatically charges the card for invoices that enter <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">payment_due</code> <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">status</code> . * off - Automatic charging is disabled; manual payment is required for due invoices.

One ofonoffDefault "on"

offline_payment_methodstring

net_term_daysinteger (int32)required

Default 0

vat_number_validated_timeinteger (unix-time)

Returns the recent VAT number validation time.

vat_number_statusstring

Represents the VAT validation status. This is applicable if you have configured EU, UK or Australian taxes and the [VAT number validation](https://www.chargebee.com/docs/2.0/uk-vat.html#uk-vat-validation) is enabled. \* not_validated - This status is only applicable for countries in European Zone. This is applicable when both the customer's billing address and the organization's address should be of the same European Zone and EU tax should be configured with the "Also validate VAT Number for Country of Business" option in the disabled status. \* undetermined - When Chargebee is not able to validate the VAT number it is stored as 'undetermined'. This can occur due to reasons like service outage etc. VAT numbers with 'undetermined' status will be in queue for validation on daily basis. \* valid - If the given VAT number is valid. \* invalid - If the given VAT number is invalid.

One ofvalidinvalidnot_validatedundetermined

allow_direct_debitbooleanrequired

Whether the customer can pay via Direct Debit

Default false

is_location_validboolean

<div class="alert alert-info">Note Applicable only when the customer's <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">billing_address.country</code> is New Zealand, Australia, or in the EU.</div> When the customer uses a <a href="/docs/api/payment_sources/payment_source-object#type" target="_blank">card</a> <a href="/docs/api/customers/customer-object#primary_payment_source_id" target="_blank">payment source</a>, this attribute specifies whether the country of the customer and the card issuer are the same. The following three location indicators are compared: <ul class="list-disc list-outside ml-6 my-4 space-y-2"> <li class="text-base leading-relaxed">The card issuer's country.</li> <li class="text-base leading-relaxed">The <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">billing_address.country</code>.</li> <li class="text-base leading-relaxed">The country to which <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">created_from_ip</code> belongs.</li> <li class="text-base leading-relaxed">When all three are the same, this attribute is set to true, otherwise it is set to false. When all three are the same, this attribute is set to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">true</code>, otherwise it is set to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">false</code>.</li> </ul>

created_atinteger (unix-time)required

Timestamp indicating when this customer resource is created.

created_from_ipstring

The IP address of the customer when this customer record was created. It's mainly used for <a href="https://www.chargebee.com/docs/marketing-integration-index.html" target="_blank">referral integrations</a> and validating VAT if the customer is in the EU or UK. Depending on the method used to create the customer record, the field is set as follows: <ul class="list-disc list-outside ml-6 my-4 space-y-2"> <li class="text-base leading-relaxed">API: When creating the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">customer</code> resource through the API, you must include the customer's IP address in a <a href="/docs/api/advanced-features">custom HTTP request header</a> (<code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">chargebee-request-origin-ip</code>) for Chargebee to capture it.</li> <li class="text-base leading-relaxed">Checkout: For <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">customer</code> resources created through <a href="https://www.chargebee.com/docs/2.0/hosted-checkout.html" target="_blank">Chargebee Checkout</a>, Chargebee automatically captures the IP address of the customer.</li> <li class="text-base leading-relaxed">UI: When <a href="https://www.chargebee.com/docs/2.0/customers.html#creating-a-new-customer" target="_blank">creating a <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">customer</code></a> resource via the Chargebee Billing UI, this field is not relevant and the value must be ignored.</li> </ul>

exemption_detailsarray<any>

taxabilitystring

Specifies if the customer is liable for tax * taxable - Computes tax for the customer based on the <a href="https://www.chargebee.com/docs/tax.html" target="_blank" rel="noopener noreferrer">site configuration</a>. In some cases, depending on the region, shipping_address is needed. If not provided, then billing_address is used to compute tax. If that's not available either, the tax is taken as zero. * exempt - <ul class="list-disc list-outside ml-6 my-4 space-y-2"> <li class="text-base leading-relaxed">Customer is exempted from tax. When using Chargebee's native <a href="https://www.chargebee.com/docs/tax.html" target="_blank" rel="noopener noreferrer">Taxes</a> feature or when using the <a href="https://www.chargebee.com/docs/taxjar.html" target="_blank" rel="noopener noreferrer">TaxJar integration</a>, no other action is needed.</li> <li class="text-base leading-relaxed">However, when using our <a href="https://www.chargebee.com/docs/avalara.html" target="_blank" rel="noopener noreferrer">Avalara integration</a>, optionally, specify <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_code</code> or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">exempt_number</code> attributes if you use Chargebee's <a href="https://www.chargebee.com/docs/avalara.html#configuring-tax-exemption" target="_blank">AvaTax for Sales</a> or specify <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">exemption_details</code> attribute if you use <a href="https://www.chargebee.com/docs/avatax-for-communication.html" target="_blank" rel="noopener noreferrer">Chargebee's AvaTax for Communications</a> integration. Tax may still be applied by Avalara for certain values of <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">entity_code</code>/<code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">exempt_number</code>/<code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">exemption_details</code> based on the state/region/province of the taxable address.</li> </ul>

One oftaxableexemptDefault "taxable"

entity_codestring

One ofabcdefghijklmnpqrmed1med2

exempt_numberstring

resource_versioninteger (int64)

Version number of this resource. The <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">resource_version</code> is updated with a new timestamp in milliseconds for every change made to the resource. This attribute will be present only if the resource has been updated after 2016-09-28.

updated_atinteger (unix-time)

Timestamp indicating when this customer was last updated. This attribute will be present only if the resource has been updated after 2016-09-28.

localestring

Determines which region-specific language Chargebee uses to communicate with the customer. In the absence of the locale attribute, Chargebee will use your site's default language for customer communication.

billing_dateinteger (int32)

<div class="alert alert-info">Note Applicable only when <a href="https://www.chargebee.com/docs/calendar-billing.html">Calendar Billing</a> with support for customer-specific billing date is enabled and <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">billing_date_mode</code> is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">manually_set</code>.</div> Specifies the day of the month for subscription renewals on month-based or year-based plans. Month-based and year-based plans are <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">item_price</code> resources where the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">item_type</code> is set to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">plan</code> and <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">period_unit</code> is set to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">month</code> and <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">year</code> respectively. <div class="alert alert-info">Example<ul class="list-disc list-outside ml-6 my-4 space-y-2"> <li class="text-base leading-relaxed">Month-based subscriptions: If <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">billing_date</code> is set to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">15</code>, month-based renewals occur on the 15th of the month. It's important to note that if the value is set to <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">31</code>, renewals align with the last day of the month. Additionally, in February, a <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">billing_date</code> of <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">29</code>, <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">30</code>, or <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">31</code> aligns renewals for the last day of February.</li> <li class="text-base leading-relaxed">Year-based subscriptions: A <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">billing_date</code> of <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">15</code> and a <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">billing_month</code> of <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">7</code> schedules the renewal on the 15th of July.</li> </ul></div>

billing_monthinteger (int32)

billing_date_modestring

One ofusing_defaultsmanually_set

billing_day_of_weekstring

Applicable when *calendar billing* (with customer specific billing date support) is enabled. When set, renewals of all the weekly subscriptions of this customer will be aligned to this week day. \* saturday - Saturday \* monday - Monday \* friday - Friday \* sunday - Sunday \* wednesday - Wednesday \* thursday - Thursday \* tuesday - Tuesday

One ofsundaymondaytuesdaywednesdaythursdayfridaysaturday

billing_day_of_week_modestring

Indicates whether this customer's *billing_day_of_week* value is derived as per configurations or its specifically set (overriden). When specifically set, the *billing_day_of_week* will not be reset even when all of the weekly subscriptions are cancelled. \* using_defaults - Billing date is set based on defaults configured. \* manually_set - Billing date is specifically set (default configuration is overridden)

One ofusing_defaultsmanually_set

pii_clearedstring

Indicates whether this customer's personal information has been cleared \* cleared - Cleared \* scheduled_for_clear - Scheduled For Clear \* active - Active

One ofactivescheduled_for_clearclearedDefault "active"

auto_close_invoicesboolean

channelstring

The subscription channel this object originated from and is maintained in. \* play_store - The object data is synchronized with data from [in-app subscription(s)](/docs/api/in_app_subscriptions) created in Google Play Store. Direct manipulation of this object via UI or API is disallowed. In-App Subscriptions is currently in early access. Contact [eap@chargebee.com](mailto:eap@chargebee.com) for more information. \* web - The object was created (and is maintained) for the web channel directly in Chargebee via API or UI. \* app_store - The object data is synchronized with data from [in-app subscription(s)](/docs/api/in_app_subscriptions) created in Apple App Store. Direct manipulation of this object via UI or API is disallowed.

One ofwebapp_storeplay_store

active_idstring

<div class="alert alert-info">Note: Present only when the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">customer</code> has been <a href="/docs/api/business_entities/transfer-resources-to-another-business-entity">transferred</a> between business entities.</div> Represents the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">id</code> of the active version of the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">customer</code> resource. <div class="alert alert-info">Tip: If the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">id</code> and <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">active_id</code> of a <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">customer</code> resource are the same, this indicates that you are working with the active version of that customer resource.</div>

fraud_flagstring

Indicates whether or not the customer has been [identified as fraudulent](https://www.chargebee.com/docs/payments/2.0/fraud-management/chargebee-fraud-management). \* suspicious - The customer has been identified as potentially fraudulent by the gateway \* safe - The customer has been marked as safe \* fraudulent - The customer has been marked as fraudulent

One ofsafesuspiciousfraudulent

primary_payment_source_idstring

The [identifier](/docs/api/payment_sources/payment_source-object#id) of the customer's [primary payment source](https://www.chargebee.com/docs/2.0/payment-method-overview.html#primary-and-backup-payment-methods)

backup_payment_source_idstring

The [identifier](/docs/api/payment_sources/payment_source-object#id) of the customer's [backup payment source](https://www.chargebee.com/docs/2.0/payment-method-overview.html#primary-and-backup-payment-methods) .

invoice_notesstring

A note for the customer that appears on all their invoice PDFs. This is one of [several notes](/docs/api/invoices/invoice-object#notes) displayed on the invoice PDF.

business_entity_idstring

The unique ID of the [business entity](/docs/api/advanced-features) of this subscription. This is always the same as the [business entity](/docs/api/subscriptions/subscription-object#customer_id) of the customer.

preferred_currency_codestring

**Note** Applicable only when the [Multi-Currency](https://www.chargebee.com/docs/2.0/multi-currency-pricing.html) feature is enabled. Specifies the customer's preferred currency in [ISO 4217](https://www.chargebee.com/docs/supported-currencies.html) format.

promotional_creditsinteger (int64)required

The balance of [promotional credits](/docs/api/promotional_credits) available to the customer.

unbilled_chargesinteger (int64)required

Total unbilled charges for this customer

cardobject

#### Deprecated The [Payment Sources API](/docs/api/payment_sources) , with its additional options and improvements, obsoletes the Cards APIs. [Learn more](/docs/api/getting-started) . The following table lists the Payment Sources API operations alongside the equivalent Card API operations: | API at Card resource | Use instead | |------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [Retrieve card for a customer](/docs/api/cards/retrieve-card-for-a-customer) | [Retrieve a payment source](/docs/api/payment_sources/retrieve-a-payment-source) | | [Update card for a customer](/docs/api/cards/update-card-for-a-customer) | * [Create using temporary token](/docs/api/payment_sources/create-using-gateway-temporary-token) * [Create using permanent token](/docs/api/payment_sources/create-using-permanent-token) * [Create a card payment source](/docs/api/payment_sources/create-a-card-payment-source) | | [Switch gateway](/docs/api/cards/switch-gateway) | [Switch gateway account](/docs/api/payment_sources/switch-gateway-account) | | [Copy card](/docs/api/cards/copy-card) | [Export payment source](/docs/api/payment_sources/export-payment-source) | | [Delete card for a customer](/docs/api/cards/delete-card-for-a-customer) | [Delete a payment source](/docs/api/payment_sources/delete-a-payment-source) |

payment_source_idstringrequired

Identifier of the payment source

statusstringrequired

Current status of the card. \* valid - A valid and active credit card \* expiring - A card which is expiring in the current month. \* expired - An expired card

One ofvalidexpiringexpired

gatewaystringrequired

Name of the gateway this payment source is stored with. \* twikey - Twikey is a payment service provider that specializes in processing direct debit payments across the EU. \* bluesnap - BlueSnap is a payment gateway. \* jp_morgan - J.P. Morgan Mobility Payment Solutions is a payment gateway that enables you to securely accept and manage digital payments across different [payment_source_type](/docs/api/payment_sources/payment_source-object#type). This feature is a **Private Beta Release** . [Request access](https://app.chargebee.com/login?forward=https://app.chargebee.com/request_access/jp-morgan-bacs&ref=feature) to enable the J.P. Morgan Mobility Payment Solutions gateway via payFURL for your test and live sites. \* tco - 2Checkout is a payment gateway. \* payway - \* moyasar - \* deutsche_bank - Deutsche Bank is the leading German bank with strong European roots and a global network. This feature is a **Private Beta Release**. \* bluepay - BluePay is a payment gateway. \* paypal_express_checkout - PayPal Express Checkout is a payment gateway. \* paypal_payflow_pro - PayPal Payflow Pro is a payment gateway. \* razorpay - Razorpay is a fast growing payment service provider in India working with all leading banks and support for major local payment methods including Netbanking, UPI etc. \* global_payments - Global Payments is a payment service provider. \* dlocal - Dlocal provides payment solutions for global commerce by accepting local payment methods. \* not_applicable - Indicates that payment gateway is not applicable for this resource. \* checkout_com - Checkout.com is a payment gateway. \* adyen - Adyen is a payment gateway. \* braintree - Braintree is a payment gateway. \* nmi - NMI is a payment gateway. \* worldpay - WorldPay is a payment gateway \* paystack - Paystack is a payment gateway for businesses in Africa. It enables secure payment acceptance both online and offline. This feature is a **Private Beta Release** . [Request access](https://app.chargebee.com/login?forward=https://app.chargebee.com/request_access/paystack&ref=feature) to enable Paystack for your test and live sites. \* pay_com - Pay.com provides payment services focused on simplicity and hassle-free operations for businesses of all sizes. \* moneris_us - Moneris USA is a payment gateway. \* pin - Pin is a payment gateway \* authorize_net - Authorize.net is a payment gateway \* tempus - \* stripe - Stripe is a payment gateway. \* moneris - Moneris is a payment gateway. \* chargebee - Chargebee test gateway. \* cybersource - CyberSource is a payment gateway. \* ecentric - Ecentric provides a seamless payment processing service in South Africa specializing on omnichannel capabilities. \* first_data_global - First Data Global Gateway Virtual Terminal Account \* exact - Exact Payments is a payment gateway. \* nuvei - Nuvei is a secure and reliable payment processing solution that allows you to accept payments from customers and suitable for various types of businesses. This feature is a **Private Beta Release** . [Request access](https://app.chargebee.com/login?forward=https://app.chargebee.com/request_access/nuvei&ref=feature) to enable Nuvei for your test and live sites. \* eway - eWAY Account is a payment gateway. \* metrics_global - Metrics global is a leading payment service provider providing unified payment services in the US. \* amazon_payments - Amazon Payments is a payment service provider. \* windcave - Windcave provides an end to end payment processing solution in ANZ and other leading global markets. \* quickbooks - Intuit QuickBooks Payments gateway \* wepay - WePay is a payment gateway. \* ezidebit - Ezidebit is a payment gateway integration based in Australia that supports automated direct debit, BPAY, and card payments for businesses. This feature is a **Private Beta Release**. \* wirecard - WireCard Account is a payment service provider. \* chargebee_payments - Chargebee Payments gateway \* sage_pay - Sage Pay is a payment gateway. \* elavon - Elavon Virtual Merchant is a payment solution. \* paypal_pro - PayPal Pro Account is a payment gateway. \* orbital - Chase Paymentech(Orbital) is a payment gateway. \* paypal - PayPal Commerce is a payment gateway. \* beanstream - Bambora(formerly known as Beanstream) is a payment gateway. \* hdfc - HDFC Account is a payment gateway. \* ingenico_direct - Worldline Online Payments is a payment gateway. \* ogone - Ingenico ePayments (formerly known as Ogone) is a payment gateway. \* migs - MasterCard Internet Gateway Service payment gateway. \* vantiv - Vantiv is a payment gateway. \* bank_of_america - Bank of America Gateway \* eway_rapid - eWAY Rapid is a payment gateway. \* gocardless - GoCardless is a payment service provider. \* mollie - Mollie is a payment gateway. \* paymill - PAYMILL is a payment gateway. \* balanced_payments - Balanced is a payment gateway \* solidgate - Solidgate is a secure and reliable payment processing solution that allows you to accept payments from customers and suitable for various types of businesses. This feature is a **Private Beta Release**. \* ebanx - EBANX is a payment gateway, enabling businesses to accept diverse local payment methods from various countries for increased market reach and conversion.

One ofchargebeechargebee_paymentsadyenstripewepaybraintreeauthorize_netpaypal_propinewayeway_rapidworldpaybalanced_paymentsbeanstreambluepayelavonfirst_data_globalhdfcmigsnmiogonepaymillpaypal_payflow_prosage_paytcowirecardamazon_paymentspaypal_express_checkoutgocardlessorbitalmoneris_usmonerisbluesnapcybersourcevantivcheckout_compaypalingenico_directexactmollie

gateway_account_idstring

The gateway account to which this payment source is stored with.

ref_tx_idstring

Reference transaction id which used for transactions

first_namestring

Cardholder's first name

last_namestring

Cardholder's last name

iinstringrequired

The Issuer Identification Number, i.e. the first six digits of the card number

last4stringrequired

Last four digits of the card number

card_typestring

Card type \* cabal - A Cabal card. \* hipercard - An Hipercard. \* dankort - A Dankort card. \* bancontact - A Bancontact card. \* american_express - An American Express card. \* maestro - A Maestro card. \* mada - A Mada card. \* nativa - A Nativa card. \* cmr_falabella - A CMR Falabella card. \* not_applicable - Used for offline entries in transactions. Not applicable for cards \* elo - A Elo card. \* diners_club - A Diner's Club card. \* discover - A Discover card. \* other - Card belonging to types other than those listed above. \* mastercard - A MasterCard. \* jcb - A JCB card. \* cartes_bancaires - A Cartes Bancaires card. \* argencard - An Argencard. \* cencosud - A Cencosud card. \* tarjeta_naranja - A Tarjeta Naranja card. \* visa - A Visa card. \* carnet - A Carnet card. \* rupay - A Rupay card.

One ofvisamastercardamerican_expressdiscoverjcbdiners_clubbancontactcmr_falabellatarjeta_naranjanativacencosudcabalargencardelohipercardcarnetrupaymaestrodankortcartes_bancairesmadaothernot_applicable

funding_typestringrequired

Card Funding type \* credit - A credit card. \* prepaid - A prepaid card. \* debit - A debit card. \* not_applicable - Used for ACH. Not applicable for cards \* not_known - An unknown card.

One ofcreditdebitprepaidnot_knownnot_applicable

expiry_monthinteger (int32)required

Card expiry month.

expiry_yearinteger (int32)required

Card expiry year.

issuing_countrystring

[two-letter(alpha2)](https://www.iso.org/iso-3166-country-codes.html) ISO country code.

billing_addr1string

Address line 1, as available in card billing address.

billing_addr2string

Address line 2, as available in card billing address.

billing_citystring

City, as available in card billing address.

billing_state_codestring

The <a href="https://www.iso.org/obp/ui/#search" target="_blank">ISO 3166-2 state/province code</a> without the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">state_code</code> as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">AZ</code> (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">US-AZ</code> ). For Tamil Nadu (India), set as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">TN</code> (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">IN-TN</code> ). For British Columbia (Canada), set as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">BC</code> (not <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">CA-BC</code> ).

billing_statestring

The state/province name.

billing_countrystring

billing_zipstring

Postal or Zip code, as available in card billing address.

created_atinteger (unix-time)required

Timestamp indicating when this card resource is created.

resource_versioninteger (int64)

updated_atinteger (unix-time)

Timestamp indicating when this credit card resource was last updated.

ip_addressstring

The IP address of the customer. Used primarily for referral integration and EU VAT validation.

powered_bystring

Card is powered by payment method. \* card - card \* ideal - ideal \* payconiq - payconiq \* sofort - sofort \* bancontact - bancontact \* giropay - giropay \* latam_local_card - latam_local_card \* not_applicable - not_applicable

One ofidealsofortbancontactgiropaycardlatam_local_cardpayconiqnot_applicable

customer_idstringrequired

Identifier of the customer.

masked_numberstring

Masked credit card number that is safe to show.

json

{
  "customer": null,
  "card": null
}

Need more? See the Chargebee guide for connection setup and behaviour shared by every action.

Was this page helpful?