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 ]

{
    "id": "8avVGOkx8U1MX",
    "customer_id": "8avVGOkx8U1MX",
    "plan_id": "basic",
    "plan_quantity": 1,
    "plan_unit_price": 900,
    "plan_amount": 900,
    "billing_period": 1,
    "billing_period_unit": "month",
    "plan_free_quantity": 0,
    "status": "non_renewing",
    "trial_start": 1412101824,
    "trial_end": 1414780224,
    "current_term_start": 1538332224,
    "current_term_end": 1541010624,
    "remaining_billing_cycles": 0,
    "created_at": 1412101824,
    "started_at": 1412101824,
    "activated_at": 1414780224,
    "cancelled_at": 1541010624,
    "updated_at": 1539327024,
    "has_scheduled_changes": false,
    "resource_version": 1539327024000,
    "deleted": false,
    "object": "subscription",
    "currency_code": "USD",
    "due_invoices_count": 2,
    "due_since": 1438367424,
    "total_dues": 1800,
    "mrr": 900,
    "exchange_rate": 1.0,
    "base_currency_code": "USD",
    "shipping_address": {
        "first_name": "Benjamin",
        "last_name": "Ross",
        "company": "Acme Inc",
        "phone": "+1 (614) 226-4809",
        "line1": "345, Redington Av",
        "line2": "Suite 1200",
        "city": "Los Angeles",
        "state_code": "CA",
        "state": "California",
        "country": "US",
        "validation_status": "not_validated",
        "object": "shipping_address"
    }
}

API Index URL GET

https://{site}.chargebee.com/api/v2/subscriptions

id

A unique identifier to identify the subscription. You will use this to perform all operations on this subscription.
string, max chars=50

customer_id

Identifier of the customer with whom this subscription is associated.
string, max chars=50

currency_code

The currency code (ISO 4217 format) of the subscription.
string, max chars=3

plan_id

Identifier of the plan for this subscription.
string, max chars=100

plan_quantity

Represents the plan quantity for this subscription.
integer, default=1, min=1

plan_unit_price

Amount that will override the Plan's default price.
optional, in cents, min=0

setup_fee

Amount that will override the default setup fee.
optional, in cents, min=0

plan_amount

optional, in cents, min=0

billing_period

Defines billing frequency. Example: to bill customer every 3 months, provide "3" here.
optional, integer, min=1

billing_period_unit

Defines billing frequency in association with the billing period.
optional, enumerated string

Possible values are

weekCharge based on week(s).monthCharge based on month(s).yearCharge based on year(s).

plan_free_quantity

The units of the item that will be free with this Plan.
optional, integer, min=0

status

Current state of the subscription.
enumerated string

Possible values are

futureThe Subscription is scheduled to start in a future date.in_trialThe subscription is in trial.activeThe subscription is in active state and will be charged at start of each term based on the recurring items(plan & addons etc.,).non_renewingThe subscription will be cancelled at end of the current term.pausedThe subscription is paused. No new recurring actions will be allowed, but any pending payments will be collected.cancelledThe subscription has been cancelled. No new recurring actions will take place, but any pending payments will be collected.

start_date

Applicable only for 'future' subscriptions. The scheduled start time of the 'future' subscription.
optional, timestamp(UTC) in seconds

trial_start

Start of the trial period for the subscription. Presence of this value for 'future' subscription implies the subscription will go into 'trial' state when it starts.
optional, timestamp(UTC) in seconds

trial_end

End of the trial period for the subscription. Presence of this value for 'future' subscription implies the subscription will go into 'trial' state when it starts.
optional, timestamp(UTC) in seconds

current_term_start

Start of the current billing term.
optional, timestamp(UTC) in seconds

current_term_end

End of the current billing term. Subscription is renewed immediately after this.
optional, timestamp(UTC) in seconds

next_billing_at

Date on which the next billing happens.
optional, timestamp(UTC) in seconds

remaining_billing_cycles

The number of billing cycles this subscription will run.
optional, integer, min=0

po_number

Purchase Order Number for this subscription.
optional, string, max chars=100

created_at

Subscription created time.
optional, timestamp(UTC) in seconds

started_at

Time at which the subscription got started. Will be null for 'future' subscriptions as it is yet to be started.
optional, timestamp(UTC) in seconds

activated_at

Time at which the subscription moved from in_trial state to active state.
optional, timestamp(UTC) in seconds

gift_id

References the gift if it is a gifted subscription.
optional, string, max chars=150

pause_date

Date on which the subscription will be paused.
optional, timestamp(UTC) in seconds

resume_date

Date on which the subscription will be resumed.
optional, timestamp(UTC) in seconds

cancelled_at

Time at which subscription was canceled or is set to be canceled.
optional, timestamp(UTC) in seconds

cancel_reason

Possible reason the subscription might be cancelled.
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.

affiliate_token

A unique tracking token.
optional, string, max chars=250

created_from_ip

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

resource_version

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

updated_at

Timestamp indicating when this subscription was last updated. This attribute will be present only if the resource has been updated after 2016-09-28.
Note: This value does not change when the following attributes are changed: due_invoices_count, due_since, total_dues.
optional, timestamp(UTC) in seconds

has_scheduled_changes

If true, there are subscription changes scheduled on next renewal.
boolean, default=false

payment_source_id

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

auto_collection

Defines whether payments need to be collected automatically for this subscription. Overrides customer's auto-collection property.
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. All payments must be recorded offline.

due_invoices_count

Total number of invoices that are due for payment.
Note: Not supported if consolidated invoicing is enabled.
optional, integer

due_since

Time since this subscription has unpaid invoices.
Note: Not supported if consolidated invoicing is enabled.
optional, timestamp(UTC) in seconds

total_dues

Total invoice due amount for this subscription.
Note: Not supported if consolidated invoicing is enabled.
optional, in cents, min=0

mrr

Monthly recurring revenue for the subscription.
Note: This may not return accurate values since updated asynchronously.
optional, in cents, min=1

exchange_rate

Exchange rate used for base currency conversion.
optional, bigdecimal, min=1E-9, max=999999999.999999999

base_currency_code

Base currency code (ISO 4217 format).
optional, string, max chars=3

invoice_notes

Invoice Notes for this resource. Read More.
optional, string, max chars=1000

meta_data

Additional data about this resource can be stored here in the JSON Format. Learn more.
optional, jsonobject

deleted

Indicates that this resource has been deleted.
boolean

addons
Show attributes[+]

List of addons for this subscription with quantity(if applicable).
optional, list of addon

Addon attributes

id

Identifier of the addon. Multiple addons can be passed.
string, max chars=100

quantity

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

unit_price

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

amount

optional, in cents, min=0

trial_end

The time at which the trial ends for the addon. In order to use this param please contact support@chargebee.com.
optional, timestamp(UTC) in seconds

remaining_billing_cycles

The number of billing cycles this addon will be attached to subscription.
optional, integer, min=0

event_based_addons
Show attributes[+]

List of non-recurring addons that will be charged on the occurrence of specified event.
optional, list of event_based_addon

Event based addon attributes

id

A unique 'id' used to identify the addon.
string, max chars=100

quantity

Addon quantity. Applicable only for the quantity based addons. Should be passed with the same index as that of associated addon id.
integer, min=1

unit_price

Amount that will override the Addon's default price.
in cents, min=0

on_event

Event on which this addon will be charged.
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.

charge_once

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

charged_event_based_addons
Show attributes[+]

List of event_based_addons that have already been charged.
optional, list of charged_event_based_addon

Charged event based addon attributes

id

Addon id.
string, max chars=100

last_charged_at

Timestamp indicating when this add-on was last charged for this subscription.
timestamp(UTC) in seconds

coupons
Show attributes[+]

List of coupons for this subscription.
optional, list of coupon

Coupon attributes

coupon_id

Used to uniquely identify the coupon.
string, max chars=50

apply_till

The date till the coupon is to be applied. Applicable for "limited months" coupons.
optional, timestamp(UTC) in seconds

applied_count

Number of times this coupon has been applied for this subscription.
integer, default=0

coupon_code

The coupon code used to redeem the coupon. Will be present only when associated code for a coupon is used.
optional, string, max chars=50

shipping_address
Show attributes[+]

Shipping address for the subscription.
optional, shipping_address

Shipping addres attributes

first_name

First name.
optional, string, max chars=150

last_name

Last name.
optional, string, max chars=150

email

Email.
optional, string, max chars=70

company

Company name.
optional, string, max chars=250

phone

Phone number.
optional, string, max chars=50

line1

Address line 1.
optional, string, max chars=180

line2

Address line 2.
optional, string, max chars=150

line3

Address line 3.
optional, string, max chars=150

city

City.
optional, string, max chars=50

state_code

The ISO 3166-2 state/province code without the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set the state_code as AZ (not US-AZ). or, for Tamil Nadu (India), set the state_code as TN (not IN-TN). or, for British Columbia (Canada), set the state_code as BC (not CA-BC).
Note: If the 'state_code' is specified, the 'state' attribute should not be provided as Chargebee will set the value automatically (for US, Canada, India).
optional, string, max chars=50

state

The state/province name.
optional, string, max chars=50

country

2-letter ISO 3166 alpha-2 country code.
optional, string, max chars=50

zip

Zip or Postal code.
optional, string, max chars=20

validation_status

The address verification status.
optional, enumerated string, default=not_validated

Possible values are

not_validatedAddress is not yet validated.validAddress was validated successfully.partially_validAddress is verified but only partially.invalidAddress is invalid.

referral_info
Show attributes[+]

Referral details if exists for the subscription.
optional, referral_info

Referral info attributes

referral_code

Referral code if available for the subscription.
optional, string, max chars=50

coupon_code

Referral coupon code if available for the subscription.
optional, string, max chars=50

referrer_id

Referrer id if available for the subscription.
optional, string, max chars=19

external_reference_id

External reference id in referral system for the subscription.
optional, string, max chars=50

reward_status

Reward status for the referral subscription.
optional, enumerated string, default=pending

Possible values are

pendingPending.paidPaid.invalidInvalid.

referral_system

Source referral system for the referral subscription.
optional, enumerated string

Possible values are

referral_candyReferral Candy.referral_saasquatchReferral Saasquatch.friendbuyFriendbuy.

account_id

Referral account id.
string, max chars=50

campaign_id

Referral campaign id.
string, max chars=50

external_campaign_id

Referral external campaign id.
optional, string, max chars=100

friend_offer_type

Friend offer type for the referral camapign.
optional, enumerated string

Possible values are

noneNone.couponCoupon.coupon_codeCoupon Code.

referrer_reward_type

Referrer reward type for the referral campaign.
optional, enumerated string

Possible values are

noneNone.referral_direct_rewardReferral Direct Reward.custom_promotional_creditCustom Promotional Credit.custom_revenue_percent_basedCustom Revenue Percent Based.

notify_referral_system

Whether or not to notify the referral purchases to the referral system.
optional, enumerated string

Possible values are

noneNone.first_paid_conversionFirst Paid Conversion.all_invoicesAll Invoices.

destination_url

Destination url for the referral campaign.
optional, string, max chars=250

post_purchase_widget_enabled

Whether post purchase widget is enabled for this campaign.
boolean, default=true

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. Please refer this 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.

You can also use our Hosted Pages based integration.

Billing Address

The Billing Address is significant especially when EU VAT taxes are involved, for tax calculations will be based on this address. For customers without Billing Address, EU VAT taxes will not be included. Thus ensure to set this properly if you have configured EU VAT Tax.

Note: For the sites created before 1st Mar 2014, customer's billing address and 'vat_number' will be replaced automatically whenever the associated card gets updated. i.e existing values for billing address and 'vat_number' will be cleared and the new values will be set. This behaviour is changed now - The VAT number should always be passed along billing address and not with card address. Both the addresses have to be dealt separately.

Billing Address attributes shall be explicitly passed for customers paying offline(Cash, Check, Bank Transfer etc).

Sample Response [ JSON ]

{
    "subscription": {
        "id": "5SK0b55NR6FAAQh8z",
        "customer_id": "5SK0b55NR6FAAQh8z",
        "plan_id": "basic",
        "plan_quantity": 1,
        "plan_unit_price": 900,
        "plan_amount": 900,
        "billing_period": 1,
        "billing_period_unit": "month",
        "plan_free_quantity": 0,
        "status": "in_trial",
        "trial_start": 1539327226,
        "trial_end": 1542005626,
        "next_billing_at": 1542005626,
        "created_at": 1539327226,
        "started_at": 1539327226,
        "updated_at": 1539327226,
        "has_scheduled_changes": false,
        "resource_version": 1539327226000,
        "deleted": false,
        "object": "subscription",
        "currency_code": "USD",
        "due_invoices_count": 0
    },
    "customer": {
        "id": "5SK0b55NR6FAAQh8z",
        "first_name": "John",
        "last_name": "Doe",
        "email": "john@user.com",
        "phone": "+1-949-999-9999",
        "auto_collection": "on",
        "net_term_days": 0,
        "allow_direct_debit": false,
        "created_at": 1539327226,
        "taxability": "taxable",
        "updated_at": 1539327226,
        "locale": "fr-CA",
        "pii_cleared": "active",
        "resource_version": 1539327226000,
        "deleted": false,
        "object": "customer",
        "billing_address": {
            "first_name": "John",
            "last_name": "Doe",
            "line1": "PO Box 9999",
            "city": "Walnut",
            "state_code": "CA",
            "state": "California",
            "country": "US",
            "zip": "91789",
            "validation_status": "not_validated",
            "object": "billing_address"
        },
        "card_status": "no_card",
        "promotional_credits": 0,
        "refundable_credits": 0,
        "excess_payments": 0,
        "unbilled_charges": 0,
        "preferred_currency_code": "USD"
    }
}

URL Format POST

https://{site}.chargebee.com/api/v2/subscriptions

id

Id for the new subscription. If not given, this will be auto-generated.
optional, string, max chars=50

plan_id

Identifier of the plan for this subscription.
required, string, max chars=100

plan_quantity

Plan quantity for this subscription.
optional, integer, default=1, min=1

plan_unit_price

Amount that will override the Plan's default price.
optional, in cents, min=0

setup_fee

Amount that will override the default setup fee.
optional, in cents, min=0

start_date

Allows you to specify a future date or a past date on which the subscription starts.Past dates can be entered in case the subscription has already started. Any past date entered must be within the current billing cycle/plan term. The subscription will start immediately if this parameter is not passed.
optional, timestamp(UTC) in seconds

trial_end

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

billing_cycles

Number of cycles(plan interval) this subscription should be charged. After the billing cycles exhausted, the subscription will be cancelled.
optional, integer, min=0

auto_collection

Defines whether payments need to be collected automatically for this subscription. Overrides customer's auto-collection property.
optional, enumerated string

Possible values are

terms_to_charge

The number of future renewals for which advance invoicing is done. However, if a new term gets started in this operation, the specified terms_to_charge will be inclusive of this new term.
optional, integer, min=1

billing_alignment_mode

Applicable when calendar billing is enabled and subscription is getting created in active / non_renewing states. Unless specified the configured default value will be used.
optional, enumerated string

Possible values are

immediateSubscription period will be aligned with the configured billing date immediately.delayedSubscription period will be aligned with the configured billing date at a later date (subsequent renewals).

mandatory_addons_to_remove[0..n]

List of addons IDs that are mandatory to the plan and has to be removed from the subscription.
optional, list of string

po_number

Purchase Order Number for this subscription.
optional, string, max chars=100

coupon_ids[0..n]

Identifier of the coupon as a List. Coupon Codes can also be passed.
optional, list of string

affiliate_token

A unique tracking token.
optional, string, max chars=250

invoice_notes

Invoice Notes for this resource. Read More.
optional, string, max chars=1000

meta_data

Additional data about this resource can be stored here in the JSON Format. Learn more.
optional, jsonobject

invoice_immediately

Applicable when charges are added during this operation. If specified as false, these charges will be added to unbilled charges. The default value for this parameter will be as per your site settings.
optional, boolean

customer

Parameters for customer
pass parameters as customer[<param name>]

customer[id]

Id for the new customer. If not given, this will be same as the subscription id.
optional, string, max chars=50

customer[email]

Email of the customer. Configured email notifications will be sent to this email.
optional, string, max chars=70

customer[first_name]

First name of the customer.
optional, string, max chars=150

customer[last_name]

Last name of the customer.
optional, string, max chars=150

customer[company]

Company name of the customer.
optional, string, max chars=250

customer[taxability]

Specifies if the customer is liable for tax.
optional, enumerated string, default=taxable

Possible values are

taxableCustomer is taxable.exemptCustomer is exempted from tax.

customer[locale]

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

customer[entity_code]

The exemption category of the customer, for the USA and Canada. applicable if you use Chargebee's Avalara integration.
optional, enumerated string

Possible values are

aFederal government (United States).bState government (United States).cTribe/Status Indian/Indian Band (both).dForeign diplomat (United States).

eCharitable or benevolent org (United States).fReligious or educational org (United States).gResale (United States).hCommercial agricultural production (United States).iIndustrial production/manufacturer (United States).jDirect pay permit (United States).kDirect mail (United States).lOther (United States).nLocal government (United States).pCommercial aquaculture (Canada).qCommercial Fishery (Canada).rNon-resident (Canada).med1US Medical Device Excise Tax with exempt sales tax.med2US Medical Device Excise Tax with taxable sales tax.

Show all values[+]

customer[exempt_number]

Any string value that will cause the sale to be exempted. Use this if your finance team manually verifies and tracks exemption certificates. Applicable only for Avalara.
optional, string, max chars=100

customer[net_term_days]

The number of days within which the customer has to make payment for the invoice.
optional, integer, default=0

customer[phone]

Phone number of the customer.
optional, string, max chars=50

customer[auto_collection]

Whether payments needs to be collected automatically for this customer.
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.

customer[allow_direct_debit]

Whether the customer can pay via Direct Debit.
optional, boolean, default=false

customer[consolidated_invoicing]

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

customer[vat_number]

VAT/ Tax registration number of the customer. Learn more.
optional, string, max chars=20

customer[registered_for_gst]

Confirms that a customer is registered under GST. This field is available for Australia only.
optional, boolean

card

Parameters for card
pass parameters as card[<param name>]

card[gateway_account_id]

The gateway account in which this payment source is stored.
optional, string, max chars=50

card[first_name]

Cardholder's first name.
optional, string, max chars=50

