Import Subscription For Items

Import a subscription

POST/customers/{customer-id}/import_for_items

Use it in a workflow

Add a step and choose the Chargebee connector.
Pick the Import Subscription For Items action (under Chargebee API).
Fill in the fields below, then reference the result from later steps as {{importSubscriptionForItems.response.data}}.

Request

Path parameters

customer-idstringrequired

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.

exhausted_coupon_idsarray<string>

<p class="mb-2">Specifies the IDs of <a href="/docs/api/coupons">coupons</a> to be marked as exhausted. This parameter accepts a list of IDs, which must correspond to coupons with a <code><a href="/docs/api/coupons/coupon-object#duration_type">duration_type</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">one_time</code>. Ensure that the IDs included in this parameter do not match any IDs provided in the <code><a href="/docs/api/subscriptions/import-subscription-for-items#coupon_ids">coupon_ids</a></code> parameter.</p>

idstring

A unique and immutable identifier for the subscription. If not provided, it is autogenerated.

trial_endinteger (unix-time)

<p class="mb-2">End of the trial period for the subscription. This overrides the trial period set for the plan-item. The value must be later than <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">start_date</code>. Set it 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">0</code> to have no trial period.</p>

billing_cyclesinteger (int32)

The number of billing cycles the subscription runs before canceling. If not provided, then the billing cycles [set for the plan-item price](/docs/api/item_prices/item_price-object#billing_cycles) is used.

net_term_daysinteger (int32)

<p class="mb-2">Defines <a href="https://www.chargebee.com/docs/net_d.html" target="_blank">Net D</a> for the subscription. Net D is the number of days within which any invoice raised for the subscription must be paid.</p> <ul class="list-disc list-outside ml-6 my-4 space-y-2"> <li class="text-base leading-relaxed">If a value is provided: Net D is set explicitly for the subscription to the value provided. The value must be one among those defined in the <a href="https://www.chargebee.com/docs/net_d.html#enable-net-d-for-chargebee-invoices" target="_blank">site configuration</a>.</li> <li class="text-base leading-relaxed">If not provided: The attribute is not set and therefore not returned by the API. In this case, when an invoice is raised - whether now or later - 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">net_term_days</code> defined at the <a href="/docs/api/customers/customer-object#net_term_days">customer level</a> is considered. .</li> </ul>

start_dateinteger (unix-time)

The date/time at which the subscription is to start or has started. If not provided, the subscription starts immediately.

auto_collectionstring

Defines whether payments need to be collected automatically for this subscription. Overrides customer's auto-collection property. \* on - Whenever an invoice is created for this subscription, an automatic charge will be attempted on the payment method available. \* off - Automatic collection of charges will not be made for this subscription. Use this for offline payments.

One ofonoff

po_numberstring

Purchase order number for this subscription.

coupon_idsarray<string>

List of coupons to be applied to this subscription. You can provide coupon ids or [coupon codes](/docs/api/coupon_codes) .

payment_source_idstring

Id of the payment source to be attached to this subscription.

statusstringrequired

Current state of the subscription. \* future - The subscription is scheduled to start at a future date. \* active - The subscription is active and will be charged for automatically based on the items in it. \* 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. \* in_trial - The subscription is in trial. \* 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.

One offuturein_trialactivenon_renewingpausedcancelledtransferred

current_term_endinteger (unix-time)

End of the current billing term. Subscription is renewed immediately after this. If not given, this will be calculated based on plan billing cycle.

current_term_startinteger (unix-time)

<p class="mb-2">Start of the current billing period of the subscription. This is required when 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> 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">paused</code>. 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">status</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">active</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">non_renewing</code> , it defaults to the current time.</p>

trial_startinteger (unix-time)

<p class="mb-2">Start of the trial period for the subscription. When not passed, it is assumed to be current time. When passed for 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">future</code> subscription, it implies that the subscription goes into <code class="bg-gray-100 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> when it starts.</p>

cancelled_atinteger (unix-time)

Time at which subscription was cancelled or is set to be cancelled.

started_atinteger (unix-time)

<p class="mb-2">Time at which the subscription was started. 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">null</code> 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">future</code> subscriptions as it is yet to be started.</p>

activated_atinteger (unix-time)

<p class="mb-2">The time at which the subscription was activated. A subscription is "activated" when its <code class="bg-gray-100 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> changes from any other, to either <code class="bg-gray-100 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> 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">non_renewing</code>.</p>

pause_dateinteger (unix-time)

<p class="mb-2">When a pause has been scheduled, it is the date/time of scheduled pause. When the subscription is in 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">paused</code> state, it is the date/time when the subscription was paused.</p>

resume_dateinteger (unix-time)

For a paused subscription, it is the date/time when the subscription is scheduled to resume. If the pause is for an indefinite period, this value is not returned.

contract_term_billing_cycle_on_renewalinteger (int32)

<p class="mb-2">Number of billing cycles the new contract term should run for, on contract renewal. The default 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">billing_cycles</code> or a custom value depending on the <a href="https://www.chargebee.com/docs/contract-terms.html#configuring-contract-terms" target="_blank" rel="noopener noreferrer">site configuration</a> .</p>

create_current_term_invoiceboolean

<p class="mb-2">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">true</code> if you want an invoice to be created for the subscription.</p> <ul class="list-disc list-outside ml-6 my-4 space-y-2"> <li class="text-base leading-relaxed">The invoice will be created for the subscription only if it has 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">active</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">non_renewing</code> status.</li> <li class="text-base leading-relaxed">The period of the invoice is 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">current_term_start</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">current_term_end</code>.</li> <li class="text-base leading-relaxed">The invoice will not be generated if the subscription amount is zero dollars (for that period) and 'Hide Zero Value Line Items' option is enabled in site settings.</li> <li class="text-base leading-relaxed">You may 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">transaction</code> details to record an offline payment against that invoice.</li> </ul>

Default false

invoice_notesstring

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

meta_dataobject

A set of key-value pairs stored as additional information for the subscription. \[Learn more\](/docs/api/subscriptions) .

cancel_reason_codestring

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.

create_pending_invoicesboolean

<p class="mb-2">Indicates whether the invoices for this subscription are generated with 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">pending</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>. 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> automatically when the subscription has item prices that belong 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">metered</code> items. You can also set this 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> explicitly using the <a href="/docs/api/subscriptions/create-subscription-for-items#create_pending_invoices">create</a>/<a href="/docs/api/subscriptions/update-subscription-for-items#create_pending_invoices">update</a> subscription operations. This is useful in the following scenarios:</p> <ul class="list-disc list-outside ml-6 my-4 space-y-2"> <li class="text-base leading-relaxed">When tracking usages and calculating usage-based charges on your end. You can then add them to the subscription as a <a href="https://www.chargebee.com/docs/charges.html" target="_blank">one-time charge</a> at the end of the billing term.</li> <li class="text-base leading-relaxed">When you need to inspect all charges before closing invoices for this subscription. Applicable only when <a href="https://www.chargebee.com/docs/metered_billing.html" target="_blank">Metered Billing</a> is enabled for the site .</li> </ul>

auto_close_invoicesboolean

<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> .</p>

contract_termobject

Parameters for contract_term

idstring

Id that uniquely identifies the contract term in the site.

created_atinteger (unix-time)

The date when the contract term was created.

contract_startinteger (unix-time)

The start date of the contract term

billing_cycleinteger (int32)

The number of billing cycles of the subscription that the contract term is for.

total_amount_raisedinteger (int64)

<p class="mb-2">The amount raised for the contract term till the time of importing the subscription. This amount is added to the <code><a href="/docs/api/contract_terms/contract_term-object#total_contract_value">total_contract_value</a></code></p>

Default 0

total_amount_raised_before_taxinteger (int64)

<p class="mb-2">The amount raised for the contract term till the time of importing the subscription excluding tax. This amount is added to the <code><a href="/docs/api/contract_terms/contract_term-object#total_contract_value">total_contract_value_before_tax</a></code></p>

Default 0

action_at_term_endstring

<p class="mb-2">Action to be taken when the contract term completes.</p> * evergreen - <p class="mb-2">Contract term completes and the subscription renews.</p> * renew - <ul class="list-disc list-outside ml-6 my-4 space-y-2"> <li class="text-base leading-relaxed">Contract term completes and a new contract term is started for the number of billing cycles specified in <a href="/docs/api/v2/pcv-1/subscriptions/create-subscription-for-customer#contract_term_billing_cycle_on_renewal"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">contract_billing_cycle_on_renewal</code></a>.</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">action_at_term_end</code> for the new contract term 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">renew</code>.</li> </ul> * renew_once - <p class="mb-2">Used when you want to renew the contract term just once. Does the following: - Contract term completes and a new contract term is started for the number of billing cycles specified in <a href="/docs/api/v2/pcv-1/subscriptions/create-subscription-for-customer#contract_term_billing_cycle_on_renewal"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">contract_billing_cycle_on_renewal</code></a>.</p> <ul class="list-disc list-outside ml-6 my-4 space-y-2"> <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">action_at_term_end</code> for the new contract term 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">cancel</code>.</li> </ul> * cancel - <p class="mb-2">Contract term completes and subscription is canceled.</p>

One ofrenewevergreencancelrenew_onceDefault "renew"

cancellation_cutoff_periodinteger (int32)

<p class="mb-2">The number of days before <a href="/docs/api/contract_terms/contract_term-object#contract_end"><code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">contract_end</code></a> , during which the customer is barred from canceling the contract term. The customer is allowed to cancel the contract term via the Self-Serve Portal only before this period. This allows you to have sufficient time for processing the contract term closure.</p>

Default 0

transactionobject

Parameters for transaction

amountinteger (int64)

The payment transaction amount.

payment_methodstring

The payment method of this transaction. This parameter should be passed only if the invoice is created for the current term. \* cash - Cash \* custom - Custom \* check - Check \* bank_transfer - Bank Transfer \* other - Payment methods other than the named types above.

One ofcashcheckbank_transferothercustom

reference_numberstring

<p class="mb-2">The reference number for this transaction. For example, check number when <code class="bg-gray-100 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_method</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">check</code>.</p>

dateinteger (unix-time)

The date of occurrence of the transaction.

shipping_addressobject

Parameters for shipping_address

first_namestring

The first name of the contact.

last_namestring

The last name of the 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

<p class="mb-2">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> ).</p>

