List Subscriptions

The number of resources to be returned.

Default 10

<p class="mb-2">Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always 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">offset</code> to the value 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">next_offset</code> obtained in the previous iteration of the API call.</p>

<p class="mb-2">Indicates whether to include deleted objects in the list. The deleted objects have the attribute <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">deleted</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">true</code> .</p>

Default false

optional, string filter A unique and immutable identifier for the subscription. If not provided, it is autogenerated. **Supported operators :** is, is_not, starts_with, in, not_in **Example →** *id\[is_not\] = "8gsnbYfsMLds"*

optional, string filter Identifier of the customer with whom this subscription is associated. **Supported operators :** is, is_not, starts_with, in, not_in **Example →** *customer_id\[is\] = "8gsnbYfsMLds"*

optional, string filter The plan item code. **Supported operators :** is, is_not, starts_with, in, not_in **Example →** *item_id\[is_not\] = "silver"*

optional, string filter The plan item price code. **Supported operators :** is, is_not, starts_with, in, not_in **Example →** *item_price_id\[is\] = "silver-USD-monthly"*

optional, enumerated string filter Current state of the subscription. Possible values are : future, in_trial, active, non_renewing, paused, cancelled. **Supported operators :** is, is_not, in, not_in **Example →** *status\[is_not\] = "active"*