card[last_name]

Cardholder's last name.
optional, string, max chars=50

card[number]

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

card[expiry_month]

Card expiry month.
required if card provided, integer, min=1, max=12

card[expiry_year]

Card expiry year.
required if card provided, integer

card[cvv]

The card verification value. If you are using Braintree.js, you can specify the Braintree encrypted cvv here.
optional, string, max chars=520

card[billing_addr1]

Address line 1, as available in card billing address.
optional, string, max chars=150

card[billing_addr2]

Address line 2, as available in card billing address.
optional, string, max chars=150

card[billing_city]

City, as available in card billing address.
optional, string, max chars=50

card[billing_state_code]

card[billing_state]

The state/province name. Use this to pass the state/province information for cases where 'state_code' is not supported or cannot be passed.
optional, string, max chars=50

card[billing_zip]

Postal or Zip code, as available in card billing address.
optional, string, max chars=20

card[billing_country]

2-letter ISO 3166 alpha-2 country code.
optional, string, max chars=50

bank_account

Parameters for bank_account
pass parameters as bank_account[<param name>]

bank_account[gateway_account_id]

The gateway account in which this payment source is stored.
optional, string, max chars=50

bank_account[iban]

Account holder’s International Bank Account Number.
optional, string, min chars=10, max chars=50

bank_account[first_name]

Account holder’s first name as per bank account. If not passed, details from customer details will be considered.
optional, string, max chars=150

bank_account[last_name]

Account holder’s last name as per bank account. If not passed, details from customer details will be considered.
optional, string, max chars=150

bank_account[company]

Account holder’s company name as per bank account. If not passed, details from customer details will be considered.
optional, string, max chars=250

bank_account[email]

Account holder’s email address. If not passed, details from customer details will be considered. All Direct Debit compliant emails will be sent to this email address.
optional, string, max chars=70

bank_account[bank_name]

Name of account holder’s bank.
optional, string, max chars=100

bank_account[account_number]

Account holder’s bank account number.
optional, string, min chars=5, max chars=17

bank_account[routing_number]

Bank account routing number.
optional, string, min chars=3, max chars=9

bank_account[bank_code]

Indicates the bank code.
optional, string, max chars=20

bank_account[account_type]

For Authorize.net ACH users only. Indicates the type of account.
optional, enumerated string

Possible values are

checkingChecking Account.savingsSavings Account.

bank_account[account_holder_type]

For Stripe ACH users only. Indicates the account holder type.
optional, enumerated string

Possible values are

individualIndividual.companyCompany.

bank_account[echeck_type]

For Authorize.net ACH users only. Indicates the type of eCheck.
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.

bank_account[issuing_country]

2-letter(alpha2) ISO country code. Required when local bank details are provided, and not IBAN.
optional, string, max chars=50

bank_account[swedish_identity_number]

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

payment_method

Parameters for payment_method
pass parameters as payment_method[<param name>]

payment_method[type]

The type of payment method. For more details refer Update payment method for a customer API under Customer resource.
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.

Show all values[+]

payment_method[gateway_account_id]

The gateway account in which this payment source is stored.
optional, string, max chars=50

payment_method[reference_id]

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=50

payment_method[tmp_token]

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

payment_method[issuing_country]

2-letter (alpha2) ISO country code. Indicates your customer's payment method country of issuance. Applicable for PayPal via Braintree.
optional, string, max chars=50

billing_address

Parameters for billing_address
pass parameters as billing_address[<param name>]

billing_address[first_name]

First name.
optional, string, max chars=150

billing_address[last_name]

Last name.
optional, string, max chars=150

billing_address[email]

Email.
optional, string, max chars=70

billing_address[company]

Company name.
optional, string, max chars=250

billing_address[phone]

Phone number.
optional, string, max chars=50

billing_address[line1]

Address line 1.
optional, string, max chars=150

billing_address[line2]

Address line 2.
optional, string, max chars=150

billing_address[line3]

Address line 3.
optional, string, max chars=150

billing_address[city]

City.
optional, string, max chars=50

billing_address[state_code]

billing_address[state]

The state/province name. Use this to pass the state/province information for cases where 'state_code' is not supported or cannot be passed.
optional, string, max chars=50

billing_address[zip]

Zip or Postal code.
optional, string, max chars=20

billing_address[country]

2-letter ISO 3166 alpha-2 country code.
optional, string, max chars=50

billing_address[validation_status]

The address verification status.
optional, enumerated string, default=not_validated

Possible values are

not_validatedAddress is not yet validated.validAddress was validated successfully.partially_validAddress is verified but only partially.invalidAddress is invalid.

shipping_address

Parameters for shipping_address
pass parameters as shipping_address[<param name>]

shipping_address[first_name]

First name.
optional, string, max chars=150

shipping_address[last_name]

Last name.
optional, string, max chars=150

shipping_address[email]

Email.
optional, string, max chars=70

shipping_address[company]

Company name.
optional, string, max chars=250

shipping_address[phone]

Phone number.
optional, string, max chars=50

shipping_address[line1]

Address line 1.
optional, string, max chars=180

shipping_address[line2]

Address line 2.
optional, string, max chars=150

shipping_address[line3]

Address line 3.
optional, string, max chars=150

shipping_address[city]

City.
optional, string, max chars=50

shipping_address[state_code]

shipping_address[state]

The state/province name. Use this to pass the state/province information for cases where 'state_code' is not supported or cannot be passed.
optional, string, max chars=50

shipping_address[zip]

Zip or Postal code.
optional, string, max chars=20

shipping_address[country]

2-letter ISO 3166 alpha-2 country code.
optional, string, max chars=50

shipping_address[validation_status]

The address verification status.
optional, enumerated string, default=not_validated

Possible values are

not_validatedAddress is not yet validated.validAddress was validated successfully.partially_validAddress is verified but only partially.invalidAddress is invalid.

addons

Parameters for addons. Multiple addons can be passed by specifying unique indices.
pass parameters as addons[<param name>][<idx:0..n>]

addons[id][0..n]

Identifier of the addon. Multiple addons can be passed.
optional, string, max chars=100

addons[quantity][0..n]

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

addons[unit_price][0..n]

addons[billing_cycles][0..n]

Number of billing cycles the addon will be charged for.
optional, integer, min=1

addons[trial_end][0..n]

The time at which the trial ends for the addon. In order to use this param please contact support@chargebee.com.
optional, timestamp(UTC) in seconds

event_based_addons

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

event_based_addons[id][0..n]

A unique 'id' used to identify the addon.
optional, string, max chars=100

event_based_addons[quantity][0..n]

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

event_based_addons[unit_price][0..n]

Amount that will override the Addon's default price.
optional, in cents, min=0

event_based_addons[on_event][0..n]

Event on which this addon will be charged.
optional, enumerated string

Possible values are

event_based_addons[charge_once][0..n]

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

event_based_addons[charge_on][0..n]

Indicates when the non-recurring addon will be charged.
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.

subscription

Resource object representing subscription.
always returned

customer

Resource object representing customer.
always returned

card

Resource object representing card.
optional

invoice

Resource object representing invoice.
optional

unbilled_charges

Resource object representing unbilled_charge.
optional

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/8avVGOkx8U1MX/subscriptions \
     -u {site_api_key}: \
     -d plan_id="basic"

copy

curl  https://{site}.chargebee.com/api/v2/customers/8avVGOkx8U1MX/subscriptions \
     -u {site_api_key}: \
     -d plan_id="basic"

Sample Response [ JSON ]

{
    "subscription": {
        "id": "5SK0b55NR6FAAbn93",
        "customer_id": "8avVGOkx8U1MX",
        "plan_id": "basic",
        "plan_quantity": 1,
        "plan_unit_price": 900,
        "plan_amount": 900,
        "billing_period": 1,
        "billing_period_unit": "month",
        "plan_free_quantity": 0,
        "status": "in_trial",
        "trial_start": 1539327226,
        "trial_end": 1542005626,
        "next_billing_at": 1542005626,
        "created_at": 1539327226,
        "started_at": 1539327226,
        "updated_at": 1539327226,
        "has_scheduled_changes": false,
        "resource_version": 1539327226000,
        "deleted": false,
        "object": "subscription",
        "currency_code": "USD",
        "due_invoices_count": 0
    },
    "customer": {
        "id": "8avVGOkx8U1MX",
        "first_name": "Benjamin",
        "last_name": "Ross",
        "email": "Benjamin@test.com",
        "auto_collection": "on",
        "net_term_days": 0,
        "allow_direct_debit": false,
        "created_at": 1412101824,
        "taxability": "taxable",
        "updated_at": 1539327223,
        "pii_cleared": "active",
        "resource_version": 1539327223000,
        "deleted": false,
        "object": "customer",
        "card_status": "valid",
        "contacts": [
            {
                "id": "d334f4g45",
                "first_name": "aasca",
                "last_name": "asas",
                "email": "sss@wss.asc",
                "label": "ascasc",
                "enabled": true,
                "send_account_email": true,
                "send_billing_email": false,
                "object": "contact"
            },
            {..}
        ],
        "primary_payment_source_id": "pm_5SK0b55NR6FA9Uy8U",
        "payment_method": {
            "object": "payment_method",
            "type": "card",
            "reference_id": "cus_DlsHbEWTIBQzqP/card_1DKKWiJv9j0DyntJS8Wfexoe",
            "gateway": "stripe",
            "gateway_account_id": "gw_5SK0b54PR6F9Odm8y",
            "status": "valid"
        },
        "promotional_credits": 0,
        "refundable_credits": 0,
        "excess_payments": 0,
        "unbilled_charges": 0,
        "preferred_currency_code": "USD"
    },
    "card": {
        "status": "valid",
        "gateway": "stripe",
        "gateway_account_id": "gw_5SK0b54PR6F9Odm8y",
        "first_name": "Richard",
        "last_name": "Fox",
        "iin": "401288",
        "last4": "1881",
        "card_type": "visa",
        "funding_type": "credit",
        "expiry_month": 10,
        "expiry_year": 2022,
        "issuing_country": "CA",
        "object": "card",
        "masked_number": "************1881",
        "customer_id": "8avVGOkx8U1MX",
        "payment_source_id": "pm_5SK0b55NR6FA9Uy8U"
    }
}

URL Format POST

https://{site}.chargebee.com/api/v2/customers/{customer_id}/subscriptions

id

Id for the new subscription. If not given, this will be auto-generated.
optional, string, max chars=50

plan_id

Identifier of the plan for this subscription.
required, string, max chars=100

plan_quantity

Plan quantity for this subscription.
optional, integer, default=1, min=1

plan_unit_price

Amount that will override the Plan's default price.
optional, in cents, min=0

setup_fee

Amount that will override the default setup fee.
optional, in cents, min=0

start_date

trial_end

billing_cycles

Number of cycles(plan interval) this subscription should be charged. After the billing cycles exhausted, the subscription will be cancelled.
optional, integer, min=0

auto_collection

Defines whether payments need to be collected automatically for this subscription. Overrides customer's auto-collection property.
optional, enumerated string

Possible values are

terms_to_charge

billing_alignment_mode

Possible values are

mandatory_addons_to_remove[0..n]

List of addons IDs that are mandatory to the plan and has to be removed from the subscription.
optional, list of string

po_number

Purchase Order Number for this subscription.
optional, string, max chars=100

coupon_ids[0..n]

Identifier of the coupon as a List. Coupon Codes can also be passed.
optional, list of string

payment_source_id

Unique identifier of the payment source to be attached to this subscription.
optional, string, max chars=40

invoice_notes

Invoice Notes for this resource. Read More.
optional, string, max chars=1000

meta_data

Additional data about this resource can be stored here in the JSON Format. Learn more.
optional, jsonobject

invoice_immediately

shipping_address

Parameters for shipping_address
pass parameters as shipping_address[<param name>]

shipping_address[first_name]

First name.
optional, string, max chars=150

shipping_address[last_name]

Last name.
optional, string, max chars=150

shipping_address[email]

Email.
optional, string, max chars=70

shipping_address[company]

Company name.
optional, string, max chars=250

shipping_address[phone]

Phone number.
optional, string, max chars=50

shipping_address[line1]

Address line 1.
optional, string, max chars=180

shipping_address[line2]

Address line 2.
optional, string, max chars=150

shipping_address[line3]

Address line 3.
optional, string, max chars=150

shipping_address[city]

City.
optional, string, max chars=50

shipping_address[state_code]

shipping_address[state]

The state/province name. Use this to pass the state/province information for cases where 'state_code' is not supported or cannot be passed.
optional, string, max chars=50

shipping_address[zip]

Zip or Postal code.
optional, string, max chars=20

shipping_address[country]

2-letter ISO 3166 alpha-2 country code.
optional, string, max chars=50

shipping_address[validation_status]

The address verification status.
optional, enumerated string, default=not_validated

Possible values are

not_validatedAddress is not yet validated.validAddress was validated successfully.partially_validAddress is verified but only partially.invalidAddress is invalid.

addons

Parameters for addons. Multiple addons can be passed by specifying unique indices.
pass parameters as addons[<param name>][<idx:0..n>]

addons[id][0..n]

Identifier of the addon. Multiple addons can be passed.
optional, string, max chars=100

addons[quantity][0..n]

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

addons[unit_price][0..n]

addons[billing_cycles][0..n]

Number of billing cycles the addon will be charged for.
optional, integer, min=1

addons[trial_end][0..n]

The time at which the trial ends for the addon. In order to use this param please contact support@chargebee.com.
optional, timestamp(UTC) in seconds

event_based_addons

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

event_based_addons[id][0..n]

A unique 'id' used to identify the addon.
optional, string, max chars=100

event_based_addons[quantity][0..n]

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

event_based_addons[unit_price][0..n]

Amount that will override the Addon's default price.
optional, in cents, min=0

event_based_addons[on_event][0..n]

Event on which this addon will be charged.
optional, enumerated string

Possible values are

event_based_addons[charge_once][0..n]

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

event_based_addons[charge_on][0..n]

Indicates when the non-recurring addon will be charged.
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.

subscription

Resource object representing subscription.
always returned

customer

Resource object representing customer.
always returned

card

Resource object representing card.
optional

invoice

Resource object representing invoice.
optional

unbilled_charges

Resource object representing unbilled_charge.
optional

Retrieves the list of subscriptions.

Sample Request

curl  https://{site}.chargebee.com/api/v2/subscriptions \
     -G  \
     -u {site_api_key}: \
     --data-urlencode limit="5" \
     --data-urlencode plan_id[is_not]="basic" \
     --data-urlencode status[is]="active" \
     --data-urlencode sort_by[asc]="created_at"

copy

curl  https://{site}.chargebee.com/api/v2/subscriptions \
     -G  \
     -u {site_api_key}: \
     --data-urlencode limit="5" \
     --data-urlencode plan_id[is]="basic" \
     --data-urlencode status[is]="active" \
     --data-urlencode sort_by[asc]="created_at"

Sample Response [ JSON ]

{
    "list": [
        {
            "subscription": {
                "id": "5SK0b55NR6FAAbn93",
                "customer_id": "8avVGOkx8U1MX",
                "plan_id": "basic",
                "plan_quantity": 1,
                "plan_unit_price": 900,
                "plan_amount": 900,
                "billing_period": 1,
                "billing_period_unit": "month",
                "plan_free_quantity": 0,
                "status": "in_trial",
                "trial_start": 1539327226,
                "trial_end": 1542005626,
                "next_billing_at": 1542005626,
                "created_at": 1539327226,
                "started_at": 1539327226,
                "updated_at": 1539327226,
                "has_scheduled_changes": false,
                "resource_version": 1539327226000,
                "deleted": false,
                "object": "subscription",
                "currency_code": "USD",
                "due_invoices_count": 0
            },
            "customer": {
                "id": "8avVGOkx8U1MX",
                "first_name": "Benjamin",
                "last_name": "Ross",
                "email": "Benjamin@test.com",
                "auto_collection": "on",
                "net_term_days": 0,
                "allow_direct_debit": false,
                "created_at": 1412101824,
                "taxability": "taxable",
                "updated_at": 1539327223,
                "pii_cleared": "active",
                "resource_version": 1539327223000,
                "deleted": false,
                "object": "customer",
                "card_status": "valid",
                "contacts": [
                    {
                        "id": "d334f4g45",
                        "first_name": "aasca",
                        "last_name": "asas",
                        "email": "sss@wss.asc",
                        "label": "ascasc",
                        "enabled": true,
                        "send_account_email": true,
                        "send_billing_email": false,
                        "object": "contact"
                    },
                    {..}
                ],
                "primary_payment_source_id": "pm_5SK0b55NR6FA9Uy8U",
                "payment_method": {
                    "object": "payment_method",
                    "type": "card",
                    "reference_id": "cus_DlsHbEWTIBQzqP/card_1DKKWiJv9j0DyntJS8Wfexoe",
                    "gateway": "stripe",
                    "gateway_account_id": "gw_5SK0b54PR6F9Odm8y",
                    "status": "valid"
                },
                "promotional_credits": 0,
                "refundable_credits": 0,
                "excess_payments": 0,
                "unbilled_charges": 0,
                "preferred_currency_code": "USD"
            },
            "card": {
                "status": "valid",
                "gateway": "stripe",
                "gateway_account_id": "gw_5SK0b54PR6F9Odm8y",
                "first_name": "Richard",
                "last_name": "Fox",
                "iin": "401288",
                "last4": "1881",
                "card_type": "visa",
                "funding_type": "credit",
                "expiry_month": 10,
                "expiry_year": 2022,
                "issuing_country": "CA",
                "object": "card",
                "masked_number": "************1881",
                "customer_id": "8avVGOkx8U1MX",
                "payment_source_id": "pm_5SK0b55NR6FA9Uy8U"
            }
        },
        {..}
    ],
    "next_offset": "[\"1539327226000\",\"173000000159\"]"
}

URL Format GET

https://{site}.chargebee.com/api/v2/subscriptions

limit

Limits the number of resources to be returned.
optional, integer, default=10, min=1, max=100

offset

Allows you to fetch the next set of resources. The value used for this parameter must be the value returned for next_offset parameter in the previous API call.
optional, string, max chars=1000

include_deleted

If set to true, includes the deleted resources in the response. For the deleted resources in the response, the 'deleted' attribute will be 'true'.
optional, boolean, default=false

sort_by[<sort-order>]

Sorts based on the specified attribute.
Supported attributes : created_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.

