- Home
- 3DS Card Payments
- Subscriptions
- Customers
- Payment sources
- Virtual bank accounts
- Cards
- Promotional credits
- Invoices
- Credit notes
- Unbilled charges
- Orders
- Gifts
- Transactions
- Hosted pages
- Estimates
- Quotes
- Plans
- Addons
- Coupons
- Coupon sets
- Coupon codes
- Addresses
- Events
- Comments
- Downloads
- Portal sessions
- Site migration details
- Time machines
- Exports
- Payment intents
- Open Source
- Chargebee JS
- Payment parameters
Subscriptions
Subscription represents the recurring items a customer has subscribed to. The recurring items can be - plan, addons. It may also contain the discount items like coupons.
Subscriptions are invoiced at the start of every term based on the recurring items and charged immediately against the customer's credit card if 'auto_collection' is turned 'on', otherwise the resulting invoice will be created as 'Payment Due'.
Sample subscription [ JSON ]
{
"activated_at": 1517505643,
"auto_collection": "off",
"billing_period": 1,
"billing_period_unit": "month",
"created_at": 1517505643,
"currency_code": "USD",
"current_term_end": 1519924843,
"current_term_start": 1517505643,
"customer_id": "__test__KyVnHhSBWkkwI2Tn",
"deleted": false,
"due_invoices_count": 1,
"due_since": 1517505643,
"has_scheduled_changes": false,
"id": "__test__KyVnHhSBWkkwI2Tn",
"mrr": 0,
"next_billing_at": 1519924843,
"object": "subscription",
"plan_amount": 895,
"plan_free_quantity": 0,
"plan_id": "no_trial",
"plan_quantity": 1,
"plan_unit_price": 895,
"resource_version": 1517505643000,
"started_at": 1517505643,
"status": "active",
"total_dues": 895,
"updated_at": 1517505643
}
API Index URL GET
https://{site}.chargebee.com/api/v2/subscriptions
A unique and immutable identifier for the subscription. If not provided, it is autogenerated.
string, max chars=50
string, max chars=50
Defines billing frequency. Example: to bill customer every 3 months, provide "3" here.
optional, integer, min=1
optional, integer, min=1
Defines billing frequency in association with the billing period.
optional, enumerated string
optional, enumerated string
Possible values are
dayCharge based on day(s).weekCharge based on week(s).monthCharge based on month(s).yearCharge based on year(s).
Applicable only for 'future' subscriptions. The scheduled start time of the subscription.
optional, timestamp(UTC) in seconds
optional, timestamp(UTC) in seconds
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.
optional, timestamp(UTC) in seconds
optional, timestamp(UTC) in seconds
- 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: this value is the number of billing cycles remaining in the contract term after the current billing cycle.
optional, integer, min=0
Defines whether payments need to be collected automatically for this subscription. Overrides customer's auto-collection property.
optional, enumerated string
optional, enumerated string
Possible values are
onWhenever an invoice is created for this subscription, an automatic charge will be attempted on the payment method available.offAutomatic collection of charges will not be made for this subscription. Use this for offline payments.
Identifier of the customer with whom this subscription is associated.
string, max chars=50
string, max chars=50
Current state of the subscription.
enumerated string
enumerated string
Possible values are
futureThe subscription is scheduled to start at a future date.in_trialThe subscription is in trial.activeThe subscription is active and will be charged for automatically based on the items in it.non_renewingThe subscription will be canceled at the end of the current term.pausedThe subscription is paused. The subscription will not renew while in this state.cancelledThe subscription has been canceled and is no longer in service.
Start of the trial period for the subscription. Presence of this value for
optional, timestamp(UTC) in seconds
future subscription implies the subscription will go into in_trial state when it starts.optional, timestamp(UTC) in seconds
Start of the current billing period of the subscription.
optional, timestamp(UTC) in seconds
optional, timestamp(UTC) in seconds
End of the current billing period of the subscription. Subscription is renewed immediately after this.
optional, timestamp(UTC) in seconds
optional, timestamp(UTC) in seconds
The date/time at which the next billing for the subscription happens. This is usually right after
optional, timestamp(UTC) in seconds
current_term_end unless multiple subscription terms were invoiced in advance using the terms_to_charge parameter.optional, timestamp(UTC) in seconds
Time at which the subscription was started. Is
optional, timestamp(UTC) in seconds
null for futuresubscriptions as it is yet to be started.optional, timestamp(UTC) in seconds
Time at which the subscription
optional, timestamp(UTC) in seconds
status last changed to
active. For example, this value is updated when an in_trial or
cancelled subscription activates.optional, timestamp(UTC) in seconds
Number of billing cycles the new contract term should run for, on contract renewal. The default value is the same as
optional, integer, min=1, max=100
billing_cycles or a custom value depending on the site configuration.optional, integer, min=1, max=100
If
optional, boolean
true, ignores the hierarchy relationship and uses customer as payment and invoice owner.optional, boolean
When a pause has been scheduled, it is the date/time of scheduled pause. When the subscription is in the
optional, timestamp(UTC) in seconds
paused state, it is the date/time when the subscription was paused.optional, timestamp(UTC) in seconds
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.
optional, timestamp(UTC) in seconds
optional, timestamp(UTC) in seconds
Time at which subscription was cancelled or is set to be cancelled.
optional, timestamp(UTC) in seconds
optional, timestamp(UTC) in seconds
The reason for canceling the subscription. Set by Chargebee automatically.
optional, enumerated string
optional, enumerated string
Possible values are
not_paidNot Paid.no_cardNo Card.fraud_review_failedFraud Review Failed.non_compliant_eu_customerNon Compliant EU Customer.tax_calculation_failedTax Calculation Failed.currency_incompatible_with_gatewayCurrency incompatible with Gateway.non_compliant_customerNon Compliant Customer.
The IP address of the user. Used primarly in Refersion integration. Refersion uses this field to track/log affiliate subscription.
optional, string, max chars=50
optional, string, max chars=50
Version number of this resource. Each update of this resource results in incremental change of this number. This attribute will be present only if the resource has been updated after 2016-09-28.
optional, long
optional, long
If
boolean, default=false
true, there are subscription changes scheduled on next renewal.boolean, default=false
Payment source attached to this subscription. If present, customer's payment sources won't be used to collect any payment for this subscripiton.
optional, string, max chars=40
optional, string, max chars=40
The free_quantity_in_decimal as set for the plan. Returned for quantity-based plans when multi-decimal pricing is enabled.
optional, string, max chars=33
optional, string, max chars=33
The decimal representation of the quantity of the plan purchased. Returned for quantity-based plans when multi-decimal pricing is enabled.
optional, string, max chars=33
optional, string, max chars=33
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 is enabled.
optional, string, max chars=33
optional, string, max chars=33
The decimal representation of the total amount for the plan, in major units of the currency. Always returned when multi-decimal pricing is enabled.
optional, string, max chars=33
optional, string, max chars=33
The preferred offline payment method for the subscription.
optional, enumerated string
optional, enumerated string
Possible values are
no_preferenceNo Preference.cashCash.checkCheck.bank_transferBank Transfer.ach_creditACH Credit.sepa_creditSEPA Credit.
Total number of invoices that are due for payment against the subscription.Note: Not supported if consolidated invoicing is enabled or when the subscription is for the customer who is in hierarchy and the parent of this customer owns and pays for the invoices of the subscription.
optional, integer
optional, integer
Time since this subscription has unpaid invoices. Note: Not supported if consolidated invoicing is enabled or when the subscription is for the customer who is in hierarchy and the parent of this customer owns and pays for the invoices of the subscription.
optional, timestamp(UTC) in seconds
optional, timestamp(UTC) in seconds
Total invoice due amount for this subscription. The value depends on the type of currency.Note: Not supported if consolidated invoicing is enabled or when the subscription is for the customer who is in hierarchy and the parent of this customer owns and pays for the invoices of the subscription.
optional, in cents, min=0
optional, in cents, min=0
Monthly recurring revenue for the subscription. Updated asynchronously, this value catches up with changes to the subscription in less than a minute. The value depends on the type of currency.Note: This may not return accurate values since updated asynchronously.
optional, in cents, min=1
optional, in cents, min=1
Exchange rate used for base currency conversion.This value is updated to the rate configured on your site each time any change is made to the subscription.
optional, bigdecimal, min=1E-9, max=999999999.999999999
optional, bigdecimal, min=1E-9, max=999999999.999999999
A set of key-value pairs stored as additional information for the subscription. Learn more.
optional, jsonobject
optional, jsonobject
Indicates that the subscription has been deleted. You can retrieve a deleted subscription using the list operation.
boolean
boolean
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.
optional, string, max chars=100
optional, string, max chars=100
The period of time by which the first term of the subscription is to be extended free-of-charge. The value must be in multiples of free_period_unit.".
optional, integer
optional, integer
Defines additional free period in association with the billing period.
optional, enumerated string
optional, enumerated string
Possible values are
dayCharge based on day(s).weekCharge based on week(s).monthCharge based on month(s).yearCharge based on year(s).Indicates whether the invoices for this subscription are generated with a pending status. This attribute is set to true automatically when the subscription has item prices that belong to metered items.
You can also set this to true explicitly using the create/update subscription operations. This is useful in the following scenarios:
- When tracking usages and calculating usage-based charges on your end. You can then add them to the subscription as a one-time charge at the end of the billing term.
- When you need to inspect all charges before closing invoices for this subscription.
Applicable only when Metered Billing is enabled for the site
.optional, boolean
Set to
optional, boolean
false to override for this subscription, the site-level setting 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 customer level.optional, boolean
List of addons for this subscription with quantity(if applicable).
optional, list of addon
optional, list of addon
Addon attributes
Addon quantity. Applicable only for the quantity based addons. Should be passed with the same index as that of associated addon id.
optional, integer, default=1, min=1
optional, integer, default=1, min=1
Amount that will override the Addon's default price. The Plan's billing frequency will not be considered for overriding. E.g. If the Plan's billing frequency is every 3 months, and if the price override amount is $10, $10 will be used, and not $30 (i.e $10*3).
optional, in cents, min=0
optional, in cents, min=0
The time at which the trial ends for the addon. This value can only be set for subscriptions that start with an
optional, timestamp(UTC) in seconds
active or non-renewing status. Once set, the value can't be changed. (Addon trial periods must be enabled by Chargebee Support.).optional, timestamp(UTC) in seconds
The number of billing cycles this addon will be attached to subscription.
optional, integer, min=0
optional, integer, min=0
The decimal representation of the quantity of the addon. Returned for quantity-based plans when multi-decimal pricing is enabled.
optional, string, max chars=33
optional, string, max chars=33
The decimal representation of the price or per-unit price of the addon. The value is in major units of the currency. Always returned when multi-decimal pricing is enabled.
optional, string, max chars=33
optional, string, max chars=33
The decimal representation of the total amount for the addon, in major units of the currency. Always returned when multi-decimal pricing is enabled.
optional, string, max chars=33
optional, string, max chars=33
List of non-recurring addons that will be charged on the occurrence of specified event.
optional, list of event_based_addon
optional, list of event_based_addon
Event based addon attributes
Addon quantity. Applicable only for the quantity based addons. Should be passed with the same index as that of associated addon id.
integer, min=0
integer, min=0
Event on which this addon will be charged.
enumerated string
enumerated string
Possible values are
subscription_creationAddon will be charged on subscription creation.subscription_trial_startAddon will be charged when the trial period starts.plan_activationAddon will be charged on plan activation.subscription_activationAddon will be charged on subscription activation.contract_terminationAddon will be charged on contract termination.If enabled, the addon will be charged only at the first occurrence of the event. Applicable only for non-recurring add-ons.
boolean, default=true
boolean, default=true
The decimal representation of the quantity of the addon. Returned for quantity-based addons when multi-decimal pricing is enabled.
optional, string, max chars=33
optional, string, max chars=33
The decimal representation of the price or per-unit price of the addon. The value is in major units of the currency. Always returned when multi-decimal pricing is enabled.
optional, string, max chars=33
optional, string, max chars=33
List of event_based_addons that have already been charged.
optional, list of charged_event_based_addon
optional, list of charged_event_based_addon
List of coupons for this subscription.
optional, list of coupon
optional, list of coupon
Coupon attributes
The date till when the coupon can be applied. Applicable for
optional, timestamp(UTC) in seconds
limited_period coupons only.optional, timestamp(UTC) in seconds
Shipping address for the subscription.
optional, shipping_address
optional, shipping_address
Shipping addres attributes
The ISO 3166-2 state/province code without the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set
optional, string, max chars=50
state_code as AZ (not US-AZ). For Tamil Nadu (India), set as TN (not IN-TN). For British Columbia (Canada), set as BC (not CA-BC).optional, string, max chars=50
Referral details if exists for the subscription.
optional, referral_info
optional, referral_info
Referral info attributes
External reference id in referral system for the subscription.
optional, string, max chars=50
optional, string, max chars=50
Reward status for the referral subscription.
optional, enumerated string, default=pending
optional, enumerated string, default=pending
Possible values are
pendingPending.paidPaid.invalidInvalid.Source referral system for the referral subscription.
optional, enumerated string
optional, enumerated string
Possible values are
referral_candyReferral Candy.referral_saasquatchReferral Saasquatch.friendbuyFriendbuy.Friend offer type for the referral camapign.
optional, enumerated string
optional, enumerated string
Possible values are
noneNone.couponCoupon.coupon_codeCoupon Code.Referrer reward type for the referral campaign.
optional, enumerated string
optional, enumerated string
Possible values are
noneNone.referral_direct_rewardReferral Direct Reward.custom_promotional_creditCustom Promotional Credit.custom_revenue_percent_basedCustom Revenue Percent Based.Whether or not to notify the referral purchases to the referral system.
optional, enumerated string
optional, enumerated string
Possible values are
noneNone.first_paid_conversionFirst Paid Conversion.all_invoicesAll Invoices.
Contract terms for this subscription.
optional, contract_term
optional, contract_term
Contract term attributes
Current status of contract.
enumerated string
enumerated string
Possible values are
activeAn actively running contract term.completedThe contract term has run its full duration.cancelledThe contract term was ended because: - a change in the subscription caused a subscription term reset.
- the subscription was cancelled due to non-payment.
The number of billing cycles of the subscription that the contract term is for.
integer, min=0
integer, min=0
Action to be taken when the contract term completes.
enumerated string, default=renew
Contract term completes and a new contract term is started for the number of billing cycles specified in The evergreenContract term completes and the subscription renews.cancelContract term completes and subscription is canceled.renew_onceUsed 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 The .
enumerated string, default=renew
Possible values are
renewcontract_billing_cycle_on_renewal.action_at_term_end for the new contract term is set to renew.contract_billing_cycle_on_renewal.action_at_term_end for the new contract term is set to cancel.The sum of the totals of all the invoices raised as part of the contract term. For
in cents, default=0, min=0
active contract terms, this is a predicted value. The value depends on the type of currency. If the subscription was imported with the contract term, then this value includes the value passed for total_amount_raised.in cents, default=0, min=0
The number of days before
optional, integer
contract_end, 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.optional, integer
Create a subscription¶
This operation supports 3DS verification flow. To achieve the same, create the
Payment Intent and pass it as input parameter to this API.
Creates a new subscription along with the customer. You can attach a plan, plan quantity, one or more addons and coupon while creating this subscription.
Future Subscriptions
If the start_date is specified, the subscription will be created in 'future' state (.ie, instead of starting immediately it will be scheduled to start at the specified 'start_date'). Besides if 'trial' is specified (plan configuration or specified explictly using trial_end), the subscription will go into 'trial' state when it starts. Otherwise it will directly become 'active' when it starts.
Trial Period
If the plan has trial period or if the trial_end is specified explicitly, the subscription will be created in 'in_trial' state.
If the card details are passed, it is not charged until the end of the trial period. Incase you need to verify the card you could enable the 'card verification option' in the gateway settings.
Invoice
If the plan does not have a trial period and if any of the recurring items has charges, then a invoice would be raised immediately. If 'auto_collection' is turned 'on', then card attributes are mandatory and subscription will be created only if the payment was successful.
Card details
Passing card details to this API involves PCI liability at your end as sensitive card information passes through your servers. If you wish to avoid that, you can use one of the following integration methodologies if applicable
- If you are using Stripe gateway, you can use Stripe.js with your checkout form. Take a look at this Stripe tutorial for more details.
- If you are using Braintree gateway, you can use Braintree.js with your checkout form. Please refer this tutorial for more details.
- If you are using Authorize.Net gateway, you use Accept.js with your checkout form.
- In case you are using the Adyen gateway, you will have to use the Adyen’s Client Side Encryption to encrypt sensitive cardholder data. Once the cardholder data is encrypted, pass the value in adyen.encrypted.data as temp token in this API.
Legacy behavior:
- For sites created before March 1st, 2014: On making this request, the
billing_addressandvat_numberof the customer are deleted and replaced by the values passed with this request. Ensure that you pass the billing address parameters and thevat_numberparameter (now deprecated), each time you make this request to avoid losing the same information at the customer-level. - For sites created on or after March 1st, 2014: This request does not alter the
billing_addressandvat_numberof the customer.
Related Tutorials
- Check out this tutorial to create trial signup with custom fields.
- Learn how to implement a in-app checkout flow that allows your customers to select addons and apply coupons. Estimate API is used to dynamically calculate the order summary shown to the customer.
Sample Request
# creates a subscription with customer information and billing details.
curl https://{site}.chargebee.com/api/v2/subscriptions \
-u {site_api_key}:\
-d plan_id="no_trial" \
-d auto_collection="off" \
-d customer[first_name]="John" \
-d customer[last_name]="Doe" \
-d customer[email]="john@user.com" \
-d billing_address[first_name]="John" \
-d billing_address[last_name]="Doe" \
-d billing_address[line1]="PO Box 9999" \
-d billing_address[city]="Walnut" \
-d billing_address[state]="California" \
-d billing_address[zip]="91789" \
-d billing_address[country]="US"
copy
Sample Response [ JSON ]
URL Format POST
https://{site}.chargebee.com/api/v2/subscriptions
Input Parameters
A unique and immutable identifier for the subscription. If not provided, it is autogenerated.
optional, string, max chars=50
optional, string, max chars=50
When price overriding is enabled for the site, the price or per-unit price of the plan can be set here. The value set for the plan 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 is enabled.
optional, string, max chars=33
optional, string, max chars=33
The decimal representation of the quantity of the plan purchased. Can be provided for quantity-based plans and only when multi-decimal pricing is enabled.
optional, string, max chars=33
optional, string, max chars=33
The time at which the trial ends for this subscription. Can be specified to override the default trial period.If '0' is passed, the subscription will be activated immediately.
optional, timestamp(UTC) in seconds
optional, timestamp(UTC) in seconds
Number of cycles(plan interval) this subscription should be charged. After the billing cycles exhausted, the subscription will be cancelled.
optional, integer, min=0
optional, integer, min=0
List of addons IDs that are mandatory to the plan and has to be removed from the subscription.
optional, list of string
optional, list of string
The date/time at which the subscription is to start or has started. If not provided, the subscription starts immediately. If set to a value in the past then that date/time should not be more than a plan billing period into the past.
optional, timestamp(UTC) in seconds
optional, timestamp(UTC) in seconds
Defines whether payments need to be collected automatically for this subscription. Overrides customer's auto-collection property.
optional, enumerated string
optional, enumerated string
Possible values are
onWhenever an invoice is created for this subscription, an automatic charge will be attempted on the payment method available.offAutomatic collection of charges will not be made for this subscription. Use this for offline payments.
The number of subscription billing cycles (including the first one) to invoice in advance.
optional, integer, min=1
optional, integer, min=1
Override the billing alignment mode for Calendar Billing. Only applicable when using Calendar Billing. The default value is that which has been configured for the site.
optional, enumerated string
optional, enumerated string
Possible values are
immediateSubscription period will be aligned with the configured billing date immediately, with credits or charges raised accordingly..delayedSubscription period will be aligned with the configured billing date at the next renewal.
The preferred offline payment method for the subscription.
optional, enumerated string
optional, enumerated string
Possible values are
no_preferenceNo Preference.cashCash.checkCheck.bank_transferBank Transfer.ach_creditACH Credit.sepa_creditSEPA Credit.
List of coupons to be applied to this subscription. You can provide coupon ids or coupon codes.
optional, list of string
optional, list of string
A set of key-value pairs stored as additional information for the subscription. Learn more.
optional, jsonobject
optional, jsonobject
If there are charges raised immediately for the subscription, this parameter specifies whether those charges are to be invoiced immediately or added to unbilled charges. The default value is as per the site settings.
optional, boolean
optional, boolean
The period of time by which the first term of the subscription is to be extended free-of-charge. The value must be in multiples of free_period_unit.
optional, integer, min=1
optional, integer, min=1
The unit of time in multiples of which the free_period parameter is expressed. The value must be equal to or lower than the period_unit attribute of the plan chosen.
optional, enumerated string
optional, enumerated string
Possible values are
dayCharge based on day(s).weekCharge based on week(s).monthCharge based on month(s).yearCharge based on year(s).
Number of billing cycles the new contract term should run for, on contract renewal. The default value is the same as
optional, integer, min=1, max=100
billing_cycles or a custom value depending on the site configuration.optional, integer, min=1, max=100
Indicates the Client profile id for the customer. This is applicable only if you use Chargebee’s AvaTax for Communications integration.
optional, string, max chars=50
optional, string, max chars=50
Parameters for customer
pass parameters as customer[<param name>]
pass parameters as customer[<param name>]
Id for the new customer. If not given, this will be same as the subscription id.
optional, string, max chars=50
optional, string, max chars=50
Email of the customer. Configured email notifications will be sent to this email.
optional, string, max chars=70
optional, string, max chars=70
Specifies if the customer is liable for tax.
optional, enumerated string, default=taxable
optional, enumerated string, default=taxable
Possible values are
taxableComputes tax for the customer based on the site configuration. In some cases, depending on the region, shipping_address is needed. If not provided, then billing_address is used to compute tax. If that’s not available either, the tax is taken as zero.exempt- Customer is exempted from tax. When using Chargebee’s native Taxes feature or when using the TaxJar integration, no other action is needed.
- However, when using our Avalara integration, optionally, specify
entity_codeorexempt_numberattributes if you use Chargebee’s AvaTax for Sales or specifyexemption_detailsattribute if you use Chargebee’s AvaTax for Communications integration. Tax may still be applied by Avalara for certain values ofentity_code/exempt_number/exemption_detailsbased on the state/region/province of the taxable address.
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.
optional, string, max chars=50
optional, string, max chars=50
The exemption category of the customer, for USA and Canada. Applicable if you use Chargebee's AvaTax for Sales integration.
optional, enumerated string
optional, enumerated string
Possible values are
aFederal government.bState government.cTribe/Status Indian/Indian Band.dForeign diplomat.eCharitable or benevolent organization.fReligious organization.gResale.hCommercial agricultural production.iIndustrial production/manufacturer.jDirect pay permit.kDirect mail.lOther or custom.mEducational organization.nLocal government.pCommercial aquaculture.qCommercial Fishery.rNon-resident.med1US Medical Device Excise Tax with exempt sales tax.med2US Medical Device Excise Tax with taxable sales tax.
Show all values[+]
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.
optional, string, max chars=100
optional, string, max chars=100
The number of days within which the customer has to make payment for the invoice.
optional, integer, default=0
optional, integer, default=0
Indicates the exemption type of the customer. This is applicable only if you use Chargebee’s TaxJar integration.
optional, enumerated string
optional, enumerated string
Possible values are
wholesaleWhole-sale.governmentGovernment.otherOther.
Whether payments needs to be collected automatically for this customer.
optional, enumerated string, default=on
optional, enumerated string, default=on
Possible values are
onWhenever an invoice is created, an automatic attempt to charge the customer's payment method is made.offAutomatic collection of charges will not be made. All payments must be recorded offline.
The preferred offline payment method for the subscription.
optional, enumerated string
optional, enumerated string
Possible values are
no_preferenceNo Preference.cashCash.checkCheck.bank_transferBank Transfer.ach_creditACH Credit.sepa_creditSEPA Credit.
Whether the customer can pay via Direct Debit.
optional, boolean, default=false
optional, boolean, default=false
Applicable when consolidated invoicing is enabled. Indicates whether invoice consolidation should happen during subscription renewals. Needs to be set only if this value is different from the defaults configured.
optional, boolean
optional, boolean
Confirms that a customer is registered under GST. If set to
optional, boolean
true then the Reverse Charge Mechanism is applicable. This field is applicable only when Australian GST is configured for your site.optional, boolean
Confirms that a customer is a valid business without an EU/UK VAT number.
optional, boolean
optional, boolean
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 integration.
To know more about what values you need to provide, refer to this Avalara’s API document.
optional, jsonarray
To know more about what values you need to provide, refer to this Avalara’s API document.
optional, jsonarray
Indicates the type of the customer. This is applicable only if you use Chargebee’s AvaTax for Communications integration.
optional, enumerated string
optional, enumerated string
Possible values are
residentialWhen the purchase is made by a customer for home use.businessWhen the purchase is made at a place of business.senior_citizenWhen the purchase is made by a customer who meets the jurisdiction requirements to be considered a senior citizen and qualifies for senior citizen tax breaks.industrialWhen the purchase is made by an industrial business.
Parameters for card
pass parameters as card[<param name>]
pass parameters as card[<param name>]
The gateway account in which this payment source is stored.
optional, string, max chars=50
optional, string, max chars=50
The credit card number without any format. If you are using Braintree.js, you can specify the Braintree encrypted card number here.
required if card provided, string, max chars=1500
required if card provided, string, max chars=1500
The card verification value (CVV). If you are using Braintree.js, you can specify the Braintree encrypted CVV here.
optional, string, max chars=520
optional, string, max chars=520
Address line 1, as available in card billing address.
optional, string, max chars=150
optional, string, max chars=150
Address line 2, as available in card billing address.
optional, string, max chars=150
optional, string, max chars=150
The ISO 3166-2 state/province code without the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set
optional, string, max chars=50
state_code as AZ (not US-AZ). For Tamil Nadu (India), set as TN (not IN-TN). For British Columbia (Canada), set as BC (not CA-BC).optional, string, max chars=50
The state/province name. Is set by Chargebee automatically for US, Canada and India If
optional, string, max chars=50
state_code is provided.optional, string, max chars=50
Postal or Zip code, as available in card billing address.
optional, string, max chars=20
optional, string, max chars=20
Parameters for bank_account
pass parameters as bank_account[<param name>]
pass parameters as bank_account[<param name>]
The gateway account in which this payment source is stored.
optional, string, max chars=50
optional, string, max chars=50
Account holder’s International Bank Account Number. For the GoCardless platform, this can be the local bank details
.
optional, string, min chars=10, max chars=50
optional, string, min chars=10, max chars=50
Account holder’s first name as per bank account. If not passed, details from customer details will be considered.
optional, string, max chars=150
optional, string, max chars=150
Account holder’s last name as per bank account. If not passed, details from customer details will be considered.
optional, string, max chars=150
optional, string, max chars=150
Account holder’s company name as per bank account. If not passed, details from customer details will be considered.
optional, string, max chars=250
optional, string, max chars=250
Account holder’s email address. If not passed, details from customer details will be considered. All Direct Debit compliant emails will be sent to this email address.
optional, string, max chars=70
optional, string, max chars=70
Account holder’s bank account number.
optional, string, min chars=4, max chars=17
optional, string, min chars=4, max chars=17
For Authorize.net ACH users only. Indicates the type of account.
optional, enumerated string
optional, enumerated string
Possible values are
checkingChecking Account.savingsSavings Account.business_checkingBusiness Checking Account.
For Stripe ACH users only. Indicates the account holder type.
optional, enumerated string
optional, enumerated string
Possible values are
individualIndividual.companyCompany.
For Authorize.net ACH users only. Indicates the type of eCheck.
optional, enumerated string
optional, enumerated string
Possible values are
webPayment Authorization obtained from the customer via the internet.ppdPayment Authorization is prearranged between the customer and the merchant.ccdPayment Authorization agreement from the corporate customer is required. Applicable for business_checking account_type.
2-letter(alpha2) ISO country code. Required when local bank details are provided, and not IBAN.
optional, string, max chars=50
optional, string, max chars=50
For GoCardless Autogiro users only. The civic/company number (personnummer, samordningsnummer, or organisationsnummer) of the customer. Must be supplied if the customer’s bank account is denominated in Swedish krona (SEK). This field cannot be changed once it has been set.
optional, string, min chars=10, max chars=12
optional, string, min chars=10, max chars=12
Parameters for payment_method
pass parameters as payment_method[<param name>]
pass parameters as payment_method[<param name>]
The type of payment method. For more details refer
Update payment method for a customer API under Customer resource.
optional, enumerated string
optional, enumerated string
Possible values are
cardCard based payment including credit cards and debit cards. Details about the card can be obtained from the card resource.paypal_express_checkoutPayments made via PayPal Express Checkout.amazon_paymentsPayments made via Amazon Payments.direct_debitRepresents bank account for which the direct debit or ACH agreement/mandate is created.genericGeneric Payment Method.alipayAlipay Payments.unionpayUnionPay Payments.apple_payApple Pay Payments.wechat_payWeChat Pay Payments.idealiDEAL Payments.google_payGoogle Pay Payments.sofortSofort Payments.bancontactBancontact Card Payments.giropaygiropay Payments.dotpayDotpay Payments.
Show all values[+]
The gateway account in which this payment source is stored.
optional, string, max chars=50
optional, string, max chars=50
The reference id. In the case of Amazon and PayPal this will be the
billing agreement id. For GoCardless direct debit this will be 'mandate id'. In the case of card this will be the identifier provided by the gateway/card vault for the specific payment method resource.
Note: This is not the one-time temporary token provided by gateways like Stripe.
For more details refer Update payment method for a customer API under Customer resource.
optional, string, max chars=200
For more details refer Update payment method for a customer API under Customer resource.
optional, string, max chars=200
Single-use token created by payment gateways. In Stripe, a single-use token is created for Apple Pay Wallet or card details. In Braintree, a nonce is created for Apple Pay Wallet, PayPal, or card details. In Authorize.Net, a nonce is created for card details. In Adyen, an encrypted data is created from the card details.
required if reference_id not provided, string, max chars=65k
required if reference_id not provided, string, max chars=65k
Parameters for payment_intent
pass parameters as payment_intent[<param name>]
pass parameters as payment_intent[<param name>]
Identifier for PaymentIntent generated by Chargebee.js. Applicable only when you are using Chargebee.js for completing the 3DS flow. The PaymentIntent should be in 'authorized' state while passing it here. You need not pass other PaymentIntent parameters if this is passed.
optional, string, max chars=150
optional, string, max chars=150
The gateway account used for performing the 3DS flow.
required if payment intent token provided, string, max chars=50
required if payment intent token provided, string, max chars=50
Identifier for 3DS transaction/verification object at the gateway. Can be passed only after successfully completing the 3DS flow. Refer 3DS implementation in Chargebee to find out the gateway-specific gw_token format. Applicable when you are using gateway APIs directly for completing the 3DS flow.
optional, string, max chars=65k
optional, string, max chars=65k
Identifier for Braintree permanent token. Applicable when you are using Braintree APIs for completing the 3DS flow.
optional, string, max chars=65k
optional, string, max chars=65k
Applicable only for Braintree gateway. Can be used only for Braintree’s Advance Fraud Management feature. Pass a stringified JSON containing the
optional, jsonobject
device_session_id and fraud_merchant_id as an input to fingerprint. Here’s a sample to it.optional, jsonobject
Parameters for billing_address
pass parameters as billing_address[<param name>]
pass parameters as billing_address[<param name>]
The ISO 3166-2 state/province code without the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set
optional, string, max chars=50
state_code as AZ (not US-AZ). For Tamil Nadu (India), set as TN (not IN-TN). For British Columbia (Canada), set as BC (not CA-BC).optional, string, max chars=50
The state/province name. Is set by Chargebee automatically for US, Canada and India If
optional, string, max chars=50
state_code is provided.optional, string, max chars=50
Parameters for shipping_address
pass parameters as shipping_address[<param name>]
pass parameters as shipping_address[<param name>]
The ISO 3166-2 state/province code without the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set
optional, string, max chars=50
state_code as AZ (not US-AZ). For Tamil Nadu (India), set as TN (not IN-TN). For British Columbia (Canada), set as BC (not CA-BC).optional, string, max chars=50
The state/province name. Is set by Chargebee automatically for US, Canada and India If
optional, string, max chars=50
state_code is provided.optional, string, max chars=50
Parameters for contract_term
pass parameters as contract_term[<param name>]
pass parameters as contract_term[<param name>]
Action to be taken when the contract term completes.
optional, enumerated string, default=cancel
Contract term completes and a new contract term is started for the number of billing cycles specified in The evergreenContract term completes and the subscription renews.cancelContract term completes and subscription is canceled.
optional, enumerated string, default=cancel
Possible values are
renewcontract_billing_cycle_on_renewal.action_at_term_end for the new contract term is set to renew.
The number of days before
optional, integer, default=0
contract_end, 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.optional, integer, default=0
Parameters for addons. Multiple addons can be passed by specifying unique indices.
pass parameters as addons[<param name>][<idx:0..n>]
pass parameters as addons[<param name>][<idx:0..n>]
Identifier of the addon. Multiple addons can be passed.
optional, string, max chars=100
optional, string, max chars=100
Addon quantity. Applicable only for the quantity based addons. Should be passed with the same index as that of associated addon id.
optional, integer, default=1, min=1
optional, integer, default=1, min=1
The decimal representation of the quantity of the addon. Can be provided for quantity-based addons and only when multi-decimal pricing is enabled.
optional, string, max chars=33
optional, string, max chars=33
Amount that will override the Addon's default price. The Plan's billing frequency will not be considered for overriding. E.g. If the Plan's billing frequency is every 3 months, and if the price override amount is $10, $10 will be used, and not $30 (i.e $10*3).
optional, in cents, min=0
optional, in cents, min=0
When price overriding is enabled for the site, the price or per-unit price of the addon can be set here. The value set for the addon is used by default. However, the price provided here is considered as the price of the addon for an entire billing cycle of the subscription regardless of the value of the addon
optional, string, max chars=33
period. Provide the value as a decimal string in major units of the currency. Can be provided only when multi-decimal pricing is enabled.optional, string, max chars=33
Number of billing cycles the addon will be charged for. When not set, the addon is attached to the subscription for an indefinite number of billing cycles. While updating a subscription to a plan with a different billing period, set this parameter again or its value will be lost. And so, the addon will be attached indefinitely.
optional, integer, min=1
optional, integer, min=1
The time at which the trial ends for the addon. This value can only be set for subscriptions that start with an
optional, timestamp(UTC) in seconds
active or non-renewing status. Once set, the value can't be changed. (Addon trial periods must be enabled by Chargebee Support.).optional, timestamp(UTC) in seconds
Parameters for event_based_addons. Multiple event_based_addons can be passed by specifying unique indices.
pass parameters as event_based_addons[<param name>][<idx:0..n>]
pass parameters as event_based_addons[<param name>][<idx:0..n>]
A unique 'id' used to identify the addon.
optional, string, max chars=100
optional, string, max chars=100
Addon quantity. Applicable only for the quantity based addons. Should be passed with the same index as that of associated addon id.
optional, integer, min=0
optional, integer, min=0
Amount that will override the Addon's default price.
optional, in cents, min=0
optional, in cents, min=0
The decimal representation of the quantity of the addon. Can be provided for quantity-based addons and only when multi-decimal pricing is enabled.
optional, string, max chars=33
optional, string, max chars=33
When price overriding is enabled for the site, the price or per-unit price of the addon can be set here. The value set for the addon 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 is enabled.
optional, string, max chars=33
optional, string, max chars=33
Defines service period of the addon in days from the day of charge.
optional, integer, min=1, max=730
optional, integer, min=1, max=730
Event on which this addon will be charged.
optional, enumerated string
optional, enumerated string
Possible values are
subscription_creationAddon will be charged on subscription creation.subscription_trial_startAddon will be charged when the trial period starts.plan_activationAddon will be charged on plan activation.subscription_activationAddon will be charged on subscription activation.contract_terminationAddon will be charged on contract termination.
If enabled, the addon will be charged only at the first occurrence of the event. Applicable only for non-recurring add-ons.
optional, boolean, default=true
optional, boolean, default=true
Returns
Resource object representing subscription.
always returned
always returned
Resource object representing customer.
always returned
always returned
Resource object representing card.
optional
optional
Resource object representing invoice.
optional
optional
Resource object representing unbilled_charge.
optional
optional
Create subscription for customer¶
This operation supports 3DS verification flow. To achieve the same, create the
Payment Intent and pass it as input parameter to this API.
Creates a new subscription for an existing customer. You can attach a plan, plan quantity, one or more addons and coupon while creating this subscription.
If the plan does not have a trial period and if any of the recurring-item has charges, then the customer is charged immediately if auto_collection is turned 'on'. In that case, subscription is created only if the customer has a payment method on file and attempted payment is successful.
Notes
If an invoice gets generated during this operation, available Credits and Excess Payments will be automatically applied.
Sample Request
curl https://{site}.chargebee.com/api/v2/customers/__test__KyVnHhSBWkmi22UR/subscriptions \
-u {site_api_key}:\
-d plan_id="no_trial" \
-d shipping_address[first_name]="Mark" \
-d shipping_address[last_name]="Henry" \
-d shipping_address[company]="chargebee" \
-d start_date=1600968050
copy
Sample Response [ JSON ]
URL Format POST
https://{site}.chargebee.com/api/v2/customers/{customer_id}/subscriptions
Input Parameters
A unique and immutable identifier for the subscription. If not provided, it is autogenerated.
optional, string, max chars=50
optional, string, max chars=50
When price overriding is enabled for the site, the price or per-unit price of the plan can be set here. The value set for the plan 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 is enabled.
optional, string, max chars=33
optional, string, max chars=33
The decimal representation of the quantity of the plan purchased. Can be provided for quantity-based plans and only when multi-decimal pricing is enabled.
optional, string, max chars=33
optional, string, max chars=33
The time at which the trial ends for this subscription. Can be specified to override the default trial period.If '0' is passed, the subscription will be activated immediately.
optional, timestamp(UTC) in seconds
optional, timestamp(UTC) in seconds
Number of cycles(plan interval) this subscription should be charged. After the billing cycles exhausted, the subscription will be cancelled.
optional, integer, min=0
optional, integer, min=0
List of addons IDs that are mandatory to the plan and has to be removed from the subscription.
optional, list of string
optional, list of string
The date/time at which the subscription is to start or has started. If not provided, the subscription starts immediately. If set to a value in the past then that date/time should not be more than a plan billing period into the past.
optional, timestamp(UTC) in seconds
optional, timestamp(UTC) in seconds
Defines whether payments need to be collected automatically for this subscription. Overrides customer's auto-collection property.
optional, enumerated string
optional, enumerated string
Possible values are
onWhenever an invoice is created for this subscription, an automatic charge will be attempted on the payment method available.offAutomatic collection of charges will not be made for this subscription. Use this for offline payments.
The number of subscription billing cycles (including the first one) to invoice in advance.
optional, integer, min=1
optional, integer, min=1
Override the billing alignment mode for Calendar Billing. Only applicable when using Calendar Billing. The default value is that which has been configured for the site.
optional, enumerated string
optional, enumerated string
Possible values are
immediateSubscription period will be aligned with the configured billing date immediately, with credits or charges raised accordingly..delayedSubscription period will be aligned with the configured billing date at the next renewal.
The preferred offline payment method for the subscription.
optional, enumerated string
optional, enumerated string
Possible values are
no_preferenceNo Preference.cashCash.checkCheck.bank_transferBank Transfer.ach_creditACH Credit.sepa_creditSEPA Credit.
List of coupons to be applied to this subscription. You can provide coupon ids or coupon codes.
optional, list of string
optional, list of string
Id of the payment source to be attached to this subscription.
optional, string, max chars=40
optional, string, max chars=40
If
optional, boolean
true, ignores the hierarchy relationship and uses customer as payment and invoice owner.optional, boolean
A set of key-value pairs stored as additional information for the subscription. Learn more.
optional, jsonobject
optional, jsonobject
If there are charges raised immediately for the subscription, this parameter specifies whether those charges are to be invoiced immediately or added to unbilled charges. The default value is as per the site settings.
optional, boolean
optional, boolean
The period of time by which the first term of the subscription is to be extended free-of-charge. The value must be in multiples of free_period_unit.
optional, integer, min=1
optional, integer, min=1
The unit of time in multiples of which the free_period parameter is expressed. The value must be equal to or lower than the period_unit attribute of the plan chosen.
optional, enumerated string
optional, enumerated string
Possible values are
dayCharge based on day(s).weekCharge based on week(s).monthCharge based on month(s).yearCharge based on year(s).
Number of billing cycles the new contract term should run for, on contract renewal. The default value is the same as
optional, integer, min=1, max=100
billing_cycles or a custom value depending on the site configuration.optional, integer, min=1, max=100
Parameters for shipping_address
pass parameters as shipping_address[<param name>]
pass parameters as shipping_address[<param name>]
The ISO 3166-2 state/province code without the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set
optional, string, max chars=50
state_code as AZ (not US-AZ). For Tamil Nadu (India), set as TN (not IN-TN). For British Columbia (Canada), set as BC (not CA-BC).optional, string, max chars=50
The state/province name. Is set by Chargebee automatically for US, Canada and India If
optional, string, max chars=50
state_code is provided.optional, string, max chars=50
Parameters for payment_intent
pass parameters as payment_intent[<param name>]
pass parameters as payment_intent[<param name>]
Identifier for PaymentIntent generated by Chargebee.js. Applicable only when you are using Chargebee.js for completing the 3DS flow. The PaymentIntent should be in 'authorized' state while passing it here. You need not pass other PaymentIntent parameters if this is passed.
optional, string, max chars=150
optional, string, max chars=150
The gateway account used for performing the 3DS flow.
required if payment intent token provided, string, max chars=50
required if payment intent token provided, string, max chars=50
Identifier for 3DS transaction/verification object at the gateway. Can be passed only after successfully completing the 3DS flow. Refer 3DS implementation in Chargebee to find out the gateway-specific gw_token format. Applicable when you are using gateway APIs directly for completing the 3DS flow.
optional, string, max chars=65k
optional, string, max chars=65k
Identifier for Braintree permanent token. Applicable when you are using Braintree APIs for completing the 3DS flow.
optional, string, max chars=65k
optional, string, max chars=65k
Applicable only for Braintree gateway. Can be used only for Braintree’s Advance Fraud Management feature. Pass a stringified JSON containing the
optional, jsonobject
device_session_id and fraud_merchant_id as an input to fingerprint. Here’s a sample to it.optional, jsonobject
Parameters for contract_term
pass parameters as contract_term[<param name>]
pass parameters as contract_term[<param name>]
Action to be taken when the contract term completes.
optional, enumerated string, default=cancel
Contract term completes and a new contract term is started for the number of billing cycles specified in The evergreenContract term completes and the subscription renews.cancelContract term completes and subscription is canceled.
optional, enumerated string, default=cancel
Possible values are
renewcontract_billing_cycle_on_renewal.action_at_term_end for the new contract term is set to renew.
The number of days before
optional, integer, default=0
contract_end, 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.optional, integer, default=0
Parameters for addons. Multiple addons can be passed by specifying unique indices.
pass parameters as addons[<param name>][<idx:0..n>]
pass parameters as addons[<param name>][<idx:0..n>]
Identifier of the addon. Multiple addons can be passed.
optional, string, max chars=100
optional, string, max chars=100
Addon quantity. Applicable only for the quantity based addons. Should be passed with the same index as that of associated addon id.
optional, integer, default=1, min=1
optional, integer, default=1, min=1
The decimal representation of the quantity of the addon. Can be provided for quantity-based addons and only when multi-decimal pricing is enabled.
optional, string, max chars=33
optional, string, max chars=33
Amount that will override the Addon's default price. The Plan's billing frequency will not be considered for overriding. E.g. If the Plan's billing frequency is every 3 months, and if the price override amount is $10, $10 will be used, and not $30 (i.e $10*3).
optional, in cents, min=0
optional, in cents, min=0
When price overriding is enabled for the site, the price or per-unit price of the addon can be set here. The value set for the addon is used by default. However, the price provided here is considered as the price of the addon for an entire billing cycle of the subscription regardless of the value of the addon
optional, string, max chars=33
period. Provide the value as a decimal string in major units of the currency. Can be provided only when multi-decimal pricing is enabled.optional, string, max chars=33
Number of billing cycles the addon will be charged for. When not set, the addon is attached to the subscription for an indefinite number of billing cycles. While updating a subscription to a plan with a different billing period, set this parameter again or its value will be lost. And so, the addon will be attached indefinitely.
optional, integer, min=1
optional, integer, min=1
The time at which the trial ends for the addon. This value can only be set for subscriptions that start with an
optional, timestamp(UTC) in seconds
active or non-renewing status. Once set, the value can't be changed. (Addon trial periods must be enabled by Chargebee Support.).optional, timestamp(UTC) in seconds
Parameters for event_based_addons. Multiple event_based_addons can be passed by specifying unique indices.
pass parameters as event_based_addons[<param name>][<idx:0..n>]
pass parameters as event_based_addons[<param name>][<idx:0..n>]
A unique 'id' used to identify the addon.
optional, string, max chars=100
optional, string, max chars=100
Addon quantity. Applicable only for the quantity based addons. Should be passed with the same index as that of associated addon id.
optional, integer, min=0
optional, integer, min=0
Amount that will override the Addon's default price.
optional, in cents, min=0
optional, in cents, min=0
The decimal representation of the quantity of the addon. Can be provided for quantity-based addons and only when multi-decimal pricing is enabled.
optional, string, max chars=33
optional, string, max chars=33
When price overriding is enabled for the site, the price or per-unit price of the addon can be set here. The value set for the addon 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 is enabled.
optional, string, max chars=33
optional, string, max chars=33
Defines service period of the addon in days from the day of charge.
optional, integer, min=1, max=730
optional, integer, min=1, max=730
Event on which this addon will be charged.
optional, enumerated string
optional, enumerated string
Possible values are
subscription_creationAddon will be charged on subscription creation.subscription_trial_startAddon will be charged when the trial period starts.plan_activationAddon will be charged on plan activation.subscription_activationAddon will be charged on subscription activation.contract_terminationAddon will be charged on contract termination.
If enabled, the addon will be charged only at the first occurrence of the event. Applicable only for non-recurring add-ons.
optional, boolean, default=true
optional, boolean, default=true
Returns
Resource object representing subscription.
always returned
always returned
Resource object representing customer.
always returned
always returned
Resource object representing card.
optional
optional
Resource object representing invoice.
optional
optional
Resource object representing unbilled_charge.
optional
optional
List subscriptions¶
Sample Request
curl https://{site}.chargebee.com/api/v2/subscriptions \
-G \
-u {site_api_key}:\
--data-urlencode limit=2 \
--data-urlencode plan_id[in]="["basic","no_trial"]"
copy
curl https://{site}.chargebee.com/api/v2/subscriptions \
-G \
-u {site_api_key}:\
--data-urlencode limit=2 \
--data-urlencode plan_id[in]="["basic","no_trial"]"
Sample Response [ JSON ]
URL Format GET
https://{site}.chargebee.com/api/v2/subscriptions
Input Parameters
Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set
optional, string, max chars=1000
offset to the value of next_offset obtained in the previous iteration of the API call.optional, string, max chars=1000
Indicates whether to include deleted objects in the list. The deleted objects have the attribute
optional, boolean, default=false
deleted as true.optional, boolean, default=false
Sorts based on the specified attribute.
Supported attributes : created_at, updated_at
Supported sort-orders : asc, desc
Example → sort_by[asc] = "created_at"
This will sort the result based on the 'created_at' attribute in ascending(earliest first) order.
optional, string filter
Supported attributes : created_at, updated_at
Supported sort-orders : asc, desc
Example → sort_by[asc] = "created_at"
This will sort the result based on the 'created_at' attribute in ascending(earliest first) order.
optional, string filter
Filter Params
For operator usages, see the Pagination and Filtering section.
A unique and immutable identifier for the subscription. If not provided, it is autogenerated.
Supported operators : is, is_not, starts_with, in, not_in
Example → id[is_not] = "8gsnbYfsMLds"
optional, string filter
Supported operators : is, is_not, starts_with, in, not_in
Example → id[is_not] = "8gsnbYfsMLds"
optional, string filter
Identifier of the customer with whom this subscription is associated.
Supported operators : is, is_not, starts_with, in, not_in
Example → customer_id[is_not] = "8gsnbYfsMLds"
optional, string filter
Supported operators : is, is_not, starts_with, in, not_in
Example → customer_id[is_not] = "8gsnbYfsMLds"
optional, string filter
Identifier of the plan for this subscription.
Supported operators : is, is_not, starts_with, in, not_in
Example → plan_id[is_not] = "basic"
optional, string filter
Supported operators : is, is_not, starts_with, in, not_in
Example → plan_id[is_not] = "basic"
optional, string filter
Current state of the subscription. Possible values are : future, in_trial, active, non_renewing, paused, cancelled.
Supported operators : is, is_not, in, not_in
Example → status[is] = "active"
optional, enumerated string filter
Supported operators : is, is_not, in, not_in
Example → status[is] = "active"
optional, enumerated string filter
The reason for canceling the subscription. Set by Chargebee automatically. Possible values are : not_paid, no_card, fraud_review_failed, non_compliant_eu_customer, tax_calculation_failed, currency_incompatible_with_gateway, non_compliant_customer.
Supported operators : is, is_not, in, not_in, is_present
Example → cancel_reason[is_not] = "not_paid"
optional, enumerated string filter
Supported operators : is, is_not, in, not_in, is_present
Example → cancel_reason[is_not] = "not_paid"
optional, enumerated string filter
Reason code for canceling the subscription. Must be one from a list of reason codes set in the Chargebee app in Settings > Configure Chargebee > Reason Codes > Subscriptions > Subscription Cancellation. Must be passed if set as mandatory in the app. The codes are case-sensitive.
Supported operators : is, is_not, starts_with, in, not_in
Example → cancel_reason_code[is] = "Not Paid"
optional, string filter
Supported operators : is, is_not, starts_with, in, not_in
Example → cancel_reason_code[is] = "Not Paid"
optional, string filter
- When the subscription is not on a contract term: this value is the number of billing cycles remaining after the current cycle, at the end of which, the subscription cancels.
- When the subscription is on a contract term: this value is the number of billing cycles remaining in the contract term after the current billing cycle.
Supported operators : is, is_not, lt, lte, gt, gte, between, is_present
Example → remaining_billing_cycles[lt] = "3"
optional, integer filter
The time at which the subscription was created.
Supported operators : after, before, on, between
Example → created_at[after] = "1435054328"
optional, timestamp(UTC) in seconds filter
Supported operators : after, before, on, between
Example → created_at[after] = "1435054328"
optional, timestamp(UTC) in seconds filter
Time at which the subscription
Supported operators : after, before, on, between, is_present
Example → activated_at[after] = "1435054328"
optional, timestamp(UTC) in seconds filter
status last changed to
active. For example, this value is updated when an in_trial or
cancelled subscription activates.Supported operators : after, before, on, between, is_present
Example → activated_at[after] = "1435054328"
optional, timestamp(UTC) in seconds filter
The date/time at which the next billing for the subscription happens. This is usually right after
Supported operators : after, before, on, between
Example → next_billing_at[after] = "1435054328"
optional, timestamp(UTC) in seconds filter
current_term_end unless multiple subscription terms were invoiced in advance using the terms_to_charge parameter.Supported operators : after, before, on, between
Example → next_billing_at[after] = "1435054328"
optional, timestamp(UTC) in seconds filter
Time at which subscription was cancelled or is set to be cancelled.
Supported operators : after, before, on, between
Example → cancelled_at[after] = "1435054328"
optional, timestamp(UTC) in seconds filter
Supported operators : after, before, on, between
Example → cancelled_at[after] = "1435054328"
optional, timestamp(UTC) in seconds filter
If
Supported operators : is
Example → has_scheduled_changes[is] = "true"
optional, boolean filter
true, there are subscription changes scheduled on next renewal. Possible values are : true, falseSupported operators : is
Example → has_scheduled_changes[is] = "true"
optional, boolean filter
To filter based on
Supported operators : after, before, on, between
Example → updated_at[after] = "1243545465"
optional, timestamp(UTC) in seconds filter
updated_at. This attribute will be present only if the resource has been updated after 2016-09-28. It is advisable when using this filter, to pass the sort_by input parameter as updated_at for a faster response.Supported operators : after, before, on, between
Example → updated_at[after] = "1243545465"
optional, timestamp(UTC) in seconds filter
The preferred offline payment method for the subscription. Possible values are : no_preference, cash, check, bank_transfer, ach_credit, sepa_credit.
Supported operators : is, is_not, in, not_in
Example → offline_payment_method[is] = "cash"
optional, enumerated string filter
Supported operators : is, is_not, in, not_in
Example → offline_payment_method[is] = "cash"
optional, enumerated string filter
Set to
Supported operators : is
Example → auto_close_invoices[is] = "true"
optional, boolean filter
false to override for this subscription, the site-level setting 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 customer level. Possible values are : true, falseSupported operators : is
Example → auto_close_invoices[is] = "true"
optional, boolean filter
Indicates whether the invoices for this subscription are generated with a pending status. This attribute is set to true automatically when the subscription has item prices that belong to metered items.
You can also set this to true explicitly using the create/update subscription operations. This is useful in the following scenarios:
- When tracking usages and calculating usage-based charges on your end. You can then add them to the subscription as a one-time charge at the end of the billing term.
- When you need to inspect all charges before closing invoices for this subscription.
Applicable only when Metered Billing is enabled for the site
. Possible values are : true, falseSupported operators : is
Example → create_pending_invoices[is] = "true"
optional, boolean filter
If
Supported operators : is
Example → override_relationship[is] = "false"
optional, boolean filter
true, ignores the hierarchy relationship and uses customer as payment and invoice owner. Possible values are : true, falseSupported operators : is
Example → override_relationship[is] = "false"
optional, boolean filter
Returns
Resource object representing subscription.
always returned
always returned
Resource object representing customer.
always returned
always returned
Resource object representing card.
optional
optional
next_offset
This attribute is returned only if more resources are present. To fetch the next set of resources use this value for the input parameter “offset”.
optional, string, max chars=1000
optional, string, max chars=1000
List contract terms for a subscription¶
Sample Request
curl https://{site}.chargebee.com/api/v2/subscriptions/__test__KyVnHhSBWkgjr2SI/contract_terms \
-G \
-u {site_api_key}:
copy
Sample Response [ JSON ]
URL Format GET
https://{site}.chargebee.com/api/v2/subscriptions/{subscription_id}/contract_terms
Input Parameters
Returns
Resource object representing contract_term.
always returned
always returned
next_offset
This attribute is returned only if more resources are present. To fetch the next set of resources use this value for the input parameter “offset”.
optional, string, max chars=1000
optional, string, max chars=1000
Retrieve a subscription¶
Sample Request
curl https://{site}.chargebee.com/api/v2/subscriptions/__test__KyVnHhSBWkv9J2YH \
-u {site_api_key}:
copy
curl https://{site}.chargebee.com/api/v2/subscriptions/__test__KyVnHhSBWkv9J2YH \
-u {site_api_key}:
Sample Response [ JSON ]
URL Format GET
https://{site}.chargebee.com/api/v2/subscriptions/{subscription_id}
Returns
Resource object representing subscription.
always returned
always returned
Resource object representing customer.
always returned
always returned
Resource object representing card.
optional
optional
Sample admin console URL
https://{site}.chargebee.com/admin-console/subscriptions/123x
Retrieve with scheduled changes¶
Retrieves a subscription with the scheduled changes applied.
Note: Only the following attributes are changed
- plan_id
- plan_quantity
- plan_unit_price
- setup_fee
- billing_period
- billing_period_unit
- plan_free_quantity
- remaining_billing_cycles
- addons
- coupons
Sample Request
curl https://{site}.chargebee.com/api/v2/subscriptions/__test__KyVnHhSBWkvUM2YO/retrieve_with_scheduled_changes \
-u {site_api_key}:
copy
curl https://{site}.chargebee.com/api/v2/subscriptions/__test__KyVnHhSBWkvUM2YO/retrieve_with_scheduled_changes \
-u {site_api_key}:
Sample Response [ JSON ]
URL Format GET
https://{site}.chargebee.com/api/v2/subscriptions/{subscription_id}/retrieve_with_scheduled_changes
Returns
Resource object representing subscription.
always returned
always returned
Resource object representing customer.
always returned
always returned
Resource object representing card.
optional
optional
Remove scheduled changes¶
Sample Request
curl https://{site}.chargebee.com/api/v2/subscriptions/__test__KyVnHhSBWkt5V2XR/remove_scheduled_changes \
-X POST \
-u {site_api_key}:
copy
curl https://{site}.chargebee.com/api/v2/subscriptions/__test__KyVnHhSBWkt5V2XR/remove_scheduled_changes \
-X POST \
-u {site_api_key}:
Sample Response [ JSON ]
URL Format POST
https://{site}.chargebee.com/api/v2/subscriptions/{subscription_id}/remove_scheduled_changes
Returns
Resource object representing subscription.
always returned
always returned
Resource object representing customer.
always returned
always returned
Resource object representing card.
optional
optional
Resource object representing credit_note.
optional
optional
Remove scheduled cancellation¶
Note: Cannot be called when the subscription is on a contract term. (That is, when the contract_term.status attribute is active.)
If the subscription is in Non Renewing or In Trial state and is also scheduled to cancel at the end of current term, then this API can be used to remove the scheduled cancellation. When a scheduled cancellation is removed, the subscription will revert to Active or In Trial state, whichever is the state before cancellation was scheduled.
While removing the scheduled cancellation, you may specify the number of billing cycles. If the billing cycle is not specified, the default billing cycle from the plan will be applied on the subscription.
Sample Request
curl https://{site}.chargebee.com/api/v2/subscriptions/__test__KyVnHhSBWksgR2XI/remove_scheduled_cancellation \
-X POST \
-u {site_api_key}:
copy
curl https://{site}.chargebee.com/api/v2/subscriptions/__test__KyVnHhSBWksgR2XI/remove_scheduled_cancellation \
-X POST \
-u {site_api_key}:
Sample Response [ JSON ]
URL Format POST
https://{site}.chargebee.com/api/v2/subscriptions/{subscription_id}/remove_scheduled_cancellation
Input Parameters
Returns
Resource object representing subscription.
always returned
always returned
Resource object representing customer.
always returned
always returned
Resource object representing card.
optional
optional
Remove coupons¶
Sample Request
# removes the listed coupons associated with the subscription.
curl https://{site}.chargebee.com/api/v2/subscriptions/__test__KyVnHhSBWkrtw2X0/remove_coupons \
-X POST \
-u {site_api_key}:\
-d coupon_ids[0]="plan_only_coupon"
copy
Sample Response [ JSON ]
URL Format POST
https://{site}.chargebee.com/api/v2/subscriptions/{subscription_id}/remove_coupons
Input Parameters
Returns
Resource object representing subscription.
always returned
always returned
Resource object representing customer.
always returned
always returned
Resource object representing card.
optional
optional
Update a subscription¶
This operation supports 3DS verification flow. To achieve the same, create the
Payment Intent and pass it as input parameter to this API.
You can modify the plan, plan quantity and add or remove addons for the subscription. By default the changes are applied immediately and the charges (/credits) are prorated and adjusted with the next billing term. You may also choose to effect the changes at the end of the current term by passing end_of_term as "true". In this case proration will not be done.
Only the parameters that are passed are modified for the subscription. Rest will reflect the existing values.
By default, the addons passed are appended to the existing list of addons for this subscription. In case a passed addon already exists for this subscription, quantity value is replaced. If you want to completely replace the addons for this subscription, pass replace_addon_list as "true".
Card and 'vat_number' attributes can also be passed during subscription update. If they are passed, corresponding Billing Info attributes - the Billing Address and 'vat_number' - will be replaced automatically.
Passing credit card details to this API involves PCI liability at your end as sensitive card info passes through your servers. If you wish to avoid that, you can use one of the following integration methodologies if applicable
- If you are using Stripe gateway, you can use Stripe.js with your checkout form. Take a look at this Stripe tutorial for more details.
- If you are using Braintree gateway, you can use Braintree.js with your checkout form. Please refer this tutorial for more details.
- If you are using Authorize.Net gateway, you use Accept.js with your checkout form.
- If you are using the Adyen gateway, you will have to use the Adyen’s Client Side Encryption to encrypt sensitive cardholder data. Once the cardholder data is encrypted, pass the value in adyen.encrypted.data as temp token in this API.
- You can also use our Hosted Pages based integration.
Notes
Proration Scenario: A customer changes from a $15 plan to $30 plan after 15 days of a monthly term. He will be charged for $7.50 immediately. The following Credit Note and Invoice will be generated
| Credit Note | |
| Prorated credits for Old Plan | $7.50 |
| Invoice | |
| Prorated charges for New Plan | $15.00 |
| Total | $15.00 |
| Credits | ($7.50) |
| Amount Due | $7.50 |
Meanwhile downgrading will result in net credits being created which will be applied when the subscription is charged on start of the next term. Learn more about our proration scenarios here.
Billing Cycle: The billing period for a subscription does not change if the plans intervals of both old and new are same. However, if a customer changes to a plan that has different billing interval(say monthly to yearly), the billing period is reset. Customer is charged immediately for the modified subscription after applying credit for the unused period for the old subscription.
Card and VAT number Input: If they are passed, corresponding Billing Address attributes and vat_number will be replaced. i.e existing values for Billing Address and 'vat_number' will be cleared and the new values will be set.
If an invoice gets generated during this operation, available Credits and Excess Payments will be automatically applied.
Advance charges, if any, will be refunded as credits and a new invoice will be generated on renewal.
Sample Request
# updates the subscription's plan and replaces the addons associated with
# it .The changes made will be effective from current end
# of term.
curl https://{site}.chargebee.com/api/v2/subscriptions/__test__KyVnHhSBWkvzp2Yd \
-u {site_api_key}:\
-d plan_id="plan1" \
-d addons[id][0]="sub_ssl" \
-d addons[id][1]="sub_monitor" \
-d addons[quantity][1]=2 \
-d end_of_term="true"
copy
Sample Response [ JSON ]
URL Format POST
https://{site}.chargebee.com/api/v2/subscriptions/{subscription_id}
Input Parameters
Should be true if the existing addons should be replaced with the ones that are being passed.
optional, boolean
optional, boolean
List of addons IDs that are mandatory to the plan and has to be removed from the subscription.
optional, list of string
optional, list of string
The decimal representation of the quantity of the plan purchased. Can be provided for quantity-based plans and only when multi-decimal pricing is enabled.
optional, string, max chars=33
optional, string, max chars=33
When price overriding is enabled for the site, the price or per-unit price of the plan can be set here. The value set for the plan 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 is enabled.
optional, string, max chars=33
optional, string, max chars=33
The new start date of a
optional, timestamp(UTC) in seconds
future subscription. Applicable only for future subscriptions.optional, timestamp(UTC) in seconds
End of the trial period for the subscription. This overrides the trial period set for the plan. In Product Catalog v2 this overrides trial period set for the plan-item. Set it to
optional, timestamp(UTC) in seconds
0 to have no trial period.optional, timestamp(UTC) in seconds
The number of billing cycles the subscription runs before canceling. If not provided, then the billing cycles set for the plan is used. For Product Catalog v2, billing cycles set for plan-item price is used by default.
optional, integer, min=0
optional, integer, min=0
The number of subscription billing cycles to invoice in advance. If a new term is started for the subscription due to this API call, then
optional, integer, min=1
terms_to_charge is inclusive of this new term. See description for the force_term_reset parameter to learn more about when a subscription term is reset.optional, integer, min=1
When the subscription is reactivated as described under the
optional, timestamp(UTC) in seconds
reactivate parameter, this is the date/time at which the subscription should be reactivated.optional, timestamp(UTC) in seconds
Override the billing alignment mode chosen for the site for calendar billing. Only applicable when using calendar billing.
optional, enumerated string
optional, enumerated string
Possible values are
immediateSubscription period will be aligned with the configured billing date immediately, with credits or charges raised accordingly..delayedSubscription period will be aligned with the configured billing date at the next renewal.
Defines whether payments need to be collected automatically for this subscription. Overrides customer's auto-collection property.
optional, enumerated string
optional, enumerated string
Possible values are
onWhenever an invoice is created for this subscription, an automatic charge will be attempted on the payment method available.offAutomatic collection of charges will not be made for this subscription. Use this for offline payments.
The preferred offline payment method for the subscription.
optional, enumerated string
optional, enumerated string
Possible values are
no_preferenceNo Preference.cashCash.checkCheck.bank_transferBank Transfer.ach_creditACH Credit.sepa_creditSEPA Credit.
List of coupons to be applied to this subscription. You can provide coupon ids or coupon codes.
optional, list of string
optional, list of string
If
optional, boolean
true then the existing coupon_ids list for the subscription is replaced by the one provided. If false then the provided list gets added to the existing coupon_ids.optional, boolean
Raise prorated credits or charges as applicable while changing the subscription. When not provided, the value is taken from the site settings.
optional, boolean
optional, boolean
Set this to true if you want the update to be applied at the end of the current subscription billing cycle.
optional, boolean
optional, boolean
Say the subscription has the renewal date as 28th of every month. When the plan-item price of the subscription is set to one that has the same billing period as the current plan-item price, the subscription change does not change the term. In other words, the subscription still renews on the 28th. Passing this parameter as
Note: When the new plan-item price has a billing period different from the current plan-item price of the subscription, the term is always reset, regardless of the value passed for this parameter.
optional, boolean, default=false
true will have the subscription reset its term to the current date (provided end_of_term is false). Note: When the new plan-item price has a billing period different from the current plan-item price of the subscription, the term is always reset, regardless of the value passed for this parameter.
optional, boolean, default=false
Applicable only for
optional, boolean
cancelled subscriptions. When passed as true, the canceled subscription is activated; otherwise subscription changes are made without changing its status. If not passed, subscription will be activated only if subscription_items is passed.optional, boolean
A set of key-value pairs stored as additional information for the subscription. Learn more.
optional, jsonobject
optional, jsonobject
If there are charges raised immediately for the subscription, this parameter specifies whether those charges are to be invoiced immediately or added to unbilled charges. The default value is as per the site settings.
optional, boolean
optional, boolean
If
optional, boolean
true, ignores the hierarchy relationship and uses customer as payment and invoice owner.optional, boolean
Number of billing cycles the new contract term should run for, on contract renewal. The default value is the same as
optional, integer, min=1, max=100
billing_cycles or a custom value depending on the site configuration.optional, integer, min=1, max=100
The period of time by which the first term of the subscription is to be extended free-of-charge. The value must be in multiples of free_period_unit.
optional, integer, min=1
optional, integer, min=1
The unit of time in multiples of which the free_period parameter is expressed. The value must be equal to or lower than the period_unit attribute of the plan chosen.
optional, enumerated string
optional, enumerated string
Possible values are
dayCharge based on day(s).weekCharge based on week(s).monthCharge based on month(s).yearCharge based on year(s).
Parameters for card
pass parameters as card[<param name>]
pass parameters as card[<param name>]
The gateway account in which this payment source is stored.
optional, string, max chars=50
optional, string, max chars=50
The credit card number without any format. If you are using Braintree.js, you can specify the Braintree encrypted card number here.
required if card provided, string, max chars=1500
required if card provided, string, max chars=1500
The card verification value (CVV). If you are using Braintree.js, you can specify the Braintree encrypted CVV here.
optional, string, max chars=520
optional, string, max chars=520
Address line 1, as available in card billing address.
optional, string, max chars=150
optional, string, max chars=150
Address line 2, as available in card billing address.
optional, string, max chars=150
optional, string, max chars=150
The ISO 3166-2 state/province code without the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set
optional, string, max chars=50
state_code as AZ (not US-AZ). For Tamil Nadu (India), set as TN (not IN-TN). For British Columbia (Canada), set as BC (not CA-BC).optional, string, max chars=50
The state/province name. Is set by Chargebee automatically for US, Canada and India If
optional, string, max chars=50
state_code is provided.optional, string, max chars=50
Postal or Zip code, as available in card billing address.
optional, string, max chars=20
optional, string, max chars=20
Parameters for payment_method
pass parameters as payment_method[<param name>]
pass parameters as payment_method[<param name>]
The type of payment method. For more details refer
Update payment method for a customer API under Customer resource.
optional, enumerated string
optional, enumerated string
Possible values are
cardCard based payment including credit cards and debit cards. Details about the card can be obtained from the card resource.paypal_express_checkoutPayments made via PayPal Express Checkout.amazon_paymentsPayments made via Amazon Payments.direct_debitRepresents bank account for which the direct debit or ACH agreement/mandate is created.genericGeneric Payment Method.alipayAlipay Payments.unionpayUnionPay Payments.apple_payApple Pay Payments.wechat_payWeChat Pay Payments.idealiDEAL Payments.google_payGoogle Pay Payments.sofortSofort Payments.bancontactBancontact Card Payments.giropaygiropay Payments.dotpayDotpay Payments.
Show all values[+]
The gateway account in which this payment source is stored.
optional, string, max chars=50
optional, string, max chars=50
The reference id. In the case of Amazon and PayPal this will be the
billing agreement id. For GoCardless direct debit this will be 'mandate id'. In the case of card this will be the identifier provided by the gateway/card vault for the specific payment method resource.
Note: This is not the one-time temporary token provided by gateways like Stripe.
For more details refer Update payment method for a customer API under Customer resource.
optional, string, max chars=200
For more details refer Update payment method for a customer API under Customer resource.
optional, string, max chars=200
Single-use tokens created by payment gateways. In Stripe, a single-use token is created for Apple Pay Wallet, card details or direct debit. In Braintree, a nonce is created for Apple Pay Wallet, PayPal, or card details. In Authorize.Net, a nonce is created for card details. In Adyen, an encrypted data is created from the card details.
required if reference_id not provided, string, max chars=65k
required if reference_id not provided, string, max chars=65k
Parameters for payment_intent
pass parameters as payment_intent[<param name>]
pass parameters as payment_intent[<param name>]
Identifier for PaymentIntent generated by Chargebee.js. Applicable only when you are using Chargebee.js for completing the 3DS flow. The PaymentIntent should be in 'authorized' state while passing it here. You need not pass other PaymentIntent parameters if this is passed.
optional, string, max chars=150
optional, string, max chars=150
The gateway account used for performing the 3DS flow.
required if payment intent token provided, string, max chars=50
required if payment intent token provided, string, max chars=50
Identifier for 3DS transaction/verification object at the gateway. Can be passed only after successfully completing the 3DS flow. Refer 3DS implementation in Chargebee to find out the gateway-specific gw_token format. Applicable when you are using gateway APIs directly for completing the 3DS flow.
optional, string, max chars=65k
optional, string, max chars=65k
Identifier for Braintree permanent token. Applicable when you are using Braintree APIs for completing the 3DS flow.
optional, string, max chars=65k
optional, string, max chars=65k
Applicable only for Braintree gateway. Can be used only for Braintree’s Advance Fraud Management feature. Pass a stringified JSON containing the
optional, jsonobject
device_session_id and fraud_merchant_id as an input to fingerprint. Here’s a sample to it.optional, jsonobject
Parameters for billing_address
pass parameters as billing_address[<param name>]
pass parameters as billing_address[<param name>]
The ISO 3166-2 state/province code without the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set
optional, string, max chars=50
state_code as AZ (not US-AZ). For Tamil Nadu (India), set as TN (not IN-TN). For British Columbia (Canada), set as BC (not CA-BC).optional, string, max chars=50
The state/province name. Is set by Chargebee automatically for US, Canada and India If
optional, string, max chars=50
state_code is provided.optional, string, max chars=50
Parameters for shipping_address
pass parameters as shipping_address[<param name>]
pass parameters as shipping_address[<param name>]
The ISO 3166-2 state/province code without the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set
optional, string, max chars=50
state_code as AZ (not US-AZ). For Tamil Nadu (India), set as TN (not IN-TN). For British Columbia (Canada), set as BC (not CA-BC).optional, string, max chars=50
The state/province name. Is set by Chargebee automatically for US, Canada and India If
optional, string, max chars=50
state_code is provided.optional, string, max chars=50
Parameters for customer
pass parameters as customer[<param name>]
pass parameters as customer[<param name>]
Confirms that a customer is a valid business without an EU/UK VAT number.
optional, boolean
optional, boolean
Confirms that a customer is registered under GST. If set to
optional, boolean
true then the Reverse Charge Mechanism is applicable. This field is applicable only when Australian GST is configured for your site.optional, boolean
Parameters for contract_term
pass parameters as contract_term[<param name>]
pass parameters as contract_term[<param name>]
Action to be taken when the contract term completes.
optional, enumerated string
Contract term completes and a new contract term is started for the number of billing cycles specified in The evergreenContract term completes and the subscription renews.cancelContract term completes and subscription is canceled.renew_onceUsed 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 The .
optional, enumerated string
Possible values are
renewcontract_billing_cycle_on_renewal.action_at_term_end for the new contract term is set to renew.contract_billing_cycle_on_renewal.action_at_term_end for the new contract term is set to cancel.
The number of days before
optional, integer
contract_end, 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.optional, integer
Parameters for addons. Multiple addons can be passed by specifying unique indices.
pass parameters as addons[<param name>][<idx:0..n>]
pass parameters as addons[<param name>][<idx:0..n>]
Identifier of the addon. Multiple addons can be passed.
optional, string, max chars=100
optional, string, max chars=100
Addon quantity. Applicable only for the quantity based addons. Should be passed with the same index as that of associated addon id.
optional, integer, min=1
optional, integer, min=1
Amount that will override the Addon's default price. The Plan's billing frequency will not be considered for overriding. E.g. If the Plan's billing frequency is every 3 months, and if the price override amount is $10, $10 will be used, and not $30 (i.e $10*3).
optional, in cents, min=0
optional, in cents, min=0
Number of billing cycles the addon will be charged for. When not set, the addon is attached to the subscription for an indefinite number of billing cycles. While updating a subscription to a plan with a different billing period, set this parameter again or its value will be lost. And so, the addon will be attached indefinitely.
optional, integer, min=1
optional, integer, min=1
The decimal representation of the quantity of the addon. Can be provided for quantity-based addons and only when multi-decimal pricing is enabled.
optional, string, max chars=33
optional, string, max chars=33
When price overriding is enabled for the site, the price or per-unit price of the addon can be set here. The value set for the addon is used by default. However, the price provided here is considered as the price of the addon for an entire billing cycle of the subscription regardless of the value of the addon
optional, string, max chars=33
period. Provide the value as a decimal string in major units of the currency. Can be provided only when multi-decimal pricing is enabled.optional, string, max chars=33
The time at which the trial ends for the addon. To update this value, redo the complete addon set using
optional, timestamp(UTC) in seconds
replace_addon_list. (Addon trial periods must be enabled by Chargebee Support.).optional, timestamp(UTC) in seconds
Parameters for event_based_addons. Multiple event_based_addons can be passed by specifying unique indices.
pass parameters as event_based_addons[<param name>][<idx:0..n>]
pass parameters as event_based_addons[<param name>][<idx:0..n>]
A unique 'id' used to identify the addon.
optional, string, max chars=100
optional, string, max chars=100
Addon quantity. Applicable only for the quantity based addons. Should be passed with the same index as that of associated addon id.
optional, integer, min=0
optional, integer, min=0
Amount that will override the Addon's default price.
optional, in cents, min=0
optional, in cents, min=0
Defines service period of the addon in days from the day of charge.
optional, integer, min=1, max=730
optional, integer, min=1, max=730
Indicates when the non-recurring addon will be charged.
optional, enumerated string
optional, enumerated string
Possible values are
immediatelyCharges for the addon will be applied immediately.on_eventCharge for the addon will be applied on the occurrence of a specified event.
Event on which this addon will be charged.
optional, enumerated string
optional, enumerated string
Possible values are
subscription_creationAddon will be charged on subscription creation.subscription_trial_startAddon will be charged when the trial period starts.plan_activationAddon will be charged on plan activation.subscription_activationAddon will be charged on subscription activation.contract_terminationAddon will be charged on contract termination.
If enabled, the addon will be charged only at the first occurrence of the event. Applicable only for non-recurring add-ons.
optional, boolean
optional, boolean
The decimal representation of the quantity of the addon. Can be provided for quantity-based addons and only when multi-decimal pricing is enabled.
optional, string, max chars=33
optional, string, max chars=33
When price overriding is enabled for the site, the price or per-unit price of the addon can be set here. The value set for the addonis used by default. Provide the value as a decimal string in major units of the currency. Can be provided only when multi-decimal pricing is enabled.
optional, string, max chars=33
optional, string, max chars=33
Returns
Resource object representing subscription.
always returned
always returned
Resource object representing customer.
always returned
always returned
Resource object representing card.
optional
optional
Resource object representing invoice.
optional
optional
Resource object representing unbilled_charge.
optional
optional
Resource object representing credit_note.
optional
optional
Change term end¶
Changes the subscription's current term end date. Depending on the "status" of the subscription, "term end date" has different effects.
- If the Subscription is in trial, it affects trial end date.
- If the Subscription is active, it affects the next billing date.
- If the Subscription's status is non_renewing, this affects the upcoming cancellation date.
Tip: To cycle through a couple of billing cycles and test webhooks, you may use this API.
Notes
- When changing the term_end for active / non_renewing subscriptions, by default no additional charges (when term gets extended) will be added or credits (when term gets reduced) will be issued. However you can specify prorate param as true for adding prorated charges / issuing prorated credits. Further for the charges that got added, you can specify invoice_immediately as false to add them to unbilled charges and invoice them later.
- Advance charges, if any will be credited back during this operation.
Sample Request
curl https://{site}.chargebee.com/api/v2/subscriptions/__test__KyVnHhSBWkfbN2Rf/change_term_end \
-u {site_api_key}:\
-d term_ends_at=1601490600
copy
curl https://{site}.chargebee.com/api/v2/subscriptions/__test__KyVnHhSBWkfbN2Rf/change_term_end \
-u {site_api_key}:\
-d term_ends_at=1601490600
Sample Response [ JSON ]
URL Format POST
https://{site}.chargebee.com/api/v2/subscriptions/{subscription_id}/change_term_end
Input Parameters
The time at which the current term should end for this subscription.
required, timestamp(UTC) in seconds
required, timestamp(UTC) in seconds
Applicable for active / non_renewing subscriptions. If specified as true prorated charges / credits will be added during this operation.
optional, boolean
optional, boolean
If there are charges raised immediately for the subscription, this parameter specifies whether those charges are to be invoiced immediately or added to unbilled charges. The default value is as per the site settings.
optional, boolean
optional, boolean
Returns
Resource object representing subscription.
always returned
always returned
Resource object representing customer.
always returned
always returned
Resource object representing card.
optional
optional
Resource object representing invoice.
optional
optional
Resource object representing unbilled_charge.
optional
optional
Resource object representing credit_note.
optional
optional
Reactivate a subscription¶
This operation supports 3DS verification flow. To achieve the same, create the
Payment Intent and pass it as input parameter to this API.
This API is used to reactivate a cancelled subscription. You may also optionally specify a trial end date, to move the subscription to In Trial state. If trial end is not specified, the subscription will be activated and any applicable charges will be initiated.
Unless the billing cycle is specified, it will be set to plan's default billing cycle.
During an in-term reactivation++, unless the billing cycle is specified, the subscription's remaining billing cycles will be restored. If a trial end date is specified, then the plan's default billing cycle is used.
++What is an "in-term reactivation"?
An "in-term reactivation" happens when the billing term of the subscription is retained upon cancellation and reactivation is initiated within that term.
When is the ‘billing term’ retained for a cancelled subscription?
When dunning (payment failure retry settings) is configured with the last retry configured as
- cancel subscription and mark invoice as ‘Not Paid’, or
- cancel subscription and mark the invoice as ‘Voided’ and the case if any of the current term invoices is partially or fully paid, the invoice is not voided but instead Chargebee marks the invoices as ‘Not Paid’.
Note : In both cases, the billing term is retained and upon reactivation the subscription will be moved to active state (if the plan does not have a trial period) and no invoice will be generated. Ensure that you collect any unpaid invoices.
Example : A Subscription was billed from 1st to 31st of a month and it was cancelled on the 20th due to one of the above cases (billing term is not reset). If the reactivation happens on 25th then it is considered an in-term reactivation.
Notes
Reactivation of a subscription in non_renewing state has been deprecated. To remove a scheduled cancellation of a non_renewing Subscription, use Remove Scheduled Cancellation API.
However, if you use reactivate API to remove scheduled cancellation for a non_renewing Subscription, then the status will be set to active and the billing cycle will be set to forever. If any value is passed for trial_end or billing cycle, an error will be thrown.
If an invoice gets generated during this operation, available Credits and Excess Payments will be automatically applied.
Additional Error Scenarios: If there is a need to create an immediate charge and the collection fails, an error will be thrown.
Sample Request
curl https://{site}.chargebee.com/api/v2/subscriptions/__test__KyVnHhSBWkrVS2Wn/reactivate \
-X POST \
-u {site_api_key}:\
-d invoice_immediately="true" \
-d billing_cycles=4
copy
curl https://{site}.chargebee.com/api/v2/subscriptions/__test__KyVnHhSBWkrVS2Wn/reactivate \
-X POST \
-u {site_api_key}:\
-d invoice_immediately="true" \
-d billing_cycles=4
Sample Response [ JSON ]
URL Format POST
https://{site}.chargebee.com/api/v2/subscriptions/{subscription_id}/reactivate
Input Parameters
The time at which the trial should end for this subscription.
optional, timestamp(UTC) in seconds
optional, timestamp(UTC) in seconds
Number of cycles(plan interval) this subscription should be charged. After the billing cycles exhausted, the subscription will be cancelled.
optional, integer, min=0
optional, integer, min=0
When the subscription is reactivated as described under the
optional, timestamp(UTC) in seconds
reactivate parameter, this is the date/time at which the subscription should be reactivated.optional, timestamp(UTC) in seconds
If there are charges raised immediately for the subscription, this parameter specifies whether those charges are to be invoiced immediately or added to unbilled charges. The default value is as per the site settings.
optional, boolean
optional, boolean
Applicable when calendar billing is enabled and a new active term gets started during this operation. Unless specified the configured default value will be used.
optional, enumerated string
optional, enumerated string
Possible values are
immediateSubscription period will be aligned with the configured billing date immediately, with credits or charges raised accordingly..delayedSubscription period will be aligned with the configured billing date at the next renewal.
The number of subscription billing cycles to invoice in advance. If a new term is started for the subscription due to this API call, then
optional, integer, min=1
terms_to_charge is inclusive of this new term. See description for the force_term_reset parameter to learn more about when a subscription term is reset.optional, integer, min=1
Number of billing cycles the new contract term should run for, on contract renewal. The default value is the same as
optional, integer, min=1, max=100
billing_cycles or a custom value depending on the site configuration.optional, integer, min=1, max=100
Parameters for contract_term
pass parameters as contract_term[<param name>]
pass parameters as contract_term[<param name>]
Action to be taken when the contract term completes.
optional, enumerated string, default=cancel
Contract term completes and a new contract term is started for the number of billing cycles specified in The evergreenContract term completes and the subscription renews.cancelContract term completes and subscription is canceled.
optional, enumerated string, default=cancel
Possible values are
renewcontract_billing_cycle_on_renewal.action_at_term_end for the new contract term is set to renew.
The number of days before
optional, integer, default=0
contract_end, 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.optional, integer, default=0
Parameters for payment_intent
pass parameters as payment_intent[<param name>]
pass parameters as payment_intent[<param name>]
Identifier for PaymentIntent generated by Chargebee.js. Applicable only when you are using Chargebee.js for completing the 3DS flow. The PaymentIntent should be in 'authorized' state while passing it here. You need not pass other PaymentIntent parameters if this is passed.
optional, string, max chars=150
optional, string, max chars=150
The gateway account used for performing the 3DS flow.
required if payment intent token provided, string, max chars=50
required if payment intent token provided, string, max chars=50
Identifier for 3DS transaction/verification object at the gateway. Can be passed only after successfully completing the 3DS flow. Refer 3DS implementation in Chargebee to find out the gateway-specific gw_token format. Applicable when you are using gateway APIs directly for completing the 3DS flow.
optional, string, max chars=65k
optional, string, max chars=65k
Identifier for Braintree permanent token. Applicable when you are using Braintree APIs for completing the 3DS flow.
optional, string, max chars=65k
optional, string, max chars=65k
Applicable only for Braintree gateway. Can be used only for Braintree’s Advance Fraud Management feature. Pass a stringified JSON containing the
optional, jsonobject
device_session_id and fraud_merchant_id as an input to fingerprint. Here’s a sample to it.optional, jsonobject
Returns
Resource object representing subscription.
always returned
always returned
Resource object representing customer.
always returned
always returned
Resource object representing card.
optional
optional
Resource object representing invoice.
optional
optional
Resource object representing unbilled_charge.
optional
optional
Add charge at term end¶
Adds a one time charge to the subscription which will be added to the invoice generated at the end of the current term. If there are any applicable coupons in the subscription, an appropriate discount will be applied.
To collect a charge immediately, use this API.
Notes
If any subscription changes happen before the end of the current term, these charges will be collected along with it.
Sample Request
curl https://{site}.chargebee.com/api/v2/subscriptions/__test__KyVnHhSBWkeIw2R1/add_charge_at_term_end \
-u {site_api_key}:\
-d amount=300 \
-d description="Service Charge"
copy
curl https://{site}.chargebee.com/api/v2/subscriptions/__test__KyVnHhSBWkeIw2R1/add_charge_at_term_end \
-u {site_api_key}:\
-d amount=300 \
-d description="Service Charge"
Sample Response [ JSON ]
URL Format POST
https://{site}.chargebee.com/api/v2/subscriptions/{subscription_id}/add_charge_at_term_end
Input Parameters
The decimal representation of the amount for the one-time charge. Provide the value in major units of the currency. Can be provided only when multi-decimal pricing is enabled.
optional, string, max chars=33
optional, string, max chars=33
Indicates the type of sale carried out. This is applicable only if you use Chargebee’s AvaTax for Communications integration.
optional, enumerated string
optional, enumerated string
Possible values are
wholesaleTransaction is a sale to another company that will resell your product or service to another consumer.retailTransaction is a sale to an end user.consumedTransaction is for an item that is consumed directly.vendor_useTransaction is for an item that is subject to vendor use tax.
Indicates the type of product to be taxed. Values for this field can be taken from Avalara. This is applicable only if you use Chargebee’s AvaTax for Communications integration.
optional, integer
optional, integer
Indicates the type of service for the product to be taxed. Values for this field can be taken from Avalara. This is applicable only if you use Chargebee’s AvaTax for Communications integration.
optional, integer
optional, integer
The time when the service period for the charge starts.
optional, timestamp(UTC) in seconds
optional, timestamp(UTC) in seconds
Returns
Resource object representing estimate.
always returned
always returned
Charge addon at term end¶
Adds a "non-recurring addon" charge to a subscription which will be added to the invoice generated at the end of the current term. If there are any applicable coupons in the subscription, an appropriate discount will be applied.
To collect the charges for the non-recurring addon immediately, use this API.
Notes
If any subscription changes happen before the end of the current term, these charges will be collected along with it.
Sample Request
curl https://{site}.chargebee.com/api/v2/subscriptions/__test__KyVnHhSBWkfvE2Rn/charge_addon_at_term_end \
-u {site_api_key}:\
-d addon_id="non_recurring_addon" \
-d addon_quantity=3 \
-d addon_unit_price=100
copy
curl https://{site}.chargebee.com/api/v2/subscriptions/__test__KyVnHhSBWkfvE2Rn/charge_addon_at_term_end \
-u {site_api_key}:\
-d addon_id="non_recurring_addon" \
-d addon_quantity=3 \
-d addon_unit_price=100
Sample Response [ JSON ]
URL Format POST
https://{site}.chargebee.com/api/v2/subscriptions/{subscription_id}/charge_addon_at_term_end
Input Parameters
The number of addon units to be charged. Mandatory for quantity based addons.
optional, integer, min=1
optional, integer, min=1
Amount that will override the Addon's default price.
optional, in cents, default=addon amount, min=0
optional, in cents, default=addon amount, min=0
The decimal representation of the quantity of the non-recurring addon. Provide the value in major units of the currency. Must be provided when the addon is quantity-based. This parameter can only be passed when multi-decimal pricing is enabled.
optional, string, max chars=33
optional, string, max chars=33
When price overriding is enabled for the site, the price or per-unit price of the non-recurring addon can be set here. The value set for the addon is used by default. Provide the value as a decimal string in major units of the currency. This parameter can only be passed when multi-decimal pricing is enabled.
optional, string, default=Addon Amount in Decimal, max chars=33
optional, string, default=Addon Amount in Decimal, max chars=33
Returns
Resource object representing estimate.
always returned
always returned
Charge Future Renewals¶
Creates an advance invoice or an advance invoicing schedule. When an advance invoice is generated, and auto_collection is on for the subscription, the payment_source associated with the subscription is charged. Any changes scheduled for the subscription are taken into account automatically while generating an advance invoice. Advance invoices are not generated for a subscription when it is in the paused status.
Notes
- This operation is supported only on select plans. To know more, take a look at our plans and pricing page.
- This operation is not supported for
non_renewingandcancelledsubscriptions. - This operation is not supported if an advance invoice is already present. You could void/delete that invoice and try creating another advance invoice.
Sample Request
curl https://{site}.chargebee.com/api/v2/subscriptions/__test__KyVkmQSCX2uew22/charge_future_renewals \
-u {site_api_key}:
copy
Sample Response [ JSON ]
URL Format POST
https://{site}.chargebee.com/api/v2/subscriptions/{subscription_id}/charge_future_renewals
Input Parameters
- For
schedule_type = immediate: the number of future billing cycles to be invoiced in advance. The invoicing is done for theremaining_billing_cyclesof the subscription if that is less thanterms_to_charge. - For
schedule_type = fixed_intervals: The number of future billing cycles in one interval. The schedule is created such that the total number of billing cycles in the schedule does not exceed the remaining_billing_cycles of the subscription.
optional, integer, default=1, min=1
Whether the charge should be invoiced immediately or added to
optional, boolean
unbilled_charges. Applicable only when schedule_type is immediate.optional, boolean
The type of advance invoice or advance invoicing schedule.
optional, enumerated string
optional, enumerated string
Possible values are
immediateCharge immediately for the number of billing cycles specified by terms_to_charge.specific_datesCharge on specific dates. For each date, specify the number of billing cycles to charge for. Up to 5 dates can be configured.fixed_intervalsCharge at fixed intervals of time. Specify the number of billing cycles that constitute an interval and the number of days before each interval that the invoice should be generated. Also specify when the schedule should end.
Parameters for fixed_interval_schedule
pass parameters as fixed_interval_schedule[<param name>]
pass parameters as fixed_interval_schedule[<param name>]
The number of advance invoices to generate. The schedule is created such that the total number of billing cycles in the schedule does not exceed the
optional, integer, min=1
remaining_billing_cycles of the subscription. This parameter is applicable only when fixed_interval_schedule[end_schedule_on] = after_number_of_intervals.optional, integer, min=1
The number of days before each interval that advance invoices are generated.
optional, integer, min=1
optional, integer, min=1
Specifies when the schedule should end.
optional, enumerated string
optional, enumerated string
Possible values are
after_number_of_intervalsAdvance invoices are generated a specified number of times.specific_dateEnd the advance invoicing schedule on a specific date.subscription_endAdvance invoices are generated for as long as the subscription is active.
The date when the schedule should end. Advance invoices are not generated beyond this date. It must be at least 1 day before the start of the last billing cycle of the subscription and also within 5 years from the current date. This parameter is only applicable when
optional, timestamp(UTC) in seconds
fixed_interval_schedule[end_schedule_on] = specific_date.optional, timestamp(UTC) in seconds
Parameters for specific_dates_schedule. Multiple specific_dates_schedule can be passed by specifying unique indices.
pass parameters as specific_dates_schedule[<param name>][<idx:0..n>]
pass parameters as specific_dates_schedule[<param name>][<idx:0..n>]
The number of billing cycles to charge for, on the date specified. Applicable only when
optional, integer
schedule_type is specific_dates.optional, integer
The unique id of the member of the advance_invoice_schedule array which corresponds to the specific_dates_schedule that you intend to modify. Only applicable when
optional, timestamp(UTC) in seconds
schedule_type is specific_dates.optional, timestamp(UTC) in seconds
Returns
Resource object representing subscription.
always returned
always returned
Resource object representing customer.
always returned
always returned
Resource object representing card.
optional
optional
Resource object representing invoice.
optional
optional
Resource object representing advance_invoice_schedule.
optional
optional
Edit Advance Invoice Schedule¶
Modifies the advance invoicing schedule for a subscription.
Sample Request
curl https://{site}.chargebee.com/api/v2/subscriptions/__test__KyVkmQSCX2vpB3C/edit_advance_invoice_schedule \
-X POST \
-u {site_api_key}:\
-d schedule_type="specific_dates" \
-d specific_dates_schedule[id][0]="__test__KyVkmQSCX2vwe3Q" \
-d specific_dates_schedule[terms_to_charge][0]=1
copy
Sample Response [ JSON ]
URL Format POST
https://{site}.chargebee.com/api/v2/subscriptions/{subscription_id}/edit_advance_invoice_schedule
Input Parameters
The type of advance invoice or advance invoicing schedule.
optional, enumerated string
optional, enumerated string
Possible values are
specific_datesCharge on specific dates. For each date, specify the number of billing cycles to charge for. Up to 5 dates can be configured.fixed_intervalsCharge at fixed intervals of time. Specify the number of billing cycles that constitute an interval and the number of days before each interval that the invoice should be generated. Also specify when the schedule should end.
Parameters for fixed_interval_schedule
pass parameters as fixed_interval_schedule[<param name>]
pass parameters as fixed_interval_schedule[<param name>]
The number of advance invoices to generate. The schedule is created such that the total number of billing cycles in the schedule does not exceed the
optional, integer, min=1
remaining_billing_cycles of the subscription. This parameter is applicable only when fixed_interval_schedule[end_schedule_on] = after_number_of_intervals.optional, integer, min=1
The number of days before each interval that advance invoices are generated.
optional, integer, min=1
optional, integer, min=1
Specifies when the schedule should end.
optional, enumerated string
optional, enumerated string
Possible values are
after_number_of_intervalsAdvance invoices are generated a specified number of times.specific_dateEnd the advance invoicing schedule on a specific date.subscription_endAdvance invoices are generated for as long as the subscription is active.
The date when the schedule should end. Advance invoices are not generated beyond this date. It must be at least 1 day before the start of the last billing cycle of the subscription and also within 5 years from the current date. This parameter is only applicable when
optional, timestamp(UTC) in seconds
fixed_interval_schedule[end_schedule_on] = specific_date.optional, timestamp(UTC) in seconds
Parameters for specific_dates_schedule. Multiple specific_dates_schedule can be passed by specifying unique indices.
pass parameters as specific_dates_schedule[<param name>][<idx:0..n>]
pass parameters as specific_dates_schedule[<param name>][<idx:0..n>]
The unique id of the member of the advance_invoice_schedule array which corresponds to the specific_dates_schedule that you intend to modify. Only applicable when schedule_type is specific_dates.
optional, string, max chars=50
optional, string, max chars=50
The number of billing cycles to charge for, on the date specified. Applicable only when
optional, integer
schedule_type is specific_dates.optional, integer
The unique id of the member of the advance_invoice_schedule array which corresponds to the specific_dates_schedule that you intend to modify. Only applicable when
optional, timestamp(UTC) in seconds
schedule_type is specific_dates.optional, timestamp(UTC) in seconds
Returns
Resource object representing advance_invoice_schedule.
always returned
always returned
Retrieve advance invoice¶
Retrieves the advance_invoice_schedule for a subscription. Note that this endpoint is only applicable for schedule_type = specific_dates or fixed_intervals.
Sample Request
curl https://{site}.chargebee.com/api/v2/subscriptions/__test__KyVkmQSCX2wPg43/retrieve_advance_invoice_schedule \
-u {site_api_key}:
copy
curl https://{site}.chargebee.com/api/v2/subscriptions/__test__KyVkmQSCX2wPg43/retrieve_advance_invoice_schedule \
-u {site_api_key}:
Sample Response [ JSON ]
URL Format GET
https://{site}.chargebee.com/api/v2/subscriptions/{subscription_id}/retrieve_advance_invoice_schedule
Returns
Resource object representing advance_invoice_schedule.
always returned
always returned
Remove an advance invoice schedules¶
Deletes an advance invoicing schedule. When schedule_type = specific_dates, you also have the option of deleting a part of the schedule.
Sample Request
curl https://{site}.chargebee.com/api/v2/subscriptions/__test__KyVkmQSCX2wFs3l/remove_advance_invoice_schedule \
-X POST \
-u {site_api_key}:
copy
curl https://{site}.chargebee.com/api/v2/subscriptions/__test__KyVkmQSCX2wFs3l/remove_advance_invoice_schedule \
-X POST \
-u {site_api_key}:
Sample Response [ JSON ]
URL Format POST
https://{site}.chargebee.com/api/v2/subscriptions/{subscription_id}/remove_advance_invoice_schedule
Input Parameters
Parameters for specific_dates_schedule. Multiple specific_dates_schedule can be passed by specifying unique indices.
pass parameters as specific_dates_schedule[<param name>][<idx:0..n>]
pass parameters as specific_dates_schedule[<param name>][<idx:0..n>]
When schedule_type = specific_dates, pass the id of the specific_dates_schedule that you want to remove. If not passed, the entire advance_invoice_schedule is removed.
optional, string, max chars=50
optional, string, max chars=50
Returns
Resource object representing subscription.
always returned
always returned
Resource object representing advance_invoice_schedule.
optional
optional
Regenerate an invoice¶
Regenerates the invoice for the current term of the subscription. The subscription must have status as active or non_renewing. This operation is not allowed when any of the following conditions hold true for the subscription:
- An invoice exists for the current term and its
statusis notvoided. - There are unbilled charges for the current term.
- The subscription has an advance invoice.
Response
Returns one of the following depending on the value of invoice_immediately:
- If the value is
true: aninvoiceobject that corresponds to the regenerated invoice. - If the value is
false: a list ofunbilled_chargeobjects corresponding to all the unbilled charges created for the current term of the subscription.
Sample Request
curl https://{site}.chargebee.com/api/v2/subscriptions/__test__KyVnOuSHufd0ih/regenerate_invoice \
-X POST \
-u {site_api_key}:\
-d invoice_immediately="true"
copy
Sample Response [ JSON ]
URL Format POST
https://{site}.chargebee.com/api/v2/subscriptions/{subscription_id}/regenerate_invoice
Input Parameters
The start date of the period being invoiced. The default value is current_term_start.
optional, timestamp(UTC) in seconds
optional, timestamp(UTC) in seconds
The end date of the period being invoiced. The default value is current_term_end.
optional, timestamp(UTC) in seconds
optional, timestamp(UTC) in seconds
Whether the charges should be prorated according to the term specified by
optional, boolean
date_from and date_to. Should not be passed without date_from and date_to.optional, boolean
Only applicable when Consolidated Invoicing is enabled for the customer. Set to
optional, boolean
false to leave the current term charge for the subscription as unbilled. Once you have done this for all suitable subscriptions of the customer, call Create an invoice for unbilled charges to invoice them.optional, boolean
Returns
Resource object representing invoice.
optional
optional
Resource object representing unbilled_charge.
optional
optional
Import a subscription¶
This API is not enabled for live sites by default. Please contact support@chargebee.com to get this enabled.
Sample Request
curl https://{site}.chargebee.com/api/v2/subscriptions/import_subscription \
-u {site_api_key}:\
-d plan_id="no_trial" \
-d status="active" \
-d current_term_end=1602095400 \
-d customer[first_name]="John" \
-d customer[last_name]="Doe" \
-d customer[locale]="fr-CA" \
-d customer[phone]="+1-949-999-9999" \
-d billing_address[first_name]="John" \
-d billing_address[last_name]="Doe" \
-d billing_address[line1]="PO Box 9999" \
-d billing_address[city]="Walnut" \
-d billing_address[state]="California" \
-d billing_address[zip]="91789" \
-d billing_address[country]="US" \
-d billing_cycles=5 \
-d addons[id][0]="ssl" \
-d contract_term[action_at_term_end]="renew" \
-d contract_term_billing_cycle_on_renewal=3 \
-d contract_term[contract_start]=1509511210 \
-d contract_term[cancellation_cutoff_period]=3 \
-d contract_term[created_at]=1509511210 \
-d contract_term[total_amount_raised]="900" \
-d contract_term[billing_cycle]=5
copy
curl https://{site}.chargebee.com/api/v2/subscriptions/import_subscription \
-u {site_api_key}:\
-d plan_id="no_trial" \
-d status="active" \
-d current_term_end=1602095400 \
-d customer[first_name]="John" \
-d customer[last_name]="Doe" \
-d customer[locale]="fr-CA" \
-d customer[phone]="+1-949-999-9999" \
-d billing_address[first_name]="John" \
-d billing_address[last_name]="Doe" \
-d billing_address[line1]="PO Box 9999" \
-d billing_address[city]="Walnut" \
-d billing_address[state]="California" \
-d billing_address[zip]="91789" \
-d billing_address[country]="US" \
-d billing_cycles=5 \
-d addons[id][0]="ssl" \
-d contract_term[action_at_term_end]="renew" \
-d contract_term_billing_cycle_on_renewal=3 \
-d contract_term[contract_start]=1509511210 \
-d contract_term[cancellation_cutoff_period]=3 \
-d contract_term[created_at]=1509511210 \
-d contract_term[total_amount_raised]="900" \
-d contract_term[billing_cycle]=5
Sample Response [ JSON ]
URL Format POST
https://{site}.chargebee.com/api/v2/subscriptions/import_subscription
Input Parameters
Id for the new subscription. If not given, this will be auto-generated.
optional, string, max chars=50
optional, string, max chars=50
Indicates the Client profile id for the customer. This is applicable only if you use Chargebee’s AvaTax for Communications integration.
optional, string, max chars=50
optional, string, max chars=50
When price overriding is enabled for the site, the price or per-unit price of the plan can be set here. The value set for the plan 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 is enabled.
optional, string, max chars=33
optional, string, max chars=33
The decimal representation of the quantity of the plan purchased. Can be provided for quantity-based plans and only when multi-decimal pricing is enabled.
optional, string, max chars=33
optional, string, max chars=33
The time at which the trial ends for this subscription. Can be specified to override the default trial period.If '0' is passed, the subscription will be activated immediately.
optional, timestamp(UTC) in seconds
optional, timestamp(UTC) in seconds
Number of cycles(plan interval) this subscription should be charged. After the billing cycles exhausted, the subscription will be cancelled.
optional, integer, min=0
optional, integer, min=0
The date/time at which the subscription is to start or has started. If not provided, the subscription starts immediately. If set to a value in the past then that date/time should not be more than a plan billing period into the past.
optional, timestamp(UTC) in seconds
optional, timestamp(UTC) in seconds
Defines whether payments need to be collected automatically for this subscription. Overrides customer's auto-collection property.
optional, enumerated string
optional, enumerated string
Possible values are
onWhenever an invoice is created for this subscription, an automatic charge will be attempted on the payment method available.offAutomatic collection of charges will not be made for this subscription. Use this for offline payments.
List of coupons to be applied to this subscription. You can provide coupon ids or coupon codes.
optional, list of string
optional, list of string
Number of billing cycles the new contract term should run for, on contract renewal. The default value is the same as
optional, integer, min=1, max=100
billing_cycles or a custom value depending on the site configuration.optional, integer, min=1, max=100
Current state of the subscription.
required, enumerated string
required, enumerated string
Possible values are
futureThe subscription is scheduled to start at a future date.in_trialThe subscription is in trial.activeThe subscription is active and will be charged for automatically based on the items in it.non_renewingThe subscription will be canceled at the end of the current term.pausedThe subscription is paused. The subscription will not renew while in this state.cancelledThe subscription has been canceled and is no longer in service.
End of the current billing term. Subscription is renewed immediately after this. If not given, this will be calculated based on plan billing cycle.
optional, timestamp(UTC) in seconds
optional, timestamp(UTC) in seconds
Start of the current billing period of the subscription.
optional, timestamp(UTC) in seconds
optional, timestamp(UTC) in seconds
Start of the trial period for the subscription. Presence of this value for
optional, timestamp(UTC) in seconds
future subscription implies the subscription will go into in_trial state when it starts.optional, timestamp(UTC) in seconds
Time at which subscription was cancelled or is set to be cancelled.
optional, timestamp(UTC) in seconds
optional, timestamp(UTC) in seconds
Time at which the subscription was started. Is
optional, timestamp(UTC) in seconds
null for futuresubscriptions as it is yet to be started.optional, timestamp(UTC) in seconds
When a pause has been scheduled, it is the date/time of scheduled pause. When the subscription is in the
optional, timestamp(UTC) in seconds
paused state, it is the date/time when the subscription was paused.optional, timestamp(UTC) in seconds
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.
optional, timestamp(UTC) in seconds
optional, timestamp(UTC) in seconds
Set as
true if you want an invoice to be created for the subscription.- The invoice will be created for the subscription only if it has an
activeornon_renewingstatus. - The period of the invoice is from
current_term_starttocurrent_term_end. - 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.
optional, boolean, default=false
A set of key-value pairs stored as additional information for the subscription. Learn more.
optional, jsonobject
optional, jsonobject
Parameters for customer
pass parameters as customer[<param name>]
pass parameters as customer[<param name>]
Id for the new customer. If not given, this will be same as the subscription id.
optional, string, max chars=50
optional, string, max chars=50
Email of the customer. Configured email notifications will be sent to this email.
optional, string, max chars=70
optional, string, max chars=70
Specifies if the customer is liable for tax.
optional, enumerated string, default=taxable
optional, enumerated string, default=taxable
Possible values are
taxableComputes tax for the customer based on the site configuration. In some cases, depending on the region, shipping_address is needed. If not provided, then billing_address is used to compute tax. If that’s not available either, the tax is taken as zero.exempt- Customer is exempted from tax. When using Chargebee’s native Taxes feature or when using the TaxJar integration, no other action is needed.
- However, when using our Avalara integration, optionally, specify
entity_codeorexempt_numberattributes if you use Chargebee’s AvaTax for Sales or specifyexemption_detailsattribute if you use Chargebee’s AvaTax for Communications integration. Tax may still be applied by Avalara for certain values ofentity_code/exempt_number/exemption_detailsbased on the state/region/province of the taxable address.
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.
optional, string, max chars=50
optional, string, max chars=50
The exemption category of the customer, for USA and Canada. Applicable if you use Chargebee's AvaTax for Sales integration.
optional, enumerated string
optional, enumerated string
Possible values are
aFederal government.bState government.cTribe/Status Indian/Indian Band.dForeign diplomat.eCharitable or benevolent organization.fReligious organization.gResale.hCommercial agricultural production.iIndustrial production/manufacturer.jDirect pay permit.kDirect mail.lOther or custom.mEducational organization.nLocal government.pCommercial aquaculture.qCommercial Fishery.rNon-resident.med1US Medical Device Excise Tax with exempt sales tax.med2US Medical Device Excise Tax with taxable sales tax.
Show all values[+]
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.
optional, string, max chars=100
optional, string, max chars=100
The number of days within which the customer has to make payment for the invoice.
optional, integer, default=0
optional, integer, default=0
Indicates the exemption type of the customer. This is applicable only if you use Chargebee’s TaxJar integration.
optional, enumerated string
optional, enumerated string
Possible values are
wholesaleWhole-sale.governmentGovernment.otherOther.
Indicates the type of the customer. This is applicable only if you use Chargebee’s AvaTax for Communications integration.
optional, enumerated string
optional, enumerated string
Possible values are
residentialWhen the purchase is made by a customer for home use.businessWhen the purchase is made at a place of business.senior_citizenWhen the purchase is made by a customer who meets the jurisdiction requirements to be considered a senior citizen and qualifies for senior citizen tax breaks.industrialWhen the purchase is made by an industrial business.
Whether payments needs to be collected automatically for this customer.
optional, enumerated string, default=on
optional, enumerated string, default=on
Possible values are
onWhenever an invoice is created, an automatic attempt to charge the customer's payment method is made.offAutomatic collection of charges will not be made. All payments must be recorded offline.
Whether the customer can pay via Direct Debit.
optional, boolean, default=false
optional, boolean, default=false
Parameters for contract_term
pass parameters as contract_term[<param name>]
pass parameters as contract_term[<param name>]
Id that uniquely identifies the contract term in the site.
optional, string, max chars=50
optional, string, max chars=50
The date when the contract term was created.
optional, timestamp(UTC) in seconds
optional, timestamp(UTC) in seconds
The start date of the contract term.
optional, timestamp(UTC) in seconds
optional, timestamp(UTC) in seconds
The number of billing cycles of the subscription that the contract term is for.
optional, integer, min=0
optional, integer, min=0
The amount raised for the contract term till the time of importing the subscription. This amount is added to the
optional, in cents, default=0, min=0
total_contract_value.optional, in cents, default=0, min=0
Action to be taken when the contract term completes.
optional, enumerated string, default=renew
Contract term completes and a new contract term is started for the number of billing cycles specified in The evergreenContract term completes and the subscription renews.cancelContract term completes and subscription is canceled.renew_onceUsed 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 The .
optional, enumerated string, default=renew
Possible values are
renewcontract_billing_cycle_on_renewal.action_at_term_end for the new contract term is set to renew.contract_billing_cycle_on_renewal.action_at_term_end for the new contract term is set to cancel.
The number of days before
optional, integer, default=0
contract_end, 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.optional, integer, default=0
Parameters for card
pass parameters as card[<param name>]
pass parameters as card[<param name>]
The gateway account in which this payment source is stored.
optional, string, max chars=50
optional, string, max chars=50
The credit card number without any format. If you are using Braintree.js, you can specify the Braintree encrypted card number here.
required if card provided, string, max chars=1500
required if card provided, string, max chars=1500
The card verification value (CVV). If you are using Braintree.js, you can specify the Braintree encrypted CVV here.
optional, string, max chars=520
optional, string, max chars=520
Address line 1, as available in card billing address.
optional, string, max chars=150
optional, string, max chars=150
Address line 2, as available in card billing address.
optional, string, max chars=150
optional, string, max chars=150
The ISO 3166-2 state/province code without the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set
optional, string, max chars=50
state_code as AZ (not US-AZ). For Tamil Nadu (India), set as TN (not IN-TN). For British Columbia (Canada), set as BC (not CA-BC).optional, string, max chars=50
The state/province name. Is set by Chargebee automatically for US, Canada and India If
optional, string, max chars=50
state_code is provided.optional, string, max chars=50
Postal or Zip code, as available in card billing address.
optional, string, max chars=20
optional, string, max chars=20
Parameters for payment_method
pass parameters as payment_method[<param name>]
pass parameters as payment_method[<param name>]
The type of payment method. For more details refer
Update payment method for a customer API under Customer resource.
optional, enumerated string
optional, enumerated string
Possible values are
cardCard based payment including credit cards and debit cards. Details about the card can be obtained from the card resource.paypal_express_checkoutPayments made via PayPal Express Checkout.amazon_paymentsPayments made via Amazon Payments.direct_debitRepresents bank account for which the direct debit or ACH agreement/mandate is created.genericGeneric Payment Method.alipayAlipay Payments.unionpayUnionPay Payments.apple_payApple Pay Payments.wechat_payWeChat Pay Payments.idealiDEAL Payments.google_payGoogle Pay Payments.sofortSofort Payments.bancontactBancontact Card Payments.giropaygiropay Payments.dotpayDotpay Payments.
Show all values[+]
The gateway account in which this payment source is stored.
optional, string, max chars=50
optional, string, max chars=50
The reference id. In the case of Amazon and PayPal this will be the
billing agreement id. For GoCardless direct debit this will be 'mandate id'. In the case of card this will be the identifier provided by the gateway/card vault for the specific payment method resource.
Note: This is not the one-time temporary token provided by gateways like Stripe.
For more details refer Update payment method for a customer API under Customer resource.
optional, string, max chars=200
For more details refer Update payment method for a customer API under Customer resource.
optional, string, max chars=200
Parameters for billing_address
pass parameters as billing_address[<param name>]
pass parameters as billing_address[<param name>]
The ISO 3166-2 state/province code without the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set
optional, string, max chars=50
state_code as AZ (not US-AZ). For Tamil Nadu (India), set as TN (not IN-TN). For British Columbia (Canada), set as BC (not CA-BC).optional, string, max chars=50
The state/province name. Is set by Chargebee automatically for US, Canada and India If
optional, string, max chars=50
state_code is provided.optional, string, max chars=50
Parameters for shipping_address
pass parameters as shipping_address[<param name>]
pass parameters as shipping_address[<param name>]
The ISO 3166-2 state/province code without the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set
optional, string, max chars=50
state_code as AZ (not US-AZ). For Tamil Nadu (India), set as TN (not IN-TN). For British Columbia (Canada), set as BC (not CA-BC).optional, string, max chars=50
The state/province name. Is set by Chargebee automatically for US, Canada and India If
optional, string, max chars=50
state_code is provided.optional, string, max chars=50
Parameters for transaction
pass parameters as transaction[<param name>]
pass parameters as transaction[<param name>]
The payment transaction amount. This parameter should be passed only if the invoice is created for current term.
optional, in cents, min=1
optional, in cents, min=1
The payment method of this transaction. This parameter should be passed only if the invoice is created for current term.
optional, enumerated string, default=card
optional, enumerated string, default=card
Possible values are
cashCash.checkCheck.bank_transferBank Transfer.otherPayment Methods other than the above types.
Show all values[+]
The reference number for this transaction. For example, check number in case of
optional, string, max chars=100
check payment_method. This parameter should be passed only if the invoice is created for current term.optional, string, max chars=100
Parameters for addons. Multiple addons can be passed by specifying unique indices.
pass parameters as addons[<param name>][<idx:0..n>]
pass parameters as addons[<param name>][<idx:0..n>]
Identifier of the addon. Multiple addons can be passed.
optional, string, max chars=100
optional, string, max chars=100
Addon quantity. Applicable only for the quantity based addons. Should be passed with the same index as that of associated addon id.
optional, integer, default=1, min=1
optional, integer, default=1, min=1
The decimal representation of the quantity of the addon. Can be provided for quantity-based addons and only when multi-decimal pricing is enabled.
optional, string, max chars=33
optional, string, max chars=33
Amount that will override the Addon's default price. The Plan's billing frequency will not be considered for overriding. E.g. If the Plan's billing frequency is every 3 months, and if the price override amount is $10, $10 will be used, and not $30 (i.e $10*3).
optional, in cents, min=0
optional, in cents, min=0
When price overriding is enabled for the site, the price or per-unit price of the addon can be set here. The value set for the addon is used by default. However, the price provided here is considered as the price of the addon for an entire billing cycle of the subscription regardless of the value of the addon
optional, string, max chars=33
period. Provide the value as a decimal string in major units of the currency. Can be provided only when multi-decimal pricing is enabled.optional, string, max chars=33
Number of billing cycles the addon will be charged for. When not set, the addon is attached to the subscription for an indefinite number of billing cycles. While updating a subscription to a plan with a different billing period, set this parameter again or its value will be lost. And so, the addon will be attached indefinitely.
optional, integer, min=1
optional, integer, min=1
Parameters for event_based_addons. Multiple event_based_addons can be passed by specifying unique indices.
pass parameters as event_based_addons[<param name>][<idx:0..n>]
pass parameters as event_based_addons[<param name>][<idx:0..n>]
A unique 'id' used to identify the addon.
optional, string, max chars=100
optional, string, max chars=100
Addon quantity. Applicable only for the quantity based addons. Should be passed with the same index as that of associated addon id.
optional, integer, min=0
optional, integer, min=0
Amount that will override the Addon's default price.
optional, in cents, min=0
optional, in cents, min=0
The decimal representation of the quantity of the addon. Can be provided for quantity-based addons and only when multi-decimal pricing is enabled.
optional, string, max chars=33
optional, string, max chars=33
When price overriding is enabled for the site, the price or per-unit price of the addon can be set here. The value set for the addon 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 is enabled.
optional, string, max chars=33
optional, string, max chars=33
Defines service period of the addon in days from the day of charge.
optional, integer, min=1, max=730
optional, integer, min=1, max=730
Event on which this addon will be charged.
optional, enumerated string
optional, enumerated string
Possible values are
subscription_creationAddon will be charged on subscription creation.subscription_trial_startAddon will be charged when the trial period starts.plan_activationAddon will be charged on plan activation.subscription_activationAddon will be charged on subscription activation.contract_terminationAddon will be charged on contract termination.
Parameters for charged_event_based_addons. Multiple charged_event_based_addons can be passed by specifying unique indices.
pass parameters as charged_event_based_addons[<param name>][<idx:0..n>]
pass parameters as charged_event_based_addons[<param name>][<idx:0..n>]
Returns
Resource object representing subscription.
always returned
always returned
Resource object representing customer.
always returned
always returned
Resource object representing card.
optional
optional
Resource object representing invoice.
optional
optional
Import subscription for customer¶
This API is not enabled for live sites by default. Please contact support@chargebee.com to get this enabled.
Sample Request
curl https://{site}.chargebee.com/api/v2/customers/__test__KyVnHhSBWkp5t2VV/import_subscription \
-u {site_api_key}:\
-d plan_id="no_trial" \
-d status="in_trial" \
-d trial_end=1602095400 \
-d billing_cycles=5 \
-d addons[id][0]="ssl" \
-d contract_term[action_at_term_end]="renew" \
-d contract_term_billing_cycle_on_renewal=3 \
-d contract_term[contract_start]=1509511210 \
-d contract_term[cancellation_cutoff_period]=3 \
-d contract_term[created_at]=1509511210 \
-d contract_term[total_amount_raised]="900" \
-d contract_term[billing_cycle]=5
copy
curl https://{site}.chargebee.com/api/v2/customers/__test__KyVnHhSBWkp5t2VV/import_subscription \
-u {site_api_key}:\
-d plan_id="no_trial" \
-d status="in_trial" \
-d trial_end=1602095400 \
-d billing_cycles=5 \
-d addons[id][0]="ssl" \
-d contract_term[action_at_term_end]="renew" \
-d contract_term_billing_cycle_on_renewal=3 \
-d contract_term[contract_start]=1509511210 \
-d contract_term[cancellation_cutoff_period]=3 \
-d contract_term[created_at]=1509511210 \
-d contract_term[total_amount_raised]="900" \
-d contract_term[billing_cycle]=5
Sample Response [ JSON ]
URL Format POST
https://{site}.chargebee.com/api/v2/customers/{customer_id}/import_subscription
Input Parameters
A unique and immutable identifier for the subscription. If not provided, it is autogenerated.
optional, string, max chars=50
optional, string, max chars=50
When price overriding is enabled for the site, the price or per-unit price of the plan can be set here. The value set for the plan 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 is enabled.
optional, string, max chars=33
optional, string, max chars=33
The decimal representation of the quantity of the plan purchased. Can be provided for quantity-based plans and only when multi-decimal pricing is enabled.
optional, string, max chars=33
optional, string, max chars=33
The time at which the trial ends for this subscription. Can be specified to override the default trial period.If '0' is passed, the subscription will be activated immediately.
optional, timestamp(UTC) in seconds
optional, timestamp(UTC) in seconds
Number of cycles(plan interval) this subscription should be charged. After the billing cycles exhausted, the subscription will be cancelled.
optional, integer, min=0
optional, integer, min=0
The date/time at which the subscription is to start or has started. If not provided, the subscription starts immediately. If set to a value in the past then that date/time should not be more than a plan billing period into the past.
optional, timestamp(UTC) in seconds
optional, timestamp(UTC) in seconds
Defines whether payments need to be collected automatically for this subscription. Overrides customer's auto-collection property.
optional, enumerated string
optional, enumerated string
Possible values are
onWhenever an invoice is created for this subscription, an automatic charge will be attempted on the payment method available.offAutomatic collection of charges will not be made for this subscription. Use this for offline payments.
List of coupons to be applied to this subscription. You can provide coupon ids or coupon codes.
optional, list of string
optional, list of string
Id of the payment source to be attached to this subscription.
optional, string, max chars=40
optional, string, max chars=40
Current state of the subscription.
required, enumerated string
required, enumerated string
Possible values are
futureThe subscription is scheduled to start at a future date.in_trialThe subscription is in trial.activeThe subscription is active and will be charged for automatically based on the items in it.non_renewingThe subscription will be canceled at the end of the current term.pausedThe subscription is paused. The subscription will not renew while in this state.cancelledThe subscription has been canceled and is no longer in service.
End of the current billing term. Subscription is renewed immediately after this. If not given, this will be calculated based on plan billing cycle.
optional, timestamp(UTC) in seconds
optional, timestamp(UTC) in seconds
Start of the current billing period of the subscription.
optional, timestamp(UTC) in seconds
optional, timestamp(UTC) in seconds
Start of the trial period for the subscription. Presence of this value for
optional, timestamp(UTC) in seconds
future subscription implies the subscription will go into in_trial state when it starts.optional, timestamp(UTC) in seconds
Time at which subscription was cancelled or is set to be cancelled.
optional, timestamp(UTC) in seconds
optional, timestamp(UTC) in seconds
Time at which the subscription was started. Is
optional, timestamp(UTC) in seconds
null for futuresubscriptions as it is yet to be started.optional, timestamp(UTC) in seconds
When a pause has been scheduled, it is the date/time of scheduled pause. When the subscription is in the
optional, timestamp(UTC) in seconds
paused state, it is the date/time when the subscription was paused.optional, timestamp(UTC) in seconds
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.
optional, timestamp(UTC) in seconds
optional, timestamp(UTC) in seconds
Number of billing cycles the new contract term should run for, on contract renewal. The default value is the same as
optional, integer, min=1, max=100
billing_cycles or a custom value depending on the site configuration.optional, integer, min=1, max=100
Set as
true if you want an invoice to be created for the subscription.- The invoice will be created for the subscription only if it has an
activeornon_renewingstatus. - The period of the invoice is from
current_term_starttocurrent_term_end. - 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.
optional, boolean, default=false
A set of key-value pairs stored as additional information for the subscription. Learn more.
optional, jsonobject
optional, jsonobject
Parameters for contract_term
pass parameters as contract_term[<param name>]
pass parameters as contract_term[<param name>]
Id that uniquely identifies the contract term in the site.
optional, string, max chars=50
optional, string, max chars=50
The date when the contract term was created.
optional, timestamp(UTC) in seconds
optional, timestamp(UTC) in seconds
The start date of the contract term.
optional, timestamp(UTC) in seconds
optional, timestamp(UTC) in seconds
The number of billing cycles of the subscription that the contract term is for.
optional, integer, min=0
optional, integer, min=0
The amount raised for the contract term till the time of importing the subscription. This amount is added to the
optional, in cents, default=0, min=0
total_contract_value.optional, in cents, default=0, min=0
Action to be taken when the contract term completes.
optional, enumerated string, default=renew
Contract term completes and a new contract term is started for the number of billing cycles specified in The evergreenContract term completes and the subscription renews.cancelContract term completes and subscription is canceled.renew_onceUsed 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 The .
optional, enumerated string, default=renew
Possible values are
renewcontract_billing_cycle_on_renewal.action_at_term_end for the new contract term is set to renew.contract_billing_cycle_on_renewal.action_at_term_end for the new contract term is set to cancel.
The number of days before
optional, integer, default=0
contract_end, 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.optional, integer, default=0
Parameters for transaction
pass parameters as transaction[<param name>]
pass parameters as transaction[<param name>]
The payment transaction amount. This parameter should be passed only if the invoice is created for current term.
optional, in cents, min=1
optional, in cents, min=1
The payment method of this transaction. This parameter should be passed only if the invoice is created for current term.
optional, enumerated string, default=card
optional, enumerated string, default=card
Possible values are
cashCash.checkCheck.bank_transferBank Transfer.otherPayment Methods other than the above types.
Show all values[+]
The reference number for this transaction. For example, check number in case of
optional, string, max chars=100
check payment_method. This parameter should be passed only if the invoice is created for current term.optional, string, max chars=100
Parameters for shipping_address
pass parameters as shipping_address[<param name>]
pass parameters as shipping_address[<param name>]
The ISO 3166-2 state/province code without the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set
optional, string, max chars=50
state_code as AZ (not US-AZ). For Tamil Nadu (India), set as TN (not IN-TN). For British Columbia (Canada), set as BC (not CA-BC).optional, string, max chars=50
The state/province name. Is set by Chargebee automatically for US, Canada and India If
optional, string, max chars=50
state_code is provided.optional, string, max chars=50
Parameters for addons. Multiple addons can be passed by specifying unique indices.
pass parameters as addons[<param name>][<idx:0..n>]
pass parameters as addons[<param name>][<idx:0..n>]
Identifier of the addon. Multiple addons can be passed.
optional, string, max chars=100
optional, string, max chars=100
Addon quantity. Applicable only for the quantity based addons. Should be passed with the same index as that of associated addon id.
optional, integer, default=1, min=1
optional, integer, default=1, min=1
The decimal representation of the quantity of the addon. Can be provided for quantity-based addons and only when multi-decimal pricing is enabled.
optional, string, max chars=33
optional, string, max chars=33
Amount that will override the Addon's default price. The Plan's billing frequency will not be considered for overriding. E.g. If the Plan's billing frequency is every 3 months, and if the price override amount is $10, $10 will be used, and not $30 (i.e $10*3).
optional, in cents, min=0
optional, in cents, min=0
When price overriding is enabled for the site, the price or per-unit price of the addon can be set here. The value set for the addon is used by default. However, the price provided here is considered as the price of the addon for an entire billing cycle of the subscription regardless of the value of the addon
optional, string, max chars=33
period. Provide the value as a decimal string in major units of the currency. Can be provided only when multi-decimal pricing is enabled.optional, string, max chars=33
Number of billing cycles the addon will be charged for. When not set, the addon is attached to the subscription for an indefinite number of billing cycles. While updating a subscription to a plan with a different billing period, set this parameter again or its value will be lost. And so, the addon will be attached indefinitely.
optional, integer, min=1
optional, integer, min=1
Parameters for event_based_addons. Multiple event_based_addons can be passed by specifying unique indices.
pass parameters as event_based_addons[<param name>][<idx:0..n>]
pass parameters as event_based_addons[<param name>][<idx:0..n>]
A unique 'id' used to identify the addon.
optional, string, max chars=100
optional, string, max chars=100
Addon quantity. Applicable only for the quantity based addons. Should be passed with the same index as that of associated addon id.
optional, integer, min=0
optional, integer, min=0
Amount that will override the Addon's default price.
optional, in cents, min=0
optional, in cents, min=0
The decimal representation of the quantity of the addon. Can be provided for quantity-based addons and only when multi-decimal pricing is enabled.
optional, string, max chars=33
optional, string, max chars=33
When price overriding is enabled for the site, the price or per-unit price of the addon can be set here. The value set for the addon 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 is enabled.
optional, string, max chars=33
optional, string, max chars=33
Defines service period of the addon in days from the day of charge.
optional, integer, min=1, max=730
optional, integer, min=1, max=730
Event on which this addon will be charged.
optional, enumerated string
optional, enumerated string
Possible values are
subscription_creationAddon will be charged on subscription creation.subscription_trial_startAddon will be charged when the trial period starts.plan_activationAddon will be charged on plan activation.subscription_activationAddon will be charged on subscription activation.contract_terminationAddon will be charged on contract termination.
Parameters for charged_event_based_addons. Multiple charged_event_based_addons can be passed by specifying unique indices.
pass parameters as charged_event_based_addons[<param name>][<idx:0..n>]
pass parameters as charged_event_based_addons[<param name>][<idx:0..n>]
Returns
Resource object representing subscription.
always returned
always returned
Resource object representing customer.
always returned
always returned
Resource object representing card.
optional
optional
Resource object representing invoice.
optional
optional
Import historical contract terms¶
subscription_id.
For contract terms in active state, import is only allowed if the associated subscription is active, in_trial, future or non-renewing.
This API is not enabled for live sites by default. Please contact support@chargebee.com to get this enabled.
Sample Request
curl https://{site}.chargebee.com/api/v2/subscriptions/__test__KyVnHhSBWkogZ2VF/import_contract_term \
-X POST \
-u {site_api_key}:\
-d contract_term[action_at_term_end]="cancel" \
-d contract_term[billing_cycle]=5 \
-d contract_term[contract_start]=1483245610 \
-d contract_term[contract_end]=1493613610 \
-d contract_term[status]="terminated" \
-d contract_term[total_contract_value]="1000"
copy
curl https://{site}.chargebee.com/api/v2/subscriptions/__test__KyVnHhSBWkogZ2VF/import_contract_term \
-X POST \
-u {site_api_key}:\
-d contract_term[action_at_term_end]="cancel" \
-d contract_term[billing_cycle]=5 \
-d contract_term[contract_start]=1483245610 \
-d contract_term[contract_end]=1493613610 \
-d contract_term[status]="terminated" \
-d contract_term[total_contract_value]="1000"
Sample Response [ JSON ]
URL Format POST
https://{site}.chargebee.com/api/v2/subscriptions/{subscription_id}/import_contract_term
Input Parameters
Number of billing cycles the new contract term should run for, on contract renewal. The default value is the same as
optional, integer, min=1, max=100
billing_cycles or a custom value depending on the site configuration.optional, integer, min=1, max=100
Parameters for contract_term
pass parameters as contract_term[<param name>]
pass parameters as contract_term[<param name>]
Id that uniquely identifies the contract term in the site.
optional, string, max chars=50
optional, string, max chars=50
The date when the contract term was created.
optional, timestamp(UTC) in seconds
optional, timestamp(UTC) in seconds
The start date of the contract term.
optional, timestamp(UTC) in seconds
optional, timestamp(UTC) in seconds
Current status of contract.
optional, enumerated string
optional, enumerated string
Possible values are
activeAn actively running contract term.completedThe contract term has run its full duration.cancelledThe contract term was ended because: - a change in the subscription caused a subscription term reset.
- the subscription was cancelled due to non-payment.
The amount raised for the contract term till the time of importing the subscription. This amount is added to the
optional, in cents, default=0, min=0
total_contract_value.optional, in cents, default=0, min=0
The sum of the totals of all the invoices raised as part of the contract term. For
optional, in cents, default=0, min=0
active contract terms, this is a predicted value. The value depends on the type of currency. If the subscription was imported with the contract term, then this value includes the value passed for total_amount_raised.optional, in cents, default=0, min=0
The number of billing cycles of the subscription that the contract term is for.
optional, integer, min=0
optional, integer, min=0
Action to be taken when the contract term completes.
optional, enumerated string, default=renew
Contract term completes and a new contract term is started for the number of billing cycles specified in The evergreenContract term completes and the subscription renews.cancelContract term completes and subscription is canceled.renew_onceUsed 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 The .
optional, enumerated string, default=renew
Possible values are
renewcontract_billing_cycle_on_renewal.action_at_term_end for the new contract term is set to renew.contract_billing_cycle_on_renewal.action_at_term_end for the new contract term is set to cancel.
The number of days before
optional, integer
contract_end, 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.optional, integer
Returns
Resource object representing contract_term.
always returned
always returned
Override Billing Profile¶
Assigns the payment source and sets auto collection state for the subscription.
Notes
When you don't pass any input param for this API, payment source and auto collection for the subscription will be the same as the customer's default settings.
Sample Request
curl https://{site}.chargebee.com/api/v2/subscriptions/__test__KyVnHhSBWkqEX2W6/override_billing_profile \
-X POST \
-u {site_api_key}:\
-d payment_source_id="pm___test__KyVnHhSBWkqIK2WD" \
-d auto_collection="on"
copy
curl https://{site}.chargebee.com/api/v2/subscriptions/__test__KyVnHhSBWkqEX2W6/override_billing_profile \
-X POST \
-u {site_api_key}:\
-d payment_source_id="pm___test__KyVnHhSBWkqIK2WD" \
-d auto_collection="on"
Sample Response [ JSON ]
URL Format POST
https://{site}.chargebee.com/api/v2/subscriptions/{subscription_id}/override_billing_profile
Input Parameters
Unique identifier of the payment source to be attached to this subscription.
optional, string, max chars=40
optional, string, max chars=40
Defines whether payments need to be collected automatically for this subscription. Overrides customer's auto-collection property.
optional, enumerated string
optional, enumerated string
Possible values are
onWhenever an invoice is created for this subscription, an automatic charge will be attempted on the payment method available.offAutomatic collection of charges will not be made for this subscription. Use this for offline payments.Returns
Resource object representing subscription.
always returned
always returned
Resource object representing payment_source.
optional
optional
Delete a subscription¶
Deletes the subscription resource.
Notes
This operation is irreversible - all data related to the subscription, such as invoices, transactions, and reports, will be deleted.
Note: This operation schedules the subscription resource for deletion. It will be deleted in a few minutes.
Sample Request
curl https://{site}.chargebee.com/api/v2/subscriptions/__test__KyVnHhSBWknaq2Ui/delete \
-X POST \
-u {site_api_key}:
copy
curl https://{site}.chargebee.com/api/v2/subscriptions/__test__KyVnHhSBWknaq2Ui/delete \
-X POST \
-u {site_api_key}:
Sample Response [ JSON ]
URL Format POST
https://{site}.chargebee.com/api/v2/subscriptions/{subscription_id}/delete
Returns
Resource object representing subscription.
always returned
always returned
Resource object representing customer.
always returned
always returned
Resource object representing card.
optional
optional
Pause a subscription¶
Pausing a subscription will move the subscription from its current state to Paused state, and will stop all recurring actions.
You could schedule the pause by passing specific_date/end_of_term parameter in pause_option. If scheduled, the subscription will not be paused until the specific_date/end_of_term is reached.
UNBILLED CHARGES
Any unbilled charges present in the subscription can be invoiced by specifying invoice or no_action. If invoice is chosen, automatic charge will be attempted on the payment method available if the customer has enabled auto-collection. If payment collection fails or when auto-collection is not enabled, the invoice will be closed as unpaid.
If no_action is chosen, charges will be added to the resumption invoice.
INVOICE DUNNING HANDLING
If invoice is in the dunning cycle, invoice_dunning_handing allows you to stop or continue dunning.
Note:
- Applicable only for active/non-renewing subscriptions.
- For non-renewing subscriptions, pause_date and resume_date should be before the cancellation date. If paused indefinitely, the subscription will be cancelled on the cancelled_at date.
- Advance charges, if any, will be refunded as credits.
Sample Request
# pauses the subscription on end of term.
curl https://{site}.chargebee.com/api/v2/subscriptions/__test__KyVnHhSBWkqkc2WM/pause \
-X POST \
-u {site_api_key}:\
-d pause_option="end_of_term"
copy
Sample Response [ JSON ]
URL Format POST
https://{site}.chargebee.com/api/v2/subscriptions/{subscription_id}/pause
Input Parameters
List of options to pause the subscription.
optional, enumerated string
optional, enumerated string
Possible values are
immediatelyPause immediately.end_of_termPause at the end of current term.specific_datePause on a specific date.
Date on which the subscription will be paused. Applicable when 'specific_date' option is chosen in the pause_option field.
optional, timestamp(UTC) in seconds
optional, timestamp(UTC) in seconds
Applicable when unbilled charges are present for the subscription and pause_option is set as 'immediately'. Note: On the invoice raised, an automatic charge will be attempted on the payment method available, if customer's auto-collection property is ‘ON’.
optional, enumerated string
optional, enumerated string
Possible values are
no_actionRetain as unbilled.invoiceInvoice charges.
Handles dunning for invoices already in the dunning cycle, when subscription is paused. Applicable when pause_option is set as 'immediately'.
optional, enumerated string
optional, enumerated string
Possible values are
continueContinue dunning.stopStop dunning.Returns
Resource object representing subscription.
always returned
always returned
Resource object representing customer.
always returned
always returned
Resource object representing card.
optional
optional
Resource object representing invoice.
optional
optional
Resource object representing unbilled_charge.
optional
optional
Resource object representing credit_note.
optional
optional
Cancel a subscription¶
Cancelling a subscription will move the subscription from its current state to Cancelled, and will stop all recurring actions.
You could schedule the cancellation by passing end_of_term parameter as true. If scheduled, the subscription status will be set to non_renewing if it is in active state, until the end of term, and then cancelled. A subscription's state will not change if it is in in_trial state. However, cancellation will be scheduled at the end of the trial.
CREDIT OPTION
On subscription cancellation, credits can be issued against current term charges of the subscription by using credit_option_for_current_term_charges. You can choose to either provide no credits, prorate credits for the unused period or issue full credits for the current term charges.
UNBILLED CHARGES
Any unbilled charges present in the subscription can either be invoiced or deleted by specifying unbilled_charges_option. Note that automatic charge will be attempted on the payment method available if the customer has enabled auto-collection. If not, the invoice will be closed as unpaid.
ACCOUNT RECEIVABLES
Specifying account_receivables_handling allows you to close invoices of the subscription which have amounts due. The invoices are chosen for payment collection or for writing off the due amount after applying the available credits and excess payments.
If specified as schedule_payment_collection, payment collection for the amount due of past invoices will be attempted. The payment method available will be charged if auto-collection is enabled for the customer, and appropriate payment collection(payment succeeded or payment failed) events will be triggered. If the payment collection fails, no further retries will be made on the invoices. Note: If the invoices of the subscription are consolidated, and any of the subscriptions in the consolidated invoice are cancelled, these invoices will not be selected for collection.
If specified as write_off, the amount due of past invoices will be written-off. Note: If the invoices of the subscription are consolidated, and any of the subscriptions in the consolidated invoice are still active(future, in-trial, active, and non-renewing), these invoices will not be selected for the write-off operation.
ACCOUNT PAYABLES
Specifying refundable_credits_handling allows you to provide refunds for refundable credits remaining, after they are applied to a subscription’s due invoices. The refund initiated will be asynchronous and the payment refunded event will be triggered on refund success. Note: Consolidated credit notes of the subscription will not be selected for refund.
Canceling Contract Terms
- Subscriptions with contract terms can only be cancelled by terminating the contract term.
- When canceling a contract term, the default value for the following parameters is taken from the site settings for contract terms instead of the site settings for subscription cancellation.
credit_option_for_current_term_chargesunbilled_charges_optionaccount_receivables_handlingrefundable_credits_handling
end_of_termorcancel_atshould not be passed when using contract terms; usecontract_term_cancel_optioninstead.- The
event_based_addonsparameter is used when canceling contract terms to override price or quantity for the termination fee. To use this parameter, the following two conditions must be met:contract_term_cancel_optionmust be set toterminate_now.- the subscription must have an event-based addon with the
on_eventparameter set tocontract_term_termination
Notes
Advance charges, if any, will be refunded as credits.
Sample Request
# cancels the subscription after the term ends.
curl https://{site}.chargebee.com/api/v2/subscriptions/__test__KyVnHhSBWkekU2RC/cancel \
-X POST \
-u {site_api_key}:\
-d end_of_term="true"
copy
Sample Response [ JSON ]
URL Format POST
https://{site}.chargebee.com/api/v2/subscriptions/{subscription_id}/cancel
Input Parameters
Set this to
optional, boolean, default=false
true if you want to cancel the subscription at the end of the current subscription billing cycle. The subscription status changes to non_renewing.optional, boolean, default=false
Specify the date at which you want to cancel the subscription. Do not pass if
optional, timestamp(UTC) in seconds
end_of_term is passed as true.optional, timestamp(UTC) in seconds
For immediate cancellation (
optional, enumerated string
end_of_term = false), specify how to provide credits for current term charges. When not provided, the site default is considered.optional, enumerated string
Possible values are
noneNo credits notes are created.prorateProrated credits are issued.fullCredits are issues for the full value of the current term charges.
For immediate cancellation (
optional, enumerated string
end_of_term = false), specify how to handle any unbilled charges. When not provided, the site default is considered.optional, enumerated string
Possible values are
invoiceAn invoice is generated immediately with the unbilled charges.deleteThe unbilled charges are deleted.
Applicable when the subscription has past due invoices. Specify this if you want to close the due invoices of the subscription. If specified as schedule_payment_collection/write_off, the due invoices of the subscription will be qualified for the selected operation after the remaining refundable credits and excess payments are applied.
Note: The payment collection attempt will be asynchronous. Not applicable when 'end_of_term' is true.
optional, enumerated string
optional, enumerated string
Possible values are
no_actionNo action is taken.schedule_payment_collectionAn automatic charge for the due amount of the past invoices will be attempted on the payment method available, if customer's auto-collection property is ‘ON’.write_offThe amount due in the invoices will be written-off. Credit notes created due to write-off will not be sent in the response.
Applicable when the customer has remaining refundable credits(issued against online payments). If specified as schedule_refund, the refund will be initiated for these credits after they are applied against the subscription’s past due invoices if any.
Note: The refunds initiated will be asynchronous. Not applicable when 'end_of_term' is true.
optional, enumerated string
optional, enumerated string
Possible values are
no_actionNo action is taken. .schedule_refundInitiates refund of the remaining credits.
Cancels the current contract term.
optional, enumerated string
terminate_immediatelyimmediately does the following:- sets the contract term
statustoterminated. - Cancels the subscription.
- Collects any termination fee.
- sets the contract term
end_of_contract_termSets thecontract_term[action_at_term_end]tocancel. In other words, the contract term is not renewed and the subscription is canceled at the end of the contract term.
optional, enumerated string
Possible values are
terminate_immediatelyTerminate immediately.end_of_contract_termEnd of contract term.
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.
optional, string, max chars=100
optional, string, max chars=100
Parameters for event_based_addons. Multiple event_based_addons can be passed by specifying unique indices.
pass parameters as event_based_addons[<param name>][<idx:0..n>]
pass parameters as event_based_addons[<param name>][<idx:0..n>]
The unique
optional, string, max chars=100
id of the event-based addon that represents the termination fee.optional, string, max chars=100
The quantity associated with the termination fee. Applicable only when the addon for the termination charge is quantity-based.
optional, integer, min=0
optional, integer, min=0
The termination fee. In case it is quantity-based, this is the fee per unit.
optional, in cents, min=0
optional, in cents, min=0
Returns
Resource object representing subscription.
always returned
always returned
Resource object representing customer.
always returned
always returned
Resource object representing card.
optional
optional
Resource object representing invoice.
optional
optional
Resource object representing unbilled_charge.
optional
optional
Resource object representing credit_note.
optional
optional
Resume a subscription¶
This operation supports 3DS verification flow. To achieve the same, create the
Payment Intent and pass it as input parameter to this API.
This API is used to resume a paused subscription. On resumption the subscription will be activated and any applicable charges will be initiated.
You could schedule the resumption by passing specific_date parameter in resume_option. If scheduled, the subscription will be resumed on the specific_date and moved to Active state.
For in-term resumption ++, unless there are scheduled changes, unbilled charges will not be charged.
++What is an "in-term resumption"?
An “in-term resumption” is when the pause and resumption happens within the billing term of the subscription.
Example : A subscription was billed from 1st to 31st of a month. It was paused on the 20th and resumed before 31st. This is an in-term resumption.
UNPAID INVOICES
Specifying unpaid_invoices allows you to close invoices of the subscription which have amounts due. The invoices are chosen for payment collection after applying the available credits and excess payments.
If specified as schedule_payment_collection, payment collection for the amount due of past invoices will be attempted. The payment method available will be charged if auto-collection is enabled for the customer, and appropriate payment collection(payment succeeded or payment failed) events will be triggered. If the payment collection fails, no further retries will be made on the invoices.
Note: If the invoices of the subscription are consolidated, and any of the subscriptions in the consolidated invoice are cancelled, these invoices will not be selected for collection.
Sample Request
# resumes a subscription immediately by scheduling payment collection for unpaid
# invoices.
curl https://{site}.chargebee.com/api/v2/subscriptions/__test__KyVnHhSBWkuL42Xz/resume \
-X POST \
-u {site_api_key}:\
-d resume_option="immediately" \
-d unpaid_invoices_handling="schedule_payment_collection"
copy
Sample Response [ JSON ]
URL Format POST
https://{site}.chargebee.com/api/v2/subscriptions/{subscription_id}/resume
Input Parameters
List of options to resume the subscription.
optional, enumerated string
optional, enumerated string
Possible values are
immediatelyResume immediately.specific_dateResume on a specific date.
Date on which the subscription will be resumed. Applicable when resume_option is set as 'specific_date'.
optional, timestamp(UTC) in seconds
optional, timestamp(UTC) in seconds
Applicable when charges get added during this operation and resume_option is set as 'immediately'. Allows to raise invoice immediately or add them to unbilled charges.
optional, enumerated string
optional, enumerated string
Possible values are
invoice_immediatelyInvoice immediately.add_to_unbilled_chargesAdd to unbilled charges.
Applicable when the subscription has past due invoices and resume_option is set as 'immediately'. Allows to collect past due invoices or retain them as unpaid. If 'schedule_payment_collection' option is chosen in this field, remaining refundable credits and excess payments are applied.
Note: The payment collection attempt will be asynchronous.
optional, enumerated string
optional, enumerated string
Possible values are
no_actionRetain as unpaid.schedule_payment_collectionCollect payment.
Parameters for payment_intent
pass parameters as payment_intent[<param name>]
pass parameters as payment_intent[<param name>]
Identifier for PaymentIntent generated by Chargebee.js. Applicable only when you are using Chargebee.js for completing the 3DS flow. The PaymentIntent should be in 'authorized' state while passing it here. You need not pass other PaymentIntent parameters if this is passed.
optional, string, max chars=150
optional, string, max chars=150
The gateway account used for performing the 3DS flow.
required if payment intent token provided, string, max chars=50
required if payment intent token provided, string, max chars=50
Identifier for 3DS transaction/verification object at the gateway. Can be passed only after successfully completing the 3DS flow. Refer 3DS implementation in Chargebee to find out the gateway-specific gw_token format. Applicable when you are using gateway APIs directly for completing the 3DS flow.
optional, string, max chars=65k
optional, string, max chars=65k
Identifier for Braintree permanent token. Applicable when you are using Braintree APIs for completing the 3DS flow.
optional, string, max chars=65k
optional, string, max chars=65k
Applicable only for Braintree gateway. Can be used only for Braintree’s Advance Fraud Management feature. Pass a stringified JSON containing the
optional, jsonobject
device_session_id and fraud_merchant_id as an input to fingerprint. Here’s a sample to it.optional, jsonobject
Returns
Resource object representing subscription.
always returned
always returned
Resource object representing customer.
always returned
always returned
Resource object representing card.
optional
optional
Resource object representing invoice.
optional
optional
Resource object representing unbilled_charge.
optional
optional
Remove scheduled pause¶
If the subscription is in Active or Non Renewing state and is also scheduled to pause at the end_of_term/specific_date, this API can be used to remove the scheduled pause.
Sample Request
curl https://{site}.chargebee.com/api/v2/subscriptions/__test__KyVnHhSBWktUL2Xh/remove_scheduled_pause \
-X POST \
-u {site_api_key}:
copy
curl https://{site}.chargebee.com/api/v2/subscriptions/__test__KyVnHhSBWktUL2Xh/remove_scheduled_pause \
-X POST \
-u {site_api_key}:
Sample Response [ JSON ]
URL Format POST
https://{site}.chargebee.com/api/v2/subscriptions/{subscription_id}/remove_scheduled_pause
Returns
Resource object representing subscription.
always returned
always returned
Resource object representing customer.
always returned
always returned
Resource object representing card.
optional
optional
Remove scheduled resumption¶
If the subscription is in Paused state and is scheduled to resume on a specific_date, this API can be used to remove the scheduled resumption. When the scheduled resumption is removed, the subscription will remain Paused.
Sample Request
curl https://{site}.chargebee.com/api/v2/subscriptions/__test__KyVnHhSBWkty42Xq/remove_scheduled_resumption \
-X POST \
-u {site_api_key}:
copy
curl https://{site}.chargebee.com/api/v2/subscriptions/__test__KyVnHhSBWkty42Xq/remove_scheduled_resumption \
-X POST \
-u {site_api_key}:
Sample Response [ JSON ]
URL Format POST
https://{site}.chargebee.com/api/v2/subscriptions/{subscription_id}/remove_scheduled_resumption
Returns
Resource object representing subscription.
always returned
always returned
Resource object representing customer.
always returned
always returned
Resource object representing card.
optional
optional