\* \`future\` - The subscription is scheduled to start at a future date. \* \`in_trial\` - The subscription is in trial. \* \`active\` - The subscription is active and will be charged for automatically based on the items in it. \* \`non_renewing\` - The subscription will be canceled at the end of the current term. \* \`paused\` - The subscription is [paused](https://www.chargebee.com/docs/2.0/pause-subscription.html). The subscription will not renew while in this state. \* \`cancelled\` - The subscription has been canceled and is no longer in service. \* \`transferred\` - The subscription has been transferred to another business entity within the organization.

One offuturein_trialactivenon_renewingpausedcancelledtransferred

\* \`future\` - The subscription is scheduled to start at a future date. \* \`in_trial\` - The subscription is in trial. \* \`active\` - The subscription is active and will be charged for automatically based on the items in it. \* \`non_renewing\` - The subscription will be canceled at the end of the current term. \* \`paused\` - The subscription is [paused](https://www.chargebee.com/docs/2.0/pause-subscription.html). The subscription will not renew while in this state. \* \`cancelled\` - The subscription has been canceled and is no longer in service. \* \`transferred\` - The subscription has been transferred to another business entity within the organization.

One offuturein_trialactivenon_renewingpausedcancelledtransferred

\* \`future\` - The subscription is scheduled to start at a future date. \* \`in_trial\` - The subscription is in trial. \* \`active\` - The subscription is active and will be charged for automatically based on the items in it. \* \`non_renewing\` - The subscription will be canceled at the end of the current term. \* \`paused\` - The subscription is [paused](https://www.chargebee.com/docs/2.0/pause-subscription.html). The subscription will not renew while in this state. \* \`cancelled\` - The subscription has been canceled and is no longer in service. \* \`transferred\` - The subscription has been transferred to another business entity within the organization.

One offuturein_trialactivenon_renewingpausedcancelledtransferred

\* \`future\` - The subscription is scheduled to start at a future date. \* \`in_trial\` - The subscription is in trial. \* \`active\` - The subscription is active and will be charged for automatically based on the items in it. \* \`non_renewing\` - The subscription will be canceled at the end of the current term. \* \`paused\` - The subscription is [paused](https://www.chargebee.com/docs/2.0/pause-subscription.html). The subscription will not renew while in this state. \* \`cancelled\` - The subscription has been canceled and is no longer in service. \* \`transferred\` - The subscription has been transferred to another business entity within the organization.

One offuturein_trialactivenon_renewingpausedcancelledtransferred

optional, enumerated string filter The reason for canceling the subscription. Set by Chargebee automatically. Possible values are : not_paid, no_card, fraud_review_failed, non_compliant_eu_customer, tax_calculation_failed, currency_incompatible_with_gateway, non_compliant_customer. **Supported operators :** is, is_not, in, not_in, is_present **Example →** *cancel_reason\[is\] = "not_paid"*

\* \`not_paid\` - Not Paid \* \`no_card\` - No Card \* \`fraud_review_failed\` - Fraud Review Failed \* \`non_compliant_eu_customer\` - Non Compliant EU Customer \* \`tax_calculation_failed\` - Tax Calculation Failed \* \`currency_incompatible_with_gateway\` - Currency incompatible with Gateway \* \`non_compliant_customer\` - Non Compliant Customer

One ofnot_paidno_cardfraud_review_failednon_compliant_eu_customertax_calculation_failedcurrency_incompatible_with_gatewaynon_compliant_customer

\* \`not_paid\` - Not Paid \* \`no_card\` - No Card \* \`fraud_review_failed\` - Fraud Review Failed \* \`non_compliant_eu_customer\` - Non Compliant EU Customer \* \`tax_calculation_failed\` - Tax Calculation Failed \* \`currency_incompatible_with_gateway\` - Currency incompatible with Gateway \* \`non_compliant_customer\` - Non Compliant Customer

One ofnot_paidno_cardfraud_review_failednon_compliant_eu_customertax_calculation_failedcurrency_incompatible_with_gatewaynon_compliant_customer

\* \`not_paid\` - Not Paid \* \`no_card\` - No Card \* \`fraud_review_failed\` - Fraud Review Failed \* \`non_compliant_eu_customer\` - Non Compliant EU Customer \* \`tax_calculation_failed\` - Tax Calculation Failed \* \`currency_incompatible_with_gateway\` - Currency incompatible with Gateway \* \`non_compliant_customer\` - Non Compliant Customer

One ofnot_paidno_cardfraud_review_failednon_compliant_eu_customertax_calculation_failedcurrency_incompatible_with_gatewaynon_compliant_customer

\* \`not_paid\` - Not Paid \* \`no_card\` - No Card \* \`fraud_review_failed\` - Fraud Review Failed \* \`non_compliant_eu_customer\` - Non Compliant EU Customer \* \`tax_calculation_failed\` - Tax Calculation Failed \* \`currency_incompatible_with_gateway\` - Currency incompatible with Gateway \* \`non_compliant_customer\` - Non Compliant Customer

One ofnot_paidno_cardfraud_review_failednon_compliant_eu_customertax_calculation_failedcurrency_incompatible_with_gatewaynon_compliant_customer

One oftruefalse

optional, string filter Reason code for canceling the subscription. Must be one from a list of reason codes set in the Chargebee app in **Settings \> Configure Chargebee \> Reason Codes \> Subscriptions \> Subscription Cancellation** . Must be passed if set as mandatory in the app. The codes are case-sensitive. **Supported operators :** is, is_not, starts_with, in, not_in **Example →** *cancel_reason_code\[is\] = "Not Paid"*

optional, integer filter * When the subscription is not on a contract term: this value is the number of billing cycles remaining after the current cycle, at the end of which, the subscription cancels. * When the subscription is on a [contract term](/docs/api/contract_terms): this value is the number of billing cycles remaining in the contract term after the current billing cycle. . **Supported operators :** is, is_not, lt, lte, gt, gte, between, is_present **Example →** *remaining_billing_cycles\[is_not\] = "3"*

One oftruefalse

optional, timestamp(UTC) in seconds filter The time at which the subscription was created. **Supported operators :** after, before, on, between **Example →** *created_at\[before\] = "1435054328"*

<dfn class="text-muted"><p class="mb-2">optional, timestamp(UTC) in seconds filter</p></dfn> <p class="mb-2">Time at which the subscription <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> last changed 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">active</code>. For example, this value is updated when an <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">cancelled</code> subscription activates. <strong class="font-semibold">Supported operators :</strong> after, before, on, between, is_present</p> <p class="mb-2"><strong class="font-semibold">Example →</strong> <em class="italic">activated_at[after] = &quot;1435054328&quot;</em></p>

One oftruefalse

<dfn class="text-muted"><p class="mb-2">optional, timestamp(UTC) in seconds filter</p></dfn> <p class="mb-2">The date/time at which the next billing for the subscription happens. This is usually right after <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">current_term_end</code> unless multiple subscription terms were invoiced in advance using 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">terms_to_charge</code> parameter. <strong class="font-semibold">Supported operators :</strong> after, before, on, between</p> <p class="mb-2"><strong class="font-semibold">Example →</strong> <em class="italic">next_billing_at[after] = &quot;1435054328&quot;</em></p>

optional, timestamp(UTC) in seconds filter Time at which subscription was cancelled or is set to be cancelled. **Supported operators :** after, before, on, between **Example →** *cancelled_at\[after\] = "1435054328"*

<dfn class="text-muted"><p class="mb-2">optional, boolean filter</p></dfn> <p class="mb-2">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">true</code> , there are subscription changes scheduled on next renewal. Possible values are : <em class="italic">true, false</em></p> <p class="mb-2"><strong class="font-semibold">Supported operators :</strong> is</p> <p class="mb-2"><strong class="font-semibold">Example →</strong> <em class="italic">has_scheduled_changes[is] = &quot;true&quot;</em></p>

One oftruefalse

<dfn class="text-muted"><p class="mb-2">optional, timestamp(UTC) in seconds filter</p></dfn> <p class="mb-2">To filter based on <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">updated_at</code>. This attribute will be present only if the resource has been updated after 2016-09-28. It is advisable when using this filter, to pass 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">sort_by</code> input parameter 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">updated_at</code> for a faster response. <strong class="font-semibold">Supported operators :</strong> after, before, on, between</p> <p class="mb-2"><strong class="font-semibold">Example →</strong> <em class="italic">updated_at[after] = &quot;1243545465&quot;</em></p>

optional, enumerated string filter The preferred offline payment method for the subscription. Possible values are : no_preference, cash, check, bank_transfer, ach_credit, sepa_credit. **Supported operators :** is, is_not, in, not_in **Example →** *offline_payment_method\[is_not\] = "cash"*

\* \`no_preference\` - No Preference \* \`cash\` - Cash \* \`check\` - Check \* \`bank_transfer\` - Bank Transfer \* \`ach_credit\` - ACH Credit \* \`sepa_credit\` - SEPA Credit \* \`boleto\` - Boleto \* \`us_automated_bank_transfer\` - US Automated Bank Transfer \* \`eu_automated_bank_transfer\` - EU Automated Bank Transfer \* \`uk_automated_bank_transfer\` - UK Automated Bank Transfer \* \`jp_automated_bank_transfer\` - JP Automated Bank Transfer \* \`mx_automated_bank_transfer\` - MX Automated Bank Transfer \* \`custom\` - Custom

One ofno_preferencecashcheckbank_transferach_creditsepa_creditboletous_automated_bank_transfereu_automated_bank_transferuk_automated_bank_transferjp_automated_bank_transfermx_automated_bank_transfercustom

\* \`no_preference\` - No Preference \* \`cash\` - Cash \* \`check\` - Check \* \`bank_transfer\` - Bank Transfer \* \`ach_credit\` - ACH Credit \* \`sepa_credit\` - SEPA Credit \* \`boleto\` - Boleto \* \`us_automated_bank_transfer\` - US Automated Bank Transfer \* \`eu_automated_bank_transfer\` - EU Automated Bank Transfer \* \`uk_automated_bank_transfer\` - UK Automated Bank Transfer \* \`jp_automated_bank_transfer\` - JP Automated Bank Transfer \* \`mx_automated_bank_transfer\` - MX Automated Bank Transfer \* \`custom\` - Custom

One ofno_preferencecashcheckbank_transferach_creditsepa_creditboletous_automated_bank_transfereu_automated_bank_transferuk_automated_bank_transferjp_automated_bank_transfermx_automated_bank_transfercustom

\* \`no_preference\` - No Preference \* \`cash\` - Cash \* \`check\` - Check \* \`bank_transfer\` - Bank Transfer \* \`ach_credit\` - ACH Credit \* \`sepa_credit\` - SEPA Credit \* \`boleto\` - Boleto \* \`us_automated_bank_transfer\` - US Automated Bank Transfer \* \`eu_automated_bank_transfer\` - EU Automated Bank Transfer \* \`uk_automated_bank_transfer\` - UK Automated Bank Transfer \* \`jp_automated_bank_transfer\` - JP Automated Bank Transfer \* \`mx_automated_bank_transfer\` - MX Automated Bank Transfer \* \`custom\` - Custom

One ofno_preferencecashcheckbank_transferach_creditsepa_creditboletous_automated_bank_transfereu_automated_bank_transferuk_automated_bank_transferjp_automated_bank_transfermx_automated_bank_transfercustom

\* \`no_preference\` - No Preference \* \`cash\` - Cash \* \`check\` - Check \* \`bank_transfer\` - Bank Transfer \* \`ach_credit\` - ACH Credit \* \`sepa_credit\` - SEPA Credit \* \`boleto\` - Boleto \* \`us_automated_bank_transfer\` - US Automated Bank Transfer \* \`eu_automated_bank_transfer\` - EU Automated Bank Transfer \* \`uk_automated_bank_transfer\` - UK Automated Bank Transfer \* \`jp_automated_bank_transfer\` - JP Automated Bank Transfer \* \`mx_automated_bank_transfer\` - MX Automated Bank Transfer \* \`custom\` - Custom

One ofno_preferencecashcheckbank_transferach_creditsepa_creditboletous_automated_bank_transfereu_automated_bank_transferuk_automated_bank_transferjp_automated_bank_transfermx_automated_bank_transfercustom

<dfn class="text-muted"><p class="mb-2">optional, boolean filter</p></dfn> <p class="mb-2">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> to override for this subscription, the <a href="https://www.chargebee.com/docs/billing/2.0/usage-based-billing/metered_billing#configuring-metered-billing" target="_blank" rel="noopener noreferrer">site-level setting</a> for auto-closing invoices. Only applicable when auto-closing invoices has been enabled for the site. This attribute has a higher precedence than the same attribute at the <a href="/docs/api/customers/customer-object#auto_close_invoices">customer level</a>. Possible values are : <em class="italic">true, false</em></p> <p class="mb-2"><strong class="font-semibold">Supported operators :</strong> is</p> <p class="mb-2"><strong class="font-semibold">Example →</strong> <em class="italic">auto_close_invoices[is] = &quot;true&quot;</em></p>

One oftruefalse

<dfn class="text-muted"><p class="mb-2">optional, boolean filter</p></dfn> <p class="mb-2">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">true</code> , ignores the <a href="/docs/api/customers/customer-object#relationship">hierarchy relationship</a> and uses customer as payment and invoice owner. Possible values are : <em class="italic">true, false</em></p> <p class="mb-2"><strong class="font-semibold">Supported operators :</strong> is</p> <p class="mb-2"><strong class="font-semibold">Example →</strong> <em class="italic">override_relationship[is] = &quot;false&quot;</em></p>

One oftruefalse

optional, string filter Sorts based on the specified attribute. **Supported attributes :** created_at, updated_at **Supported sort-orders :** asc, desc **Example →** *sort_by\[asc\] = "created_at"* This will sort the result based on the 'created_at' attribute in ascending(earliest first) order.

One ofcreated_atupdated_at

One ofcreated_atupdated_at

optional, string filter 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. **Supported operators :** is, is_not, starts_with **Example →** *business_entity_id\[is_not\] = "business_entity_id"*

optional, enumerated string filter The subscription channel this object originated from and is maintained in. Possible values are : web, app_store, play_store. **Supported operators :** is, is_not, in, not_in **Example →** *channel\[is_not\] = "APP STORE"*

\* \`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)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions) created in Apple App Store. Direct manipulation of this object via UI or API is disallowed. \* \`play_store\` - The object data is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/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.

One ofwebapp_storeplay_store

\* \`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)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions) created in Apple App Store. Direct manipulation of this object via UI or API is disallowed. \* \`play_store\` - The object data is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/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.

One ofwebapp_storeplay_store

\* \`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)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions) created in Apple App Store. Direct manipulation of this object via UI or API is disallowed. \* \`play_store\` - The object data is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/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.

One ofwebapp_storeplay_store

\* \`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)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions) created in Apple App Store. Direct manipulation of this object via UI or API is disallowed. \* \`play_store\` - The object data is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/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.

One ofwebapp_storeplay_store

One oftruefalse

The device from which the customer has made the request

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

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.

The IP address of the customer where the request originated

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.

<div class="api-description"><p class="mb-2">A Chargebee subscription connects a customer record to products/services. It describes what the customer has signed up for and how often they&#x27;re charged for it. The essential components of a subscription are:</p><ul class="list-disc list-outside ml-6 my-4 space-y-2"> <li class="text-base leading-relaxed">A <a href="/docs/api/item_prices">plan-item price</a>.</li> <li class="text-base leading-relaxed">Any addon- and charge-item prices applied to the subscription.</li> <li class="text-base leading-relaxed">Any <a href="/docs/api/coupons">coupons</a> applied.</li> <li class="text-base leading-relaxed">Any <a href="/docs/api/discounts">discounts</a> applied.</li> </ul><p class="mb-2">The charges in a subscription are billed via invoices.</p><div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Note:</strong> The maximum number of subscriptions for any given <a href="/docs/api/customers">customer</a> (<code><a href="/docs/api/subscriptions/subscription-object#status">active</a></code> or not) is 900.</p></div><div id="subscription-billing-frequencies" class="cb-accordion"><div class="cb-accordion-title collapsed" data-toggle="collapse" data-target="#subscription-billing-frequencies-content" aria-expanded="false" aria-controls="subscription-billing-frequencies-content"><h4>Subscription billing frequencies</h4><i class="fa fa-chevron-circle-down fa-lg" aria-hidden="true"></i></div><div class="collapse" id="subscription-billing-frequencies-content"><p class="mb-2">Chargebee offers two billing frequency options for subscriptions:</p><ul class="list-disc list-outside ml-6 my-4 space-y-2"> <li class="text-base leading-relaxed"> <p class="mb-2"><strong class="font-semibold">Plan-based billing</strong> (<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">default</code>): Subscriptions are billed based on the billing period defined for the item price 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">item_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">plan</code>. <a href="https://www.chargebee.com/docs/billing/2.0/subscriptions/subscriptions#plan-based-billing" target="_blank" rel="noopener noreferrer" class="text-blue-600 hover:text-blue-800 underline">Learn more</a>.</p> </li> <li class="text-base leading-relaxed"> <p class="mb-2"><strong class="font-semibold">Multi-frequency billing</strong>: Subscriptions are billed according to the billing period of each recurring item price within the subscription. <a href="https://www.chargebee.com/docs/billing/2.0/subscriptions/multi-frequency-billing" target="_blank" rel="noopener noreferrer" class="text-blue-600 hover:text-blue-800 underline">Learn more</a>.</p> <div class="warning alert alert-warning"><p class="mb-2"><strong class="font-semibold">Important</strong></p><p class="mb-2"><a href="https://www.chargebee.com/docs/billing/2.0/subscriptions/multi-frequency-billing#limitations" target="_blank" rel="noopener noreferrer" class="text-blue-600 hover:text-blue-800 underline">Limitations</a> of Multi-frequency billing.</p></div> <div class="warning alert alert-warning"><p class="mb-2"><strong class="font-semibold">Private Beta</strong></p><p class="mb-2">Multi-frequency billing is in private beta. Please reach out to the Chargebee <a href="https://www.chargebee.com/docs/billing/2.0/kb/getting-started/how-to-contact-chargebees-support-team?utm_source=docs_api&amp;utm_medium=content&amp;utm_campaign=support" target="_blank" rel="noopener noreferrer" class="text-blue-600 hover:text-blue-800 underline">support</a> to enable this feature.</p></div> </li> </ul><p class="mb-2">The selection of the billing frequency preference is configured at the site level.</p></div></div><div id="item-price-compatibility" class="cb-accordion"><div class="cb-accordion-title collapsed" data-toggle="collapse" data-target="#item-price-compatibility-content" aria-expanded="false" aria-controls="item-price-compatibility-content"><h4>Item price compatibility in a subscription</h4><i class="fa fa-chevron-circle-down fa-lg" aria-hidden="true"></i></div><div class="collapse" id="item-price-compatibility-content"><p class="mb-2">When creating or updating a subscription, one of the item prices specified under subscription_items must be a plan-item price. The remaining must be compatible addon- or charge-item prices. An item price is compatible with a plan-item price if their currencies are the same. Additionally, an addon-item price is compatible with a plan-item price only if their billing frequencies meet the following conditions:</p><div class="relative w-full overflow-x-auto"><table class="cb-table" border="2"><thead><tr><th><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> for plan-item price</th><th>Compatible <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> for addon-item price</th><th>Compatible period for addon-item price</th></tr></thead><tbody><tr><td><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">day</code></td><td><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">day</code></td><td><p class="mb-2">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">period</code> of the plan-item price should be divisible by 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">period</code> of the addon-item price.</p><div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Example</strong></p><p class="mb-2">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">period</code> of the plan-item price 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">10</code>, then the period of the addon-item price can 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">10</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">5</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">2</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">1</code>.</p></div></td></tr><tr><td><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">week</code></td><td><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">week</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">day</code></td><td><p class="mb-2">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">period</code> (in days) of the plan-item price should be divisible by 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">period</code> of the addon-item price.</p><div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Example</strong> 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">period</code> of the plan-item price 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">2</code>, then the period of the addon-item price can be as follows depending on the value 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">period_unit</code>:</p><ul class="list-disc list-outside ml-6 my-4 space-y-2"> <li class="text-base leading-relaxed">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">period_unit</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">week</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">period</code> can 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">2</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">1</code>.</li> <li class="text-base leading-relaxed">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">period_unit</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">day</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">period</code> can 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">14</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">7</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">2</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">1</code>.</li> </ul></div></td></tr><tr><td><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></td><td><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></td><td><p class="mb-2">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">period</code> of the plan-item price should be divisible by 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">period</code> of the addon-item price.</p><div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Example</strong></p><p class="mb-2">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">period</code> of the plan-item price 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">6</code>, then 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">period</code> of the addon-item price can 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">6</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">3</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">2</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">1</code>.</p></div></td></tr><tr><td><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></td><td><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> 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">month</code></td><td><p class="mb-2">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">period</code> (in months) of the plan-item price should be divisible by 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">period</code> of the addon-item price.</p><div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Example</strong></p><p class="mb-2">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">period</code> of the plan-item price 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">2</code>, then 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">period</code> of the addon-item price can be as follows depending on the value 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">period_unit</code>:</p><ul class="list-disc list-outside ml-6 my-4 space-y-2"> <li class="text-base leading-relaxed">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">period_unit</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">year</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">period</code> can 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">2</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">1</code>.</li> <li class="text-base leading-relaxed">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">period_unit</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">month</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">period</code> can 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">24</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">12</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">8</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">6</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">4</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">3</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">2</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">1</code>.</li> </ul></div></td></tr></tbody></table></div></div></div><div id="tax-provider" class="cb-accordion"><div class="cb-accordion-title collapsed" data-toggle="collapse" data-target="#tax-provider-content" aria-expanded="false" aria-controls="tax-provider-content"><h4>Tax provider fields</h4><i class="fa fa-chevron-circle-down fa-lg" aria-hidden="true"></i></div><div class="collapse" id="tax-provider-content"><p class="mb-2"><strong class="font-semibold">Avalara</strong>: Merchants using <strong class="font-semibold">Avalara Sales Tax</strong> can optionally associate each item price with a locationCode (from their Avalara company locations), so tax can be resolved correctly at the line item level.</p><div class="relative w-full overflow-x-auto"><table class="cb-table" border="2"><thead><tr><th colSpan="1" rowspan="1" style="text-align:center;vertical-align:top">Field ID</th><th colSpan="1" rowspan="1" style="text-align:center;vertical-align:top">Field Value</th><th colSpan="1" rowspan="1" style="text-align:center;vertical-align:top">APIs</th></tr></thead><tbody><tr><td><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">locationCode</code></td><td colSpan="1" rowspan="1" style="text-align:center;vertical-align:top">Merchant to configure it on Avalara Platform under company locations</td><td colSpan="1" rowspan="4" style="text-align:center;vertical-align:top">APIs having <a href="/docs/api/item_prices/item-price-object" class="text-blue-600 hover:text-blue-800 underline">Item Prices</a> attributes.</td></tr></tbody></table></div><p class="mb-2"><strong class="font-semibold">Anrok</strong>: Canadian customers can have multiple tax registration numbers. We currently support only sharing one tax registration number with Anrok. So we added a new field which can have comma separated multiple tax reg numbers for Anrok. Values configured in the field is passed as it is to Anrok for accurate tax calculation</p><div class="relative w-full overflow-x-auto"><table class="cb-table" border="2"><thead><tr><th colSpan="1" rowspan="1" style="text-align:center;vertical-align:top">Field ID</th><th colSpan="1" rowspan="1" style="text-align:center;vertical-align:top">Field Value</th><th colSpan="1" rowspan="1" style="text-align:center;vertical-align:top">APIs</th></tr></thead><tbody><tr><td><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">additionalTaxRegistrationNumber</code></td><td colSpan="1" rowspan="1" style="text-align:center;vertical-align:top">Canadian tax registration numbers in comma separated fashion.</td><td colSpan="1" rowspan="4" style="text-align:center;vertical-align:top">APIs involving customer attributes. Also includes APIs where we are creating new customers. Eg: estimate, subscription, hosted pages.</td></tr></tbody></table></div><p class="mb-2"><strong class="font-semibold">Vertex</strong>: Chargebee shares field IDs and corresponding values with merchants, who then configure them on the Vertex Platform for seamless integration</p><div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Note:</strong> Field Id like <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">customerCode</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">customerClass</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">taxExempted</code> belong to the customer object.</p><p class="mb-2">Field Id like <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">productCode</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">productClass</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">productTaxCode</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">productClass</code> belong to the product object.</p></div><div class="relative w-full overflow-x-auto"><table class="cb-table" border="2"><thead><tr><th colSpan="1" rowspan="1" style="vertical-align:top;text-align:center">Field ID</th><th colSpan="1" rowspan="1" style="vertical-align:top;text-align:center">Field Value</th><th colSpan="1" rowspan="1" style="vertical-align:top;text-align:center">APIs</th></tr></thead><tbody><tr><td colSpan="1" rowspan="1" style="vertical-align:top;text-align:center"><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">productCode</code></td><td colSpan="1" rowspan="4" style="vertical-align:top;text-align:center">Merchant to configure it on Vertex Platform</td><td colSpan="1" rowspan="2" style="vertical-align:top;text-align:center">APIs having <a href="/docs/api/item_prices/item-price-object">Item Prices</a> attributes.</td></tr><tr><td colSpan="1" rowspan="1" style="vertical-align:top;text-align:center"><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">productClass</code></td></tr><tr><td colSpan="1" rowspan="1" style="vertical-align:top;text-align:center"><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">customerCode</code></td><td colSpan="1" rowspan="2" style="vertical-align:top;text-align:center">APIs involving <a href="/docs/api/customers/customer-object">customer</a> attributes. Also includes APIs where we are creating new customers. For example: <a href="/docs/api/estimates/estimate-for-creating-a-customer-and-subscription">estimate</a>, <a href="/docs/api/subscriptions">subscription</a>, <a href="/docs/api/hosted_pages/checkout-charge-items-and-one-time-charges">hosted pages</a>.</td></tr><tr><td colSpan="1" rowspan="1" style="vertical-align:top;text-align:center"><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">customerClass</code></td></tr></tbody></table></div><p class="mb-2"><strong class="font-semibold">Taxamo:</strong> Chargebee shares field IDs and corresponding values with merchants, who then configure them on the Taxamo Platform for seamless integration</p><div class="relative w-full overflow-x-auto"><table class="cb-table" border="2"><thead><tr><th colSpan="1" rowspan="1" style="vertical-align:top;text-align:center">Field Id</th><th colSpan="1" rowspan="1" style="vertical-align:top;text-align:center">Field Value</th><th colSpan="1" rowspan="1" style="vertical-align:top;text-align:center">APIs</th></tr></thead><tbody><tr><td colSpan="1" rowspan="1" style="vertical-align:top;text-align:center"><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">productTaxCode</code></td><td colSpan="1" rowspan="3" style="vertical-align:top;text-align:center">Merchant to configure it on Taxamo Platform</td><td colSpan="1" rowspan="2" style="vertical-align:top;text-align:center">APIs having <a href="/docs/api/item_prices/item-price-object" class="text-blue-600 hover:text-blue-800 underline">Item Prices</a> attributes.</td></tr><tr><td colSpan="1" rowspan="1" style="vertical-align:top;text-align:center"><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">productClass</code></td></tr><tr><td colSpan="1" rowspan="1" style="vertical-align:top;text-align:center"><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">taxExempted</code></td><td colSpan="1" rowspan="1" style="vertical-align:top;text-align:center">APIs involving <a href="/docs/api/customers/customer-object">customer</a> attributes. Also includes APIs where we are creating new customers. For example: <a href="/docs/api/estimates/estimate-for-creating-a-customer-and-subscription">estimate</a>, <a href="/docs/api/subscriptions">subscription</a>, <a href="/docs/api/hosted_pages/checkout-charge-items-and-one-time-charges">hosted pages</a>.</td></tr></tbody></table></div><p class="mb-2"><strong class="font-semibold">cbtaxes</strong>: With CBTaxes, you can activate India IGST for customers located in Special Economic Zones (SEZ), implement zero-rated tax for SEZ customers, enable India IGST for customers outside of India, and set up zero-rated tax for customers outside of India.</p><div class="relative w-full overflow-x-auto"><table class="cb-table" border="2"><thead><tr><th colSpan="1" rowspan="1" style="text-align:center;vertical-align:top">Field ID</th><th colSpan="1" rowspan="1" style="text-align:center;vertical-align:top">Field Value</th><th colSpan="1" rowspan="1" style="text-align:center;vertical-align:top">APIs</th></tr></thead><tbody><tr><td colSpan="1" rowspan="2" style="text-align:center;vertical-align:top"><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">indiaSez</code></td><td colSpan="1" rowspan="1" style="text-align:center;vertical-align:top"><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">SEZ_IGST_TAX</code></td><td colSpan="1" rowspan="4" style="text-align:center;vertical-align:top">APIs involving <a href="/docs/api/customers/customer-object">customer</a> attributes. Also includes APIs where we are creating new customers. For example: <a href="/docs/api/estimates/estimate-for-creating-a-customer-and-subscription">estimate</a>, <a href="/docs/api/subscriptions">subscription</a>, <a href="/docs/api/hosted_pages/checkout-charge-items-and-one-time-charges">hosted pages</a>.</td></tr><tr><td colSpan="1" rowspan="1" style="text-align:center;vertical-align:top"><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">SEZ_ZERO_RATED_TAX</code></td></tr><tr><td colSpan="1" rowspan="2" style="text-align:center;vertical-align:top"><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">indiaExport</code></td><td colSpan="1" rowspan="1" style="text-align:center;vertical-align:top"><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">EXPORT_IGST_TAX</code></td></tr><tr><td colSpan="1" rowspan="1" style="text-align:center;vertical-align:top"><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">EXPORT_ZERO_RATED_TAX</code></td></tr></tbody></table></div><p class="mb-2"><strong class="font-semibold">All</strong>: For tax inclusive tax calculation, For tax exclusive tax calculation. This is currently used for price type overriding at customer level</p><div class="relative w-full overflow-x-auto"><table class="cb-table" border="2"><thead><tr><th style="text-align:center;vertical-align:top">Field ID</th><th style="text-align:center;vertical-align:top">Field Value</th><th style="text-align:center;vertical-align:top">APIs</th></tr></thead><tbody><tr><td style="text-align:center;vertical-align:top"><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">priceType</code></td><td style="text-align:center;vertical-align:top"><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">TAX_INCLUSIVE</code></td><td style="text-align:center;vertical-align:top">APIs involving <a href="/docs/api/customers/customer-object">customer</a> attributes. Also includes APIs where we are creating new customers. For example: <a href="/docs/api/estimates/estimate-for-creating-a-customer-and-subscription">estimate</a>, <a href="/docs/api/subscriptions">subscription</a>, <a href="/docs/api/hosted_pages/checkout-charge-items-and-one-time-charges">hosted pages</a>.</td></tr><tr><td style="text-align:center;vertical-align:top"></td><td style="text-align:center;vertical-align:top"><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">TAX_EXCLUSIVE</code></td><td style="text-align:center;vertical-align:top"></td></tr><tr><td style="text-align:center;vertical-align:top"></td><td style="text-align:center;vertical-align:top"><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">SITE_DEFAULT</code> or blank</td><td style="text-align:center;vertical-align:top">Removes price type override, and allows site level configuration to be used for tax calculation.</td></tr></tbody></table></div></div></div><div id="ramps-compat-mode" class="cb-accordion"><div class="cb-accordion-title collapsed" data-toggle="collapse" data-target="#ramps-compat-mode-content" aria-expanded="false" aria-controls="ramps-compat-mode-content"><h4>Ramps API compatibility mode</h4><i class="fa fa-chevron-circle-down fa-lg" aria-hidden="true"></i></div><div class="collapse" id="ramps-compat-mode-content"><p class="mb-2">If you want to schedule changes on a subscription, use the <a href="/docs/api/ramps" class="text-blue-600 hover:text-blue-800 underline">Ramps API</a>.</p><p class="mb-2">If you are currently scheduling changes through the <a href="/docs/api/subscriptions/update-subscription-for-items" class="text-blue-600 hover:text-blue-800 underline">Update subscription API</a>, migrate to the Ramps API. To get started, <a href="https://app.chargebee.com/login?forward=https://app.chargebee.com/request_access/subscription-ramps&amp;ref=feature" target="_blank" rel="noopener noreferrer" class="text-blue-600 hover:text-blue-800 underline">request access for Subscription Ramps</a>. Chargebee will enable Ramps compatibility mode for your site. Once enabled, you can test the Ramps API without impacting your existing integrations.</p><p class="mb-2">The following parts of the Billing API have subtle differences in behavior when the Ramps feature is disabled versus when it is enabled with compatibility mode. (Follow the links to learn more.)</p><ul class="list-disc list-outside ml-6 my-4 space-y-2"> <li class="text-base leading-relaxed">The value of the <a href="/docs/api/subscriptions/subscription-object#has_scheduled_changes" 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">subscription.has_scheduled_changes</code></a> attribute.</li> <li class="text-base leading-relaxed"><a href="/docs/api/subscriptions/update-subscription-for-items#impact-scheduled-changes" class="text-blue-600 hover:text-blue-800 underline">Update subscription</a></li> <li class="text-base leading-relaxed"><a href="/docs/api/hosted_pages/create-checkout-to-update-a-subscription#impact-scheduled-changes" class="text-blue-600 hover:text-blue-800 underline">Create Checkout for updating a subscription</a></li> <li class="text-base leading-relaxed"><a href="/docs/api/subscriptions/remove-scheduled-changes" class="text-blue-600 hover:text-blue-800 underline">Remove scheduled changes</a></li> <li class="text-base leading-relaxed"><a href="/docs/api/subscriptions/retrieve-with-scheduled-changes" class="text-blue-600 hover:text-blue-800 underline">Retrieve with scheduled changes</a></li> <li class="text-base leading-relaxed"><a href="/docs/api/quotes/create-a-quote-for-update-subscription-items" class="text-blue-600 hover:text-blue-800 underline">Create a quote for updating a subscription</a></li> <li class="text-base leading-relaxed"><a href="/docs/api/quotes/edit-update-subscription-quote-for-items" class="text-blue-600 hover:text-blue-800 underline">Edit a quote for updating a subscription</a></li> <li class="text-base leading-relaxed"><a href="/docs/api/portal_sessions#scheduled-subscription-changes" class="text-blue-600 hover:text-blue-800 underline">Portal sessions</a></li> </ul></div></div></div>

<div class="api-description"><p class="mb-2">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&#x27;d like to associate with them.</p><div class="warning alert alert-warning"><p class="mb-2"><strong class="font-semibold">Breaking Change</strong>:</p><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"><strong class="font-semibold">Sites</strong></a> <strong class="font-semibold">created before March 1, 2014</strong>: <a href="/docs/api/cards/update-card-for-a-customer">updating the card</a> deletes the customer&#x27;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"><strong class="font-semibold">Sites created on or after March 1, 2014</strong>: updating the card doesn&#x27;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>

#### 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) |

<p class="mb-2">This attribute is returned only if more resources are present. To fetch the next set of resources use this value for the input parameter <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">offset</code>.</p>