id[<operator>]

To filter based on Subscription Id.
Supported operators : is, is_not, starts_with, in, not_in

Example → id[is] = "8gsnbYfsMLds"
optional, string filter

customer_id[<operator>]

To filter based on Subscription Customer Id.
Supported operators : is, is_not, starts_with, in, not_in

Example → customer_id[is] = "8gsnbYfsMLds"
optional, string filter

plan_id[<operator>]

To filter based on Subscription Plan Id.
Supported operators : is, is_not, starts_with, in, not_in

Example → plan_id[is] = "basic"
optional, string filter

status[<operator>]

To filter based on Subscription State. Possible values are : future, in_trial, active, non_renewing, paused, cancelled.
Supported operators : is, is_not, in, not_in

Example → status[is_not] = "active"
optional, enumerated string filter

cancel_reason[<operator>]

To filter based on Subscription Cancel Reason. Possible values are : not_paid, no_card, fraud_review_failed, non_compliant_eu_customer, tax_calculation_failed, currency_incompatible_with_gateway, non_compliant_customer.
Supported operators : is, is_not, in, not_in, is_present

Example → cancel_reason[is] = "not_paid"
optional, enumerated string filter

remaining_billing_cycles[<operator>]

To filter based on Subscription Remaining Billing Cycles.
Supported operators : is, is_not, lt, lte, gt, gte, between, is_present

Example → remaining_billing_cycles[gt] = "3"
optional, integer filter

created_at[<operator>]

To filter based on Subscription Created At.
Supported operators : after, before, on, between

Example → created_at[after] = "1435054328"
optional, timestamp(UTC) in seconds filter

activated_at[<operator>]

To filter based on Subscription Activated At.
Supported operators : after, before, on, between, is_present

Example → activated_at[after] = "1435054328"
optional, timestamp(UTC) in seconds filter

next_billing_at[<operator>]

To filter based on Subscription Next Billing At.
Supported operators : after, before, on, between

Example → next_billing_at[before] = "1435054328"
optional, timestamp(UTC) in seconds filter

cancelled_at[<operator>]

To filter based on Subscription Cancelled At.
Supported operators : after, before, on, between

Example → cancelled_at[after] = "1435054328"
optional, timestamp(UTC) in seconds filter

has_scheduled_changes[<operator>]

To filter based on Subscription Has Scheduled Changes. Possible values are : true, false
Supported operators : is

Example → has_scheduled_changes[is] = "true"
optional, boolean filter

updated_at[<operator>]

To filter based on updated at. This attribute will be present only if the resource has been updated after 2016-09-28.
Supported operators : after, before, on, between

Example → updated_at[after] = "1243545465"
optional, timestamp(UTC) in seconds filter

subscription

Resource object representing subscription.
always returned

customer

Resource object representing customer.
always returned

card

Resource object representing card.
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

Retrieves the subscription identified by the 'subscription id' specified in the url.

Sample Request

curl  https://{site}.chargebee.com/api/v2/subscriptions/8avVGOkx8U1MX \
     -u {site_api_key}:

copy

curl  https://{site}.chargebee.com/api/v2/subscriptions/8avVGOkx8U1MX \
     -u {site_api_key}:

Sample Response [ JSON ]

{
    "subscription": {
        "id": "8avVGOkx8U1MX",
        "customer_id": "8avVGOkx8U1MX",
        "plan_id": "basic",
        "plan_quantity": 1,
        "plan_unit_price": 900,
        "plan_amount": 900,
        "billing_period": 1,
        "billing_period_unit": "month",
        "plan_free_quantity": 0,
        "status": "non_renewing",
        "trial_start": 1412101824,
        "trial_end": 1414780224,
        "current_term_start": 1538332224,
        "current_term_end": 1541010624,
        "remaining_billing_cycles": 0,
        "created_at": 1412101824,
        "started_at": 1412101824,
        "activated_at": 1414780224,
        "cancelled_at": 1541010624,
        "updated_at": 1539327165,
        "has_scheduled_changes": false,
        "resource_version": 1539327165000,
        "deleted": false,
        "object": "subscription",
        "currency_code": "USD",
        "due_invoices_count": 3,
        "due_since": 1394532759,
        "total_dues": 6700,
        "mrr": 900,
        "exchange_rate": 1.0,
        "base_currency_code": "USD",
        "shipping_address": {
            "first_name": "Benjamin",
            "last_name": "Ross",
            "line1": "PO Box 9999",
            "city": "Walnut",
            "state_code": "CA",
            "state": "California",
            "country": "US",
            "zip": "91789",
            "validation_status": "not_validated",
            "object": "shipping_address"
        }
    },
    "customer": {
        "id": "8avVGOkx8U1MX",
        "first_name": "Benjamin",
        "last_name": "Ross",
        "email": "Benjamin@test.com",
        "auto_collection": "on",
        "net_term_days": 0,
        "allow_direct_debit": false,
        "created_at": 1412101824,
        "taxability": "taxable",
        "updated_at": 1539327223,
        "pii_cleared": "active",
        "resource_version": 1539327223000,
        "deleted": false,
        "object": "customer",
        "card_status": "valid",
        "contacts": [
            {
                "id": "d334f4g45",
                "first_name": "aasca",
                "last_name": "asas",
                "email": "sss@wss.asc",
                "label": "ascasc",
                "enabled": true,
                "send_account_email": true,
                "send_billing_email": false,
                "object": "contact"
            },
            {..}
        ],
        "primary_payment_source_id": "pm_5SK0b55NR6FA9Uy8U",
        "payment_method": {
            "object": "payment_method",
            "type": "card",
            "reference_id": "cus_DlsHbEWTIBQzqP/card_1DKKWiJv9j0DyntJS8Wfexoe",
            "gateway": "stripe",
            "gateway_account_id": "gw_5SK0b54PR6F9Odm8y",
            "status": "valid"
        },
        "promotional_credits": 0,
        "refundable_credits": 0,
        "excess_payments": 0,
        "unbilled_charges": 0,
        "preferred_currency_code": "USD"
    },
    "card": {
        "status": "valid",
        "gateway": "stripe",
        "gateway_account_id": "gw_5SK0b54PR6F9Odm8y",
        "first_name": "Richard",
        "last_name": "Fox",
        "iin": "401288",
        "last4": "1881",
        "card_type": "visa",
        "funding_type": "credit",
        "expiry_month": 10,
        "expiry_year": 2022,
        "issuing_country": "CA",
        "object": "card",
        "masked_number": "************1881",
        "customer_id": "8avVGOkx8U1MX",
        "payment_source_id": "pm_5SK0b55NR6FA9Uy8U"
    }
}

URL Format GET

https://{site}.chargebee.com/api/v2/subscriptions/{subscription_id}

subscription

Resource object representing subscription.
always returned

customer

Resource object representing customer.
always returned

card

Resource object representing card.
optional

Sample admin console URL

https://{site}.chargebee.com/admin-console/subscriptions/8avVGOkx8U1MX

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

Other attributes such as status, next_billing_at are not changed and will reflect the current subscription values.

Sample Request

curl  https://{site}.chargebee.com/api/v2/subscriptions/8avVGOkx8U1MX/retrieve_with_scheduled_changes \
     -u {site_api_key}:

copy

curl  https://{site}.chargebee.com/api/v2/subscriptions/8avVGOkx8U1MX/retrieve_with_scheduled_changes \
     -u {site_api_key}:

Sample Response [ JSON ]

{
    "subscription": {
        "id": "8avVGOkx8U1MX",
        "customer_id": "8avVGOkx8U1MX",
        "plan_id": "no_trial",
        "plan_quantity": 7,
        "plan_unit_price": 1000,
        "plan_amount": 900,
        "billing_period": 1,
        "billing_period_unit": "month",
        "plan_free_quantity": 0,
        "status": "non_renewing",
        "trial_start": 1412101824,
        "trial_end": 1414780224,
        "current_term_start": 1538332224,
        "current_term_end": 1541010624,
        "remaining_billing_cycles": 4,
        "created_at": 1412101824,
        "started_at": 1412101824,
        "activated_at": 1414780224,
        "cancelled_at": 1541010624,
        "updated_at": 1539327165,
        "has_scheduled_changes": false,
        "resource_version": 1539327165000,
        "deleted": false,
        "object": "subscription",
        "currency_code": "USD",
        "due_invoices_count": 3,
        "due_since": 1394532759,
        "total_dues": 6700,
        "mrr": 900,
        "exchange_rate": 1.0,
        "base_currency_code": "USD",
        "shipping_address": {
            "first_name": "Benjamin",
            "last_name": "Ross",
            "line1": "PO Box 9999",
            "city": "Walnut",
            "state_code": "CA",
            "state": "California",
            "country": "US",
            "zip": "91789",
            "validation_status": "not_validated",
            "object": "shipping_address"
        }
    },
    "customer": {
        "id": "8avVGOkx8U1MX",
        "first_name": "Benjamin",
        "last_name": "Ross",
        "email": "Benjamin@test.com",
        "auto_collection": "on",
        "net_term_days": 0,
        "allow_direct_debit": false,
        "created_at": 1412101824,
        "taxability": "taxable",
        "updated_at": 1539327223,
        "pii_cleared": "active",
        "resource_version": 1539327223000,
        "deleted": false,
        "object": "customer",
        "card_status": "valid",
        "contacts": [
            {
                "id": "d334f4g45",
                "first_name": "aasca",
                "last_name": "asas",
                "email": "sss@wss.asc",
                "label": "ascasc",
                "enabled": true,
                "send_account_email": true,
                "send_billing_email": false,
                "object": "contact"
            },
            {..}
        ],
        "primary_payment_source_id": "pm_5SK0b55NR6FA9Uy8U",
        "payment_method": {
            "object": "payment_method",
            "type": "card",
            "reference_id": "cus_DlsHbEWTIBQzqP/card_1DKKWiJv9j0DyntJS8Wfexoe",
            "gateway": "stripe",
            "gateway_account_id": "gw_5SK0b54PR6F9Odm8y",
            "status": "valid"
        },
        "promotional_credits": 0,
        "refundable_credits": 0,
        "excess_payments": 0,
        "unbilled_charges": 0,
        "preferred_currency_code": "USD"
    },
    "card": {
        "status": "valid",
        "gateway": "stripe",
        "gateway_account_id": "gw_5SK0b54PR6F9Odm8y",
        "first_name": "Richard",
        "last_name": "Fox",
        "iin": "401288",
        "last4": "1881",
        "card_type": "visa",
        "funding_type": "credit",
        "expiry_month": 10,
        "expiry_year": 2022,
        "issuing_country": "CA",
        "object": "card",
        "masked_number": "************1881",
        "customer_id": "8avVGOkx8U1MX",
        "payment_source_id": "pm_5SK0b55NR6FA9Uy8U"
    }
}

URL Format GET

https://{site}.chargebee.com/api/v2/subscriptions/{subscription_id}/retrieve_with_scheduled_changes

subscription

Resource object representing subscription.
always returned

customer

Resource object representing customer.
always returned

card

Resource object representing card.
optional

Removes the subscription changes scheduled on next renewal. Advance charges, if any, will be refunded as credits and a new invoice will be generated on renewal.

Sample Request

curl  https://{site}.chargebee.com/api/v2/subscriptions/8avVGOkx8U1MX/remove_scheduled_changes \
     -X POST  \
     -u {site_api_key}:

copy

curl  https://{site}.chargebee.com/api/v2/subscriptions/8avVGOkx8U1MX/remove_scheduled_changes \
     -X POST  \
     -u {site_api_key}:

Sample Response [ JSON ]

{
    "subscription": {
        "id": "8avVGOkx8U1MX",
        "customer_id": "8avVGOkx8U1MX",
        "plan_id": "basic",
        "plan_quantity": 1,
        "plan_unit_price": 900,
        "plan_amount": 900,
        "billing_period": 1,
        "billing_period_unit": "month",
        "plan_free_quantity": 0,
        "status": "non_renewing",
        "trial_start": 1412101824,
        "trial_end": 1414780224,
        "current_term_start": 1538332224,
        "current_term_end": 1541010624,
        "remaining_billing_cycles": 0,
        "created_at": 1412101824,
        "started_at": 1412101824,
        "activated_at": 1414780224,
        "cancelled_at": 1541010624,
        "updated_at": 1539327227,
        "has_scheduled_changes": false,
        "resource_version": 1539327227000,
        "deleted": false,
        "object": "subscription",
        "currency_code": "USD",
        "due_invoices_count": 3,
        "due_since": 1394532759,
        "total_dues": 6700,
        "mrr": 900,
        "exchange_rate": 1.0,
        "base_currency_code": "USD",
        "shipping_address": {
            "first_name": "Benjamin",
            "last_name": "Ross",
            "line1": "PO Box 9999",
            "city": "Walnut",
            "state_code": "CA",
            "state": "California",
            "country": "US",
            "zip": "91789",
            "validation_status": "not_validated",
            "object": "shipping_address"
        }
    },
    "customer": {
        "id": "8avVGOkx8U1MX",
        "first_name": "Benjamin",
        "last_name": "Ross",
        "email": "Benjamin@test.com",
        "auto_collection": "on",
        "net_term_days": 0,
        "allow_direct_debit": false,
        "created_at": 1412101824,
        "taxability": "taxable",
        "updated_at": 1539327223,
        "pii_cleared": "active",
        "resource_version": 1539327223000,
        "deleted": false,
        "object": "customer",
        "card_status": "valid",
        "contacts": [
            {
                "id": "d334f4g45",
                "first_name": "aasca",
                "last_name": "asas",
                "email": "sss@wss.asc",
                "label": "ascasc",
                "enabled": true,
                "send_account_email": true,
                "send_billing_email": false,
                "object": "contact"
            },
            {..}
        ],
        "primary_payment_source_id": "pm_5SK0b55NR6FA9Uy8U",
        "payment_method": {
            "object": "payment_method",
            "type": "card",
            "reference_id": "cus_DlsHbEWTIBQzqP/card_1DKKWiJv9j0DyntJS8Wfexoe",
            "gateway": "stripe",
            "gateway_account_id": "gw_5SK0b54PR6F9Odm8y",
            "status": "valid"
        },
        "promotional_credits": 0,
        "refundable_credits": 0,
        "excess_payments": 0,
        "unbilled_charges": 0,
        "preferred_currency_code": "USD"
    },
    "card": {
        "status": "valid",
        "gateway": "stripe",
        "gateway_account_id": "gw_5SK0b54PR6F9Odm8y",
        "first_name": "Richard",
        "last_name": "Fox",
        "iin": "401288",
        "last4": "1881",
        "card_type": "visa",
        "funding_type": "credit",
        "expiry_month": 10,
        "expiry_year": 2022,
        "issuing_country": "CA",
        "object": "card",
        "masked_number": "************1881",
        "customer_id": "8avVGOkx8U1MX",
        "payment_source_id": "pm_5SK0b55NR6FA9Uy8U"
    }
}

URL Format POST

https://{site}.chargebee.com/api/v2/subscriptions/{subscription_id}/remove_scheduled_changes

subscription

Resource object representing subscription.
always returned

customer

Resource object representing customer.
always returned

card

Resource object representing card.
optional

credit_notes

Resource object representing credit_note.
optional

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/8avVGOkx8U1MX/remove_scheduled_cancellation \
     -X POST  \
     -u {site_api_key}:

copy

curl  https://{site}.chargebee.com/api/v2/subscriptions/8avVGOkx8U1MX/remove_scheduled_cancellation \
     -X POST  \
     -u {site_api_key}:

Sample Response [ JSON ]

{
    "subscription": {
        "id": "8avVGOkx8U1MX",
        "customer_id": "8avVGOkx8U1MX",
        "plan_id": "basic",
        "plan_quantity": 1,
        "plan_unit_price": 900,
        "plan_amount": 900,
        "billing_period": 1,
        "billing_period_unit": "month",
        "plan_free_quantity": 0,
        "status": "active",
        "trial_start": 1412101824,
        "trial_end": 1414780224,
        "current_term_start": 1538332224,
        "current_term_end": 1541010624,
        "next_billing_at": 1541010624,
        "created_at": 1412101824,
        "started_at": 1412101824,
        "activated_at": 1414780224,
        "updated_at": 1539327227,
        "has_scheduled_changes": false,
        "resource_version": 1539327227000,
        "deleted": false,
        "object": "subscription",
        "currency_code": "USD",
        "due_invoices_count": 3,
        "due_since": 1394532759,
        "total_dues": 6700,
        "mrr": 900,
        "exchange_rate": 1.0,
        "base_currency_code": "USD",
        "shipping_address": {
            "first_name": "Benjamin",
            "last_name": "Ross",
            "line1": "PO Box 9999",
            "city": "Walnut",
            "state_code": "CA",
            "state": "California",
            "country": "US",
            "zip": "91789",
            "validation_status": "not_validated",
            "object": "shipping_address"
        }
    },
    "customer": {
        "id": "8avVGOkx8U1MX",
        "first_name": "Benjamin",
        "last_name": "Ross",
        "email": "Benjamin@test.com",
        "auto_collection": "on",
        "net_term_days": 0,
        "allow_direct_debit": false,
        "created_at": 1412101824,
        "taxability": "taxable",
        "updated_at": 1539327223,
        "pii_cleared": "active",
        "resource_version": 1539327223000,
        "deleted": false,
        "object": "customer",
        "card_status": "valid",
        "contacts": [
            {
                "id": "d334f4g45",
                "first_name": "aasca",
                "last_name": "asas",
                "email": "sss@wss.asc",
                "label": "ascasc",
                "enabled": true,
                "send_account_email": true,
                "send_billing_email": false,
                "object": "contact"
            },
            {..}
        ],
        "primary_payment_source_id": "pm_5SK0b55NR6FA9Uy8U",
        "payment_method": {
            "object": "payment_method",
            "type": "card",
            "reference_id": "cus_DlsHbEWTIBQzqP/card_1DKKWiJv9j0DyntJS8Wfexoe",
            "gateway": "stripe",
            "gateway_account_id": "gw_5SK0b54PR6F9Odm8y",
            "status": "valid"
        },
        "promotional_credits": 0,
        "refundable_credits": 0,
        "excess_payments": 0,
        "unbilled_charges": 0,
        "preferred_currency_code": "USD"
    },
    "card": {
        "status": "valid",
        "gateway": "stripe",
        "gateway_account_id": "gw_5SK0b54PR6F9Odm8y",
        "first_name": "Richard",
        "last_name": "Fox",
        "iin": "401288",
        "last4": "1881",
        "card_type": "visa",
        "funding_type": "credit",
        "expiry_month": 10,
        "expiry_year": 2022,
        "issuing_country": "CA",
        "object": "card",
        "masked_number": "************1881",
        "customer_id": "8avVGOkx8U1MX",
        "payment_source_id": "pm_5SK0b55NR6FA9Uy8U"
    }
}