statestring

<p class="mb-2">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.</p>

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

<p class="mb-2">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> .</p> <p class="mb-2"><strong class="font-semibold">Note</strong>: If you enter an invalid country code, the system will return an error.</p> <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Brexit</strong></p><p class="mb-2">If 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 <strong class="font-semibold">United Kingdom - Northern Ireland</strong>) is available as an option.</p></div>

validation_statusstring

The address verification status. \* 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. \* valid - Address was validated successfully.

One ofnot_validatedvalidpartially_validinvalidDefault "not_validated"

subscription_itemsobject

Parameters for subscription_items

item_price_idarray<string>required

The unique identifier of the [item price](/docs/api/item_prices) in Chargebee. At least one entry is required to import the subscription.

quantityarray<integer (int32)>

The quantity of the item purchased

quantity_in_decimalarray<string>

The decimal representation of the quantity of the item purchased. Can be provided for quantity-based item prices and only when [multi-decimal pricing](/docs/api/getting-started) is enabled.

unit_pricearray<integer (int64)>

The price or per-unit price of the item. When not provided, [the value set](/docs/api/item_prices/item-price-object) for the item price is used.

unit_price_in_decimalarray<string>

When [price overriding](https://www.chargebee.com/docs/2.0/price-override.html) is enabled for the site, the price or per-unit price of the item can be set here. The [value set for the item price](/docs/api/item_prices/item_price-object#price) is used by default. Provide the value as a decimal string in major units of the currency. Can be provided only when [multi-decimal pricing](/docs/api/getting-started) is enabled.

billing_cyclesarray<integer (int32)>

For the plan-item price: the value determines the number of billing cycles the subscription runs before canceling automatically. If not provided, then [the value set](/docs/api/item_prices/item-price-object) for the plan-item price is used. For addon-item prices: If [addon billing cycles](https://www.chargebee.com/docs/2.0/addons-billingcycle.html) are enabled then this is the number of subscription billing cycles for which the addon is included. If not provided, then [the value set under attached addons](/docs/api/attached_items/attached-item-object) is used. Further, if that value is not provided, then [the value set for the addon-item price](/docs/api/item_prices/item-price-object) is used.

trial_endarray<integer (unix-time)>

The date/time when the trial period of the item ends. Applies to plan-items and--when [enabled](https://www.chargebee.com/docs/2.0/addons-trial.html) --addon-items as well.

service_period_daysarray<integer (int32)>

The service period of the item in days from the day of charge.

charge_on_eventarray<string>

charge_oncearray<boolean>

<p class="mb-2">Indicates if the charge-item is to be charged only once or each time 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">charge_on_event</code> occurs. This parameter only applies to charge-items.</p>

discountsobject

Parameters for discounts

apply_onarray<string>

duration_typearray<string>required

percentagearray<number (double)>

The percentage of the original amount that should be deducted from it.

amountarray<integer (int64)>

The value of the discount. [The format of this value](/docs/api/currencies) depends on the kind of currency.

periodarray<integer (int32)>

<p class="mb-2">The duration of time for which the discount is attached to the subscription, in <code class="bg-gray-100 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_units</code>. Applicable only when <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">duration_type</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">limited_period</code>.</p> <span featureId="cb-discounts" isMicro="true"></span>

period_unitarray<string>

included_in_mrrarray<boolean>

<p class="mb-2">The discount is included in MRR calculations for your site. This attribute is only applicable when <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">duration_type</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">one_time</code> and when the <a href="https://www.chargebee.com/docs/reporting.html#dashboards_flexible-mrr-calculation" target="_blank">feature is enabled</a> in Chargebee. Also, If the <a href="https://www.chargebee.com/docs/reporting.html#chart_flexible-mrr-calculation" target="_blank">site-level setting</a> is to exclude one-time discounts from MRR calculations, this value is always returned <code class="bg-gray-100 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>.</p> <span featureId="cb-discounts" isMicro="true"></span>

item_price_idarray<string>

The [id of the item price](/docs/api/subscriptions/subscription-object#subscription_items_item_price_id) in the subscription to which the discount is to be applied.

quantityarray<integer (int32)>

Specifies the number of free units provided for the item, without affecting the total quantity sold

charged_itemsobject

Parameters for charged_items

item_price_idarray<string>

<p class="mb-2">Identifier of the <a href="/docs/api/item_prices" 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">charge</code> item price</a> that was already charged for this subscription.</p>

last_charged_atarray<integer (unix-time)>

Timestamp when this charge item price was last charged for this subscription in the source system.

item_tiersobject

Parameters for item_tiers

item_price_idarray<string>

The id of the item price for which the tier price is being overridden.

starting_unitarray<integer (int32)>

The lowest value in the quantity tier.

ending_unitarray<integer (int32)>

The highest value in the quantity tier.

pricearray<integer (int64)>

The overridden price of the tier. The value depends on the [type of currency](/docs/api/subscriptions) .

starting_unit_in_decimalarray<string>

<p class="mb-2">The decimal representation of the lowest value of quantity in this tier. This is zero for the lowest tier. For all other tiers, it 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">ending_unit_in_decimal</code> of the next lower tier. Returned only when the pricing_model 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">tiered</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">volume</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">stairstep</code> and <a href="/docs/api/getting-started">multi-decimal pricing</a> is enabled.</p>

ending_unit_in_decimalarray<string>

<p class="mb-2">The decimal representation of the highest value of quantity in this tier. This attribute is not applicable for the highest tier. For all other tiers, it must be equal 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">starting_unit_in_decimal</code> of the next higher tier. Returned only when the pricing_model 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">tiered</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">volume</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">stairstep</code> and <a href="/docs/api/getting-started">multi-decimal pricing</a> is enabled.</p>

price_in_decimalarray<string>

<p class="mb-2">The decimal representation of the per-unit price for the tier 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">pricing_model</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">tiered</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">volume</code>. 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">pricing_model</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">stairstep</code> , it is the decimal representation of the total price for the item. The value is in major units of the currency. Returned when the plan is quantity-based and <a href="/docs/api/getting-started">multi-decimal pricing</a> is enabled.</p>

pricing_typearray<string>

package_sizearray<integer (int32)>

<p class="mb-2">Package size for the tier when pricing type 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">package</code>. Specify the number of units that make up one package. For example, if 1000 API hits are grouped into a single package, set the package size to 1000.</p>

json

{
  "status": null,
  "exhausted_coupon_ids": null,
  "id": null,
  "trial_end": null,
  "billing_cycles": null,
  "net_term_days": null,
  "start_date": null,
  "auto_collection": null,
  "po_number": null,
  "coupon_ids": null,
  "payment_source_id": null,
  "current_term_end": null
}

Response

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

subscriptionobject

<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'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&utm_medium=content&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&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>

idstringrequired

<p class="mb-2">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">subscription</code> resource. You have the option to specify this value when creating a customer. If not specified, Chargebee automatically generates a unique identifier.</p> <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Note</strong> In the event that the subscription resource is <a href="/docs/api/business_entities/transfer-resources-to-another-business-entity">transferred</a> along with its associated <code><a href="/docs/api/customers">customer</a></code> resource to a different business entity, Chargebee assigns a new random value 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">id</code> for the subscription. 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">subscription</code> resource. (See also: <a href="/docs/api/business_entities">Mechanics of business entity transfer</a>.)</p></div> <span featureId="cb-mbe" isMicro="true"></span>

currency_codestringrequired

The currency code ([ISO 4217 format](https://www.chargebee.com/docs/supported-currencies.html) ) of the subscription

billing_periodinteger (int32)

<p class="mb-2">Specifies the length of each billing cycle (or term) of the subscription, expressed in the unit defined by <code class="bg-gray-100 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_period_unit</code>.</p>

billing_period_unitstring

<p class="mb-2">Specifies the unit used to measure 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_period</code>.</p> * day - * month - * year - * week -

One ofdayweekmonthyear

start_dateinteger (unix-time)

Applicable only for 'future' subscriptions. The scheduled start time of the subscription.

trial_endinteger (unix-time)

End of the trial period for the subscription. Presence of this value for 'future' subscription implies the subscription will go into 'in_trial' state when it starts.

remaining_billing_cyclesinteger (int32)

* 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.

po_numberstring

Purchase order number for this subscription.

auto_collectionstring

One ofonoff

plan_quantity_in_decimalstring

The decimal representation of the quantity of the plan purchased. Returned for quantity-based plans when [multi-decimal pricing](/docs/api/currencies) is enabled.

plan_unit_price_in_decimalstring

The decimal representation of the price or per-unit price of the plan. The value is in major units of the currency. Always returned when [multi-decimal pricing](/docs/api/currencies) is enabled.

customer_idstringrequired

Identifier of the customer with whom this subscription is associated.

statusstringrequired

<p class="mb-2">Current state of the subscription</p> * future - <p class="mb-2">The subscription is scheduled to start at a future date.</p> * non_renewing - <p class="mb-2">The subscription will be canceled at the end of the current term.</p> * active - <p class="mb-2">The subscription is active and will be charged for automatically based on the items in it.</p> * cancelled - <p class="mb-2">The subscription has been canceled and is no longer in service.</p> * transferred - <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">transferred</code> status will be reflected on the source business entity's subscription attribute once the <a href="https://www.chargebee.com/docs/2.0/mbe-getting-started-with-customer-transfer.html">customer transfer</a> activity is completed successfully.</p> * in_trial - <p class="mb-2">The subscription is in trial.</p> * paused - <p class="mb-2">The subscription is <a href="https://www.chargebee.com/docs/2.0/pause-subscription.html" target="_blank">paused</a>. The subscription will not renew while in this state.</p>

One offuturein_trialactivenon_renewingpausedcancelledtransferred

trial_startinteger (unix-time)

<p class="mb-2">Start of the trial period for the subscription. Presence of this value 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">future</code> subscription implies the subscription will go into <code class="bg-gray-100 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> state when it starts.</p>

trial_end_actionstring

Applicable only when [End-of-trial Action](https://www.chargebee.com/docs/2.0/trial_periods_hidden.html#how-to-define-the-end-of-trial-actions-for-subscriptions) has been enabled for the site. Whenever the subscription has a trial period, this attribute (parameter) is returned (required) and specifies the operation to be carried out for the subscription once the trial ends. \* activate_subscription - The subscription activates and charges are raised for non-metered items. \* cancel_subscription - The subscription cancels. \* plan_default - The action [configured for the site](https://www.chargebee.com/docs/2.0/trial_periods_hidden.html#how-to-define-the-end-of-trial-actions-for-subscriptions) at the time when the trial ends, takes effect. \* site_default - This is the default value. The action [configured for the site](https://www.chargebee.com/docs/2.0/trial_periods_hidden.html#how-to-define-the-end-of-trial-actions-for-subscriptions) at the time when the trial ends, takes effect.

One ofsite_defaultplan_defaultactivate_subscriptioncancel_subscription

current_term_startinteger (unix-time)

Start of the current billing period of the subscription.

current_term_endinteger (unix-time)

End of the current billing period of the subscription. Subscription is renewed immediately after this.

next_billing_atinteger (unix-time)

<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.</p>

created_atinteger (unix-time)

The time at which the subscription was created.

started_atinteger (unix-time)

activated_atinteger (unix-time)

<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.</p>

contract_term_billing_cycle_on_renewalinteger (int32)

override_relationshipboolean

<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.</p>

pause_dateinteger (unix-time)

resume_dateinteger (unix-time)

For a paused subscription, it is the date/time when the subscription is scheduled to resume. If the pause is for an indefinite period, this value is not returned.

cancelled_atinteger (unix-time)

Time at which subscription was cancelled or is set to be cancelled.

cancel_reasonstring

The reason for canceling the subscription. Set by Chargebee automatically. \* no_card - No Card \* non_compliant_customer - Non Compliant Customer \* currency_incompatible_with_gateway - Currency incompatible with Gateway \* fraud_review_failed - Fraud Review Failed \* tax_calculation_failed - Tax Calculation Failed \* not_paid - Not Paid \* non_compliant_eu_customer - Non Compliant EU Customer

One ofnot_paidno_cardfraud_review_failednon_compliant_eu_customertax_calculation_failedcurrency_incompatible_with_gatewaynon_compliant_customer

created_from_ipstring

The IP address of the user. Used primarly in Refersion integration. Refersion uses this field to track/log affiliate subscription.

resource_versioninteger (int64)

<p class="mb-2">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.</p>

updated_atinteger (unix-time)

Timestamp indicating when the item was last updated.

has_scheduled_advance_invoicesbooleanrequired

The subscription has an [advance invoicing schedule](/docs/api/advance_invoice_schedules) .

Default false

has_scheduled_changesbooleanrequired

Indicates whether a change is scheduled on the subscription. **Note** When [Ramps](ramps) are enabled with compatibility mode, this attribute indicates whether one or more ramps are scheduled for the subscription. For more details, see [Ramps API compatibility mode](/docs/api/subscriptions#ramps-compat-mode).

Default false

payment_source_idstring

Payment source attached to this subscription. If present, customer's payment sources won't be used to collect any payment for this subscripiton.

plan_free_quantity_in_decimalstring

The free_quantity_in_decimal as set for the plan. Returned for quantity-based plans when [multi-decimal pricing](/docs/api/currencies) is enabled.

plan_amount_in_decimalstring

The decimal representation of the total amount for the plan, in major units of the currency. Always returned when [multi-decimal pricing](/docs/api/currencies) is enabled.

cancel_schedule_created_atinteger (unix-time)

<p class="mb-2">This is the date/time at which the most recent cancellation schedule for the subscription was created in Chargebee. Applicable only 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">cancelled</code> subscriptions or subscriptions that are scheduled for cancellation.</p>

offline_payment_methodstring

\* sepa_credit - \* cash - \* no_preference - \* bank_transfer - \* check - \* eu_automated_bank_transfer - \* jp_automated_bank_transfer - \* uk_automated_bank_transfer - \* custom - \* boleto - \* mx_automated_bank_transfer - \* us_automated_bank_transfer - \* ach_credit -

One ofno_preferencecashcheckbank_transferach_creditsepa_creditboletous_automated_bank_transfereu_automated_bank_transferuk_automated_bank_transferjp_automated_bank_transfermx_automated_bank_transfercustom

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. \* 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

net_term_daysinteger (int32)

<p class="mb-2">The <a href="https://www.chargebee.com/docs/net_d.html" target="_blank">Net D</a> value explicitly set for this subscription. Net D is 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. When an invoice is raised, and this value is unavailable, the net_term_days defined at <a href="/docs/api/customers/customer-object#net_term_days">the customer level</a> is considered.</p>

active_idstring

<div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Note</strong>: 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">subscription</code> has been <a href="/docs/api/business_entities/transfer-resources-to-another-business-entity">transferred</a> between business entities.</p></div> <p class="mb-2">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">subscription</code> resource.</p> <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Tip</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">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">subscription</code> resource are the same, this indicates that you are working with the active version of that <code class="bg-gray-100 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</code> resource.</p></div> <span featureId="cb-mbe" isMicro="true"></span>

customerobject

<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'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'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'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

<p class="mb-2">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.</p> <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Tip</strong> 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>.)</p></div> <span featureId="cb-mbe" isMicro="true"></span>

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

<p class="mb-2">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></p> <p class="mb-2"><code class="bg-gray-100 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 <strong class="font-semibold">United Kingdom - Northern Ireland</strong> ), 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> .</p>

auto_collectionstringrequired

<p class="mb-2">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> .</p> <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Note</strong> This setting can be <a href="/docs/api/subscriptions/create-subscription-for-items#auto_collection">overridden</a> for individual subscriptions of the customer.</p></div> * on - <p class="mb-2">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> .</p> * off - <p class="mb-2">Automatic charging is disabled; manual payment is required for due invoices.</p>

One ofonoffDefault "on"

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

net_term_daysinteger (int32)required

<p class="mb-2">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.</p> <span featureId="cb-net-d-payment-terms" isMicro="true"></span>

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"><p class="mb-2"><strong class="font-semibold">Note</strong> 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.</p></div> <p class="mb-2">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:</p> <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

<p class="mb-2">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:</p> <ul class="list-disc list-outside ml-6 my-4 space-y-2"> <li class="text-base leading-relaxed"><strong class="font-semibold">API</strong>: 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"><strong class="font-semibold">Checkout</strong>: 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"><strong class="font-semibold">UI</strong>: 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>

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/) .

taxabilitystring

<p class="mb-2">Specifies if the customer is liable for tax</p> * taxable - <p class="mb-2">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.</p> * 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

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

resource_versioninteger (int64)

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"><p class="mb-2"><strong class="font-semibold">Note</strong> 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>.</p></div> <p class="mb-2">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.</p> <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Example</strong></p><ul class="list-disc list-outside ml-6 my-4 space-y-2"> <li class="text-base leading-relaxed"><strong class="font-semibold">Month-based subscriptions</strong>: 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"><strong class="font-semibold">Year-based subscriptions</strong>: 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

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.

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"><p class="mb-2"><strong class="font-semibold">Note</strong>: 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.</p></div> <p class="mb-2">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.</p> <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Tip</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">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.</p></div> <span featureId="cb-mbe" isMicro="true"></span>

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

<p class="mb-2">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> ).</p>

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.

invoiceobject

<div class="api-description"><p class="mb-2">An invoice is a commercial document representing a sale of products/services offered by you to a customer. It enumerates all the charges, adjustments, payments, discounts and taxes associated with the sale.</p><p class="mb-2">An invoice is said to be a recurring one when it is has at least one charge for <a href="/docs/api/items">a plan or an addon item price</a>. It is a non-recurring one when it has charges for only charge-item prices or <a href="https://www.chargebee.com/docs/2.0/charges.html" target="_blank">one-time charges</a>.</p><p class="mb-2">The item prices for any given billing term of a subscription are billed via an invoice at the beginning of the term (unless the charges are left unbilled). However, item prices that belong 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">metered</code> items are billed at the end of the term via 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">pending</code> invoice that can <a href="https://www.chargebee.com/docs/billing/2.0/usage-based-billing/metered_billing#configuring-metered-billing" target="_blank">close automatically</a> or via <a href="/docs/api/invoices/close-a-pending-invoice">an API call</a>. Moreover, when there are no <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">metered</code> items in the subscription, the invoices can still be generated 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">pending</code> while <a href="/docs/api/subscriptions/create-subscription-for-items">creating</a> or <a href="/docs/api/subscriptions/update-subscription-for-items">updating</a> a subscription.</p><h4>Auto-collection</h4><p class="mb-2">If <a href="https://www.chargebee.com/docs/2.0/customers.html#auto-collection-status" target="_blank">auto-collection</a> is enabled, then immediately on invoice generation (or, in case of subscriptions that have <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">create_pending_invoices</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>, on <a href="/docs/api/invoices/close-a-pending-invoice">invoice closure</a>), the <a href="/docs/api/customers/customer-object#payment_method">payment method</a> on file is charged:</p><ul class="list-disc list-outside ml-6 my-4 space-y-2"> <li class="text-base leading-relaxed">If the payment succeeds, the invoice is marked 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">paid</code>.</li> <li class="text-base leading-relaxed">On payment failure, the invoice is marked 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">payment_due</code> and <a href="https://www.chargebee.com/docs/2.0/dunning-v2.html" target="_blank">dunning settings</a> are taken into account for payment retries.</li> <li class="text-base leading-relaxed">If no retry attempts are configured, or when retries are exhausted, the invoice is marked 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">not_paid</code>.</li> <li class="text-base leading-relaxed">the amount due is zero or negative, the invoice is immediately marked 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">paid</code> and the balance, if any, is added to <a href="https://www.chargebee.com/docs/2.0/customers.html#excess-payments" target="_blank">excess payments</a> for the customer.</li> </ul><div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Note:</strong> If <a href="https://www.chargebee.com/docs/2.0/consolidated-invoicing.html" target="_blank">consolidated invoicing</a> is enabled, 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">subscription_id</code> is unavailable when the invoice has line items from multiple subscriptions. The individual subscription ids are seen 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">line_items.subscription_id</code>.</p></div><div id="recurring-invoice" class="cb-accordion"><div class="cb-accordion-title collapsed" data-toggle="collapse" data-target="#recurring-invoice-content" aria-expanded="false" aria-controls="recurring-invoice-content"><h4>Recurring and non-recurring invoices</h4><i class="fa fa-chevron-circle-down fa-lg" aria-hidden="true"></i></div><div class="collapse" id="recurring-invoice-content"><p class="mb-2">A recurring invoice contains at least one line item that is billed on a recurring basis. Specifically, it has at least one <a href="/docs/api/invoices/invoice-object#line_items" 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">line_items[]</code></a> with <code class="bg-gray-100 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_type</code> 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_item_price</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">addon_item_price</code>. A non-recurring invoice contains no recurring line items.</p></div></div><div id="refundable-amount" class="cb-accordion"><div class="cb-accordion-title collapsed" data-toggle="collapse" data-target="#refundable-amount-content" aria-expanded="false" aria-controls="refundable-amount-content"><h4>Refundable amount for an invoice</h4><i class="fa fa-chevron-circle-down fa-lg" aria-hidden="true"></i></div><div class="collapse" id="refundable-amount-content"><p class="mb-2">The refundable amount for an invoice is the (amount paid on the invoice + refundable credit applied on the invoice + taxes withheld on the invoice) minus (amount issued as refundable credit notes from the invoice). Each of these amounts is obtained from the invoice resource as follows:</p><ul class="list-disc list-outside ml-6 my-4 space-y-2"> <li class="text-base leading-relaxed">Amount paid on the invoice: <a href="/docs/api/invoices/invoice-object#invoice_amount_paid" 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">amount_paid</code></a></li> <li class="text-base leading-relaxed">Refundable credit applied on the invoice: <a href="/docs/api/invoices/invoice-object#invoice_credits_applied" 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">credits_applied</code></a></li> <li class="text-base leading-relaxed">Taxes withheld on the invoice: Sum of <a href="/docs/api/invoices/invoice-object#invoice_linked_taxes_withheld" 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">linked_taxes_withheld[].amount</code></a></li> <li class="text-base leading-relaxed">Amount issued as refundable credit notes from the invoice: Sum of <a href="/docs/api/invoices/invoice-object#invoice_issued_credit_notes" 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">issued_credit_notes[i].cn_total</code></a> where <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">issued_credit_notes[i].cn_status</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">refunded</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">refund_due</code>.</li> </ul></div></div></div>

idstringrequired

The invoice number. Acts as a identifier for invoice and typically generated sequentially.

customer_idstringrequired

The identifier of the customer this invoice belongs to.

payment_ownerstring

Payment owner of an invoice

subscription_idstring

<p class="mb-2">The identifier of the subscription this invoice belongs to. <strong class="font-semibold">Note</strong>: When consolidated invoicing is enabled, you have to refer to <a href="/docs/api/invoices/invoice-object#line_items">line_item`s</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">subscription_id</code> to identify the subscriptions associated with this invoice. However, it is important to avoid using this attribute if the invoice includes charges from multiple subscriptions, as it will be null in such cases.</p>

recurringbooleanrequired

Boolean indicating whether this invoice belongs to a subscription

Default true

statusstringrequired

<p class="mb-2">Current status of this invoice.</p> * paid - <p class="mb-2">Indicates a paid invoice.</p> * posted - <p class="mb-2">Indicates the payment is not yet collected and will be in this state till the due date to indicate the due period</p> * pending - <p class="mb-2">The <a href="/docs/api/invoices/invoice-object#status">invoice</a> is yet to be closed (sent for payment collection). An invoice is generated with 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">status</code> when it has line items that belong to items that 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">metered</code> or 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">subscription.create_pending_invoices</code>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>. The <a href="/docs/api/v2/pcv-1/invoices/invoice-object#status">invoice</a> is yet to be closed (sent for payment collection). All invoices are generated with 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">status</code> when <a href="https://www.chargebee.com/docs/1.0/metered_billing.html" target="_blank">Metered Billing</a> is enabled for the site.</p> * payment_due - <p class="mb-2">Indicates the payment is not yet collected and is being retried as per retry settings.</p> * not_paid - <p class="mb-2">Indicates the payment is not made and all attempts to collect is failed.</p> * voided - <p class="mb-2">Indicates a voided invoice.</p>

One ofpaidpostedpayment_duenot_paidvoidedpending

dateinteger (unix-time)

<p class="mb-2">The document date displayed on the invoice PDF. By default, it has the same value as the effective date of the action that created the invoice (subscription creation, update, or invoice creation). This date can be backdated (set to a value in the past) while performing the actions. Backdating an invoice is done for reasons such as booking revenue for a previous date or when the subscription or non-recurring charge is effective as of a past date. However, if the invoice is created 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">pending</code> , and if the site is configured to set invoice dates to the date of closing, then upon invoice closure, this date is changed to the invoice closing date.</p>

due_dateinteger (unix-time)

Due date of the invoice

net_term_daysinteger (int32)

Default 0

po_numberstring

Purchase Order Number for this invoice

vat_numberstring

VAT/ Tax registration number of the customer. [Learn more](https://www.chargebee.com/docs/tax.html#capture-tax-registration-number)

price_typestringrequired

The price type of the invoice. \* tax_exclusive - All amounts in the document are exclusive of tax. \* tax_inclusive - All amounts in the document are inclusive of tax.

One oftax_exclusivetax_inclusiveDefault "tax_exclusive"

exchange_ratenumber (decimal)

Exchange rate used for base currency conversion.Note that when converting foreign currency invoices to local currency for VAT purposes, the exchange rates used differ from the base currency exchange rate provided in this field. This is due to regulations set by tax authorities, which require the use of official sources such as European Central Bank rates for local currency conversion.

local_currency_exchange_ratenumber (decimal)

This parameter represents the exchange rate as a relative price of the base currency that appears as local currency in invoices and credit notes. The local currency exchange rate specifically refers to the exchange rate of a country's currency when converting it to another currency. For example, if you want to convert US dollars to euros, the local currency exchange rate would be the rate at which you can convert US dollars to euros.

currency_codestringrequired

The currency code (ISO 4217 format) for the invoice

local_currency_codestring

The currency code (ISO 4217 format) of the place of supply in which VAT needs to be converted and displayed.

taxinteger (int64)required

Total tax amount for this invoice

sub_totalinteger (int64)required

<p class="mb-2">The sum of all the line item amounts minus the sum of all line item discounts. In other words, this is the sum of all <code><a href="/docs/api/invoices/invoice-object#line_items">line_items[]</a>.amount</code></p> <ul class="list-disc list-outside ml-6 my-4 space-y-2"> <li class="text-base leading-relaxed">the sum of all <code><a href="/docs/api/invoices/invoice-object#line_item_discounts">line_item_discounts[]</a>.discount_amount</code>.</li> </ul>

sub_total_in_local_currencyinteger (int64)

Invoice subtotal in the currency of the place of supply.

totalinteger (int64)

Invoiced amount displayed in cents; that is, a decimal point is not present between the whole number and the decimal part. For example, $499.99 is displayed as 49999, and so on.

total_in_local_currencyinteger (int64)

Total invoice amount in the currency of the place of supply.

amount_dueinteger (int64)

<p class="mb-2">The unpaid amount that is due on the invoice. This is calculated as: <code><a href="/docs/api/invoices/invoice-object#total">total</a></code></p> <ul class="list-disc list-outside ml-6 my-4 space-y-2"> <li class="text-base leading-relaxed"> <code><a href="/docs/api/invoices/invoice-object#amount_paid">amount_paid</a></code> </li> <li class="text-base leading-relaxed">sum of <code><a href="/docs/api/invoices/invoice-object#applied_credits">applied_credits</a>.applied_amount</code></li> <li class="text-base leading-relaxed">sum of <code><a href="/docs/api/invoices/invoice-object#adjustment_credit_notes">adjustment_credit_notes</a>.cn_total</code></li> <li class="text-base leading-relaxed">sum of <code><a href="/docs/api/invoices/invoice-object#linked_taxes_withheld">linked_taxes_withheld</a>.amount</code>.</li> </ul>

amount_adjustedinteger (int64)

Total adjustments made against this invoice.

Default 0

amount_paidinteger (int64)

<p class="mb-2">Payments collected successfully for the invoice. This is the sum of <code><a href="/docs/api/invoices/invoice-object#linked_payments">linked_payments[]</a>.txn_amount</code> for all <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">linked_payments[]</code> that have <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">txn_status</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">success</code>.</p>

paid_atinteger (unix-time)

Timestamp indicating the date \& time this invoice got paid.

write_off_amountinteger (int64)

Amount written off against this invoice.

Default 0

credits_appliedinteger (int64)

Total credits applied against this invoice.

Default 0

dunning_statusstring

Current dunning status of the invoice. \* exhausted - Maximum number of attempts have been made. \* stopped - Dunning has stopped for this invoice. \* success - Payment successfully collected during dunning process. \* in_progress - Dunning is still in progress.

One ofin_progressexhaustedstoppedsuccess

next_retry_atinteger (unix-time)

Timestamp indicating when will the next attempt to collect payment for this invoice occur.

voided_atinteger (unix-time)

Timestamp indicating the date \& time this invoice got voided.

resource_versioninteger (int64)

<p class="mb-2">The version number of this resource. For every change made to the resource, <code class="bg-gray-100 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.</p>

updated_atinteger (unix-time)

Timestamp indicating when this invoice was last updated. This attribute will be present only if the resource has been updated after 2016-09-28. **Note** : This value does not change when the following attributes are changed: *next_retry_at, dunning_status, has_advance_charges*

line_items_next_offsetstring

<p class="mb-2">This attribute is returned only if additional resources are available. Use this value as the input parameter 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">line_items_offset</code> to retrieve the next set of resources.</p> <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Note:</strong></p><ul class="list-disc list-outside ml-6 my-4 space-y-2"> <li class="text-base leading-relaxed">Applicable only when Enterprise-scale Invoicing is enabled.</li> <li class="text-base leading-relaxed">Enterprise-scale Invoicing is currently in <strong class="font-semibold">Private Beta</strong>. Please reach out to <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">Chargebee Support</a> to enable this feature.</li> </ul></div>

first_invoiceboolean

Boolean indicating the first invoice raised for the subscription. In the case of a non-recurring invoice, it indicates the first invoice raised for the customer.

new_sales_amountinteger (int64)

<p class="mb-2">The share of the invoice total due to new sales. When <code class="bg-gray-100 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_invoice</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">true</code> , this attribute is the same as total. However, when the invoice is a <a href="https://www.chargebee.com/docs/2.0/consolidated-invoicing.html " target="_blank">consolidated</a> one, then it is the sum of all <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">line_items.amount</code> belonging to a new.</p>

has_advance_chargesboolean

Indicates whether an [advance charge](https://www.chargebee.com/docs/billing/2.0/invoices-credit-notes-and-quotes/advance-invoices) is present in this invoice.

term_finalizedbooleanrequired

Boolean indicating this invoice line_items terms are finalized or not.

Default true

is_giftedbooleanrequired

Boolean indicating this invoice is gifted or not.

Default false

generated_atinteger (unix-time)

<p class="mb-2">The date when the invoice is finalized. This is the date in the invoice lifecycle when its <code class="bg-gray-100 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> becomes any one of the following for the first time: <code class="bg-gray-100 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">posted</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">paid</code>. For an invoice with <code class="bg-gray-100 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> 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">pending</code> , this happens when it gets closed.</p>

expected_payment_dateinteger (unix-time)

The date and time at which [dunning](https://www.chargebee.com/docs/payments/2.0/dunning-v2.html) should resume automatically for the invoice. This attribute is present only if dunning is currently [paused](/docs/api/invoices/pause-dunning-for-invoice) for the invoice. **See also** : [Dunning resumption process](/docs/api/invoices/resume-dunning-for-invoice).

json

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

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

Was this page helpful?