URL Format POST

https://{site}.chargebee.com/api/v2/subscriptions/{subscription_id}/remove_scheduled_cancellation

billing_cycles

Number of cycles(plan interval) this subscription should be charged. After the billing cycles exhausted, the subscription will be cancelled.
optional, integer, min=0

subscription

Resource object representing subscription.
always returned

customer

Resource object representing customer.
always returned

card

Resource object representing card.
optional

Removes Coupons associated with the Subscription. If the param 'coupon_ids' is not specified, all the Coupons linked to the Subscription will be removed.

Sample Request

curl  https://{site}.chargebee.com/api/v2/subscriptions/8avVGOkx8U1MX/remove_coupons \
     -X POST  \
     -u {site_api_key}:

copy

curl  https://{site}.chargebee.com/api/v2/subscriptions/8avVGOkx8U1MX/remove_coupons \
     -X POST  \
     -u {site_api_key}:

Sample Response [ JSON ]

{
    "subscription": {
        "id": "RtSlqIzN6qkgFw",
        "customer_id": "RtSlqIzN6qkgFw",
        "plan_id": "basic",
        "plan_quantity": 1,
        "plan_unit_price": 900,
        "plan_amount": 900,
        "billing_period": 1,
        "billing_period_unit": "month",
        "plan_free_quantity": 0,
        "status": "in_trial",
        "trial_start": 1539327029,
        "trial_end": 1542005429,
        "next_billing_at": 1542005429,
        "created_at": 1539327029,
        "started_at": 1539327029,
        "updated_at": 1539327228,
        "has_scheduled_changes": false,
        "resource_version": 1539327228000,
        "deleted": false,
        "object": "subscription",
        "currency_code": "USD",
        "due_invoices_count": 0
    },
    "customer": {
        "id": "RtSlqIzN6qkgFw",
        "first_name": "Steve",
        "last_name": "Smith",
        "email": "Steve@test.com",
        "auto_collection": "on",
        "net_term_days": 0,
        "allow_direct_debit": false,
        "created_at": 1539327029,
        "taxability": "taxable",
        "updated_at": 1539327029,
        "pii_cleared": "active",
        "resource_version": 1539327029000,
        "deleted": false,
        "object": "customer",
        "card_status": "valid",
        "primary_payment_source_id": "pm_5SK0b54PR6F9L998T",
        "payment_method": {
            "object": "payment_method",
            "type": "card",
            "reference_id": "tok_5SK0b54PR6F9L928S",
            "gateway": "chargebee",
            "gateway_account_id": "gw_5SK0b54PR6F92Xh2",
            "status": "valid"
        },
        "promotional_credits": 0,
        "refundable_credits": 0,
        "excess_payments": 0,
        "unbilled_charges": 0,
        "preferred_currency_code": "USD"
    },
    "card": {
        "status": "valid",
        "gateway": "chargebee",
        "gateway_account_id": "gw_5SK0b54PR6F92Xh2",
        "iin": "411111",
        "last4": "1111",
        "card_type": "visa",
        "funding_type": "credit",
        "expiry_month": 1,
        "expiry_year": 2022,
        "object": "card",
        "masked_number": "************1111",
        "customer_id": "RtSlqIzN6qkgFw",
        "payment_source_id": "pm_5SK0b54PR6F9L998T"
    }
}

URL Format POST

https://{site}.chargebee.com/api/v2/subscriptions/{subscription_id}/remove_coupons

coupon_ids[0..n]

Identifier of the coupon as a List. Coupon Codes can also be passed.
optional, list of string

subscription

Resource object representing subscription.
always returned

customer

Resource object representing customer.
always returned

card

Resource object representing card.
optional

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. Please refer this 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

curl  https://{site}.chargebee.com/api/v2/subscriptions/8avVGOkx8U1MX \
     -u {site_api_key}: \
     -d plan_id="basic" \
     -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

curl  https://{site}.chargebee.com/api/v2/subscriptions/8avVGOkx8U1MX \
     -u {site_api_key}: \
     -d plan_id="basic" \
     -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"

Sample Response [ JSON ]

{
    "subscription": {
        "id": "8avVGOkx8U1MX",
        "customer_id": "8avVGOkx8U1MX",
        "plan_id": "basic",
        "plan_quantity": 1,
        "plan_unit_price": 900,
        "plan_amount": 900,
        "billing_period": 1,
        "billing_period_unit": "month",
        "plan_free_quantity": 0,
        "status": "active",
        "trial_start": 1412101824,
        "trial_end": 1414780224,
        "current_term_start": 1538332224,
        "current_term_end": 1541010624,
        "next_billing_at": 1541010624,
        "created_at": 1412101824,
        "started_at": 1412101824,
        "activated_at": 1414780224,
        "updated_at": 1539327228,
        "has_scheduled_changes": false,
        "resource_version": 1539327228000,
        "deleted": false,
        "object": "subscription",
        "currency_code": "USD",
        "due_invoices_count": 3,
        "due_since": 1394532759,
        "total_dues": 6700,
        "mrr": 900,
        "exchange_rate": 1.0,
        "base_currency_code": "USD",
        "shipping_address": {
            "first_name": "Benjamin",
            "last_name": "Ross",
            "line1": "PO Box 9999",
            "city": "Walnut",
            "state_code": "CA",
            "state": "California",
            "country": "US",
            "zip": "91789",
            "validation_status": "not_validated",
            "object": "shipping_address"
        }
    },
    "customer": {
        "id": "8avVGOkx8U1MX",
        "first_name": "Benjamin",
        "last_name": "Ross",
        "email": "Benjamin@test.com",
        "auto_collection": "on",
        "net_term_days": 0,
        "allow_direct_debit": false,
        "created_at": 1412101824,
        "taxability": "taxable",
        "updated_at": 1539327228,
        "pii_cleared": "active",
        "resource_version": 1539327228000,
        "deleted": false,
        "object": "customer",
        "billing_address": {
            "first_name": "John",
            "last_name": "Doe",
            "line1": "PO Box 9999",
            "city": "Walnut",
            "state_code": "CA",
            "state": "California",
            "country": "US",
            "zip": "91789",
            "validation_status": "not_validated",
            "object": "billing_address"
        },
        "card_status": "valid",
        "contacts": [
            {
                "id": "d334f4g45",
                "first_name": "aasca",
                "last_name": "asas",
                "email": "sss@wss.asc",
                "label": "ascasc",
                "enabled": true,
                "send_account_email": true,
                "send_billing_email": false,
                "object": "contact"
            },
            {..}
        ],
        "primary_payment_source_id": "pm_5SK0b55NR6FA9Uy8U",
        "payment_method": {
            "object": "payment_method",
            "type": "card",
            "reference_id": "cus_DlsHbEWTIBQzqP/card_1DKKWiJv9j0DyntJS8Wfexoe",
            "gateway": "stripe",
            "gateway_account_id": "gw_5SK0b54PR6F9Odm8y",
            "status": "valid"
        },
        "promotional_credits": 0,
        "refundable_credits": 0,
        "excess_payments": 0,
        "unbilled_charges": 0,
        "preferred_currency_code": "USD"
    },
    "card": {
        "status": "valid",
        "gateway": "stripe",
        "gateway_account_id": "gw_5SK0b54PR6F9Odm8y",
        "first_name": "Richard",
        "last_name": "Fox",
        "iin": "401288",
        "last4": "1881",
        "card_type": "visa",
        "funding_type": "credit",
        "expiry_month": 10,
        "expiry_year": 2022,
        "issuing_country": "CA",
        "object": "card",
        "masked_number": "************1881",
        "customer_id": "8avVGOkx8U1MX",
        "payment_source_id": "pm_5SK0b55NR6FA9Uy8U"
    },
    "credit_notes": []
}

URL Format POST

https://{site}.chargebee.com/api/v2/subscriptions/{subscription_id}

plan_id

Identifier of the plan for this subscription.
optional, string, max chars=100

plan_quantity

Represents the plan quantity for this subscription.
optional, integer, min=1

plan_unit_price

Amount that will override the Plan's default price.
optional, in cents, min=0

setup_fee

Amount that will override the default setup fee.
optional, in cents, min=0

start_date

Applicable only for 'future' subscriptions. The new start date of the 'future' subscription.
optional, timestamp(UTC) in seconds

trial_end

The time at which the trial should end for this subscription. Can be specified to override the default trial period defined in plan. If '0' is passed, the subscription will be activated immediately.
optional, timestamp(UTC) in seconds

billing_cycles

Number of cycles(plan interval) this subscription should be charged. After the billing cycles exhausted, the subscription will be cancelled.
optional, integer, min=0

replace_addon_list

Should be true if the existing addons should be replaced with the ones that are being passed.
optional, boolean

mandatory_addons_to_remove[0..n]

List of addons IDs that are mandatory to the plan and has to be removed from the subscription.
optional, list of string

terms_to_charge

reactivate_from

The time from which this subscription should be reactivated.
optional, timestamp(UTC) in seconds

billing_alignment_mode

Applicable when calendar billing is enabled and a new term gets started during this operation. Unless specified the configured default value will be used.
optional, enumerated string

Possible values are

po_number

Purchase Order Number for this subscription.
optional, string, max chars=100

coupon_ids[0..n]

Identifier of the coupon as a List. Coupon Codes can also be passed.
optional, list of string

replace_coupon_list

Should be true if the existing coupons should be replaced with the ones that are being passed.
optional, boolean

prorate

Add Prorated Credits and Charges, if applicable, while updating the subscription. If this parameter is not passed, the default value set in the Site Settings will be used. Else, it will be assumed as true.
optional, boolean

end_of_term

You can specify when you want to update the subscription.
optional, boolean

force_term_reset

Applicable for 'Active' & 'Non Renewing' states alone. Generally, subscription's term will be reset (i.e current term is ended and a new term starts immediately) when a new plan having different billing frequency is specified in the input. For all the other cases, the subscription's term will remain intact. Now for this later scenario, if you want to force a term reset you can specify this param as 'true'.
Note: Specifying this value as 'false' has no impact on the default behaviour.
optional, boolean, default=false

reactivate

Applicable only for cancelled subscriptions. Once this is passed as true, cancelled subscription will become active; otherwise subscription changes will be made but the the subscription state will remain cancelled. If not passed, subscription will be activated only if there is any change in subscription data.
optional, boolean

invoice_notes

Invoice Notes for this resource. Read More.
optional, string, max chars=1000

meta_data

Additional data about this resource can be stored here in the JSON Format. Learn more.
optional, jsonobject

invoice_immediately

card

Parameters for card
pass parameters as card[<param name>]

card[gateway_account_id]

The gateway account in which this payment source is stored.
optional, string, max chars=50

card[first_name]

Cardholder's first name.
optional, string, max chars=50

card[last_name]

Cardholder's last name.
optional, string, max chars=50

card[number]

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

card[expiry_month]

Card expiry month.
required if card provided, integer, min=1, max=12

card[expiry_year]

Card expiry year.
required if card provided, integer

card[cvv]

The card verification value. If you are using Braintree.js, you can specify the Braintree encrypted cvv here.
optional, string, max chars=520

card[billing_addr1]

Address line 1, as available in card billing address.
optional, string, max chars=150

card[billing_addr2]

Address line 2, as available in card billing address.
optional, string, max chars=150

card[billing_city]

City, as available in card billing address.
optional, string, max chars=50

card[billing_state_code]

card[billing_state]

The state/province name. Use this to pass the state/province information for cases where 'state_code' is not supported or cannot be passed.
optional, string, max chars=50

card[billing_zip]

Postal or Zip code, as available in card billing address.
optional, string, max chars=20

card[billing_country]

2-letter ISO 3166 alpha-2 country code.
optional, string, max chars=50

payment_method

Parameters for payment_method
pass parameters as payment_method[<param name>]

payment_method[type]

The type of payment method. For more details refer Update payment method for a customer API under Customer resource.
optional, enumerated string

Possible values are

genericGeneric Payment Method.alipayAlipay Payments.unionpayUnionPay Payments.apple_payApple Pay Payments.wechat_payWeChat Pay Payments.

Show all values[+]

payment_method[gateway_account_id]

The gateway account in which this payment source is stored.
optional, string, max chars=50

payment_method[reference_id]

payment_method[tmp_token]

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

payment_method[issuing_country]

2-letter (alpha2) ISO country code. Indicates your customer's payment method country of issuance. Applicable for PayPal via Braintree.
optional, string, max chars=50

billing_address

Parameters for billing_address
pass parameters as billing_address[<param name>]

billing_address[first_name]

First name.
optional, string, max chars=150

billing_address[last_name]

Last name.
optional, string, max chars=150

billing_address[email]

Email.
optional, string, max chars=70

billing_address[company]

Company name.
optional, string, max chars=250

billing_address[phone]

Phone number.
optional, string, max chars=50

billing_address[line1]

Address line 1.
optional, string, max chars=150

billing_address[line2]

Address line 2.
optional, string, max chars=150

billing_address[line3]

Address line 3.
optional, string, max chars=150

billing_address[city]

City.
optional, string, max chars=50

billing_address[state_code]

billing_address[state]

The state/province name. Use this to pass the state/province information for cases where 'state_code' is not supported or cannot be passed.
optional, string, max chars=50

billing_address[zip]

Zip or Postal code.
optional, string, max chars=20

billing_address[country]

2-letter ISO 3166 alpha-2 country code.
optional, string, max chars=50

billing_address[validation_status]

The address verification status.
optional, enumerated string

Possible values are

not_validatedAddress is not yet validated.validAddress was validated successfully.partially_validAddress is verified but only partially.invalidAddress is invalid.

shipping_address

Parameters for shipping_address
pass parameters as shipping_address[<param name>]

shipping_address[first_name]

First name.
optional, string, max chars=150

shipping_address[last_name]

Last name.
optional, string, max chars=150

shipping_address[email]

Email.
optional, string, max chars=70

shipping_address[company]

Company name.
optional, string, max chars=250

shipping_address[phone]

Phone number.
optional, string, max chars=50

shipping_address[line1]

Address line 1.
optional, string, max chars=180

shipping_address[line2]

Address line 2.
optional, string, max chars=150

shipping_address[line3]

Address line 3.
optional, string, max chars=150

shipping_address[city]

City.
optional, string, max chars=50

shipping_address[state_code]

shipping_address[state]

The state/province name. Use this to pass the state/province information for cases where 'state_code' is not supported or cannot be passed.
optional, string, max chars=50

shipping_address[zip]

Zip or Postal code.
optional, string, max chars=20

shipping_address[country]

2-letter ISO 3166 alpha-2 country code.
optional, string, max chars=50

shipping_address[validation_status]

The address verification status.
optional, enumerated string

Possible values are

not_validatedAddress is not yet validated.validAddress was validated successfully.partially_validAddress is verified but only partially.invalidAddress is invalid.

customer

Parameters for customer
pass parameters as customer[<param name>]

customer[vat_number]

VAT/ Tax registration number of the customer. Learn more.
optional, string, max chars=20

customer[registered_for_gst]

Confirms that a customer is registered under GST. This field is available for Australia only.
optional, boolean

addons

Parameters for addons. Multiple addons can be passed by specifying unique indices.
pass parameters as addons[<param name>][<idx:0..n>]

addons[id][0..n]

Identifier of the addon. Multiple addons can be passed.
optional, string, max chars=100

addons[quantity][0..n]

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

addons[unit_price][0..n]

addons[billing_cycles][0..n]

Number of billing cycles the addon will be charged for.
optional, integer, min=1

addons[trial_end][0..n]

The time at which the trial ends for the addon. Trial end cannot be updated for addons which are attached to subscriptions. In order to use this param please contact support@chargebee.com.
optional, timestamp(UTC) in seconds

event_based_addons

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

event_based_addons[id][0..n]

A unique 'id' used to identify the addon.
optional, string, max chars=100

event_based_addons[quantity][0..n]

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

event_based_addons[unit_price][0..n]

Amount that will override the Addon's default price.
optional, in cents, min=0

event_based_addons[charge_on][0..n]

Indicates when the non-recurring addon will be charged.
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_based_addons[on_event][0..n]

Event on which this addon will be charged.
optional, enumerated string

Possible values are

event_based_addons[charge_once][0..n]

If enabled, the addon will be charged only at the first occurrence of the event. Applicable only for non-recurring add-ons.
optional, boolean

subscription

Resource object representing subscription.
always returned

customer

Resource object representing customer.
always returned

card

Resource object representing card.
optional

invoice

Resource object representing invoice.
optional

unbilled_charges

Resource object representing unbilled_charge.
optional

credit_notes

Resource object representing credit_note.
optional

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/8avVGOkx8U1MX/change_term_end \
     -u {site_api_key}: \
     -d term_ends_at="1609459199"

copy

curl  https://{site}.chargebee.com/api/v2/subscriptions/8avVGOkx8U1MX/change_term_end \
     -u {site_api_key}: \
     -d term_ends_at="1609459199"

Sample Response [ JSON ]

{
    "subscription": {
        "id": "8avVGOkx8U1MX",
        "customer_id": "8avVGOkx8U1MX",
        "plan_id": "basic",
        "plan_quantity": 1,
        "plan_unit_price": 900,
        "plan_amount": 900,
        "billing_period": 1,
        "billing_period_unit": "month",
        "plan_free_quantity": 0,
        "status": "active",
        "trial_start": 1412101824,
        "trial_end": 1414780224,
        "current_term_start": 1538332224,
        "current_term_end": 1609459199,
        "next_billing_at": 1609459199,
        "created_at": 1412101824,
        "started_at": 1412101824,
        "activated_at": 1414780224,
        "updated_at": 1539327228,
        "has_scheduled_changes": false,
        "resource_version": 1539327228000,
        "deleted": false,
        "object": "subscription",
        "currency_code": "USD",
        "due_invoices_count": 3,
        "due_since": 1394532759,
        "total_dues": 6700,
        "mrr": 900,
        "exchange_rate": 1.0,
        "base_currency_code": "USD",
        "shipping_address": {
            "first_name": "Benjamin",
            "last_name": "Ross",
            "line1": "PO Box 9999",
            "city": "Walnut",
            "state_code": "CA",
            "state": "California",
            "country": "US",
            "zip": "91789",
            "validation_status": "not_validated",
            "object": "shipping_address"
        }
    },
    "customer": {
        "id": "8avVGOkx8U1MX",
        "first_name": "Benjamin",
        "last_name": "Ross",
        "email": "Benjamin@test.com",
        "auto_collection": "on",
        "net_term_days": 0,
        "allow_direct_debit": false,
        "created_at": 1412101824,
        "taxability": "taxable",
        "updated_at": 1539327228,
        "pii_cleared": "active",
        "resource_version": 1539327228000,
        "deleted": false,
        "object": "customer",
        "billing_address": {
            "first_name": "John",
            "last_name": "Doe",
            "line1": "PO Box 9999",
            "city": "Walnut",
            "state_code": "CA",
            "state": "California",
            "country": "US",
            "zip": "91789",
            "validation_status": "not_validated",
            "object": "billing_address"
        },
        "card_status": "valid",
        "contacts": [
            {
                "id": "d334f4g45",
                "first_name": "aasca",
                "last_name": "asas",
                "email": "sss@wss.asc",
                "label": "ascasc",
                "enabled": true,
                "send_account_email": true,
                "send_billing_email": false,
                "object": "contact"
            },
            {..}
        ],
        "primary_payment_source_id": "pm_5SK0b55NR6FA9Uy8U",
        "payment_method": {
            "object": "payment_method",
            "type": "card",
            "reference_id": "cus_DlsHbEWTIBQzqP/card_1DKKWiJv9j0DyntJS8Wfexoe",
            "gateway": "stripe",
            "gateway_account_id": "gw_5SK0b54PR6F9Odm8y",
            "status": "valid"
        },
        "promotional_credits": 0,
        "refundable_credits": 0,
        "excess_payments": 0,
        "unbilled_charges": 0,
        "preferred_currency_code": "USD"
    },
    "card": {
        "status": "valid",
        "gateway": "stripe",
        "gateway_account_id": "gw_5SK0b54PR6F9Odm8y",
        "first_name": "Richard",
        "last_name": "Fox",
        "iin": "401288",
        "last4": "1881",
        "card_type": "visa",
        "funding_type": "credit",
        "expiry_month": 10,
        "expiry_year": 2022,
        "issuing_country": "CA",
        "object": "card",
        "masked_number": "************1881",
        "customer_id": "8avVGOkx8U1MX",
        "payment_source_id": "pm_5SK0b55NR6FA9Uy8U"
    }
}

URL Format POST

https://{site}.chargebee.com/api/v2/subscriptions/{subscription_id}/change_term_end

term_ends_at

The time at which the current term should end for this subscription.
required, timestamp(UTC) in seconds

prorate

Applicable for active / non_renewing subscriptions. If specified as true prorated charges / credits will be added during this operation.
optional, boolean

invoice_immediately

subscription

Resource object representing subscription.
always returned

customer

Resource object representing customer.
always returned

card

Resource object representing card.
optional

invoice

Resource object representing invoice.
optional

unbilled_charges

Resource object representing unbilled_charge.
optional

credit_notes

Resource object representing credit_note.
optional

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.

Notes

Advance charges, if any, will be refunded as credits.

Sample Request

curl  https://{site}.chargebee.com/api/v2/subscriptions/8avVGOkx8U1MX/cancel \
     -X POST  \
     -u {site_api_key}:

copy

curl  https://{site}.chargebee.com/api/v2/subscriptions/8avVGOkx8U1MX/cancel \
     -X POST  \
     -u {site_api_key}:

Sample Response [ JSON ]

{
    "subscription": {
        "id": "8avVGOkx8U1MX",
        "customer_id": "8avVGOkx8U1MX",
        "plan_id": "basic",
        "plan_quantity": 1,
        "plan_unit_price": 900,
        "plan_amount": 900,
        "billing_period": 1,
        "billing_period_unit": "month",
        "plan_free_quantity": 0,
        "status": "cancelled",
        "trial_start": 1412101824,
        "trial_end": 1414780224,
        "current_term_start": 1538332224,
        "current_term_end": 1539327228,
        "created_at": 1412101824,
        "started_at": 1412101824,
        "activated_at": 1414780224,
        "cancelled_at": 1539327228,
        "updated_at": 1539327229,
        "has_scheduled_changes": false,
        "resource_version": 1539327229000,
        "deleted": false,
        "object": "subscription",
        "currency_code": "USD",
        "due_invoices_count": 3,
        "due_since": 1394532759,
        "total_dues": 6700,
        "mrr": 0,
        "shipping_address": {
            "first_name": "Benjamin",
            "last_name": "Ross",
            "line1": "PO Box 9999",
            "city": "Walnut",
            "state_code": "CA",
            "state": "California",
            "country": "US",
            "zip": "91789",
            "validation_status": "not_validated",
            "object": "shipping_address"
        }
    },
    "customer": {
        "id": "8avVGOkx8U1MX",
        "first_name": "Benjamin",
        "last_name": "Ross",
        "email": "Benjamin@test.com",
        "auto_collection": "on",
        "net_term_days": 0,
        "allow_direct_debit": false,
        "created_at": 1412101824,
        "taxability": "taxable",
        "updated_at": 1539327228,
        "pii_cleared": "active",
        "resource_version": 1539327228000,
        "deleted": false,
        "object": "customer",
        "billing_address": {
            "first_name": "John",
            "last_name": "Doe",
            "line1": "PO Box 9999",
            "city": "Walnut",
            "state_code": "CA",
            "state": "California",
            "country": "US",
            "zip": "91789",
            "validation_status": "not_validated",
            "object": "billing_address"
        },
        "card_status": "valid",
        "contacts": [
            {
                "id": "d334f4g45",
                "first_name": "aasca",
                "last_name": "asas",
                "email": "sss@wss.asc",
                "label": "ascasc",
                "enabled": true,
                "send_account_email": true,
                "send_billing_email": false,
                "object": "contact"
            },
            {..}
        ],
        "primary_payment_source_id": "pm_5SK0b55NR6FA9Uy8U",
        "payment_method": {
            "object": "payment_method",
            "type": "card",
            "reference_id": "cus_DlsHbEWTIBQzqP/card_1DKKWiJv9j0DyntJS8Wfexoe",
            "gateway": "stripe",
            "gateway_account_id": "gw_5SK0b54PR6F9Odm8y",
            "status": "valid"
        },
        "promotional_credits": 0,
        "refundable_credits": 0,
        "excess_payments": 0,
        "unbilled_charges": 0,
        "preferred_currency_code": "USD"
    },
    "card": {
        "status": "valid",
        "gateway": "stripe",
        "gateway_account_id": "gw_5SK0b54PR6F9Odm8y",
        "first_name": "Richard",
        "last_name": "Fox",
        "iin": "401288",
        "last4": "1881",
        "card_type": "visa",
        "funding_type": "credit",
        "expiry_month": 10,
        "expiry_year": 2022,
        "issuing_country": "CA",
        "object": "card",
        "masked_number": "************1881",
        "customer_id": "8avVGOkx8U1MX",
        "payment_source_id": "pm_5SK0b55NR6FA9Uy8U"
    }
}

URL Format POST

https://{site}.chargebee.com/api/v2/subscriptions/{subscription_id}/cancel

end_of_term

You can specify when you want to cancel the subscription.
optional, boolean, default=false

credit_option_for_current_term_charges

Specify this if you want to issue credits against the current term charges. Not applicable when 'end_of_term' is true.
optional, enumerated string

Possible values are

noneNo credits will be issued against current term charges.prorateProrated credits for the unused period will be issued against current term charges.fullCredits will be issued for all the current term charges.

unbilled_charges_option

Applicable when unbilled charges are present for this subscription. If specified as delete, these charges will be deleted instead of getting invoiced 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’. Not applicable when 'end_of_term' is true.
optional, enumerated string

Possible values are

invoiceUnbilled charges will be raised as an invoice. An attempt to collect payment will be made.deleteUnbilled charges will be deleted.

account_receivables_handling

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

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.

refundable_credits_handling

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

Possible values are

no_actionNo action is taken. .schedule_refundInitiates refund of the remaining credits.

subscription

Resource object representing subscription.
always returned

customer

Resource object representing customer.
always returned

card

Resource object representing card.
optional

invoice

Resource object representing invoice.
optional

unbilled_charges

Resource object representing unbilled_charge.
optional

credit_notes

Resource object representing credit_note.
optional

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 canceled 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/8avVGOkx8U1MX/reactivate \
     -X POST  \
     -u {site_api_key}:

copy

curl  https://{site}.chargebee.com/api/v2/subscriptions/8avVGOkx8U1MX/reactivate \
     -X POST  \
     -u {site_api_key}:

Sample Response [ JSON ]

{
    "subscription": {
        "id": "8avVGOkx8U1MX",
        "customer_id": "8avVGOkx8U1MX",
        "plan_id": "basic",
        "plan_quantity": 1,
        "plan_unit_price": 900,
        "plan_amount": 900,
        "billing_period": 1,
        "billing_period_unit": "month",
        "plan_free_quantity": 0,
        "status": "active",
        "trial_start": 1412101824,
        "trial_end": 1414780224,
        "current_term_start": 1539327229,
        "current_term_end": 1542005629,
        "next_billing_at": 1542005629,
        "created_at": 1412101824,
        "started_at": 1412101824,
        "activated_at": 1539327229,
        "updated_at": 1539327233,
        "has_scheduled_changes": false,
        "resource_version": 1539327233000,
        "deleted": false,
        "object": "subscription",
        "currency_code": "USD",
        "due_invoices_count": 3,
        "due_since": 1394532759,
        "total_dues": 6700,
        "mrr": 900,
        "exchange_rate": 1.0,
        "base_currency_code": "USD",
        "shipping_address": {
            "first_name": "Benjamin",
            "last_name": "Ross",
            "line1": "PO Box 9999",
            "city": "Walnut",
            "state_code": "CA",
            "state": "California",
            "country": "US",
            "zip": "91789",
            "validation_status": "not_validated",
            "object": "shipping_address"
        }
    },
    "customer": {
        "id": "8avVGOkx8U1MX",
        "first_name": "Benjamin",
        "last_name": "Ross",
        "email": "Benjamin@test.com",
        "auto_collection": "on",
        "net_term_days": 0,
        "allow_direct_debit": false,
        "created_at": 1412101824,
        "taxability": "taxable",
        "updated_at": 1539327228,
        "pii_cleared": "active",
        "resource_version": 1539327228000,
        "deleted": false,
        "object": "customer",
        "billing_address": {
            "first_name": "John",
            "last_name": "Doe",
            "line1": "PO Box 9999",
            "city": "Walnut",
            "state_code": "CA",
            "state": "California",
            "country": "US",
            "zip": "91789",
            "validation_status": "not_validated",
            "object": "billing_address"
        },
        "card_status": "valid",
        "contacts": [
            {
                "id": "d334f4g45",
                "first_name": "aasca",
                "last_name": "asas",
                "email": "sss@wss.asc",
                "label": "ascasc",
                "enabled": true,
                "send_account_email": true,
                "send_billing_email": false,
                "object": "contact"
            },
            {..}
        ],
        "primary_payment_source_id": "pm_5SK0b55NR6FA9Uy8U",
        "payment_method": {
            "object": "payment_method",
            "type": "card",
            "reference_id": "cus_DlsHbEWTIBQzqP/card_1DKKWiJv9j0DyntJS8Wfexoe",
            "gateway": "stripe",
            "gateway_account_id": "gw_5SK0b54PR6F9Odm8y",
            "status": "valid"
        },
        "promotional_credits": 0,
        "refundable_credits": 0,
        "excess_payments": 0,
        "unbilled_charges": 0,
        "preferred_currency_code": "USD"
    },
    "card": {
        "status": "valid",
        "gateway": "stripe",
        "gateway_account_id": "gw_5SK0b54PR6F9Odm8y",
        "first_name": "Richard",
        "last_name": "Fox",
        "iin": "401288",
        "last4": "1881",
        "card_type": "visa",
        "funding_type": "credit",
        "expiry_month": 10,
        "expiry_year": 2022,
        "issuing_country": "CA",
        "object": "card",
        "masked_number": "************1881",
        "customer_id": "8avVGOkx8U1MX",
        "payment_source_id": "pm_5SK0b55NR6FA9Uy8U"
    },
    "invoice": {
        "id": "81",
        "customer_id": "8avVGOkx8U1MX",
        "subscription_id": "8avVGOkx8U1MX",
        "recurring": true,
        "status": "paid",
        "price_type": "tax_exclusive",
        "date": 1539327229,
        "due_date": 1539327229,
        "net_term_days": 0,
        "exchange_rate": 1.0,
        "total": 900,
        "amount_paid": 900,
        "amount_adjusted": 0,
        "write_off_amount": 0,
        "credits_applied": 0,
        "amount_due": 0,
        "paid_at": 1539327228,
        "updated_at": 1539327233,
        "resource_version": 1539327233000,
        "deleted": false,
        "object": "invoice",
        "first_invoice": false,
        "amount_to_collect": 0,
        "round_off_amount": 0,
        "has_advance_charges": false,
        "currency_code": "USD",
        "base_currency_code": "USD",
        "tax": 0,
        "line_items": [
            {
                "id": "li_5SK0b55NR6FABGT9E",
                "date_from": 1539327229,
                "date_to": 1542005629,
                "unit_amount": 900,
                "quantity": 1,
                "amount": 900,
                "pricing_model": "per_unit",
                "is_taxed": false,
                "tax_amount": 0,
                "object": "line_item",
                "subscription_id": "8avVGOkx8U1MX",
                "description": "sample plan",
                "entity_type": "plan",
                "entity_id": "basic",
                "tax_exempt_reason": "tax_not_configured",
                "discount_amount": 0,
                "item_level_discount_amount": 0
            },
            {..}
        ],
        "sub_total": 900,
        "linked_payments": [
            {
                "txn_id": "txn_5SK0b55NR6FABIs9F",
                "applied_amount": 900,
                "applied_at": 1539327233,
                "txn_status": "success",
                "txn_date": 1539327228,
                "txn_amount": 900
            },
            {..}
        ],
        "applied_credits": [],
        "adjustment_credit_notes": [],
        "issued_credit_notes": [],
        "linked_orders": [],
        "billing_address": {
            "first_name": "John",
            "last_name": "Doe",
            "line1": "PO Box 9999",
            "city": "Walnut",
            "state_code": "CA",
            "state": "California",
            "country": "US",
            "zip": "91789",
            "validation_status": "not_validated",
            "object": "billing_address"
        },
        "shipping_address": {
            "first_name": "Benjamin",
            "last_name": "Ross",
            "line1": "PO Box 9999",
            "city": "Walnut",
            "state_code": "CA",
            "state": "California",
            "country": "US",
            "zip": "91789",
            "validation_status": "not_validated",
            "object": "shipping_address"
        }
    }
}

URL Format POST

https://{site}.chargebee.com/api/v2/subscriptions/{subscription_id}/reactivate

trial_end

The time at which the trial should end for this subscription.
optional, timestamp(UTC) in seconds

billing_cycles

Number of cycles(plan interval) this subscription should be charged. After the billing cycles exhausted, the subscription will be cancelled.
optional, integer, min=0

reactivate_from

The time from which this subscription should be reactivated.
optional, timestamp(UTC) in seconds

invoice_immediately

billing_alignment_mode

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

Possible values are

terms_to_charge

subscription

Resource object representing subscription.
always returned

customer

Resource object representing customer.
always returned

card

Resource object representing card.
optional

invoice

Resource object representing invoice.
optional

unbilled_charges

Resource object representing unbilled_charge.
optional

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/8avVGOkx8U1MX/add_charge_at_term_end \
     -u {site_api_key}: \
     -d amount="1000" \
     -d description="Support charge"

copy

curl  https://{site}.chargebee.com/api/v2/subscriptions/8avVGOkx8U1MX/add_charge_at_term_end \
     -u {site_api_key}: \
     -d amount="1000" \
     -d description="Support charge"

Sample Response [ JSON ]

{"estimate": {
    "created_at": 1539327234,
    "object": "estimate",
    "subscription_estimate": {
        "id": "8avVGOkx8U1MX",
        "status": "active",
        "next_billing_at": 1542005629,
        "object": "subscription_estimate",
        "currency_code": "USD",
        "shipping_address": {
            "first_name": "Benjamin",
            "last_name": "Ross",
            "line1": "PO Box 9999",
            "city": "Walnut",
            "state_code": "CA",
            "state": "California",
            "country": "US",
            "zip": "91789",
            "validation_status": "not_validated",
            "object": "shipping_address"
        }
    },
    "invoice_estimate": {
        "recurring": true,
        "price_type": "tax_exclusive",
        "sub_total": 1900,
        "total": 1900,
        "credits_applied": 0,
        "amount_paid": 0,
        "amount_due": 1900,
        "object": "invoice_estimate",
        "line_items": [
            {
                "id": "li_5SK0b55NR6FACWo9K",
                "date_from": 1539327234,
                "date_to": 1539327234,
                "unit_amount": 1000,
                "quantity": 1,
                "amount": 1000,
                "pricing_model": "flat_fee",
                "is_taxed": false,
                "tax_amount": 0,
                "object": "line_item",
                "subscription_id": "8avVGOkx8U1MX",
                "description": "Support charge",
                "entity_type": "adhoc",
                "discount_amount": 0,
                "item_level_discount_amount": 0
            },
            {..}
        ],
        "taxes": [],
        "line_item_taxes": [],
        "currency_code": "USD",
        "round_off_amount": 0,
        "line_item_discounts": []
    }
}}

URL Format POST

https://{site}.chargebee.com/api/v2/subscriptions/{subscription_id}/add_charge_at_term_end

amount

The amount to be charged.
required, in cents, min=1

description

Description for this charge.
required, string, max chars=250

estimate

Resource object representing estimate.
always returned

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/8avVGOkx8U1MX/charge_addon_at_term_end \
     -u {site_api_key}: \
     -d addon_id="ssl"

copy

curl  https://{site}.chargebee.com/api/v2/subscriptions/8avVGOkx8U1MX/charge_addon_at_term_end \
     -u {site_api_key}: \
     -d addon_id="ssl"

Sample Response [ JSON ]

{"estimate": {
    "created_at": 1539327234,
    "object": "estimate",
    "subscription_estimate": {
        "id": "8avVGOkx8U1MX",
        "status": "active",
        "next_billing_at": 1542005629,
        "object": "subscription_estimate",
        "currency_code": "USD",
        "shipping_address": {
            "first_name": "Benjamin",
            "last_name": "Ross",
            "line1": "PO Box 9999",
            "city": "Walnut",
            "state_code": "CA",
            "state": "California",
            "country": "US",
            "zip": "91789",
            "validation_status": "not_validated",
            "object": "shipping_address"
        }
    },
    "invoice_estimate": {
        "recurring": true,
        "price_type": "tax_exclusive",
        "sub_total": 2900,
        "total": 2900,
        "credits_applied": 0,
        "amount_paid": 0,
        "amount_due": 2900,
        "object": "invoice_estimate",
        "line_items": [
            {
                "id": "li_5SK0b55NR6FACWo9K",
                "date_from": 1539327234,
                "date_to": 1539327234,
                "unit_amount": 1000,
                "quantity": 1,
                "amount": 1000,
                "pricing_model": "flat_fee",
                "is_taxed": false,
                "tax_amount": 0,
                "object": "line_item",
                "subscription_id": "8avVGOkx8U1MX",
                "description": "Support charge",
                "entity_type": "adhoc",
                "discount_amount": 0,
                "item_level_discount_amount": 0
            },
            {..}
        ],
        "taxes": [],
        "line_item_taxes": [],
        "currency_code": "USD",
        "round_off_amount": 0,
        "line_item_discounts": []
    }
}}

URL Format POST

https://{site}.chargebee.com/api/v2/subscriptions/{subscription_id}/charge_addon_at_term_end

addon_id

The ID of the non-recurring addon to be charged.
required, string, max chars=100

addon_quantity

The number of addon units to be charged. Mandatory for quantity based addons.
optional, integer, min=1

addon_unit_price

Amount that will override the Addon's default price.
optional, in cents, default=addon amount, min=0

estimate

Resource object representing estimate.
always returned

Use this API to create an advance invoice for the future renewals of a subscription. This operation will charge your customer if they have a payment method and Auto Collection is turned on. Any changes scheduled for the subscription will be considered while generating an advance invoice. Read More.

Notes

This operation is not supported for non-renewing and canceled subscriptions.

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/8avVGOkx8U1MX/charge_future_renewals \
     -u {site_api_key}: \
     -d terms_to_charge="1"

copy

curl  https://{site}.chargebee.com/api/v2/subscriptions/8avVGOkx8U1MX/charge_future_renewals \
     -u {site_api_key}: \
     -d terms_to_charge="1"

Sample Response [ JSON ]

{
    "subscription": {
        "id": "8avVGOkx8U1MX",
        "customer_id": "8avVGOkx8U1MX",
        "plan_id": "basic",
        "plan_quantity": 1,
        "plan_unit_price": 900,
        "plan_amount": 900,
        "billing_period": 1,
        "billing_period_unit": "month",
        "plan_free_quantity": 0,
        "status": "active",
        "trial_start": 1412101824,
        "trial_end": 1414780224,
        "current_term_start": 1539327229,
        "current_term_end": 1542005629,
        "next_billing_at": 1544597629,
        "created_at": 1412101824,
        "started_at": 1412101824,
        "activated_at": 1539327229,
        "updated_at": 1539327233,
        "has_scheduled_changes": false,
        "resource_version": 1539327233000,
        "deleted": false,
        "object": "subscription",
        "currency_code": "USD",
        "due_invoices_count": 3,
        "due_since": 1394532759,
        "total_dues": 6700,
        "mrr": 900,
        "exchange_rate": 1.0,
        "base_currency_code": "USD",
        "shipping_address": {
            "first_name": "Benjamin",
            "last_name": "Ross",
            "line1": "PO Box 9999",
            "city": "Walnut",
            "state_code": "CA",
            "state": "California",
            "country": "US",
            "zip": "91789",
            "validation_status": "not_validated",
            "object": "shipping_address"
        }
    },
    "customer": {
        "id": "8avVGOkx8U1MX",
        "first_name": "Benjamin",
        "last_name": "Ross",
        "email": "Benjamin@test.com",
        "auto_collection": "on",
        "net_term_days": 0,
        "allow_direct_debit": false,
        "created_at": 1412101824,
        "taxability": "taxable",
        "updated_at": 1539327240,
        "pii_cleared": "active",
        "resource_version": 1539327240000,
        "deleted": false,
        "object": "customer",
        "billing_address": {
            "first_name": "John",
            "last_name": "Doe",
            "line1": "PO Box 9999",
            "city": "Walnut",
            "state_code": "CA",
            "state": "California",
            "country": "US",
            "zip": "91789",
            "validation_status": "not_validated",
            "object": "billing_address"
        },
        "card_status": "valid",
        "contacts": [
            {
                "id": "d334f4g45",
                "first_name": "aasca",
                "last_name": "asas",
                "email": "sss@wss.asc",
                "label": "ascasc",
                "enabled": true,
                "send_account_email": true,
                "send_billing_email": false,
                "object": "contact"
            },
            {..}
        ],
        "primary_payment_source_id": "pm_5SK0b55NR6FA9Uy8U",
        "payment_method": {
            "object": "payment_method",
            "type": "card",
            "reference_id": "cus_DlsHbEWTIBQzqP/card_1DKKWiJv9j0DyntJS8Wfexoe",
            "gateway": "stripe",
            "gateway_account_id": "gw_5SK0b54PR6F9Odm8y",
            "status": "valid"
        },
        "promotional_credits": 0,
        "refundable_credits": 0,
        "excess_payments": 0,
        "unbilled_charges": 0,
        "preferred_currency_code": "USD"
    },
    "card": {
        "status": "valid",
        "gateway": "stripe",
        "gateway_account_id": "gw_5SK0b54PR6F9Odm8y",
        "first_name": "Richard",
        "last_name": "Fox",
        "iin": "401288",
        "last4": "1881",
        "card_type": "visa",
        "funding_type": "credit",
        "expiry_month": 10,
        "expiry_year": 2022,
        "issuing_country": "CA",
        "object": "card",
        "masked_number": "************1881",
        "customer_id": "8avVGOkx8U1MX",
        "payment_source_id": "pm_5SK0b55NR6FA9Uy8U"
    },
    "invoice": {
        "id": "82",
        "customer_id": "8avVGOkx8U1MX",
        "subscription_id": "8avVGOkx8U1MX",
        "recurring": true,
        "status": "paid",
        "price_type": "tax_exclusive",
        "date": 1539327234,
        "due_date": 1539327234,
        "net_term_days": 0,
        "exchange_rate": 1.0,
        "total": 2900,
        "amount_paid": 2900,
        "amount_adjusted": 0,
        "write_off_amount": 0,
        "credits_applied": 0,
        "amount_due": 0,
        "paid_at": 1539327234,
        "updated_at": 1539327240,
        "resource_version": 1539327240000,
        "deleted": false,
        "object": "invoice",
        "first_invoice": false,
        "amount_to_collect": 0,
        "round_off_amount": 0,
        "has_advance_charges": true,
        "currency_code": "USD",
        "base_currency_code": "USD",
        "tax": 0,
        "line_items": [
            {
                "id": "li_5SK0b55NR6FACWo9K",
                "date_from": 1539327234,
                "date_to": 1539327234,
                "unit_amount": 1000,
                "quantity": 1,
                "amount": 1000,
                "pricing_model": "flat_fee",
                "is_taxed": false,
                "tax_amount": 0,
                "object": "line_item",
                "subscription_id": "8avVGOkx8U1MX",
                "description": "Support charge",
                "entity_type": "adhoc",
                "tax_exempt_reason": "tax_not_configured",
                "discount_amount": 0,
                "item_level_discount_amount": 0
            },
            {..}
        ],
        "sub_total": 2900,
        "linked_payments": [
            {
                "txn_id": "txn_5SK0b55NR6FACvG9T",
                "applied_amount": 2900,
                "applied_at": 1539327240,
                "txn_status": "success",
                "txn_date": 1539327234,
                "txn_amount": 2900
            },
            {..}
        ],
        "applied_credits": [],
        "adjustment_credit_notes": [],
        "issued_credit_notes": [],
        "linked_orders": [],
        "billing_address": {
            "first_name": "John",
            "last_name": "Doe",
            "line1": "PO Box 9999",
            "city": "Walnut",
            "state_code": "CA",
            "state": "California",
            "country": "US",
            "zip": "91789",
            "validation_status": "not_validated",
            "object": "billing_address"
        },
        "shipping_address": {
            "first_name": "Benjamin",
            "last_name": "Ross",
            "line1": "PO Box 9999",
            "city": "Walnut",
            "state_code": "CA",
            "state": "California",
            "country": "US",
            "zip": "91789",
            "validation_status": "not_validated",
            "object": "shipping_address"
        }
    }
}

URL Format POST

https://{site}.chargebee.com/api/v2/subscriptions/{subscription_id}/charge_future_renewals

terms_to_charge

The number of future renewals for which the advance invoicing is done.
optional, integer, default=1, min=1

subscription

Resource object representing subscription.
always returned

customer

Resource object representing customer.
always returned

card

Resource object representing card.
optional

invoice

Resource object representing invoice.
always returned

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 customer[email]="john@user.com" \
     -d customer[first_name]="John" \
     -d customer[last_name]="Doe" \
     -d customer[locale]="fr-CA" \
     -d customer[phone]="+1-949-999-9999" \
     -d plan_id="basic" \
     -d status="active" \
     -d current_term_end="1541010624" \
     -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

curl  https://{site}.chargebee.com/api/v2/subscriptions/import_subscription \
     -u {site_api_key}: \
     -d customer[email]="john@user.com" \
     -d customer[first_name]="John" \
     -d customer[last_name]="Doe" \
     -d customer[locale]="fr-CA" \
     -d customer[phone]="+1-949-999-9999" \
     -d plan_id="basic" \
     -d status="active" \
     -d current_term_end="1541010624" \
     -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"

Sample Response [ JSON ]

{
    "subscription": {
        "id": "5SK0b55NR6FAE889Z",
        "customer_id": "5SK0b55NR6FAE889Z",
        "plan_id": "basic",
        "plan_quantity": 1,
        "plan_unit_price": 900,
        "plan_amount": 900,
        "billing_period": 1,
        "billing_period_unit": "month",
        "plan_free_quantity": 0,
        "status": "active",
        "current_term_start": 1539327240,
        "current_term_end": 1541010624,
        "next_billing_at": 1541010624,
        "created_at": 1539327240,
        "started_at": 1539327240,
        "activated_at": 1539327240,
        "updated_at": 1539327240,
        "has_scheduled_changes": false,
        "resource_version": 1539327240000,
        "deleted": false,
        "object": "subscription",
        "currency_code": "USD",
        "due_invoices_count": 0,
        "mrr": 0
    },
    "customer": {
        "id": "5SK0b55NR6FAE889Z",
        "first_name": "John",
        "last_name": "Doe",
        "email": "john@user.com",
        "phone": "+1-949-999-9999",
        "auto_collection": "on",
        "net_term_days": 0,
        "allow_direct_debit": false,
        "created_at": 1539327240,
        "taxability": "taxable",
        "updated_at": 1539327240,
        "locale": "fr-CA",
        "pii_cleared": "active",
        "resource_version": 1539327240000,
        "deleted": false,
        "object": "customer",
        "billing_address": {
            "first_name": "John",
            "last_name": "Doe",
            "line1": "PO Box 9999",
            "city": "Walnut",
            "state_code": "CA",
            "state": "California",
            "country": "US",
            "zip": "91789",
            "validation_status": "not_validated",
            "object": "billing_address"
        },
        "card_status": "no_card",
        "promotional_credits": 0,
        "refundable_credits": 0,
        "excess_payments": 0,
        "unbilled_charges": 0,
        "preferred_currency_code": "USD"
    }
}

URL Format POST

https://{site}.chargebee.com/api/v2/subscriptions/import_subscription

id

Id for the new subscription. If not given, this will be auto-generated.
optional, string, max chars=50

plan_id

Identifier of the plan for this subscription.
required, string, max chars=100

plan_quantity

Plan quantity for this subscription.
optional, integer, default=1, min=1

plan_unit_price

Amount that will override the Plan's default price.
optional, in cents, min=0

setup_fee

Amount that will override the default setup fee.
optional, in cents, min=0

start_date

trial_end

billing_cycles

Number of cycles(plan interval) this subscription should be charged. After the billing cycles exhausted, the subscription will be cancelled.
optional, integer, min=0

auto_collection

Defines whether payments need to be collected automatically for this subscription. Overrides customer's auto-collection property.
optional, enumerated string

Possible values are

po_number

Purchase Order Number for this subscription.
optional, string, max chars=100

coupon_ids[0..n]

Identifier of the coupon as a List. Coupon Codes can also be passed.
optional, list of string

status

Current state of the subscription.
required, enumerated string

Possible values are

current_term_end

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

current_term_start

Start of the current billing term.
optional, timestamp(UTC) in seconds

trial_start

cancelled_at

Time at which subscription was canceled or is set to be canceled.
optional, timestamp(UTC) in seconds

started_at

Time at which the subscription got started. Will be null for 'future' subscriptions as it is yet to be started.
optional, timestamp(UTC) in seconds

pause_date

Date on which the subscription will be paused.
optional, timestamp(UTC) in seconds

resume_date

Date on which the subscription will be resumed.
optional, timestamp(UTC) in seconds

create_current_term_invoice

Set as TRUE if you want Chargebee to create an invoice for the subscription.

Invoice will be created for subscriptions with ACTIVE or NON_RENEWING status only.
Invoice will be created for the period mentioned in the current_term_start and current_term_end attributes.
Invoice will not be generated if subscription amount is zero dollars (for that period) and 'Hide Zero Value Line Items' option is enabled in Settings.
Invoice will not be generated if the given quantity is not greater than free quantity (If free quantity is configured in the plan/addon).
optional, boolean, default=false

affiliate_token

A unique tracking token.
optional, string, max chars=250

invoice_notes

Invoice Notes for this resource. Read More.
optional, string, max chars=1000

meta_data

Additional data about this resource can be stored here in the JSON Format. Learn more.
optional, jsonobject

customer

Parameters for customer
pass parameters as customer[<param name>]

customer[id]

Id for the new customer. If not given, this will be same as the subscription id.
optional, string, max chars=50

customer[email]

Email of the customer. Configured email notifications will be sent to this email.
optional, string, max chars=70

customer[first_name]

First name of the customer.
optional, string, max chars=150

customer[last_name]

Last name of the customer.
optional, string, max chars=150

customer[company]

Company name of the customer.
optional, string, max chars=250

customer[taxability]

Specifies if the customer is liable for tax.
optional, enumerated string, default=taxable

Possible values are

taxableCustomer is taxable.exemptCustomer is exempted from tax.

customer[locale]

customer[entity_code]

The exemption category of the customer, for the USA and Canada. applicable if you use Chargebee's Avalara integration.
optional, enumerated string

Possible values are

aFederal government (United States).bState government (United States).cTribe/Status Indian/Indian Band (both).dForeign diplomat (United States).

Show all values[+]

customer[exempt_number]

customer[net_term_days]

The number of days within which the customer has to make payment for the invoice.
optional, integer, default=0

customer[phone]

Phone number of the customer.
optional, string, max chars=50

customer[auto_collection]

Whether payments needs to be collected automatically for this customer.
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.

customer[allow_direct_debit]

Whether the customer can pay via Direct Debit.
optional, boolean, default=false

customer[vat_number]

VAT/ Tax registration number of the customer. Learn more.
optional, string, max chars=20

card

Parameters for card
pass parameters as card[<param name>]

card[gateway_account_id]

The gateway account in which this payment source is stored.
optional, string, max chars=50

card[first_name]

Cardholder's first name.
optional, string, max chars=50

card[last_name]

Cardholder's last name.
optional, string, max chars=50

card[number]

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

card[expiry_month]

Card expiry month.
required if card provided, integer, min=1, max=12

card[expiry_year]

Card expiry year.
required if card provided, integer

card[cvv]

The card verification value. If you are using Braintree.js, you can specify the Braintree encrypted cvv here.
optional, string, max chars=520

card[billing_addr1]

Address line 1, as available in card billing address.
optional, string, max chars=150

card[billing_addr2]

Address line 2, as available in card billing address.
optional, string, max chars=150

card[billing_city]

City, as available in card billing address.
optional, string, max chars=50

card[billing_state_code]

card[billing_state]

The state/province name. Use this to pass the state/province information for cases where 'state_code' is not supported or cannot be passed.
optional, string, max chars=50

card[billing_zip]

Postal or Zip code, as available in card billing address.
optional, string, max chars=20

card[billing_country]

2-letter ISO 3166 alpha-2 country code.
optional, string, max chars=50

payment_method

Parameters for payment_method
pass parameters as payment_method[<param name>]

payment_method[type]

The type of payment method. For more details refer Update payment method for a customer API under Customer resource.
optional, enumerated string

Possible values are

genericGeneric Payment Method.alipayAlipay Payments.unionpayUnionPay Payments.apple_payApple Pay Payments.wechat_payWeChat Pay Payments.

Show all values[+]

payment_method[gateway_account_id]

The gateway account in which this payment source is stored.
optional, string, max chars=50

payment_method[reference_id]

payment_method[issuing_country]

2-letter (alpha2) ISO country code. Indicates your customer's payment method country of issuance. Applicable for PayPal via Braintree.
optional, string, max chars=50

billing_address

Parameters for billing_address
pass parameters as billing_address[<param name>]

billing_address[first_name]

First name.
optional, string, max chars=150

billing_address[last_name]

Last name.
optional, string, max chars=150

billing_address[email]

Email.
optional, string, max chars=70

billing_address[company]

Company name.
optional, string, max chars=250

billing_address[phone]

Phone number.
optional, string, max chars=50

billing_address[line1]

Address line 1.
optional, string, max chars=150

billing_address[line2]

Address line 2.
optional, string, max chars=150

billing_address[line3]

Address line 3.
optional, string, max chars=150

billing_address[city]

City.
optional, string, max chars=50

billing_address[state_code]

billing_address[state]

The state/province name. Use this to pass the state/province information for cases where 'state_code' is not supported or cannot be passed.
optional, string, max chars=50

billing_address[zip]

Zip or Postal code.
optional, string, max chars=20

billing_address[country]

2-letter ISO 3166 alpha-2 country code.
optional, string, max chars=50

billing_address[validation_status]

The address verification status.
optional, enumerated string, default=not_validated

Possible values are

not_validatedAddress is not yet validated.validAddress was validated successfully.partially_validAddress is verified but only partially.invalidAddress is invalid.

shipping_address

Parameters for shipping_address
pass parameters as shipping_address[<param name>]

shipping_address[first_name]

First name.
optional, string, max chars=150

shipping_address[last_name]

Last name.
optional, string, max chars=150

shipping_address[email]

Email.
optional, string, max chars=70

shipping_address[company]

Company name.
optional, string, max chars=250

shipping_address[phone]

Phone number.
optional, string, max chars=50

shipping_address[line1]

Address line 1.
optional, string, max chars=180

shipping_address[line2]

Address line 2.
optional, string, max chars=150

shipping_address[line3]

Address line 3.
optional, string, max chars=150

shipping_address[city]

City.
optional, string, max chars=50

shipping_address[state_code]

shipping_address[state]

The state/province name. Use this to pass the state/province information for cases where 'state_code' is not supported or cannot be passed.
optional, string, max chars=50

shipping_address[zip]

Zip or Postal code.
optional, string, max chars=20

shipping_address[country]

2-letter ISO 3166 alpha-2 country code.
optional, string, max chars=50

shipping_address[validation_status]

The address verification status.
optional, enumerated string, default=not_validated

Possible values are

not_validatedAddress is not yet validated.validAddress was validated successfully.partially_validAddress is verified but only partially.invalidAddress is invalid.

transaction

Parameters for transaction
pass parameters as transaction[<param name>]

transaction[amount]

The payment transaction amount. This param should be passed only if the invoice is created for current term.
optional, in cents, min=1

transaction[payment_method]

The Payment Method of this transaction. This param should be passed only if the invoice is created for current term.
optional, enumerated string, default=card

Possible values are

cashCash.checkCheck.

bank_transferBank Transfer.otherPayment Methods other than the above types.

Show all values[+]

transaction[reference_number]

The reference number for this transaction. e.g check number in case of 'check' payment. This param should be passed only if the invoice is created for current term.
optional, string, max chars=100

transaction[date]

Indicates when this transaction occurred. This param should be passed only if the invoice is created for current term.
optional, timestamp(UTC) in seconds

addons

Parameters for addons. Multiple addons can be passed by specifying unique indices.
pass parameters as addons[<param name>][<idx:0..n>]

addons[id][0..n]

Identifier of the addon. Multiple addons can be passed.
optional, string, max chars=100

addons[quantity][0..n]

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

addons[unit_price][0..n]

addons[billing_cycles][0..n]

Number of billing cycles the addon will be charged for.
optional, integer, min=1

event_based_addons

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

event_based_addons[id][0..n]

A unique 'id' used to identify the addon.
optional, string, max chars=100

event_based_addons[quantity][0..n]

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

event_based_addons[unit_price][0..n]

Amount that will override the Addon's default price.
optional, in cents, min=0

event_based_addons[on_event][0..n]

Event on which this addon will be charged.
optional, enumerated string

Possible values are

event_based_addons[charge_once][0..n]

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

charged_event_based_addons

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

charged_event_based_addons[id][0..n]

Addon id.
optional, string, max chars=100

charged_event_based_addons[last_charged_at][0..n]

Timestamp indicating when this add-on was last charged for this subscription.
optional, timestamp(UTC) in seconds

subscription

Resource object representing subscription.
always returned

customer

Resource object representing customer.
always returned

card

Resource object representing card.
optional

invoice

Resource object representing invoice.
optional

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/8avVGOkx8U1MX/import_subscription \
     -u {site_api_key}: \
     -d plan_id="basic" \
     -d status="active" \
     -d current_term_end="1541010624"

copy

curl  https://{site}.chargebee.com/api/v2/customers/8avVGOkx8U1MX/import_subscription \
     -u {site_api_key}: \
     -d plan_id="basic" \
     -d status="active" \
     -d current_term_end="1541010624"

Sample Response [ JSON ]

{
    "subscription": {
        "id": "5SK0b55NR6FAEGB9d",
        "customer_id": "8avVGOkx8U1MX",
        "plan_id": "basic",
        "plan_quantity": 1,
        "plan_unit_price": 900,
        "plan_amount": 900,
        "billing_period": 1,
        "billing_period_unit": "month",
        "plan_free_quantity": 0,
        "status": "active",
        "current_term_start": 1539327240,
        "current_term_end": 1541010624,
        "next_billing_at": 1541010624,
        "created_at": 1539327240,
        "started_at": 1539327240,
        "activated_at": 1539327240,
        "updated_at": 1539327241,
        "has_scheduled_changes": false,
        "resource_version": 1539327241000,
        "deleted": false,
        "object": "subscription",
        "currency_code": "USD",
        "due_invoices_count": 0,
        "mrr": 0
    },
    "customer": {
        "id": "8avVGOkx8U1MX",
        "first_name": "Benjamin",
        "last_name": "Ross",
        "email": "Benjamin@test.com",
        "auto_collection": "on",
        "net_term_days": 0,
        "allow_direct_debit": false,
        "created_at": 1412101824,
        "taxability": "taxable",
        "updated_at": 1539327240,
        "pii_cleared": "active",
        "resource_version": 1539327240000,
        "deleted": false,
        "object": "customer",
        "billing_address": {
            "first_name": "John",
            "last_name": "Doe",
            "line1": "PO Box 9999",
            "city": "Walnut",
            "state_code": "CA",
            "state": "California",
            "country": "US",
            "zip": "91789",
            "validation_status": "not_validated",
            "object": "billing_address"
        },
        "card_status": "valid",
        "contacts": [
            {
                "id": "d334f4g45",
                "first_name": "aasca",
                "last_name": "asas",
                "email": "sss@wss.asc",
                "label": "ascasc",
                "enabled": true,
                "send_account_email": true,
                "send_billing_email": false,
                "object": "contact"
            },
            {..}
        ],
        "primary_payment_source_id": "pm_5SK0b55NR6FA9Uy8U",
        "payment_method": {
            "object": "payment_method",
            "type": "card",
            "reference_id": "cus_DlsHbEWTIBQzqP/card_1DKKWiJv9j0DyntJS8Wfexoe",
            "gateway": "stripe",
            "gateway_account_id": "gw_5SK0b54PR6F9Odm8y",
            "status": "valid"
        },
        "promotional_credits": 0,
        "refundable_credits": 0,
        "excess_payments": 0,
        "unbilled_charges": 0,
        "preferred_currency_code": "USD"
    },
    "card": {
        "status": "valid",
        "gateway": "stripe",
        "gateway_account_id": "gw_5SK0b54PR6F9Odm8y",
        "first_name": "Richard",
        "last_name": "Fox",
        "iin": "401288",
        "last4": "1881",
        "card_type": "visa",
        "funding_type": "credit",
        "expiry_month": 10,
        "expiry_year": 2022,
        "issuing_country": "CA",
        "object": "card",
        "masked_number": "************1881",
        "customer_id": "8avVGOkx8U1MX",
        "payment_source_id": "pm_5SK0b55NR6FA9Uy8U"
    }
}

URL Format POST

https://{site}.chargebee.com/api/v2/customers/{customer_id}/import_subscription

id

Id for the new subscription. If not given, this will be auto-generated.
optional, string, max chars=50

plan_id

Identifier of the plan for this subscription.
required, string, max chars=100

plan_quantity

Plan quantity for this subscription.
optional, integer, default=1, min=1

plan_unit_price

Amount that will override the Plan's default price.
optional, in cents, min=0

setup_fee

Amount that will override the default setup fee.
optional, in cents, min=0

start_date

trial_end

billing_cycles

Number of cycles(plan interval) this subscription should be charged. After the billing cycles exhausted, the subscription will be cancelled.
optional, integer, min=0

auto_collection

Defines whether payments need to be collected automatically for this subscription. Overrides customer's auto-collection property.
optional, enumerated string

Possible values are

po_number

Purchase Order Number for this subscription.
optional, string, max chars=100

coupon_ids[0..n]

Identifier of the coupon as a List. Coupon Codes can also be passed.
optional, list of string

payment_source_id

Unique identifier of the payment source to be attached to this subscription.
optional, string, max chars=40

status

Current state of the subscription.
required, enumerated string

Possible values are

current_term_end

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

current_term_start

Start of the current billing term.
optional, timestamp(UTC) in seconds

trial_start

cancelled_at

Time at which subscription was canceled or is set to be canceled.
optional, timestamp(UTC) in seconds

started_at

Time at which the subscription got started. Will be null for 'future' subscriptions as it is yet to be started.
optional, timestamp(UTC) in seconds

pause_date

Date on which the subscription will be paused.
optional, timestamp(UTC) in seconds

resume_date

Date on which the subscription will be resumed.
optional, timestamp(UTC) in seconds

create_current_term_invoice

Set as TRUE if you want Chargebee to create an invoice for the subscription.

Invoice will be created for subscriptions with ACTIVE or NON_RENEWING status only.
Invoice will be created for the period mentioned in the current_term_start and current_term_end attributes.
Invoice will not be generated if subscription amount is zero dollars (for that period) and 'Hide Zero Value Line Items' option is enabled in Settings.
Invoice will not be generated if the given quantity is not greater than free quantity (If free quantity is configured in the plan/addon).
optional, boolean, default=false

invoice_notes

Invoice Notes for this resource. Read More.
optional, string, max chars=1000

meta_data

Additional data about this resource can be stored here in the JSON Format. Learn more.
optional, jsonobject

transaction

Parameters for transaction
pass parameters as transaction[<param name>]

transaction[amount]

The payment transaction amount. This param should be passed only if the invoice is created for current term.
optional, in cents, min=1

transaction[payment_method]

The Payment Method of this transaction. This param should be passed only if the invoice is created for current term.
optional, enumerated string, default=card

Possible values are

cashCash.checkCheck.

bank_transferBank Transfer.otherPayment Methods other than the above types.

Show all values[+]

transaction[reference_number]

The reference number for this transaction. e.g check number in case of 'check' payment. This param should be passed only if the invoice is created for current term.
optional, string, max chars=100

transaction[date]

Indicates when this transaction occurred. This param should be passed only if the invoice is created for current term.
optional, timestamp(UTC) in seconds

shipping_address

Parameters for shipping_address
pass parameters as shipping_address[<param name>]

shipping_address[first_name]

First name.
optional, string, max chars=150

shipping_address[last_name]

Last name.
optional, string, max chars=150

shipping_address[email]

Email.
optional, string, max chars=70

shipping_address[company]

Company name.
optional, string, max chars=250

shipping_address[phone]

Phone number.
optional, string, max chars=50

shipping_address[line1]

Address line 1.
optional, string, max chars=180

shipping_address[line2]

Address line 2.
optional, string, max chars=150

shipping_address[line3]

Address line 3.
optional, string, max chars=150

shipping_address[city]

City.
optional, string, max chars=50

shipping_address[state_code]

shipping_address[state]

The state/province name. Use this to pass the state/province information for cases where 'state_code' is not supported or cannot be passed.
optional, string, max chars=50

shipping_address[zip]

Zip or Postal code.
optional, string, max chars=20

shipping_address[country]

2-letter ISO 3166 alpha-2 country code.
optional, string, max chars=50

shipping_address[validation_status]

The address verification status.
optional, enumerated string, default=not_validated

Possible values are

not_validatedAddress is not yet validated.validAddress was validated successfully.partially_validAddress is verified but only partially.invalidAddress is invalid.

addons

Parameters for addons. Multiple addons can be passed by specifying unique indices.
pass parameters as addons[<param name>][<idx:0..n>]

addons[id][0..n]

Identifier of the addon. Multiple addons can be passed.
optional, string, max chars=100

addons[quantity][0..n]

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

addons[unit_price][0..n]

addons[billing_cycles][0..n]

Number of billing cycles the addon will be charged for.
optional, integer, min=1

event_based_addons

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

event_based_addons[id][0..n]

A unique 'id' used to identify the addon.
optional, string, max chars=100

event_based_addons[quantity][0..n]

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

event_based_addons[unit_price][0..n]

Amount that will override the Addon's default price.
optional, in cents, min=0

event_based_addons[on_event][0..n]

Event on which this addon will be charged.
optional, enumerated string

Possible values are

event_based_addons[charge_once][0..n]

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

charged_event_based_addons

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

charged_event_based_addons[id][0..n]

Addon id.
optional, string, max chars=100

charged_event_based_addons[last_charged_at][0..n]

Timestamp indicating when this add-on was last charged for this subscription.
optional, timestamp(UTC) in seconds

subscription

Resource object representing subscription.
always returned

customer

Resource object representing customer.
always returned

card

Resource object representing card.
optional

invoice

Resource object representing invoice.
optional

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/8avVGOkx8U1MX/override_billing_profile \
     -X POST  \
     -u {site_api_key}:

copy

curl  https://{site}.chargebee.com/api/v2/subscriptions/8avVGOkx8U1MX/override_billing_profile \
     -X POST  \
     -u {site_api_key}:

Sample Response [ JSON ]

{
    "subscription": {
        "id": "8avVGOkx8U1MX",
        "customer_id": "8avVGOkx8U1MX",
        "plan_id": "basic",
        "plan_quantity": 1,
        "plan_unit_price": 900,
        "plan_amount": 900,
        "billing_period": 1,
        "billing_period_unit": "month",
        "plan_free_quantity": 0,
        "status": "active",
        "trial_start": 1412101824,
        "trial_end": 1414780224,
        "current_term_start": 1539327229,
        "current_term_end": 1542005629,
        "next_billing_at": 1544597629,
        "created_at": 1412101824,
        "started_at": 1412101824,
        "activated_at": 1539327229,
        "updated_at": 1539327241,
        "has_scheduled_changes": false,
        "payment_source_id": "pm_XpbBroXQF5m78F6",
        "resource_version": 1539327241000,
        "deleted": false,
        "object": "subscription",
        "currency_code": "USD",
        "due_invoices_count": 3,
        "due_since": 1394532759,
        "total_dues": 6700,
        "mrr": 900,
        "exchange_rate": 1.0,
        "base_currency_code": "USD",
        "shipping_address": {
            "first_name": "Benjamin",
            "last_name": "Ross",
            "line1": "PO Box 9999",
            "city": "Walnut",
            "state_code": "CA",
            "state": "California",
            "country": "US",
            "zip": "91789",
            "validation_status": "not_validated",
            "object": "shipping_address"
        }
    },
    "payment_source": {
        "id": "pm_XpbBroXQF5m78F6",
        "deleted": false,
        "object": "payment_source",
        "customer_id": "8avVGOkx8U1MX",
        "type": "card",
        "reference_id": "tok_5SK0b54PR6F95YLG",
        "status": "valid",
        "gateway": "chargebee",
        "gateway_account_id": "gw_5SK0b54PR6F92Xh2",
        "card": {
            "iin": "385200",
            "last4": "3237",
            "funding_type": "not_known",
            "expiry_month": 12,
            "expiry_year": 2022,
            "masked_number": "************3237",
            "object": "card",
            "brand": "diners_club"
        }
    }
}

URL Format POST

https://{site}.chargebee.com/api/v2/subscriptions/{subscription_id}/override_billing_profile

payment_source_id

Unique identifier of the payment source to be attached to this subscription.
optional, string, max chars=40

auto_collection

Defines whether payments need to be collected automatically for this subscription. Overrides customer's auto-collection property.
optional, enumerated string

Possible values are

subscription

Resource object representing subscription.
always returned

payment_source

Resource object representing payment_source.
optional

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/5cDfREwp3I5lJ/delete \
     -X POST  \
     -u {site_api_key}:

copy

curl  https://{site}.chargebee.com/api/v2/subscriptions/5cDfREwp3I5lJ/delete \
     -X POST  \
     -u {site_api_key}:

Sample Response [ JSON ]

{
    "subscription": {
        "id": "5cDfREwp3I5lJ",
        "customer_id": "5cDfREwp3I5lJ",
        "plan_id": "basic",
        "plan_quantity": 1,
        "plan_unit_price": 900,
        "plan_amount": 900,
        "billing_period": 1,
        "billing_period_unit": "month",
        "plan_free_quantity": 0,
        "status": "active",
        "trial_start": 1539327024,
        "trial_end": 1539161424,
        "current_term_start": 1539161424,
        "current_term_end": 1541839824,
        "next_billing_at": 1541839824,
        "created_at": 1539327024,
        "started_at": 1539327024,
        "activated_at": 1539161424,
        "updated_at": 1539327025,
        "has_scheduled_changes": false,
        "resource_version": 1539327025000,
        "deleted": false,
        "object": "subscription",
        "currency_code": "USD",
        "due_invoices_count": 1,
        "due_since": 1539161424,
        "total_dues": 900,
        "mrr": 900,
        "exchange_rate": 1.0,
        "base_currency_code": "USD"
    },
    "customer": {
        "id": "5cDfREwp3I5lJ",
        "first_name": "David",
        "last_name": "White",
        "email": "David@test.com",
        "auto_collection": "on",
        "net_term_days": 0,
        "allow_direct_debit": false,
        "created_at": 1539327024,
        "taxability": "taxable",
        "updated_at": 1539327224,
        "pii_cleared": "active",
        "resource_version": 1539327224000,
        "deleted": false,
        "object": "customer",
        "card_status": "valid",
        "primary_payment_source_id": "pm_5SK0b54PR6F9K3z7x",
        "payment_method": {
            "object": "payment_method",
            "type": "card",
            "reference_id": "tok_5SK0b54PR6F9K3q7w",
            "gateway": "chargebee",
            "gateway_account_id": "gw_5SK0b54PR6F92Xh2",
            "status": "valid"
        },
        "promotional_credits": 0,
        "refundable_credits": 0,
        "excess_payments": 0,
        "unbilled_charges": 0,
        "preferred_currency_code": "USD"
    },
    "card": {
        "status": "valid",
        "gateway": "chargebee",
        "gateway_account_id": "gw_5SK0b54PR6F92Xh2",
        "iin": "400551",
        "last4": "0004",
        "card_type": "visa",
        "funding_type": "not_known",
        "expiry_month": 12,
        "expiry_year": 2022,
        "object": "card",
        "masked_number": "************0004",
        "customer_id": "5cDfREwp3I5lJ",
        "payment_source_id": "pm_5SK0b54PR6F9K3z7x"
    }
}

URL Format POST

https://{site}.chargebee.com/api/v2/subscriptions/{subscription_id}/delete

subscription

Resource object representing subscription.
always returned

customer

Resource object representing customer.
always returned

card

Resource object representing card.
optional

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

curl  https://{site}.chargebee.com/api/v2/subscriptions/8avVGOkx8U1MX/pause \
     -X POST  \
     -u {site_api_key}:

copy

curl  https://{site}.chargebee.com/api/v2/subscriptions/8avVGOkx8U1MX/pause \
     -X POST  \
     -u {site_api_key}:

Sample Response [ JSON ]

{
    "card": {
        "card_type": "visa",
        "customer_id": "5SK0b54PR6F9qEB9O",
        "expiry_month": 1,
        "expiry_year": 2032,
        "funding_type": "credit",
        "gateway": "chargebee",
        "gateway_account_id": "gw_5SK0b54PR6F92Xh2",
        "iin": "411111",
        "last4": "1111",
        "masked_number": "************1111",
        "object": "card",
        "payment_source_id": "pm_5SK0b54PR6F9qEp9Q",
        "status": "valid"
    },
    "customer": {
        "allow_direct_debit": false,
        "auto_collection": "on",
        "card_status": "valid",
        "created_at": 1539327148,
        "deleted": false,
        "email": "joe@user.com",
        "excess_payments": 0,
        "first_name": "Joe",
        "id": "5SK0b54PR6F9qEB9O",
        "last_name": "D",
        "net_term_days": 0,
        "object": "customer",
        "payment_method": {
            "gateway": "chargebee",
            "gateway_account_id": "gw_5SK0b54PR6F92Xh2",
            "object": "payment_method",
            "reference_id": "tok_5SK0b54PR6F9qEl9P",
            "status": "valid",
            "type": "card"
        },
        "pii_cleared": "active",
        "preferred_currency_code": "USD",
        "primary_payment_source_id": "pm_5SK0b54PR6F9qEp9Q",
        "promotional_credits": 0,
        "refundable_credits": 0,
        "resource_version": 1539327149000,
        "taxability": "taxable",
        "unbilled_charges": 0,
        "updated_at": 1539327149
    },
    "invoice": {
        "adjustment_credit_notes": [],
        "amount_adjusted": 0,
        "amount_due": 0,
        "amount_paid": 1000,
        "amount_to_collect": 0,
        "applied_credits": [],
        "base_currency_code": "USD",
        "billing_address": {
            "first_name": "Joe",
            "last_name": "D",
            "object": "billing_address",
            "validation_status": "not_validated"
        },
        "credits_applied": 0,
        "currency_code": "USD",
        "customer_id": "5SK0b54PR6F9qEB9O",
        "date": 1539327149,
        "deleted": false,
        "due_date": 1539327149,
        "exchange_rate": 1,
        "first_invoice": true,
        "has_advance_charges": false,
        "id": "55",
        "issued_credit_notes": [],
        "line_items": [
            {
                "amount": 1000,
                "date_from": 1539327148,
                "date_to": 1539327148,
                "description": "unbilled_charges",
                "discount_amount": 0,
                "entity_type": "adhoc",
                "id": "li_5SK0b55NR6F9qKO3d",
                "is_taxed": false,
                "item_level_discount_amount": 0,
                "object": "line_item",
                "pricing_model": "flat_fee",
                "quantity": 1,
                "subscription_id": "5SK0b54PR6F9qEB9O",
                "tax_amount": 0,
                "tax_exempt_reason": "tax_not_configured",
                "unit_amount": 1000
            },
            {..}
        ],
        "linked_orders": [],
        "linked_payments": [
            {
                "applied_amount": 1000,
                "applied_at": 1539327149,
                "txn_amount": 1000,
                "txn_date": 1539327149,
                "txn_id": "txn_5SK0b55NR6F9qTv3i",
                "txn_status": "success"
            },
            {..}
        ],
        "net_term_days": 0,
        "new_sales_amount": 1000,
        "object": "invoice",
        "paid_at": 1539327149,
        "price_type": "tax_exclusive",
        "recurring": false,
        "resource_version": 1539327149000,
        "round_off_amount": 0,
        "status": "paid",
        "sub_total": 1000,
        "subscription_id": "5SK0b54PR6F9qEB9O",
        "tax": 0,
        "total": 1000,
        "updated_at": 1539327149,
        "write_off_amount": 0
    },
    "subscription": {
        "activated_at": 1539327148,
        "addons": [
            {
                "amount": 190,
                "id": "data_usage",
                "object": "addon",
                "quantity": 2,
                "unit_price": 95
            },
            {..}
        ],
        "billing_period": 1,
        "billing_period_unit": "month",
        "created_at": 1539327148,
        "currency_code": "USD",
        "current_term_end": 1542005548,
        "current_term_start": 1539327148,
        "customer_id": "5SK0b54PR6F9qEB9O",
        "deleted": false,
        "due_invoices_count": 0,
        "has_scheduled_changes": false,
        "id": "5SK0b54PR6F9qEB9O",
        "mrr": 0,
        "next_billing_at": 1542005549,
        "object": "subscription",
        "pause_date": 1539327149,
        "plan_amount": 3000,
        "plan_free_quantity": 0,
        "plan_id": "no_trial",
        "plan_quantity": 3,
        "plan_unit_price": 1000,
        "resource_version": 1539327149000,
        "resume_date": 1542005549,
        "started_at": 1539327148,
        "status": "paused",
        "updated_at": 1539327149
    }
}

URL Format POST

https://{site}.chargebee.com/api/v2/subscriptions/{subscription_id}/pause

pause_option

List of options to pause the subscription.
optional, enumerated string

Possible values are

immediatelyPause immediately.end_of_termPause at the end of current term.specific_datePause on a specific date.

pause_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

unbilled_charges_handling

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

Possible values are

no_actionRetain as unbilled.invoiceInvoice charges.

invoice_dunning_handling

Handles dunning for invoices already in the dunning cycle, when subscription is paused. Applicable when pause_option is set as 'immediately'.
optional, enumerated string

Possible values are

continueContinue dunning.stopStop dunning.

resume_date

Date on which the subscription will be resumed.
optional, timestamp(UTC) in seconds

subscription

Resource object representing subscription.
always returned

customer

Resource object representing customer.
always returned

card

Resource object representing card.
optional

invoice

Resource object representing invoice.
optional

unbilled_charges

Resource object representing unbilled_charge.
optional

credit_notes

Resource object representing credit_note.
optional

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.

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

curl  https://{site}.chargebee.com/api/v2/subscriptions/8avVGOkx8U1MX/resume \
     -X POST  \
     -u {site_api_key}:

copy

curl  https://{site}.chargebee.com/api/v2/subscriptions/8avVGOkx8U1MX/resume \
     -X POST  \
     -u {site_api_key}:

Sample Response [ JSON ]

{
    "card": {
        "card_type": "visa",
        "customer_id": "5SK0b54PR6F9qEB9O",
        "expiry_month": 1,
        "expiry_year": 2032,
        "funding_type": "credit",
        "gateway": "chargebee",
        "gateway_account_id": "gw_5SK0b54PR6F92Xh2",
        "iin": "411111",
        "last4": "1111",
        "masked_number": "************1111",
        "object": "card",
        "payment_source_id": "pm_5SK0b54PR6F9qEp9Q",
        "status": "valid"
    },
    "customer": {
        "allow_direct_debit": false,
        "auto_collection": "on",
        "card_status": "valid",
        "created_at": 1539327148,
        "deleted": false,
        "email": "joe@user.com",
        "excess_payments": 0,
        "first_name": "Joe",
        "id": "5SK0b54PR6F9qEB9O",
        "last_name": "D",
        "net_term_days": 0,
        "object": "customer",
        "payment_method": {
            "gateway": "chargebee",
            "gateway_account_id": "gw_5SK0b54PR6F92Xh2",
            "object": "payment_method",
            "reference_id": "tok_5SK0b54PR6F9qEl9P",
            "status": "valid",
            "type": "card"
        },
        "pii_cleared": "active",
        "preferred_currency_code": "USD",
        "primary_payment_source_id": "pm_5SK0b54PR6F9qEp9Q",
        "promotional_credits": 0,
        "refundable_credits": 0,
        "resource_version": 1539327149000,
        "taxability": "taxable",
        "unbilled_charges": 0,
        "updated_at": 1539327149
    },
    "subscription": {
        "activated_at": 1539327148,
        "addons": [
            {
                "amount": 190,
                "id": "data_usage",
                "object": "addon",
                "quantity": 2,
                "unit_price": 95
            },
            {..}
        ],
        "billing_period": 1,
        "billing_period_unit": "month",
        "created_at": 1539327148,
        "currency_code": "USD",
        "current_term_end": 1542005548,
        "current_term_start": 1539327148,
        "customer_id": "5SK0b54PR6F9qEB9O",
        "deleted": false,
        "due_invoices_count": 0,
        "has_scheduled_changes": false,
        "id": "5SK0b54PR6F9qEB9O",
        "mrr": 0,
        "next_billing_at": 1542005548,
        "object": "subscription",
        "plan_amount": 3000,
        "plan_free_quantity": 0,
        "plan_id": "no_trial",
        "plan_quantity": 3,
        "plan_unit_price": 1000,
        "resource_version": 1539327150000,
        "started_at": 1539327148,
        "status": "active",
        "updated_at": 1539327150
    }
}

URL Format POST

https://{site}.chargebee.com/api/v2/subscriptions/{subscription_id}/resume

resume_option

List of options to resume the subscription.
optional, enumerated string

Possible values are

immediatelyResume immediately.specific_dateResume on a specific date.

resume_date

Date on which the subscription will be resumed. Applicable when resume_option is set as 'specific_date'.
optional, timestamp(UTC) in seconds

charges_handling

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

Possible values are

invoice_immediatelyInvoice immediately.add_to_unbilled_chargesAdd to unbilled charges.

unpaid_invoices_handling

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

Possible values are

no_actionRetain as unpaid.schedule_payment_collectionCollect payment.

subscription

Resource object representing subscription.
always returned

customer

Resource object representing customer.
always returned

card

Resource object representing card.
optional

invoice

Resource object representing invoice.
optional

unbilled_charges

Resource object representing unbilled_charge.
optional

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/8avVGOkx8U1MX/remove_scheduled_pause \
     -X POST  \
     -u {site_api_key}:

copy

curl  https://{site}.chargebee.com/api/v2/subscriptions/8avVGOkx8U1MX/remove_scheduled_pause \
     -X POST  \
     -u {site_api_key}:

Sample Response [ JSON ]

{
    "card": {
        "card_type": "visa",
        "customer_id": "5SK0b54PR6F9qEB9O",
        "expiry_month": 1,
        "expiry_year": 2032,
        "funding_type": "credit",
        "gateway": "chargebee",
        "gateway_account_id": "gw_5SK0b54PR6F92Xh2",
        "iin": "411111",
        "last4": "1111",
        "masked_number": "************1111",
        "object": "card",
        "payment_source_id": "pm_5SK0b54PR6F9qEp9Q",
        "status": "valid"
    },
    "customer": {
        "allow_direct_debit": false,
        "auto_collection": "on",
        "card_status": "valid",
        "created_at": 1539327148,
        "deleted": false,
        "email": "joe@user.com",
        "excess_payments": 0,
        "first_name": "Joe",
        "id": "5SK0b54PR6F9qEB9O",
        "last_name": "D",
        "net_term_days": 0,
        "object": "customer",
        "payment_method": {
            "gateway": "chargebee",
            "gateway_account_id": "gw_5SK0b54PR6F92Xh2",
            "object": "payment_method",
            "reference_id": "tok_5SK0b54PR6F9qEl9P",
            "status": "valid",
            "type": "card"
        },
        "pii_cleared": "active",
        "preferred_currency_code": "USD",
        "primary_payment_source_id": "pm_5SK0b54PR6F9qEp9Q",
        "promotional_credits": 0,
        "refundable_credits": 0,
        "resource_version": 1539327149000,
        "taxability": "taxable",
        "unbilled_charges": 0,
        "updated_at": 1539327149
    },
    "subscription": {
        "activated_at": 1539327148,
        "addons": [
            {
                "amount": 190,
                "id": "data_usage",
                "object": "addon",
                "quantity": 2,
                "unit_price": 95
            },
            {..}
        ],
        "billing_period": 1,
        "billing_period_unit": "month",
        "created_at": 1539327148,
        "currency_code": "USD",
        "current_term_end": 1542005548,
        "current_term_start": 1539327148,
        "customer_id": "5SK0b54PR6F9qEB9O",
        "deleted": false,
        "due_invoices_count": 0,
        "has_scheduled_changes": false,
        "id": "5SK0b54PR6F9qEB9O",
        "mrr": 0,
        "next_billing_at": 1542005548,
        "object": "subscription",
        "plan_amount": 3000,
        "plan_free_quantity": 0,
        "plan_id": "no_trial",
        "plan_quantity": 3,
        "plan_unit_price": 1000,
        "resource_version": 1539327150000,
        "started_at": 1539327148,
        "status": "active",
        "updated_at": 1539327150
    }
}

URL Format POST

https://{site}.chargebee.com/api/v2/subscriptions/{subscription_id}/remove_scheduled_pause

subscription

Resource object representing subscription.
always returned

customer

Resource object representing customer.
always returned

card

Resource object representing card.
optional

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/8avVGOkx8U1MX/remove_scheduled_resumption \
     -X POST  \
     -u {site_api_key}:

copy

curl  https://{site}.chargebee.com/api/v2/subscriptions/8avVGOkx8U1MX/remove_scheduled_resumption \
     -X POST  \
     -u {site_api_key}:

Sample Response [ JSON ]

{
    "card": {
        "card_type": "visa",
        "customer_id": "5SK0b54PR6F9qEB9O",
        "expiry_month": 1,
        "expiry_year": 2032,
        "funding_type": "credit",
        "gateway": "chargebee",
        "gateway_account_id": "gw_5SK0b54PR6F92Xh2",
        "iin": "411111",
        "last4": "1111",
        "masked_number": "************1111",
        "object": "card",
        "payment_source_id": "pm_5SK0b54PR6F9qEp9Q",
        "status": "valid"
    },
    "customer": {
        "allow_direct_debit": false,
        "auto_collection": "on",
        "card_status": "valid",
        "created_at": 1539327148,
        "deleted": false,
        "email": "joe@user.com",
        "excess_payments": 0,
        "first_name": "Joe",
        "id": "5SK0b54PR6F9qEB9O",
        "last_name": "D",
        "net_term_days": 0,
        "object": "customer",
        "payment_method": {
            "gateway": "chargebee",
            "gateway_account_id": "gw_5SK0b54PR6F92Xh2",
            "object": "payment_method",
            "reference_id": "tok_5SK0b54PR6F9qEl9P",
            "status": "valid",
            "type": "card"
        },
        "pii_cleared": "active",
        "preferred_currency_code": "USD",
        "primary_payment_source_id": "pm_5SK0b54PR6F9qEp9Q",
        "promotional_credits": 0,
        "refundable_credits": 0,
        "resource_version": 1539327149000,
        "taxability": "taxable",
        "unbilled_charges": 0,
        "updated_at": 1539327149
    },
    "subscription": {
        "activated_at": 1539327148,
        "addons": [
            {
                "amount": 190,
                "id": "data_usage",
                "object": "addon",
                "quantity": 2,
                "unit_price": 95
            },
            {..}
        ],
        "billing_period": 1,
        "billing_period_unit": "month",
        "created_at": 1539327148,
        "currency_code": "USD",
        "current_term_end": 1542005548,
        "current_term_start": 1539327148,
        "customer_id": "5SK0b54PR6F9qEB9O",
        "deleted": false,
        "due_invoices_count": 0,
        "has_scheduled_changes": false,
        "id": "5SK0b54PR6F9qEB9O",
        "mrr": 0,
        "object": "subscription",
        "pause_date": 1539327151,
        "plan_amount": 3000,
        "plan_free_quantity": 0,
        "plan_id": "no_trial",
        "plan_quantity": 3,
        "plan_unit_price": 1000,
        "resource_version": 1539327151000,
        "started_at": 1539327148,
        "status": "paused",
        "updated_at": 1539327151
    }
}

URL Format POST

https://{site}.chargebee.com/api/v2/subscriptions/{subscription_id}/remove_scheduled_resumption

subscription

Resource object representing subscription.
always returned

customer

Resource object representing customer.
always returned

card

Resource object representing card.
optional

Sample subscription [ JSON ]

API Index URL GET

Subscription attributes

Create a subscription¶

Future Subscriptions

Trial Period

Invoice

Card details

Billing Address

Related Tutorials

Sample Response [ JSON ]

URL Format POST

Input Parameters

Returns

Create subscription for customer¶

Notes

Sample Response [ JSON ]

URL Format POST

Input Parameters

Returns

List subscriptions¶

Sample Response [ JSON ]

URL Format GET

Input Parameters

Filter Params

For operator usages, see the Pagination and Filtering section.

Returns

Retrieve a subscription¶

Sample Response [ JSON ]

URL Format GET

Returns

Sample admin console URL

Retrieve with scheduled changes¶

Sample Response [ JSON ]

URL Format GET

Returns

Remove scheduled changes¶

Sample Response [ JSON ]

URL Format POST

Returns

Remove scheduled cancellation¶

Sample Response [ JSON ]

URL Format POST

Input Parameters

Returns

Remove coupons¶

Sample Response [ JSON ]

URL Format POST

Input Parameters

Returns

Update a subscription¶

Notes

Sample Response [ JSON ]

URL Format POST

Input Parameters

Returns

Change term end¶

Notes

Sample Response [ JSON ]

URL Format POST

Input Parameters

Returns

Cancel a subscription¶

CREDIT OPTION

UNBILLED CHARGES

ACCOUNT RECEIVABLES

ACCOUNT PAYABLES

Notes

Sample Response [ JSON ]

URL Format POST

Input Parameters

Returns

Reactivate a subscription¶

Notes

Sample Response [ JSON ]

URL Format POST

Input Parameters

Returns

Add charge at term end¶