You are viewing the documentation for Chargebee API V2. If you're using the older version (V1), click here.

A Chargebee subscription connects a customer record to products/services. It describes what the customer has signed up for and how often they're charged for it. The essential components of a subscription are:

The charges in a subscription are billed via invoices.

Note: The maximum number of subscriptions for any given customer (active or not) is 900.

When creating or updating a subscription, one of the item prices specified under subscription_items must be a plan-item price. The remaining must be compatible addon- or charge-item prices. An item price is compatible with a plan-item price if their currencies are the same. Additionally, an addon-item price is compatible with a plan-item price only if their billing frequencies meet the following conditions:

period_unit for plan-item price Compatible period_unit for addon-item price
Compatible period for addon-item price
day day

The period of the plan-item price should be divisible by the period of the addon-item price.

Example

If the period of the plan-item price is 10, then the period of the addon-item price can be 10, 5, 2, or 1.

week week or day

The period (in days) of the plan-item price should be divisible by the period of the addon-item price.

Example

If the period of the plan-item price is 2, then the period of the addon-item price can be as follows depending on the value of period_unit:

  • for period_unit as week, period can be 2 or 1.
  • for period_unit as day, period can be 14, 7, 2, or 1.

month month

The period of the plan-item price should be divisible by the period of the addon-item price.

Example

If the period of the plan-item price is 6, then the period of the addon-item price can be 6, 3, 2, or 1.

year year or month

The period (in months) of the plan-item price should be divisible by the period of the addon-item price.

Example

If the period of the plan-item price is 2, then the period of the addon-item price can be as follows depending on the value of period_unit:

  • for period_unit as year, period can be 2 or 1.
  • for period_unit as month, period can be 24, 12, 8, 6, 4, 3, 2, or 1.

See also
  • Purchase: a resource that represents multiple subscriptions bought together by a customer.

Sample subscription [ JSON ]

{ "activated_at": 1612890916, "billing_period": 1, "billing_period_unit": "month", "created_at": 1612890916, "currency_code": "USD", "current_term_end": 1615310116, "current_term_start": 1612890916, "customer_id": "__test__8asukSOXdulGOV", "deleted": false, "due_invoices_count": 1, "due_since": 1612890916, "has_scheduled_changes": false, "id": "__test__8asukSOXduqmOY", "mrr": 0, "next_billing_at": 1615310116, "object": "subscription", "remaining_billing_cycles": 1, "resource_version": 1612890917000, "started_at": 1612890916, "status": "active", "subscription_items": [ { "amount": 1000, "billing_cycles": 1, "free_quantity": 0, "item_price_id": "basic-USD", "item_type": "plan", "object": "subscription_item", "quantity": 1, "unit_price": 1000 }, { "amount": 100, "item_price_id": "day-pass-USD", "item_type": "addon", "object": "subscription_item", "quantity": 1, "unit_price": 100 } ], "total_dues": 1100, "updated_at": 1612890917 }

API Index URL GET

https://{site}.chargebee.com/api/v2/subscriptions
id
string, max chars=50
A unique and immutable identifier for the subscription. If not provided, it is autogenerated.
currency_code
string, max chars=3
The currency code (ISO 4217 format) of the subscription
start_date
optional, timestamp(UTC) in seconds
Applicable only for 'future' subscriptions. The scheduled start time of the subscription.
trial_end
optional, timestamp(UTC) in seconds
End of the trial period for the subscription. Presence of this value for 'future' subscription implies the subscription will go into 'in_trial' state when it starts.
remaining_billing_cycles
optional, integer, min=0
  • When the subscription is not on a contract term: this value is the number of billing cycles remaining after the current cycle, at the end of which, the subscription cancels.
  • When the subscription is on a contract term: this value is the number of billing cycles remaining in the contract term after the current billing cycle.

po_number
optional, string, max chars=100
Purchase order number for this subscription.
plan_quantity_in_decimal
optional, string, max chars=33
The decimal representation of the quantity of the plan purchased. Returned for quantity-based plans when multi-decimal pricing is enabled.
plan_unit_price_in_decimal
optional, string, max chars=39
The decimal representation of the price or per-unit price of the plan. The value is in major units of the currency. Always returned when multi-decimal pricing is enabled.
customer_id
string, max chars=50
Identifier of the customer with whom this subscription is associated.
status
enumerated string
Current state of the subscription
Possible values are
futureThe subscription is scheduled to start at a future date.in_trialThe subscription is in trial.activeThe subscription is active and will be charged for automatically based on the items in it.non_renewingThe subscription will be canceled at the end of the current term.pausedThe subscription is paused. The subscription will not renew while in this state.cancelledThe subscription has been canceled and is no longer in service.
trial_start
optional, timestamp(UTC) in seconds
Start of the trial period for the subscription. Presence of this value for future subscription implies the subscription will go into in_trial state when it starts.
trial_end_action
optional, enumerated string
Applicable only when End-of-trial Action has been enabled for the site. Whenever the subscription has a trial period, this attribute (parameter) is returned (required) and specifies the operation to be carried out for the subscription once the trial ends.
Possible values are
site_defaultThe action configured for the site at the time when the trial ends, takes effect. This is the default value when trial_end_action is not defined for the plan.plan_defaultThe action configured for the site at the time when the trial ends, takes effect. This is the default value when trial_end_action is defined for the plan.activate_subscriptionThe subscription activates and charges are raised for non-metered items.cancel_subscriptionThe subscription cancels.
current_term_start
optional, timestamp(UTC) in seconds
Start of the current billing period of the subscription.
current_term_end
optional, timestamp(UTC) in seconds
End of the current billing period of the subscription. Subscription is renewed immediately after this
next_billing_at
optional, timestamp(UTC) in seconds
The date/time at which the next billing for the subscription happens. This is usually right after current_term_end unless multiple subscription terms were invoiced in advance using the terms_to_charge parameter.
created_at
optional, timestamp(UTC) in seconds
The time at which the subscription was created.
started_at
optional, timestamp(UTC) in seconds
Time at which the subscription was started. Is null for futuresubscriptions as it is yet to be started.
activated_at
optional, timestamp(UTC) in seconds
Time at which the subscription status last changed to  active. For example, this value is updated when an in_trial or  cancelled subscription activates.
contract_term_billing_cycle_on_renewal
optional, integer, min=1, max=100
Number of billing cycles the new contract term should run for, on contract renewal. The default value is the same as billing_cycles or a custom value depending on the site configuration.
override_relationship
optional, boolean
If true, ignores the hierarchy relationship and uses customer as payment and invoice owner.
pause_date
optional, timestamp(UTC) in seconds
When a pause has been scheduled, it is the date/time of scheduled pause. When the subscription is in the paused state, it is the date/time when the subscription was paused.
resume_date
optional, timestamp(UTC) in seconds
For a paused subscription, it is the date/time when the subscription is scheduled to resume. If the pause is for an indefinite period, this value is not returned.
cancelled_at
optional, timestamp(UTC) in seconds
Time at which subscription was cancelled or is set to be cancelled.
cancel_reason
optional, enumerated string
The reason for canceling the subscription. Set by Chargebee automatically.
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.
created_from_ip
optional, string, max chars=50
The IP address of the user. Used primarly in Refersion integration. Refersion uses this field to track/log affiliate subscription.
resource_version
optional, long
Version number of this resource. The resource_version is updated with a new timestamp in milliseconds for every change made to the resource. This attribute will be present only if the resource has been updated after 2016-09-28.
updated_at
optional, timestamp(UTC) in seconds
Timestamp indicating when the item was last updated.
has_scheduled_advance_invoices
boolean, default=false
The subscription has an advance invoicing schedule.
has_scheduled_changes
boolean, default=false
If true, there are subscription changes scheduled on next renewal.
payment_source_id
optional, string, max chars=40
Payment source attached to this subscription. If present, customer's payment sources won't be used to collect any payment for this subscripiton.
plan_free_quantity_in_decimal
optional, string, max chars=33
The free_quantity_in_decimal as set for the plan. Returned for quantity-based plans when multi-decimal pricing is enabled.
plan_amount_in_decimal
optional, string, max chars=39
The decimal representation of the total amount for the plan, in major units of the currency. Always returned when multi-decimal pricing is enabled.
cancel_schedule_created_at
optional, timestamp(UTC) in seconds
This is the date/time at which the most recent cancellation schedule for the subscription was created in Chargebee. Applicable only for cancelled subscriptions or subscriptions that are scheduled for cancellation.
channel
optional, enumerated string
The subscription channel this object originated from and is maintained in.
Possible values are
webThe object was created (and is maintained) for the web channel directly in Chargebee via API or UI.app_storeThe object data is synchronized with data from in-app subscription(s) created in Apple App Store. Direct manipulation of this object via UI or API is disallowed.play_storeThe object data is synchronized with data from in-app subscription(s) created in Google Play Store. Direct manipulation of this object via UI or API is disallowed.

In-App Subscriptions is currently in early access. Contact eap@chargebee.com for more information.
.
net_term_days
optional, integer
The Net D value explicitly set for this subscription. Net D is the number of days within which any invoice raised for the subscription must be paid. When an invoice is raised, and this value is unavailable, the net_term_days defined at the customer level is considered.
due_invoices_count
optional, integer
Total number of invoices that are due for payment against the subscription.
Note: Not supported if consolidated invoicing is enabled, or when the subscription is for the customer who is in hierarchy, and the parent of this customer owns and pays for the invoices of the subscription. It is also worth noting that the consolidated invoice amount is not included in the calculation of due_invoices_count.
due_since
optional, timestamp(UTC) in seconds
Time since this subscription has unpaid invoices.
Note: Not supported if consolidated invoicing is enabled, or when the subscription is for the customer who is in hierarchy, and the parent of this customer owns and pays for the invoices of the subscription.
total_dues
optional, in cents, min=0
Total invoice due amount for this subscription. The value depends on the type of currency.
Note: Not supported if consolidated invoicing is enabled, or when the subscription is for the customer who is in hierarchy, and the parent of this customer owns and pays for the invoices of the subscription. It is also worth noting that the consolidated invoice amount is not included in the calculation of total_dues.
mrr
optional, in cents, min=1
Monthly recurring revenue for the subscription. Updated asynchronously, this value catches up with changes to the subscription in less than a minute. The value depends on the type of currency.
Note: This may not return accurate values since updated asynchronously.
exchange_rate
optional, bigdecimal, min=1E-9, max=999999999.999999999
Exchange rate used for base currency conversion.This value is updated to the rate configured on your site each time any change is made to the subscription.
base_currency_code
optional, string, max chars=3
The currency code (ISO 4217 format) of the site’s base currency.
invoice_notes
optional, string, max chars=2000
A customer-facing note added to all invoices associated with this subscription. This note is one among all the notes displayed on the invoice PDF.
metadata
optional, jsonobject
A set of key-value pairs stored as additional information for the subscription. Learn more.
deleted
boolean
Indicates that the subscription has been deleted. You can retrieve a deleted subscription using the list operation.
changes_scheduled_at
optional, timestamp(UTC) in seconds
If a subscription change has been scheduled, this is the date/time when the change is set to take effect. Note: As a limitation, this attribute is not returned when the change is scheduled to happen at the end of the current term.
cancel_reason_code
optional, string, max chars=100
Reason code for canceling the subscription. Must be one from a list of reason codes set in the Chargebee app in Settings > Configure Chargebee > Reason Codes > Subscriptions > Subscription Cancellation. Must be passed if set as mandatory in the app. The codes are case-sensitive
free_period
optional, integer
The period of time by which the first term of the subscription is to be extended free-of-charge. The value must be in multiples of free_period_unit."
free_period_unit
optional, enumerated string
Defines additional free period in association with the billing period.
Possible values are
dayCharge based on day(s).weekCharge based on week(s).monthCharge based on month(s).yearCharge based on year(s).
create_pending_invoices
optional, boolean

Indicates whether the invoices for this subscription are generated with a pending status. This attribute is set to true automatically when the subscription has item prices that belong to metered items.

You can also set this to true explicitly using the create/update subscription operations. This is useful in the following scenarios:

  • When tracking usages and calculating usage-based charges on your end. You can then add them to the subscription as a one-time charge at the end of the billing term.
  • When you need to inspect all charges before closing invoices for this subscription.

Applicable only when Metered Billing is enabled for the site


auto_close_invoices
optional, boolean
Set to false to override for this subscription, the site-level setting for auto-closing invoices. Only applicable when auto-closing invoices has been enabled for the site. This attribute has a higher precedence than the same attribute at the customer level.
business_entity_id
optional, string, max chars=50
The unique ID of the business entity of this subscription. This is always the same as the business entity of the customer.
subscription_items
Show attributes[+]
optional, list of subscription_item
Details of individual item prices that are part of this subscription.
Subscription item attributes
item_price_id
string, max chars=100
The unique identifier of the item price.
item_type
enumerated string
The type of item. There must be one and only one item of type plan in this list.
Possible values are
planPlanaddonAddonchargeCharge
quantity
optional, integer, min=1
The quantity of the item purchased
quantity_in_decimal
optional, string, max chars=33
The decimal representation of the quantity of the item purchased. Can be provided for quantity-based item prices and only when multi-decimal pricing is enabled.
unit_price
optional, in cents, min=0
The price/per unit price of the item. When not provided, the value set for the item price is used. This is only applicable when the pricing_model of the item price is flat_fee or per_unit. Also, it is only allowed when price overriding is enabled for the site. The value depends on the type of currency. If changes_scheduled_at is in the past and a unit_price is not passed, then the item price’s current unit price is considered even if the item price did not exist on the date as of when the change is scheduled.
unit_price_in_decimal
optional, string, max chars=39
The decimal representation of the price or per-unit price of the plan. The value is in major units of the currency. Always returned when multi-decimal pricing is enabled.
amount
optional, in cents, min=0
The total amount for the item as determined from unit_price, free_quantity, quantity and item_tiers as applicable. The value depends on the type of currency.
amount_in_decimal
optional, string, max chars=39
The decimal representation of the total amount for the item, in major units of the currency. Always returned when multi-decimal pricing is enabled.
free_quantity
optional, integer, min=0
The free_quantity of the plan-item as specified for the item price.
free_quantity_in_decimal
optional, string, max chars=33
The free_quantity_in_decimal as set for the item price. Returned for quantity-based item prices when multi-decimal pricing is enabled.
trial_end
optional, timestamp(UTC) in seconds
The date/time when the trial period of the item ends. Applies to plan-items and—-when enabled-—addon-items as well.
billing_cycles
optional, integer, min=0
For the plan-item price:
the value determines the number of billing cycles the subscription runs before canceling automatically. If not provided, then the value set for the plan-item price is used.

For addon-item prices:
If addon billing cycles are enabled then this is the number of subscription billing cycles for which the addon is included. If not provided, then the value set under attached addons is used. Further, if that value is not provided, then the value set for the addon-item price is used.
service_period_days
optional, integer, min=1, max=730
The service period of the item in days from the day of charge.
charge_on_event
optional, enumerated string
When charge_on_option option is set to on_event, this parameter specifies the event at which the charge-item is applied to the subscription. This parameter only applies to charge-items.
Possible values are
subscription_creationthe time of creation of the subscription.subscription_trial_startthe time when the trial period of the subscription begins.plan_activationsame as subscription activation, but also includes the case when the plan-item of the subscription is changed.subscription_activationthe moment a subscription enters an active or non-renewing state. Also includes reactivations of canceled subscriptions.contract_terminationwhen a contract term is terminated.
charge_once
optional, boolean
Indicates if the charge-item is to be charged only once or each time the charge_on_event occurs. This parameter only applies to charge-items.
charge_on_option
optional, enumerated string
Indicates when the charge-item is to be charged. This parameter only applies to charge-items.
Possible values are
immediatelyThe item is charged immediately on being added to the subscription.on_eventThe item is charged at the occurrence of the event specified as charge_on_event.
item_tiers
Show attributes[+]
optional, list of item_tier
The pricing details of subscription_items which have pricing_model as tiered, volume or stairstep.
Item tier attributes
item_price_id
string, max chars=100
The id of the item price to which this tier belongs.
starting_unit
integer, min=1
The lowest value in the quantity tier.
ending_unit
optional, integer
The highest value in the quantity tier.
price
in cents, default=0, min=0
The per-unit price for the tier when the pricing_model is tiered or volume. The total cost for the item price when the pricing_model is stairstep. The value is in the minor unit of the currency.
starting_unit_in_decimal
optional, string, max chars=33
The decimal representation of the the lowest value of quantity in this tier. This is zero for the lowest tier. For all other tiers, it is the same as ending_unit_in_decimal of the next lower tier. Returned only when the pricing_model is tiered, volume or stairstep and multi-decimal pricing is enabled.
ending_unit_in_decimal
optional, string, max chars=33
The decimal representation of the highest value of quantity in this tier. This attribute is not applicable for the highest tier. For all other tiers, it must be equal to the starting_unit_in_decimal of the next higher tier. Returned only when the pricing_model is tiered, volume or stairstep and multi-decimal pricing is enabled.
price_in_decimal
optional, string, max chars=39
The decimal representation of the per-unit price for the tier when the pricing_model is tiered or volume. When the pricing_model is stairstep, it is the decimal representation of the total price for the item. The value is in major units of the currency. Returned when the plan is quantity-based and multi-decimal pricing is enabled.
index
integer, min=0
The index number of the subscription to which the item price is added. Provide a unique number between 0 and 4 (inclusive) for each subscription that is to be created.
charged_items
Show attributes[+]
optional, list of charged_item
List of event based charge items that have already been charged.
Charged item attributes
item_price_id
string, max chars=100
A unique ID for your system to identify the item price.
last_charged_at
timestamp(UTC) in seconds
Timestamp indicating when this charge item_price was last charged for this subscription.
optional, list of coupon
List of coupons for this subscription
Coupon attributes
coupon_id
string, max chars=100
Used to uniquely identify the coupon
apply_till
optional, timestamp(UTC) in seconds
The date till when the coupon can be applied. Applicable for limited_period coupons only.
applied_count
integer, default=0
Number of times this coupon has been applied for this subscription
coupon_code
optional, string, max chars=50
The coupon code used to redeem the coupon. Will be present only when associated code for a coupon is used.
shipping_address
Show attributes[+]
optional, shipping_address
Shipping address for the subscription.
Shipping address attributes
first_name
optional, string, max chars=150
The first name of the contact.
last_name
optional, string, max chars=150
The last name of the contact.
email
optional, string, max chars=70
The email address.
company
optional, string, max chars=250
The company name.
phone
optional, string, max chars=50
The phone number.
line1
optional, string, max chars=150
Address line 1
line2
optional, string, max chars=150
Address line 2
line3
optional, string, max chars=150
Address line 3
city
optional, string, max chars=50
The name of the city.
state_code
optional, string, max chars=50
The ISO 3166-2 state/province code without the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set state_code as AZ (not US-AZ). For Tamil Nadu (India), set as TN (not IN-TN). For British Columbia (Canada), set as BC (not CA-BC).
state
optional, string, max chars=50
The state/province name.
country
optional, string, max chars=50
The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code.

Note: If you enter an invalid country code, the system will return an error.

Brexit

If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom – Northern Ireland) is available as an option.


zip
optional, string, max chars=20
Zip or postal code. The number of characters is validated according to the rules specified here.
validation_status
optional, enumerated string, default=not_validated
The address verification status.
Possible values are
not_validatedAddress is not yet validated.validAddress was validated successfully.partially_validThe address is valid for taxability but has not been validated for shipping.invalidAddress is invalid.
index
integer, min=0
The index number of the subscription to which the item price is added. Provide a unique number between 0 and 4 (inclusive) for each subscription that is to be created.
referral_info
Show attributes[+]
optional, referral_info
Referral details if exists for the subscription
Referral info attributes
referral_code
optional, string, max chars=50
Referral code if available for the subscription
coupon_code
optional, string, max chars=50
Referral coupon code if available for the subscription
referrer_id
optional, string, max chars=19
Referrer id if available for the subscription
external_reference_id
optional, string, max chars=50
External reference id in referral system for the subscription
reward_status
optional, enumerated string, default=pending
Reward status for the referral subscription
Possible values are
pendingPendingpaidPaidinvalidInvalid
referral_system
optional, enumerated string
Source referral system for the referral subscription
Possible values are
referral_candyReferral Candyreferral_saasquatchReferral SaasquatchfriendbuyFriendbuy
account_id
string, max chars=50
Referral account id
campaign_id
string, max chars=50
Referral campaign id
external_campaign_id
optional, string, max chars=100
Referral external campaign id
friend_offer_type
optional, enumerated string
Friend offer type for the referral camapign
Possible values are
noneNonecouponCouponcoupon_codeCoupon Code
referrer_reward_type
optional, enumerated string
Referrer reward type for the referral campaign
Possible values are
noneNonereferral_direct_rewardReferral Direct Rewardcustom_promotional_creditCustom Promotional Creditcustom_revenue_percent_basedCustom Revenue Percent Based
notify_referral_system
optional, enumerated string
Whether or not to notify the referral purchases to the referral system
Possible values are
noneNonefirst_paid_conversionFirst Paid Conversionall_invoicesAll Invoices
destination_url
optional, string, max chars=250
Destination url for the referral campaign
post_purchase_widget_enabled
boolean, default=true
Whether post purchase widget is enabled for this campaign
contract_term
Show attributes[+]
optional, contract_term
Contract terms for this subscription
Contract term attributes
id
string, max chars=50
Id that uniquely identifies the contract term in the site.
status
enumerated string
Current status of contract
Possible values are
activeAn actively running contract term.completedThe contract term has run its full duration.cancelledThe contract term was ended because: terminatedThe contract term was terminated ahead of completion.
contract_start
timestamp(UTC) in seconds
The start date of the contract term
contract_end
timestamp(UTC) in seconds
The end date of the contract term
billing_cycle
integer, min=0
The number of billing cycles of the subscription that the contract term is for.
action_at_term_end
enumerated string, default=renew
Action to be taken when the contract term completes.
Possible values are
renew
  • Contract term completes and a new contract term is started for the number of billing cycles specified in contract_billing_cycle_on_renewal.
  • The action_at_term_end for the new contract term is set to renew.
  • evergreenContract term completes and the subscription renews.cancelContract term completes and subscription is canceled.renew_onceUsed when you want to renew the contract term just once. Does the following:
  • Contract term completes and a new contract term is started for the number of billing cycles specified in contract_billing_cycle_on_renewal.
  • The action_at_term_end for the new contract term is set to cancel.
  • total_contract_value
    in cents, default=0, min=0
    The sum of the totals of all the invoices raised as part of the contract term. For active contract terms, this is a predicted value. The value depends on the type of currency. If the subscription was imported with the contract term, then this value includes the value passed for total_amount_raised.
    total_contract_value_before_tax
    in cents, default=0, min=0
    It refers to the total amount of revenue that is expected to be generated from a specific contract term, calculated as the sum of all invoices raised during the term, regardless of payment status. It is based on past performance and the specified currency in the contract. If the subscription was imported, the value for total_amount_raised_before_tax is included in the calculation of the total contract value before tax. It's important to note that this value excludes any applicable taxes.
    cancellation_cutoff_period
    optional, integer
    The number of days before contract_end, during which the customer is barred from canceling the contract term. The customer is allowed to cancel the contract term via the Self-Serve Portal only before this period. This allows you to have sufficient time for processing the contract term closure
    created_at
    timestamp(UTC) in seconds
    The date when the contract term was created.
    subscription_id
    string, max chars=50
    The Id of the subscription that this contract term is for.
    remaining_billing_cycles
    optional, integer, min=0
    The number of subscription billing cycles remaining after the current one for the contract term. This attribute is only returned for active contract terms.
    discounts
    Show attributes[+]
    optional, list of discount
    List of discounts for this subscription
    Discount attributes
    id
    string, max chars=50
    An immutable unique id for the discount. It is always auto-generated.
    invoice_name
    optional, string, max chars=100
    The name of the discount as it should appear on customer-facing pages and documents such as invoices and hosted pages. This is auto-generated based on the type, amount, and currency_code of the discount. For example, it can be 10% off or 10$ off.
    type
    enumerated string, default=percentage
    The type of discount. Possible value are:
    Possible values are
    fixed_amountThe specified amount will be given as discount.percentageThe specified percentage will be given as discount.
    percentage
    optional, double, min=0.01, max=100.0
    The percentage of the original amount that should be deducted from it. Only applicable when discount.type is percentage.
    amount
    optional, in cents, min=0
    The value of the discount. The format of this value depends on the kind of currency. This is only applicable when discount.type is fixed_amount.
    currency_code
    optional, string, max chars=3
    The currency code (ISO 4217 format) of the discount. This is only applicable when discount.type is fixed_amount.
    duration_type
    enumerated string, default=forever
    Specifies the time duration for which this discount is attached to the subscription.
    Possible values are
    one_timeThe discount stays attached to the subscription till it is applied on an invoice once. It is removed after that from the subscription.foreverThe discount is attached to the subscription and applied on the invoices till it is explicitly removed.limited_periodThe discount is attached to the subscription and applied on the invoices for a limited duration. This duration starts from the point it is applied to an invoice for the first time and expires after a period specified by period and period_unit.
    period
    optional, integer, min=1
    The duration of time for which the discount is attached to the subscription, in period_units. Applicable only when duration_type is limited_period.
    period_unit
    optional, enumerated string
    The unit of time for period. Applicable only when duration_type is limited_period.
    Possible values are
    dayA period of 24 hours.weekA period of 7 days.monthA period of 1 calendar month.yearA period of 1 calendar year.
    included_in_mrr
    boolean
    The discount is included in MRR calculations for your site. This attribute is only applicable when duration_type is one_time and when the feature is enabled in Chargebee. Also, If the site-level setting is to exclude one-time discounts from MRR calculations, this value is always returned false.
    apply_on
    enumerated string
    The amount on the invoice to which the discount is applied.
    Possible values are
    invoice_amountThe discount is applied to the invoice sub_total.specific_item_priceThe discount is applied to the invoice.line_item.amount that corresponds to the item price specified by item_price_id.
    item_price_id
    optional, string, max chars=100
    The id of the item price in the subscription to which the discount is to be applied. Relevant only when apply_on = specific_item_price.
    created_at
    timestamp(UTC) in seconds
    Timestamp indicating when this discount is created.
    apply_till
    optional, timestamp(UTC) in seconds
    Specifies till when the limited period discount is applicable. This attribute will be sent in the response only for limited_period duration type discount.
    applied_count
    optional, integer
    Specifies the number of times the discount has been applied.
    coupon_id
    string, max chars=100

    Used to uniquely identify the coupon in your website/application and to integrate with Chargebee.

    Note:

    When the coupon ID contains a special character; for example: #, the API returns an error. Make sure that you encode the coupon ID in the path parameter before making an API call.


    index
    integer, min=0
    The index number of the subscription to which the item price is added. Provide a unique number between 0 and 4 (inclusive) for each subscription that is to be created.
    Note: This endpoint optionally supports 3DS. To use it create a payment_intent and provide it via this endpoint.

    Creates a new subscription for an existing customer in Chargebee. Any available credits and excess payments for the customer are automatically applied on the invoice.

    See also
    • Create a purchase: an operation that creates a purchase representing multiple subscriptions bought together by a customer.
    Sample Request
    curl  https://{site}.chargebee.com/api/v2/customers/__test__8asz8Ru9WhHOJO/subscription_for_items \
         -X POST  \
         -u {site_api_key}:\
         -d subscription_items[item_price_id][0]="basic-USD" \
         -d subscription_items[billing_cycles][0]=2 \
         -d subscription_items[quantity][0]=1 \
         -d subscription_items[item_price_id][1]="day-pass-USD" \
         -d subscription_items[unit_price][1]=100
    copy
    curl  https://{site}.chargebee.com/api/v2/customers/__test__8asz8Ru9WhHOJO/subscription_for_items \
         -X POST  \
         -u {site_api_key}:\
         -d subscription_items[item_price_id][0]="basic-USD" \
         -d subscription_items[billing_cycles][0]=2 \
         -d subscription_items[quantity][0]=1 \
         -d subscription_items[item_price_id][1]="day-pass-USD" \
         -d subscription_items[unit_price][1]=100

    Sample Response [ JSON ]

    Show more...
    { "customer": { "allow_direct_debit": false, "auto_collection": "off", "card_status": "no_card", "created_at": 1612890916, "deleted": false, "excess_payments": 0, "first_name": "John", "id": "__test__8asukSOXdulGOV", "last_name": "Doe", "net_term_days": 0, "object": "customer", "pii_cleared": "active", "preferred_currency_code": "USD", "promotional_credits": 0, "refundable_credits": 0, "resource_version": 1612890916000, "taxability": "taxable", "unbilled_charges": 0, "updated_at": 1612890916 }, "invoice": { "adjustment_credit_notes": [], "amount_adjusted": 0, "amount_due": 1100, "amount_paid": 0, "amount_to_collect": 1100, "applied_credits": [], "base_currency_code": "USD", "billing_address": { "first_name": "John", "last_name": "Doe", "object": "billing_address", "validation_status": "not_validated" }, "credits_applied": 0, "currency_code": "USD", "customer_id": "__test__8asukSOXdulGOV", "date": 1612890916, "deleted": false, "due_date": 1612890916, "dunning_attempts": [], "exchange_rate": 1, "first_invoice": true, "has_advance_charges": false, "id": "__demo_inv__10", "is_gifted": false, "issued_credit_notes": [], "line_items": [ { "amount": 1000, "customer_id": "__test__8asukSOXdulGOV", "date_from": 1612890916, "date_to": 1615310116, "description": "basic USD", "discount_amount": 0, "entity_id": "basic-USD", "entity_type": "plan_item_price", "id": "li___test__8asukSOXdutkOa", "is_taxed": false, "item_level_discount_amount": 0, "object": "line_item", "pricing_model": "per_unit", "quantity": 1, "subscription_id": "__test__8asukSOXduqmOY", "tax_amount": 0, "tax_exempt_reason": "tax_not_configured", "unit_amount": 1000 }, {..} ], "linked_orders": [], "linked_payments": [], "net_term_days": 0, "new_sales_amount": 1100, "object": "invoice", "price_type": "tax_exclusive", "recurring": true, "resource_version": 1612890917000, "round_off_amount": 0, "status": "payment_due", "sub_total": 1100, "subscription_id": "__test__8asukSOXduqmOY", "tax": 0, "term_finalized": true, "total": 1100, "updated_at": 1612890917, "write_off_amount": 0 }, "subscription": { "activated_at": 1612890916, "billing_period": 1, "billing_period_unit": "month", "created_at": 1612890916, "currency_code": "USD", "current_term_end": 1615310116, "current_term_start": 1612890916, "customer_id": "__test__8asukSOXdulGOV", "deleted": false, "due_invoices_count": 1, "due_since": 1612890916, "has_scheduled_changes": false, "id": "__test__8asukSOXduqmOY", "mrr": 0, "next_billing_at": 1615310116, "object": "subscription", "remaining_billing_cycles": 1, "resource_version": 1612890917000, "started_at": 1612890916, "status": "active", "subscription_items": [ { "amount": 1000, "billing_cycles": 1, "free_quantity": 0, "item_price_id": "basic-USD", "item_type": "plan", "object": "subscription_item", "quantity": 1, "unit_price": 1000 }, {..} ], "total_dues": 1100, "updated_at": 1612890917 } }

    URL Format POST

    https://{site}.chargebee.com/api/v2/customers/{customer_id}/subscription_for_items
    id
    optional, string, max chars=50
    A unique and immutable identifier for the subscription. If not provided, it is autogenerated.
    business_entity_id
    optional, string, max chars=50

    The unique ID of the business entity this subscription should be linked to. Applicable only when multiple business entities have been created for the site. This must be the same as the business entity of the {customer_id} for the operation to be successful.

    Note

    An alternative way of passing this parameter is by means of a custom HTTP header.

    .
    trial_end
    optional, timestamp(UTC) in seconds
    End of the trial period for the subscription. This overrides the trial period set for the plan-item. The value must be later than start_date. Set it to 0 to have no trial period.
    billing_cycles
    optional, integer, min=0
    The number of billing cycles the subscription runs before canceling. If not provided, then the billing cycles set for the plan-item price is used.
    mandatory_items_to_remove[0..n]
    optional, list of string
    Item ids of mandatorily attached addons that are to be removed from the subscription.
    net_term_days
    optional, integer
    Defines Net D for the subscription. Net D is the number of days within which any invoice raised for the subscription must be paid.
    • If a value is provided: Net D is set explicitly for the subscription to the value provided. The value must be one among those defined in the site configuration.
    • If not provided: The attribute is not set and therefore not returned by the API. In this case, when an invoice is raised – whether now or later – the net_term_days defined at the customer level is considered.
    .
    start_date
    optional, timestamp(UTC) in seconds
    The date/time at which the subscription is to start. If not provided, the subscription starts immediately. You can provide a value in the past as well. This is called backdating the subscription creation and is done when the subscription has already been provisioned but its billing has been delayed. Backdating is allowed only when the following prerequisites are met:
    • Backdating is enabled for subscription creation operations.
    • The current day of the month does not exceed the limit set in Chargebee for backdating such operations. This day is typically the day of the month by which the accounting for the previous month must be closed.
    • The date is not more than duration X into the past, where X is the billing period of the plan. For example, if the period of the plan in the subscription is 2 months and today is 14th April, start_date cannot be earlier than 14th February.
    .
    auto_collection
    optional, enumerated string
    Defines whether payments need to be collected automatically for this subscription. Overrides customer's auto-collection property.
    Possible values are
    onWhenever an invoice is created for this subscription, an automatic charge will be attempted on the payment method available.offAutomatic collection of charges will not be made for this subscription. Use this for offline payments.
    terms_to_charge
    optional, integer, min=1
    The number of subscription billing cycles (including the first one) to invoice in advance.
    billing_alignment_mode
    optional, enumerated string
    Override the billing alignment mode for Calendar Billing. Only applicable when using Calendar Billing. The default value is that which has been configured for the site.
    Possible values are
    immediateSubscription period will be aligned with the configured billing date immediately, with credits or charges raised accordingly..delayedSubscription period will be aligned with the configured billing date at the next renewal.
    po_number
    optional, string, max chars=100
    Purchase order number for this subscription.
    coupon_ids[0..n]
    optional, list of string
    List of coupons to be applied to this subscription. You can provide coupon ids or coupon codes.
    payment_source_id
    optional, string, max chars=40
    Id of the payment source to be attached to this subscription.
    override_relationship
    optional, boolean
    If true, ignores the hierarchy relationship and uses customer as payment and invoice owner.
    invoice_notes
    optional, string, max chars=2000
    A customer-facing note added to all invoices associated with this subscription. This note is one among all the notes displayed on the invoice PDF.
    invoice_date
    optional, timestamp(UTC) in seconds
    The document date displayed on the invoice PDF. The default value is the current date. Provide this value to backdate the invoice. Backdating an invoice is done for reasons such as booking revenue for a previous date or when the subscription is effective as of a past date. Moreover, if create_pending_invoices is set to true, and if the site is configured to set invoice dates to the date of closing, then upon invoice closure, this date is changed to the invoice closing date. taxes and line_item_taxes are computed based on the tax configuration as of invoice_date. When passing this parameter, the following prerequisites must be met:
    • invoice_date must be in the past.
    • It is not earlier than start_date.
    • It is not more than one calendar month into the past. Eg. If today is 13th January, then you cannot pass a value that is earlier than 13th December.
    • invoice_immediately is true.
    .
    meta_data
    optional, jsonobject
    A set of key-value pairs stored as additional information for the subscription. Learn more.
    invoice_immediately
    optional, boolean
    If there are charges raised immediately for the subscription, this parameter specifies whether those charges are to be invoiced immediately or added to unbilled charges. The default value is as per the site settings.
    Note: invoice_immediately only affects charges that are raised at the time of execution of this API call. Any charges scheduled to be raised in the future are not affected by this parameter.
    .
    replace_primary_payment_source
    optional, boolean, default=true
    Indicates whether the primary payment source should be replaced with this payment source. In case of Create Subscription for Customer endpoint, the default value is True. Otherwise, the default value is False.
    free_period
    optional, integer, min=1
    The period of time by which the first term of the subscription is to be extended free-of-charge. The value must be in multiples of free_period_unit.
    free_period_unit
    optional, enumerated string
    The unit of time in multiples of which the free_period parameter is expressed. The value must be equal to or lower than the period_unit attribute of the plan chosen.
    Possible values are
    dayCharge based on day(s)weekCharge based on week(s)monthCharge based on month(s)yearCharge based on year(s)
    contract_term_billing_cycle_on_renewal
    optional, integer, min=1, max=100
    Number of billing cycles the new contract term should run for, on contract renewal. The default value is the same as billing_cycles or a custom value depending on the site configuration.
    create_pending_invoices
    optional, boolean

    Indicates whether the invoices for this subscription are generated with a pending status. This attribute is set to true automatically when the subscription has item prices that belong to metered items.

    You can also set this to true explicitly using the create/update subscription operations. This is useful in the following scenarios:

    • When tracking usages and calculating usage-based charges on your end. You can then add them to the subscription as a one-time charge at the end of the billing term.
    • When you need to inspect all charges before closing invoices for this subscription.

    Applicable only when Metered Billing is enabled for the site

    .
    auto_close_invoices
    optional, boolean
    Set to false to override for this subscription, the site-level setting for auto-closing invoices. Only applicable when auto-closing invoices has been enabled for the site. This attribute has a higher precedence than the same attribute at the customer level.
    first_invoice_pending
    optional, boolean, default=false

    If you want to bill the usages from the previous billing cycle, set this parameter to true. This is useful if the subscription has moved from another system into Chargebee and you haven’t closed the previous cycle’s invoice yet. This creates a pending invoice immediately on subscription creation, to which you can add usages for the previous cycle.

    If any non-metered items are present for the current term, they’re also added to this pending invoice. As with all pending invoices, this invoice is also closed automatically or via an API call. This parameter can be passed only when the create_pending_invoices is true

    .
    trial_end_action
    optional, enumerated string
    Applicable only when End-of-trial Action has been enabled for the site. Whenever the subscription has a trial period, this attribute (parameter) is returned (required) and specifies the operation to be carried out for the subscription once the trial ends.
    Possible values are
    site_defaultThe action configured for the site at the time when the trial ends, takes effect. This is the default value when trial_end_action is not defined for the plan.plan_defaultThe action configured for the site at the time when the trial ends, takes effect. This is the default value when trial_end_action is defined for the plan.activate_subscriptionThe subscription activates and charges are raised for non-metered items.cancel_subscriptionThe subscription cancels.
    payment_initiator
    optional, enumerated string
    The type of initiator to be used for the payment request triggered by this operation.
    Possible values are
    customerPass this value to indicate that the request is initiated by the customermerchantPass this value to indicate that the request is initiated by the merchant
    +
    shipping_address
    Parameters for shipping_address
    pass parameters as shipping_address[<param name>]
    shipping_address[first_name]
    optional, string, max chars=150
    The first name of the contact.
    shipping_address[last_name]
    optional, string, max chars=150
    The last name of the contact.
    shipping_address[email]
    optional, string, max chars=70
    The email address.
    shipping_address[company]
    optional, string, max chars=250
    The company name.
    shipping_address[phone]
    optional, string, max chars=50
    The phone number.
    shipping_address[line1]
    optional, string, max chars=150
    Address line 1
    shipping_address[line2]
    optional, string, max chars=150
    Address line 2
    shipping_address[line3]
    optional, string, max chars=150
    Address line 3
    shipping_address[city]
    optional, string, max chars=50
    The name of the city.
    shipping_address[state_code]
    optional, string, max chars=50
    The ISO 3166-2 state/province code without the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set state_code as AZ (not US-AZ). For Tamil Nadu (India), set as TN (not IN-TN). For British Columbia (Canada), set as BC (not CA-BC).
    shipping_address[state]
    optional, string, max chars=50
    The state/province name. Is set by Chargebee automatically for US, Canada and India If state_code is provided.
    shipping_address[zip]
    optional, string, max chars=20
    Zip or postal code. The number of characters is validated according to the rules specified here.
    shipping_address[country]
    optional, string, max chars=50
    The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code.

    Note: If you enter an invalid country code, the system will return an error.

    Brexit

    If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom – Northern Ireland) is available as an option.

    shipping_address[validation_status]
    optional, enumerated string, default=not_validated
    The address verification status.
    Possible values are
    not_validatedAddress is not yet validated.validAddress was validated successfully.partially_validThe address is valid for taxability but has not been validated for shipping.invalidAddress is invalid.
    +
    payment_intent
    Parameters for payment_intent
    pass parameters as payment_intent[<param name>]
    payment_intent[id]
    optional, string, max chars=150
    Identifier for PaymentIntent generated by Chargebee.js. Applicable only when you are using Chargebee.js for completing the 3DS flow. The PaymentIntent should be in 'authorized' state while passing it here. You need not pass other PaymentIntent parameters if this is passed.
    payment_intent[gateway_account_id]
    required if payment intent token provided, string, max chars=50
    The gateway account used for performing the 3DS flow.
    payment_intent[gw_token]
    optional, string, max chars=65k
    Identifier for 3DS transaction/verification object at the gateway. Can be passed only after successfully completing the 3DS flow. Refer 3DS implementation in Chargebee to find out the gateway-specific gw_token format. Applicable when you are using gateway APIs directly for completing the 3DS flow.
    payment_intent[payment_method_type]
    optional, enumerated string
    The list of payment method types (For example, card, ideal, sofort, bancontact, etc.) this Payment Intent is allowed to use. If payment method type is empty, Card is taken as the default type for all gateways except Razorpay.
    Possible values are
    cardcardidealidealsofortsofortbancontactbancontact
    google_paygoogle_paydotpaydotpaygiropaygiropayapple_payapple_payupiupinetbanking_emandatesnetbanking_emandatespaypal_express_checkoutpaypal_express_checkoutdirect_debitdirect_debitboletoboletovenmoamazon_paymentsamazon_paymentspay_tofaster_paymentssepa_instant_transfer
    Show all values[+]
    payment_intent[reference_id]
    optional, string, max chars=65k
    Identifier for Braintree permanent token. Applicable when you are using Braintree APIs for completing the 3DS flow.
    payment_intent[additional_information]
    optional, jsonobject
    • checkout_com: While adding a new payment method using permanent token or passing raw card details to Checkout.com, document ID and country_of_residence are required to support payments through dLocal.
      • payer: User related information.
        • country_of_residence: This is required since the billing country associated with the user’s payment method may not be the same as their country of residence. Hence the user’s country of residence needs to be specified. The country code should be a two-character ISO code.
        • document: Document ID is the user’s identification number based on their country.
    • bluesnap: While passing raw card details to BlueSnap, if fraud_session_id is added, additional validation is performed to avoid fraudulent transactions.
      • fraud: Fraud identification related information.
    • braintree: While passing raw card details to Braintree, your fraud_merchant_id and the user’s device_session_id can be added to perform additional validation and avoid fraudulent transactions.
      • fraud: Fraud identification related information.
        • device_session_id: Session ID associated with the user's device.
        • fraud_merchant_id: Your merchant ID for fraud detection.
    • chargebee_payments: While passing raw card details to Chargebee Payments, if fraud_session_id is added, additional validation is performed to avoid fraudulent transactions.
      • fraud: Fraud identification related information.
        • fraud_session_id: Your Chargebee Payments fraud session ID required to perform anti-fraud validation.
    +
    contract_term
    Parameters for contract_term
    pass parameters as contract_term[<param name>]
    contract_term[action_at_term_end]
    optional, enumerated string, default=cancel
    Action to be taken when the contract term completes.
    Possible values are
    renew
  • Contract term completes and a new contract term is started for the number of billing cycles specified in contract_billing_cycle_on_renewal.
  • The action_at_term_end for the new contract term is set to renew.
  • evergreenContract term completes and the subscription renews.cancelContract term completes and subscription is canceled.
    contract_term[cancellation_cutoff_period]
    optional, integer, default=0
    The number of days before contract_end, during which the customer is barred from canceling the contract term. The customer is allowed to cancel the contract term via the Self-Serve Portal only before this period. This allows you to have sufficient time for processing the contract term closure
    +
    subscription_items
    Parameters for subscription_items. Multiple subscription_items can be passed by specifying unique indices.
    pass parameters as subscription_items[<param name>][<idx:0..n>]
    subscription_items[item_price_id][0..n]
    required, string, max chars=100
    The unique identifier of the item price.
    subscription_items[quantity][0..n]
    optional, integer, min=1
    The quantity of the item purchased
    subscription_items[quantity_in_decimal][0..n]
    optional, string, max chars=33
    The decimal representation of the quantity of the item purchased. Can be provided for quantity-based item prices and only when multi-decimal pricing is enabled.
    subscription_items[unit_price][0..n]
    optional, in cents, min=0
    Sub Item Plan Unit Amount for create subscription
    subscription_items[unit_price_in_decimal][0..n]
    optional, string, max chars=39
    Sub Item Plan Unit Amount in Decimal for create subscription
    subscription_items[billing_cycles][0..n]
    optional, integer, min=0
    For the plan-item price:
    the value determines the number of billing cycles the subscription runs before canceling automatically. If not provided, then the value set for the plan-item price is used.

    For addon-item prices:
    If addon billing cycles are enabled then this is the number of subscription billing cycles for which the addon is included. If not provided, then the value set under attached addons is used. Further, if that value is not provided, then the value set for the addon-item price is used.
    subscription_items[trial_end][0..n]
    optional, timestamp(UTC) in seconds
    The date/time when the trial period of the item ends. Applies to plan-items and—-when enabled-—addon-items as well.
    subscription_items[service_period_days][0..n]
    optional, integer, min=1, max=730
    The service period of the item in days from the day of charge.
    subscription_items[charge_on_event][0..n]
    optional, enumerated string
    When charge_on_option option is set to on_event, this parameter specifies the event at which the charge-item is applied to the subscription. This parameter only applies to charge-items.
    Possible values are
    subscription_creationthe time of creation of the subscription.subscription_trial_startthe time when the trial period of the subscription begins.plan_activationsame as subscription activation, but also includes the case when the plan-item of the subscription is changed.subscription_activationthe moment a subscription enters an active or non-renewing state. Also includes reactivations of canceled subscriptions.contract_terminationwhen a contract term is terminated.
    subscription_items[charge_once][0..n]
    optional, boolean
    Indicates if the charge-item is to be charged only once or each time the charge_on_event occurs. This parameter only applies to charge-items.
    subscription_items[charge_on_option][0..n]
    optional, enumerated string
    Indicates when the charge-item is to be charged. This parameter only applies to charge-items.
    Possible values are
    immediatelyThe item is charged immediately on being added to the subscription.on_eventThe item is charged at the occurrence of the event specified as charge_on_event.
    +
    discounts
    Parameters for discounts. Multiple discounts can be passed by specifying unique indices.
    pass parameters as discounts[<param name>][<idx:0..n>]
    discounts[apply_on][0..n]
    required, enumerated string
    The amount on the invoice to which the discount is applied.
    Possible values are
    invoice_amountThe discount is applied to the invoice sub_total.specific_item_priceThe discount is applied to the invoice.line_item.amount that corresponds to the item price specified by item_price_id.
    discounts[duration_type][0..n]
    required, enumerated string, default=forever
    Specifies the time duration for which this discount is attached to the subscription.
    Possible values are
    one_timeThe discount stays attached to the subscription till it is applied on an invoice once. It is removed after that from the subscription.foreverThe discount is attached to the subscription and applied on the invoices till it is explicitly removed.limited_periodThe discount is attached to the subscription and applied on the invoices for a limited duration. This duration starts from the point it is applied to an invoice for the first time and expires after a period specified by period and period_unit.
    discounts[percentage][0..n]
    optional, double, min=0.01, max=100.0
    The percentage of the original amount that should be deducted from it. Only applicable when discount.type is percentage.
    discounts[amount][0..n]
    optional, in cents, min=0
    The value of the discount. The format of this value depends on the kind of currency. This is only applicable when discount.type is fixed_amount.
    discounts[period][0..n]
    optional, integer, min=1
    The duration of time for which the discount is attached to the subscription, in period_units. Applicable only when duration_type is limited_period.
    discounts[period_unit][0..n]
    optional, enumerated string
    The unit of time for period. Applicable only when duration_type is limited_period.
    Possible values are
    dayA period of 24 hours.weekA period of 7 days.monthA period of 1 calendar month.yearA period of 1 calendar year.
    discounts[included_in_mrr][0..n]
    optional, boolean
    The discount is included in MRR calculations for your site. This attribute is only applicable when duration_type is one_time and when the feature is enabled in Chargebee. Also, If the site-level setting is to exclude one-time discounts from MRR calculations, this value is always returned false.
    discounts[item_price_id][0..n]
    optional, string, max chars=100
    The id of the item price in the subscription to which the discount is to be applied. Relevant only when apply_on = specific_item_price.
    +
    item_tiers
    Parameters for item_tiers. Multiple item_tiers can be passed by specifying unique indices.
    pass parameters as item_tiers[<param name>][<idx:0..n>]
    item_tiers[item_price_id][0..n]
    optional, string, max chars=100
    The id of the item price for which the tier price is being overridden.
    item_tiers[starting_unit][0..n]
    optional, integer, min=1
    The lowest value in the quantity tier.
    item_tiers[ending_unit][0..n]
    optional, integer
    The highest value in the quantity tier.
    item_tiers[price][0..n]
    optional, in cents, default=0, min=0
    The overridden price of the tier. The value depends on the type of currency.
    item_tiers[starting_unit_in_decimal][0..n]
    optional, string, max chars=33
    The decimal representation of the the lowest value of quantity in this tier. This is zero for the lowest tier. For all other tiers, it is the same as ending_unit_in_decimal of the next lower tier. Returned only when the pricing_model is tiered, volume or stairstep and multi-decimal pricing is enabled.
    item_tiers[ending_unit_in_decimal][0..n]
    optional, string, max chars=33
    The decimal representation of the highest value of quantity in this tier. This attribute is not applicable for the highest tier. For all other tiers, it must be equal to the starting_unit_in_decimal of the next higher tier. Returned only when the pricing_model is tiered, volume or stairstep and multi-decimal pricing is enabled.
    item_tiers[price_in_decimal][0..n]
    optional, string, max chars=39
    The decimal representation of the per-unit price for the tier when the pricing_model is tiered or volume. When the pricing_model is stairstep, it is the decimal representation of the total price for the item. The value is in major units of the currency. Returned when the plan is quantity-based and multi-decimal pricing is enabled.
    always returned
    Resource object representing subscription
    always returned
    Resource object representing customer
    optional
    Resource object representing card
    optional
    Resource object representing invoice
    optional
    Resource object representing unbilled_charge
    Returns a list of subscriptions meeting all the conditions specified in the filter parameters below.
    Sample Request
    curl  https://{site}.chargebee.com/api/v2/subscriptions \
         -G  \
         -u {site_api_key}:\
         --data-urlencode limit=2 \
         --data-urlencode item_id[in]="["basic"]"
    copy
    curl  https://{site}.chargebee.com/api/v2/subscriptions \
         -G  \
         -u {site_api_key}:\
         --data-urlencode limit=2 \
         --data-urlencode item_id[in]="["basic"]"

    Sample Response [ JSON ]

    Show more...
    { "list": [ { "customer": { "allow_direct_debit": false, "auto_collection": "off", "card_status": "no_card", "created_at": 1612890919, "deleted": false, "excess_payments": 0, "first_name": "John", "id": "__test__8asukSOXdvg4PD", "last_name": "Doe", "net_term_days": 0, "object": "customer", "pii_cleared": "active", "preferred_currency_code": "USD", "promotional_credits": 0, "refundable_credits": 0, "resource_version": 1612890919000, "taxability": "taxable", "unbilled_charges": 0, "updated_at": 1612890919 }, "subscription": { "activated_at": 1612890920, "billing_period": 1, "billing_period_unit": "month", "created_at": 1612890920, "currency_code": "USD", "current_term_end": 1615310120, "current_term_start": 1612890920, "customer_id": "__test__8asukSOXdvg4PD", "deleted": false, "due_invoices_count": 1, "due_since": 1612890920, "has_scheduled_changes": false, "id": "__test__8asukSOXdvliPG", "mrr": 0, "next_billing_at": 1615310120, "object": "subscription", "remaining_billing_cycles": 1, "resource_version": 1612890920000, "started_at": 1612890920, "status": "active", "subscription_items": [ { "amount": 1000, "billing_cycles": 1, "free_quantity": 0, "item_price_id": "basic-USD", "item_type": "plan", "object": "subscription_item", "quantity": 1, "unit_price": 1000 }, {..} ], "total_dues": 1100, "updated_at": 1612890920 } }, {..} ], "next_offset": "[\"1612890918000\",\"230000000081\"]" }

    URL Format GET

    https://{site}.chargebee.com/api/v2/subscriptions
    limit
    optional, integer, default=10, min=1, max=100
    The number of resources to be returned.
    offset
    optional, string, max chars=1000
    Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set offset to the value of next_offset obtained in the previous iteration of the API call.
    include_deleted
    optional, boolean, default=false
    Indicates whether to include deleted objects in the list. The deleted objects have the attribute deleted as true.
    sort_by[<sort-order>]
    optional, string filter
    Sorts based on the specified attribute.
    Supported attributes : created_at, updated_at
    Supported sort-orders : asc, desc

    Example sort_by[asc] = "created_at"
    This will sort the result based on the 'created_at' attribute in ascending(earliest first) order.
    Filter Params
    For operator usages, see the Pagination and Filtering section.
    id[<operator>]
    optional, string filter
    A unique and immutable identifier for the subscription. If not provided, it is autogenerated.
    Supported operators : is, is_not, starts_with, in, not_in

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

    Example customer_id[is_not] = "8gsnbYfsMLds"
    item_id[<operator>]
    optional, string filter
    The plan item code.
    Supported operators : is, is_not, starts_with, in, not_in

    Example item_id[is] = "silver"
    item_price_id[<operator>]
    optional, string filter
    The plan item price code.
    Supported operators : is, is_not, starts_with, in, not_in

    Example item_price_id[is] = "silver-USD-monthly"
    status[<operator>]
    optional, enumerated string filter
    Current state of the subscription. Possible values are : future, in_trial, active, non_renewing, paused, cancelled.
    Supported operators : is, is_not, in, not_in

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

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

    Example cancel_reason_code[is] = "Not Paid"
    remaining_billing_cycles[<operator>]
    optional, integer filter
    • When the subscription is not on a contract term: this value is the number of billing cycles remaining after the current cycle, at the end of which, the subscription cancels.
    • When the subscription is on a contract term: this value is the number of billing cycles remaining in the contract term after the current billing cycle.
    .
    Supported operators : is, is_not, lt, lte, gt, gte, between, is_present

    Example remaining_billing_cycles[is] = "3"
    created_at[<operator>]
    optional, timestamp(UTC) in seconds filter
    The time at which the subscription was created.
    Supported operators : after, before, on, between

    Example created_at[on] = "1435054328"
    activated_at[<operator>]
    optional, timestamp(UTC) in seconds filter
    Time at which the subscription status last changed to  active. For example, this value is updated when an in_trial or  cancelled subscription activates.
    Supported operators : after, before, on, between, is_present

    Example activated_at[after] = "1435054328"
    next_billing_at[<operator>]
    optional, timestamp(UTC) in seconds filter
    The date/time at which the next billing for the subscription happens. This is usually right after current_term_end unless multiple subscription terms were invoiced in advance using the terms_to_charge parameter.
    Supported operators : after, before, on, between

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

    Example cancelled_at[before] = "1435054328"
    has_scheduled_changes[<operator>]
    optional, boolean filter
    If true, there are subscription changes scheduled on next renewal. Possible values are : true, false
    Supported operators : is

    Example has_scheduled_changes[is] = "true"
    updated_at[<operator>]
    optional, timestamp(UTC) in seconds filter
    To filter based on updated_at. This attribute will be present only if the resource has been updated after 2016-09-28. It is advisable when using this filter, to pass the sort_by input parameter as updated_at for a faster response.
    Supported operators : after, before, on, between

    Example updated_at[after] = "1243545465"
    offline_payment_method[<operator>]
    optional, enumerated string filter
    The preferred offline payment method for the subscription. Possible values are : no_preference, cash, check, bank_transfer, ach_credit, sepa_credit, boleto.
    Supported operators : is, is_not, in, not_in

    Example offline_payment_method[is] = "cash"
    auto_close_invoices[<operator>]
    optional, boolean filter
    Set to false to override for this subscription, the site-level setting for auto-closing invoices. Only applicable when auto-closing invoices has been enabled for the site. This attribute has a higher precedence than the same attribute at the customer level. Possible values are : true, false
    Supported operators : is

    Example auto_close_invoices[is] = "true"
    override_relationship[<operator>]
    optional, boolean filter
    If true, ignores the hierarchy relationship and uses customer as payment and invoice owner. Possible values are : true, false
    Supported operators : is

    Example override_relationship[is] = "false"
    business_entity_id[<operator>]
    optional, string filter
    The unique ID of the business entity of this subscription. This is always the same as the business entity of the customer.
    Supported operators : is, is_not, starts_with

    Example business_entity_id[is] = "business_entity_id"
    channel[<operator>]
    optional, enumerated string filter
    The subscription channel this object originated from and is maintained in. Possible values are : web, app_store, play_store.
    Supported operators : is, is_not, in, not_in

    Example channel[is] = "APP STORE"
    always returned
    Resource object representing subscription
    always returned
    Resource object representing customer
    optional
    Resource object representing card
    next_offset
    optional, string, max chars=1000
    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”.
    Retrieves a list of contract term resources for the subscription specified in the path.
    Sample Request
    curl  https://{site}.chargebee.com/api/v2/subscriptions/__test__8asukSOXdty0Mv/contract_terms \
         -G  \
         -u {site_api_key}:
    copy
    curl  https://{site}.chargebee.com/api/v2/subscriptions/__test__8asukSOXdty0Mv/contract_terms \
         -G  \
         -u {site_api_key}:

    Sample Response [ JSON ]

    Show more...
    {"list": [ {"contract_term": { "action_at_term_end": "renew", "billing_cycle": 6, "cancellation_cutoff_period": 0, "contract_end": 1628529313, "contract_start": 1612890913, "created_at": 1612890913, "id": "__test__8asukSOXdty7Mw", "object": "contract_term", "remaining_billing_cycles": 5, "status": "active", "total_contract_value": 6600 }}, {..} ]}

    URL Format GET

    https://{site}.chargebee.com/api/v2/subscriptions/{subscription_id}/contract_terms
    limit
    optional, integer, default=10, min=1, max=100
    The number of resources to be returned.
    offset
    optional, string, max chars=1000
    Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set offset to the value of next_offset obtained in the previous iteration of the API call.
    always returned
    Resource object representing contract_term
    next_offset
    optional, string, max chars=1000
    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”.

    Returns a list of discounts currently attached to the subscription given by {subscription_id}. The list is sorted by date of creation, in descending order.

    Sample Request
    curl  https://{site}.chargebee.com/api/v2/subscriptions/__test__8at0iSK6IPu41q/discounts \
         -G  \
         -u {site_api_key}:\
         --data-urlencode limit=2
    copy
    curl  https://{site}.chargebee.com/api/v2/subscriptions/__test__8at0iSK6IPu41q/discounts \
         -G  \
         -u {site_api_key}:\
         --data-urlencode limit=2

    Sample Response [ JSON ]

    Show more...
    {"list": [ {"discount": { "amount": 100, "applied_count": 1, "apply_on": "invoice_amount", "created_at": 1608822300, "currency_code": "USD", "duration_type": "forever", "id": "__test__8at0iSK6IPuW1r", "invoice_name": "__test__8at0iSK6IPuW1r", "object": "discount", "type": "fixed_amount" }}, {..} ]}

    URL Format GET

    https://{site}.chargebee.com/api/v2/subscriptions/{subscription_id}/discounts
    limit
    optional, integer, default=10, min=1, max=100
    The number of resources to be returned.
    offset
    optional, string, max chars=1000
    Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set offset to the value of next_offset obtained in the previous iteration of the API call.
    always returned
    Resource object representing discount
    next_offset
    optional, string, max chars=1000
    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”.

    Retrieves a subscription.

    Sample Request
    curl  https://{site}.chargebee.com/api/v2/subscriptions/__test__8asukSOXe0W3SU \
         -u {site_api_key}:
    copy
    curl  https://{site}.chargebee.com/api/v2/subscriptions/__test__8asukSOXe0W3SU \
         -u {site_api_key}:

    Sample Response [ JSON ]

    Show more...
    { "customer": { "allow_direct_debit": false, "auto_collection": "off", "card_status": "no_card", "created_at": 1612890938, "deleted": false, "excess_payments": 0, "first_name": "John", "id": "__test__8asukSOXe0QYSR", "last_name": "Doe", "net_term_days": 0, "object": "customer", "pii_cleared": "active", "preferred_currency_code": "USD", "promotional_credits": 0, "refundable_credits": 0, "resource_version": 1612890938000, "taxability": "taxable", "unbilled_charges": 0, "updated_at": 1612890938 }, "subscription": { "activated_at": 1612890938, "billing_period": 1, "billing_period_unit": "month", "created_at": 1612890938, "currency_code": "USD", "current_term_end": 1615310138, "current_term_start": 1612890938, "customer_id": "__test__8asukSOXe0QYSR", "deleted": false, "due_invoices_count": 1, "due_since": 1612890938, "has_scheduled_changes": false, "id": "__test__8asukSOXe0W3SU", "mrr": 0, "next_billing_at": 1615310138, "object": "subscription", "remaining_billing_cycles": 1, "resource_version": 1612890938000, "started_at": 1612890938, "status": "active", "subscription_items": [ { "amount": 1000, "billing_cycles": 1, "free_quantity": 0, "item_price_id": "basic-USD", "item_type": "plan", "object": "subscription_item", "quantity": 1, "unit_price": 1000 }, {..} ], "total_dues": 1100, "updated_at": 1612890938 } }

    URL Format GET

    https://{site}.chargebee.com/api/v2/subscriptions/{subscription_id}
    always returned
    Resource object representing subscription
    always returned
    Resource object representing customer
    optional
    Resource object representing card

    Sample admin console URL

    https://{site}.chargebee.com/admin-console/subscriptions/123x

    Retrieves a subscription with the scheduled changes applied.
    Note: Only the following attributes are changed

    • item_id
    • item_price_id
    • billing_period
    • billing_period_unit
    • remaining_billing_cycles
    • 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/__test__8asukSOXe0ksSf/retrieve_with_scheduled_changes \
         -u {site_api_key}:
    copy
    curl  https://{site}.chargebee.com/api/v2/subscriptions/__test__8asukSOXe0ksSf/retrieve_with_scheduled_changes \
         -u {site_api_key}:

    Sample Response [ JSON ]

    Show more...
    { "customer": { "allow_direct_debit": false, "auto_collection": "off", "card_status": "no_card", "created_at": 1612890939, "deleted": false, "excess_payments": 0, "first_name": "John", "id": "__test__8asukSOXe0g2Sc", "last_name": "Doe", "net_term_days": 0, "object": "customer", "pii_cleared": "active", "preferred_currency_code": "USD", "promotional_credits": 0, "refundable_credits": 0, "resource_version": 1612890939000, "taxability": "taxable", "unbilled_charges": 0, "updated_at": 1612890939 }, "subscription": { "activated_at": 1612890939, "billing_period": 1, "billing_period_unit": "month", "created_at": 1612890939, "currency_code": "USD", "current_term_end": 1615310139, "current_term_start": 1612890939, "customer_id": "__test__8asukSOXe0g2Sc", "deleted": false, "due_invoices_count": 1, "due_since": 1612890939, "has_scheduled_changes": true, "id": "__test__8asukSOXe0ksSf", "item_tiers": [], "mrr": 0, "next_billing_at": 1615310139, "object": "subscription", "remaining_billing_cycles": 1, "resource_version": 1612890940000, "started_at": 1612890939, "status": "active", "subscription_items": [ { "amount": 8000, "billing_cycles": 1, "free_quantity": 0, "item_price_id": "basic-USD", "item_type": "plan", "object": "subscription_item", "quantity": 4, "unit_price": 2000 }, {..} ], "total_dues": 1100, "updated_at": 1612890940 } }

    URL Format GET

    https://{site}.chargebee.com/api/v2/subscriptions/{subscription_id}/retrieve_with_scheduled_changes
    always returned
    Resource object representing subscription
    always returned
    Resource object representing customer
    optional
    Resource object representing card
    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/__test__8asukSOXdyTgRH/remove_scheduled_changes \
         -X POST  \
         -u {site_api_key}:
    copy
    curl  https://{site}.chargebee.com/api/v2/subscriptions/__test__8asukSOXdyTgRH/remove_scheduled_changes \
         -X POST  \
         -u {site_api_key}:

    Sample Response [ JSON ]

    Show more...
    { "customer": { "allow_direct_debit": false, "auto_collection": "off", "card_status": "no_card", "created_at": 1612890930, "deleted": false, "excess_payments": 0, "first_name": "John", "id": "__test__8asukSOXdyOjRE", "last_name": "Doe", "net_term_days": 0, "object": "customer", "pii_cleared": "active", "preferred_currency_code": "USD", "promotional_credits": 0, "refundable_credits": 0, "resource_version": 1612890930000, "taxability": "taxable", "unbilled_charges": 0, "updated_at": 1612890930 }, "subscription": { "activated_at": 1612890930, "billing_period": 1, "billing_period_unit": "month", "created_at": 1612890930, "currency_code": "USD", "current_term_end": 1615310130, "current_term_start": 1612890930, "customer_id": "__test__8asukSOXdyOjRE", "deleted": false, "due_invoices_count": 1, "due_since": 1612890930, "has_scheduled_changes": false, "id": "__test__8asukSOXdyTgRH", "mrr": 0, "next_billing_at": 1615310130, "object": "subscription", "remaining_billing_cycles": 1, "resource_version": 1612890932000, "started_at": 1612890930, "status": "active", "subscription_items": [ { "amount": 1000, "billing_cycles": 1, "free_quantity": 0, "item_price_id": "basic-USD", "item_type": "plan", "object": "subscription_item", "quantity": 1, "unit_price": 1000 }, {..} ], "total_dues": 1100, "updated_at": 1612890932 } }

    URL Format POST

    https://{site}.chargebee.com/api/v2/subscriptions/{subscription_id}/remove_scheduled_changes
    always returned
    Resource object representing subscription
    always returned
    Resource object representing customer
    optional
    Resource object representing card
    optional
    Resource object representing credit_note

    Note: Cannot be called when the subscription is on a contract term. (That is, when the contract_term.status attribute is active.)

    If the subscription is in Non Renewing or In Trial state and is also scheduled to cancel at the end of current term, then this API can be used to remove the scheduled cancellation. When a scheduled cancellation is removed, the subscription will revert to Active or In Trial state, whichever is the state before cancellation was scheduled.

    While removing the scheduled cancellation, you may specify the number of billing cycles. If the billing cycle is not specified, the default billing cycle from the plan will be applied on the subscription.

    Sample Request
    curl  https://{site}.chargebee.com/api/v2/subscriptions/__test__8asukSOXdy9TR2/remove_scheduled_cancellation \
         -X POST  \
         -u {site_api_key}:
    copy
    curl  https://{site}.chargebee.com/api/v2/subscriptions/__test__8asukSOXdy9TR2/remove_scheduled_cancellation \
         -X POST  \
         -u {site_api_key}:

    Sample Response [ JSON ]

    Show more...
    { "customer": { "allow_direct_debit": false, "auto_collection": "off", "card_status": "no_card", "created_at": 1517505329, "deleted": false, "excess_payments": 0, "first_name": "John", "id": "__test__8asukSOXdy5GQz", "last_name": "Doe", "net_term_days": 0, "object": "customer", "pii_cleared": "active", "preferred_currency_code": "USD", "promotional_credits": 0, "refundable_credits": 0, "resource_version": 1517505329175, "taxability": "taxable", "unbilled_charges": 0, "updated_at": 1517505329 }, "subscription": { "activated_at": 1517505329, "billing_period": 1, "billing_period_unit": "month", "created_at": 1517505329, "currency_code": "USD", "current_term_end": 1519924529, "current_term_start": 1517505329, "customer_id": "__test__8asukSOXdy5GQz", "deleted": false, "due_invoices_count": 1, "due_since": 1517505329, "has_scheduled_changes": false, "id": "__test__8asukSOXdy9TR2", "mrr": 0, "next_billing_at": 1519924529, "object": "subscription", "resource_version": 1517505330230, "started_at": 1517505329, "status": "active", "subscription_items": [ { "amount": 1000, "free_quantity": 0, "item_price_id": "basic-USD", "item_type": "plan", "object": "subscription_item", "quantity": 1, "unit_price": 1000 }, {..} ], "total_dues": 1100, "updated_at": 1517505330 } }

    URL Format POST

    https://{site}.chargebee.com/api/v2/subscriptions/{subscription_id}/remove_scheduled_cancellation
    billing_cycles
    optional, integer, min=0
    Number of cycles(plan interval) this subscription should be charged. After the billing cycles exhausted, the subscription will be cancelled.
    always returned
    Resource object representing subscription
    always returned
    Resource object representing customer
    optional
    Resource object representing card
    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
    # removes the listed coupons associated with the subscription.
    curl  https://{site}.chargebee.com/api/v2/subscriptions/__test__8asukSOXdxPSQY/remove_coupons \
         -X POST  \
         -u {site_api_key}:\
         -d coupon_ids[0]="P10DISC"
    copy
    # removes the listed coupons associated with the subscription.
    curl  https://{site}.chargebee.com/api/v2/subscriptions/__test__8asukSOXdxPSQY/remove_coupons \
         -X POST  \
         -u {site_api_key}:\
         -d coupon_ids[0]="P10DISC"

    Sample Response [ JSON ]

    Show more...
    { "customer": { "allow_direct_debit": false, "auto_collection": "off", "card_status": "no_card", "created_at": 1612890926, "deleted": false, "excess_payments": 0, "first_name": "John", "id": "__test__8asukSOXdxKsQV", "last_name": "Doe", "net_term_days": 0, "object": "customer", "pii_cleared": "active", "preferred_currency_code": "USD", "promotional_credits": 0, "refundable_credits": 0, "resource_version": 1612890926000, "taxability": "taxable", "unbilled_charges": 0, "updated_at": 1612890926 }, "subscription": { "activated_at": 1612890926, "billing_period": 1, "billing_period_unit": "month", "coupon": "A5USD", "coupons": [ { "applied_count": 1, "apply_till": 1644340526, "coupon_id": "A5USD", "object": "coupon" }, {..} ], "created_at": 1612890926, "currency_code": "USD", "current_term_end": 1615310126, "current_term_start": 1612890926, "customer_id": "__test__8asukSOXdxKsQV", "deleted": false, "due_invoices_count": 1, "due_since": 1612890926, "has_scheduled_changes": false, "id": "__test__8asukSOXdxPSQY", "mrr": 0, "next_billing_at": 1615310126, "object": "subscription", "remaining_billing_cycles": 1, "resource_version": 1612890927000, "started_at": 1612890926, "status": "active", "subscription_items": [ { "amount": 1000, "billing_cycles": 1, "free_quantity": 0, "item_price_id": "basic-USD", "item_type": "plan", "object": "subscription_item", "quantity": 1, "unit_price": 1000 }, {..} ], "total_dues": 540, "updated_at": 1612890927 } }

    URL Format POST

    https://{site}.chargebee.com/api/v2/subscriptions/{subscription_id}/remove_coupons
    coupon_ids[0..n]
    optional, list of string
    List of coupons to be applied to this subscription. You can provide coupon ids or coupon codes.
    always returned
    Resource object representing subscription
    always returned
    Resource object representing customer
    optional
    Resource object representing card
    Note: This endpoint optionally supports 3DS. To use it, create a payment_intent and provide it via this endpoint.

    Updates the specified subscription by setting the parameters passed. Any parameters not provided are left unmodified. If an invoice is generated for this operation, any available credits and excess payments for the customer are automatically applied.

    Sample Request
    curl  https://{site}.chargebee.com/api/v2/subscriptions/__test__8asrKRrLKtirr/update_for_items \
         -u {site_api_key}:\
         -d subscription_items[item_price_id][0]="basic-USD" \
         -d subscription_items[quantity][0]=4 \
         -d subscription_items[unit_price][0]=1000 \
         -d invoice_immediately="true"
    copy
    curl  https://{site}.chargebee.com/api/v2/subscriptions/__test__8asrKRrLKtirr/update_for_items \
         -u {site_api_key}:\
         -d subscription_items[item_price_id][0]="basic-USD" \
         -d subscription_items[quantity][0]=4 \
         -d subscription_items[unit_price][0]=1000 \
         -d invoice_immediately="true"

    Sample Response [ JSON ]

    Show more...
    { "credit_notes": [], "customer": { "allow_direct_debit": false, "auto_collection": "off", "card_status": "no_card", "created_at": 1612890941, "deleted": false, "excess_payments": 0, "first_name": "John", "id": "__test__8asukSOXe1B5Sp", "last_name": "Doe", "net_term_days": 0, "object": "customer", "pii_cleared": "active", "preferred_currency_code": "USD", "promotional_credits": 0, "refundable_credits": 0, "resource_version": 1612890941000, "taxability": "taxable", "unbilled_charges": 0, "updated_at": 1612890941 }, "invoice": { "adjustment_credit_notes": [], "amount_adjusted": 0, "amount_due": 3000, "amount_paid": 0, "amount_to_collect": 3000, "applied_credits": [], "base_currency_code": "USD", "billing_address": { "first_name": "John", "last_name": "Doe", "object": "billing_address", "validation_status": "not_validated" }, "credits_applied": 0, "currency_code": "USD", "customer_id": "__test__8asukSOXe1B5Sp", "date": 1612890942, "deleted": false, "due_date": 1612890942, "dunning_attempts": [], "exchange_rate": 1, "first_invoice": false, "has_advance_charges": false, "id": "__demo_inv__30", "is_gifted": false, "issued_credit_notes": [], "line_items": [ { "amount": 3000, "customer_id": "__test__8asukSOXe1B5Sp", "date_from": 1612890942, "date_to": 1615310141, "description": "basic USD - Prorated Charges", "discount_amount": 0, "entity_id": "basic-USD", "entity_type": "plan_item_price", "id": "li___test__8asukSOXe1VTT0", "is_taxed": false, "item_level_discount_amount": 0, "object": "line_item", "pricing_model": "per_unit", "quantity": 3, "subscription_id": "__test__8asukSOXe1FHSs", "tax_amount": 0, "tax_exempt_reason": "tax_not_configured", "unit_amount": 1000 }, {..} ], "linked_orders": [], "linked_payments": [], "net_term_days": 0, "object": "invoice", "price_type": "tax_exclusive", "recurring": true, "resource_version": 1612890942000, "round_off_amount": 0, "status": "payment_due", "sub_total": 3000, "subscription_id": "__test__8asukSOXe1FHSs", "tax": 0, "term_finalized": true, "total": 3000, "updated_at": 1612890942, "write_off_amount": 0 }, "subscription": { "activated_at": 1612890941, "billing_period": 1, "billing_period_unit": "month", "created_at": 1612890941, "currency_code": "USD", "current_term_end": 1615310141, "current_term_start": 1612890941, "customer_id": "__test__8asukSOXe1B5Sp", "deleted": false, "due_invoices_count": 2, "due_since": 1612890941, "has_scheduled_changes": false, "id": "__test__8asukSOXe1FHSs", "mrr": 0, "next_billing_at": 1615310141, "object": "subscription", "remaining_billing_cycles": 1, "resource_version": 1612890942000, "started_at": 1612890941, "status": "active", "subscription_items": [ { "amount": 4000, "billing_cycles": 1, "free_quantity": 0, "item_price_id": "basic-USD", "item_type": "plan", "object": "subscription_item", "quantity": 4, "unit_price": 1000 }, {..} ], "total_dues": 4100, "updated_at": 1612890942 } }

    URL Format POST

    https://{site}.chargebee.com/api/v2/subscriptions/{subscription_id}/update_for_items
    mandatory_items_to_remove[0..n]
    optional, list of string
    Item ids of mandatorily attached addons that are to be removed from the subscription.
    replace_items_list
    optional, boolean
    If true then the existing subscription_items list for the subscription is replaced by the one provided. If false then the provided subscription_items list gets added to the existing list.
    net_term_days
    optional, integer
    Updates Net D for the subscription. Net D is the number of days within which any invoice raised for the subscription must be paid.
    • If the value is 0 or a positive integer: Net D is set explicitly for the subscription to the value provided. The value must be one of those defined in the site configuration.
    • If the value is -1: The attribute is reset and therefore not returned by the API. In this case, when an invoice is raised – whether now or later – the net_term_days defined at the customer level is considered.
    • If the value is not provided: The attribute is left unaltered.
    .
    invoice_date
    optional, timestamp(UTC) in seconds
    The document date displayed on the invoice PDF. The default value is the current date. Provide this value to backdate the invoice. Backdating an invoice is done for reasons such as booking revenue for a previous date or when the subscription is effective as of a past date. Moreover, if create_pending_invoices is set to true, and if the site is configured to set invoice dates to date of closing, then upon invoice closure, this date is changed to the invoice closing date. taxes and line_item_taxes are computed based on the tax configuration as of invoice_date. When passing this parameter, the following prerequisites must be met:
    • invoice_date must be in the past.
    • invoice_date is not more than one calendar month into the past. For example, if today is 13th January, then you cannot pass a value that is earlier than 13th December.
    • It is not earlier than changes_scheduled_at, reactivate_from, or trial_end.
    • invoice_immediately is true.
    .
    start_date
    optional, timestamp(UTC) in seconds
    The new start date of a future subscription. Applicable only for future subscriptions.
    trial_end
    optional, timestamp(UTC) in seconds
    The time at which the trial has ended or will end for the subscription. This is only allowed when the subscription status is future, in_trial, or cancelled. Also, the value must not be earlier than changes_scheduled_at or start_date. Note: This parameter can be backdated (set to a value in the past) only when the subscription is in cancelled or in_trial status. Do this to keep a record of when the trial ended in case it ended at some point in the past. When trial_end is backdated, the subscription immediately goes into active or non_renewing status.
    billing_cycles
    optional, integer, min=0
    Billing cycles set for plan-item price is used by default.
    terms_to_charge
    optional, integer, min=1
    The number of subscription billing cycles to invoice in advance. If a new term is started for the subscription due to this API call, then terms_to_charge is inclusive of this new term. See description for the force_term_reset parameter to learn more about when a subscription term is reset.
    reactivate_from
    optional, timestamp(UTC) in seconds
    If the subscription status is cancelled and it is being reactivated via this operation, this is the date/time at which the subscription should be reactivated.
    Note: It is recommended not to pass this parameter along with changed_scheduled_at. reactivate_from can be backdated (set to a value in the past). Use backdating when the subscription has been reactivated already but its billing has been delayed. Backdating is allowed only when the following prerequisites are met:
    • Backdating must be enabled for subscription reactivation operations.
    • The current day of the month does not exceed the limit set in Chargebee for backdating subscription change. This limit is the day of the month by which the accounting for the previous month must be closed.
    • The date is on or after the last date/time any of the product catalog items of the subscription were changed.
    • The date is not more than duration X into the past where X is the billing period of the plan. For example, if the period of the plan in the subscription is 2 months and today is 14th April, changes_scheduled_at cannot be earlier than 14th February.
    .
    billing_alignment_mode
    optional, enumerated string
    Override the billing alignment mode chosen for the site for calendar billing. Only applicable when using calendar billing.
    Possible values are
    immediateSubscription period will be aligned with the configured billing date immediately, with credits or charges raised accordingly..delayedSubscription period will be aligned with the configured billing date at the next renewal.
    auto_collection
    optional, enumerated string
    Defines whether payments need to be collected automatically for this subscription. Overrides customer's auto-collection property.
    Possible values are
    onWhenever an invoice is created for this subscription, an automatic charge will be attempted on the payment method available.offAutomatic collection of charges will not be made for this subscription. Use this for offline payments.
    offline_payment_method
    optional, enumerated string
    The preferred offline payment method for the subscription.
    Possible values are
    no_preferenceNo PreferencecashCashcheckCheckbank_transferBank Transferach_creditACH Creditsepa_creditSEPA CreditboletoBoleto
    po_number
    optional, string, max chars=100
    Purchase order number for this subscription.
    coupon_ids[0..n]
    optional, list of string
    List of coupons to be applied to this subscription. You can provide coupon ids or coupon codes. If changes_scheduled_at is in the past, then the currently available coupons can be used even if they were not available as of the date for when the change is scheduled.
    replace_coupon_list
    optional, boolean
    If true then the existing coupon_ids list for the subscription is replaced by the one provided. If false then the provided list gets added to the existing coupon_ids.
    prorate
    optional, boolean
    • When true: Prorated credits or charges are created as applicable for this change.
    • When false: The subscription is changed without creating any credits or charges.
    • When not provided, the value configured in the site settings is considered.
    Caveat

    For further changes within the same billing term, when prorate is set to true, credits are not created when all the conditions below hold true:

    An immediate previous change was made

    • with prorate set to false and
    • no changes were made to the subscription’s billing term and
    • a change was made to either the subscription’s items or their prices.
    end_of_term
    optional, boolean
    Set this to true if you want the update to be applied at the end of the current subscription billing cycle.
    force_term_reset
    optional, boolean, default=false
    Say the subscription has the renewal date as 28th of every month. When the plan-item price of the subscription is set to one that has the same billing period as the current plan-item price, the subscription change does not change the term. In other words, the subscription still renews on the 28th. Passing this parameter as true will have the subscription reset its term to the current date (provided end_of_term is false).
    Note: When the new plan-item price has a billing period different from the current plan-item price of the subscription, the term is always reset, regardless of the value passed for this parameter.
    reactivate
    optional, boolean
    When the status of the subscription is cancelled, this parameter determines whether the subscription is reactivated upon making this API request. Unless passed explicitly as false, this parameter is implied as true when you provide the subscription_items parameter.
    token_id
    optional, string, max chars=40
    The Chargebee payment token generated by Chargebee JS.
    invoice_notes
    optional, string, max chars=2000
    A customer-facing note added to all invoices associated with this subscription. This note is one among all the notes displayed on the invoice PDF.
    meta_data
    optional, jsonobject
    A set of key-value pairs stored as additional information for the subscription. Learn more.
    invoice_immediately
    optional, boolean
    If there are charges raised immediately for the subscription, this parameter specifies whether those charges are to be invoiced immediately or added to unbilled charges. The default value is as per the site settings.
    Note: invoice_immediately only affects charges that are raised at the time of execution of this API call. Any charges scheduled to be raised in the future are not affected by this parameter.
    .
    override_relationship
    optional, boolean
    If true, ignores the hierarchy relationship and uses customer as payment and invoice owner.
    changes_scheduled_at
    optional, timestamp(UTC) in seconds
    When change_option is set to specific_date, then set the date/time at which the subscription change is to happen or has happened. Note: It is recommended not to pass this parameter along with reactivate_from. changes_scheduled_at can be set to a value in the past. This is called backdating the subscription change and is performed when the subscription change has already been provisioned but its billing has been delayed. Backdating is allowed only when the following prerequisites are met:
    • Backdating must be enabled for subscription change operations.
    • Only the following changes can be backdated:
      • Changes in the recurring items or their prices.
      • Addition of non-recurring items.
    • Subscription status is active, cancelled, or non_renewing.
    • The current day of the month does not exceed the limit set in Chargebee for backdating subscription change. This limit is typically the day of the month by which the accounting for the previous month must be closed.
    • The date is on or after current_term_start.
    • The date is on or after the last date/time any of the following changes were made:
      • Changes in the recurring items or their prices.
      • Addition of non-recurring items.
    • The date is not more than duration X into the past where X is the billing period of the plan. For example, if the period of the plan in the subscription is 2 months and today is 14th April, changes_scheduled_at cannot be earlier than 14th February.
    .
    change_option
    optional, enumerated string
    When the quote is converted, this attribute determines the date/time as of when the subscription change is to be carried out.
    Possible values are
    immediatelyThe change is carried out immediately.end_of_termThe change is carried out at the end of the current billing cycle of the subscription.specific_dateThe change is carried out as of the date specified under changes_scheduled_at.
    contract_term_billing_cycle_on_renewal
    optional, integer, min=1, max=100
    Number of billing cycles the new contract term should run for, on contract renewal. The default value is the same as billing_cycles or a custom value depending on the site configuration.
    free_period
    optional, integer, min=1
    The period of time by which the first term of the subscription is to be extended free-of-charge. The value must be in multiples of free_period_unit.
    free_period_unit
    optional, enumerated string
    The unit of time in multiples of which the free_period parameter is expressed. The value must be equal to or lower than the period_unit attribute of the plan chosen.
    Possible values are
    dayCharge based on day(s)weekCharge based on week(s)monthCharge based on month(s)yearCharge based on year(s)
    create_pending_invoices
    optional, boolean

    Indicates whether the invoices for this subscription are generated with a pending status. This attribute is set to true automatically when the subscription has item prices that belong to metered items.

    You can also set this to true explicitly using the create/update subscription operations. This is useful in the following scenarios:

    • When tracking usages and calculating usage-based charges on your end. You can then add them to the subscription as a one-time charge at the end of the billing term.
    • When you need to inspect all charges before closing invoices for this subscription.

    Applicable only when Metered Billing is enabled for the site

    .
    auto_close_invoices
    optional, boolean
    Set to false to override for this subscription, the site-level setting for auto-closing invoices. Only applicable when auto-closing invoices has been enabled for the site. This attribute has a higher precedence than the same attribute at the customer level.
    trial_end_action
    optional, enumerated string
    Applicable only when End-of-trial Action has been enabled for the site. Whenever the subscription has a trial period, this attribute (parameter) is returned (required) and specifies the operation to be carried out for the subscription once the trial ends.
    Possible values are
    site_defaultThe action configured for the site at the time when the trial ends, takes effect. This is the default value when trial_end_action is not defined for the plan.plan_defaultThe action configured for the site at the time when the trial ends, takes effect. This is the default value when trial_end_action is defined for the plan.activate_subscriptionThe subscription activates and charges are raised for non-metered items.cancel_subscriptionThe subscription cancels.
    payment_initiator
    optional, enumerated string
    The type of initiator to be used for the payment request triggered by this operation.
    Possible values are
    customerPass this value to indicate that the request is initiated by the customermerchantPass this value to indicate that the request is initiated by the merchant
    +
    card
    Parameters for card
    pass parameters as card[<param name>]
    card[gateway_account_id]
    optional, string, max chars=50
    The gateway account in which this payment source is stored.
    card[first_name]
    optional, string, max chars=50
    Cardholder's first name
    card[last_name]
    optional, string, max chars=50
    Cardholder's last name
    card[number]
    required if card provided, string, max chars=1500
    The credit card number without any format. If you are using Braintree.js, you can specify the Braintree encrypted card number here.
    card[expiry_month]
    required if card provided, integer, min=1, max=12
    Card expiry month.
    card[expiry_year]
    required if card provided, integer
    Card expiry year.
    card[cvv]
    optional, string, max chars=520
    The card verification value (CVV). If you are using Braintree.js, you can specify the Braintree encrypted CVV here.
    card[billing_addr1]
    optional, string, max chars=150
    Address line 1, as available in card billing address.
    card[billing_addr2]
    optional, string, max chars=150
    Address line 2, as available in card billing address.
    card[billing_city]
    optional, string, max chars=50
    City, as available in card billing address.
    card[billing_state_code]
    optional, string, max chars=50
    The ISO 3166-2 state/province code without the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set state_code as AZ (not US-AZ). For Tamil Nadu (India), set as TN (not IN-TN). For British Columbia (Canada), set as BC (not CA-BC).
    card[billing_state]
    optional, string, max chars=50
    The state/province name. Is set by Chargebee automatically for US, Canada and India If state_code is provided.
    card[billing_zip]
    optional, string, max chars=20
    Postal or Zip code, as available in card billing address.
    card[billing_country]
    optional, string, max chars=50
    The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code.

    Note: If you enter an invalid country code, the system will return an error.

    Brexit

    If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom – Northern Ireland) is available as an option.

    card[additional_information]
    optional, jsonobject
    • checkout_com: While adding a new payment method using permanent token or passing raw card details to Checkout.com, document ID and country_of_residence are required to support payments through dLocal.
      • payer: User related information.
        • country_of_residence: This is required since the billing country associated with the user’s payment method may not be the same as their country of residence. Hence the user’s country of residence needs to be specified. The country code should be a two-character ISO code.
        • document: Document ID is the user’s identification number based on their country.
    • bluesnap: While passing raw card details to BlueSnap, if fraud_session_id is added, additional validation is performed to avoid fraudulent transactions.
      • fraud: Fraud identification related information.
    • braintree: While passing raw card details to Braintree, your fraud_merchant_id and the user’s device_session_id can be added to perform additional validation and avoid fraudulent transactions.
      • fraud: Fraud identification related information.
        • device_session_id: Session ID associated with the user's device.
        • fraud_merchant_id: Your merchant ID for fraud detection.
    • chargebee_payments: While passing raw card details to Chargebee Payments, if fraud_session_id is added, additional validation is performed to avoid fraudulent transactions.
      • fraud: Fraud identification related information.
        • fraud_session_id: Your Chargebee Payments fraud session ID required to perform anti-fraud validation.
    +
    payment_method
    Parameters for payment_method
    pass parameters as payment_method[<param name>]
    payment_method[type]
    optional, enumerated string
    The type of payment method. For more details refer Update payment method for a customer API under Customer resource.
    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.
    genericPayments made via Generic Payment Method.alipayPayments made via Alipay.unionpayPayments made via UnionPay.apple_payPayments made via Apple Pay.wechat_payPayments made via WeChat Pay.idealPayments made via iDEAL.google_payPayments made via Google Pay.sofortPayments made via Sofort.bancontactPayments made via Bancontact Card.giropayPayments made via giropay.dotpayPayments made via Dotpay.upiUPI Payments.netbanking_emandatesNetbanking (eMandates) Payments.venmoPayments made via Venmo pay_toPayments made via PayTo faster_paymentsPayments made via Faster Payments sepa_instant_transferPayments made via Sepa Instant Transfer
    Show all values[+]
    payment_method[gateway_account_id]
    optional, string, max chars=50
    The gateway account in which this payment source is stored.
    payment_method[reference_id]
    optional, string, max chars=200
    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.
    payment_method[tmp_token]
    required if reference_id not provided, string, max chars=65k
    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.
    payment_method[issuing_country]
    optional, string, max chars=50
    ISO 3166 alpha-2 country code.

    Note: If you enter an invalid country code, the system will return an error.

    If you have enabled EU VAT in 2021 or have manually enabled the Brexit configuration, then XI (the code for United Kingdom – Northern Ireland) is available as an option.
    payment_method[additional_information]
    optional, jsonobject
    • checkout_com: While adding a new payment method using permanent token or passing raw card details to Checkout.com, document ID and country_of_residence are required to support payments through dLocal.
      • payer: User related information.
        • country_of_residence: This is required since the billing country associated with the user’s payment method may not be the same as their country of residence. Hence the user’s country of residence needs to be specified. The country code should be a two-character ISO code.
        • document: Document ID is the user’s identification number based on their country.
    • bluesnap: While passing raw card details to BlueSnap, if fraud_session_id is added, additional validation is performed to avoid fraudulent transactions.
      • fraud: Fraud identification related information.
    • braintree: While passing raw card details to Braintree, your fraud_merchant_id and the user’s device_session_id can be added to perform additional validation and avoid fraudulent transactions.
      • fraud: Fraud identification related information.
        • device_session_id: Session ID associated with the user's device.
        • fraud_merchant_id: Your merchant ID for fraud detection.
    • chargebee_payments: While passing raw card details to Chargebee Payments, if fraud_session_id is added, additional validation is performed to avoid fraudulent transactions.
      • fraud: Fraud identification related information.
        • fraud_session_id: Your Chargebee Payments fraud session ID required to perform anti-fraud validation.
    +
    payment_intent
    Parameters for payment_intent
    pass parameters as payment_intent[<param name>]
    payment_intent[id]
    optional, string, max chars=150
    Identifier for PaymentIntent generated by Chargebee.js. Applicable only when you are using Chargebee.js for completing the 3DS flow. The PaymentIntent should be in 'authorized' state while passing it here. You need not pass other PaymentIntent parameters if this is passed.
    payment_intent[gateway_account_id]
    required if payment intent token provided, string, max chars=50
    The gateway account used for performing the 3DS flow.
    payment_intent[gw_token]
    optional, string, max chars=65k
    Identifier for 3DS transaction/verification object at the gateway. Can be passed only after successfully completing the 3DS flow. Refer 3DS implementation in Chargebee to find out the gateway-specific gw_token format. Applicable when you are using gateway APIs directly for completing the 3DS flow.
    payment_intent[payment_method_type]
    optional, enumerated string
    The list of payment method types (For example, card, ideal, sofort, bancontact, etc.) this Payment Intent is allowed to use. If payment method type is empty, Card is taken as the default type for all gateways except Razorpay.
    Possible values are
    cardcardidealidealsofortsofortbancontactbancontact
    google_paygoogle_paydotpaydotpaygiropaygiropayapple_payapple_payupiupinetbanking_emandatesnetbanking_emandatespaypal_express_checkoutpaypal_express_checkoutdirect_debitdirect_debitboletoboletovenmoamazon_paymentsamazon_paymentspay_tofaster_paymentssepa_instant_transfer
    Show all values[+]
    payment_intent[reference_id]
    optional, string, max chars=65k
    Identifier for Braintree permanent token. Applicable when you are using Braintree APIs for completing the 3DS flow.
    payment_intent[additional_information]
    optional, jsonobject
    • checkout_com: While adding a new payment method using permanent token or passing raw card details to Checkout.com, document ID and country_of_residence are required to support payments through dLocal.
      • payer: User related information.
        • country_of_residence: This is required since the billing country associated with the user’s payment method may not be the same as their country of residence. Hence the user’s country of residence needs to be specified. The country code should be a two-character ISO code.
        • document: Document ID is the user’s identification number based on their country.
    • bluesnap: While passing raw card details to BlueSnap, if fraud_session_id is added, additional validation is performed to avoid fraudulent transactions.
      • fraud: Fraud identification related information.
    • braintree: While passing raw card details to Braintree, your fraud_merchant_id and the user’s device_session_id can be added to perform additional validation and avoid fraudulent transactions.
      • fraud: Fraud identification related information.
        • device_session_id: Session ID associated with the user's device.
        • fraud_merchant_id: Your merchant ID for fraud detection.
    • chargebee_payments: While passing raw card details to Chargebee Payments, if fraud_session_id is added, additional validation is performed to avoid fraudulent transactions.
      • fraud: Fraud identification related information.
        • fraud_session_id: Your Chargebee Payments fraud session ID required to perform anti-fraud validation.
    +
    billing_address
    Parameters for billing_address
    pass parameters as billing_address[<param name>]
    billing_address[first_name]
    optional, string, max chars=150
    The first name of the billing contact.
    billing_address[last_name]
    optional, string, max chars=150
    The last name of the billing contact.
    billing_address[email]
    optional, string, max chars=70
    The email address.
    billing_address[company]
    optional, string, max chars=250
    The company name.
    billing_address[phone]
    optional, string, max chars=50
    The phone number.
    billing_address[line1]
    optional, string, max chars=150
    Address line 1
    billing_address[line2]
    optional, string, max chars=150
    Address line 2
    billing_address[line3]
    optional, string, max chars=150
    Address line 3
    billing_address[city]
    optional, string, max chars=50
    The name of the city.
    billing_address[state_code]
    optional, string, max chars=50
    The ISO 3166-2 state/province code without the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set state_code as AZ (not US-AZ). For Tamil Nadu (India), set as TN (not IN-TN). For British Columbia (Canada), set as BC (not CA-BC).
    billing_address[state]
    optional, string, max chars=50
    The state/province name. Is set by Chargebee automatically for US, Canada and India If state_code is provided.
    billing_address[zip]
    optional, string, max chars=20
    Zip or postal code. The number of characters is validated according to the rules specified here.
    billing_address[country]
    optional, string, max chars=50
    The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code.

    Brexit

    If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom – Northern Ireland) is available as an option.

    billing_address[validation_status]
    optional, enumerated string
    The address verification status.
    Possible values are
    not_validatedAddress is not yet validated.validAddress was validated successfully.partially_validThe address is valid for taxability but has not been validated for shipping.invalidAddress is invalid.
    +
    shipping_address
    Parameters for shipping_address
    pass parameters as shipping_address[<param name>]
    shipping_address[first_name]
    optional, string, max chars=150
    The first name of the contact.
    shipping_address[last_name]
    optional, string, max chars=150
    The last name of the contact.
    shipping_address[email]
    optional, string, max chars=70
    The email address.
    shipping_address[company]
    optional, string, max chars=250
    The company name.
    shipping_address[phone]
    optional, string, max chars=50
    The phone number.
    shipping_address[line1]
    optional, string, max chars=150
    Address line 1
    shipping_address[line2]
    optional, string, max chars=150
    Address line 2
    shipping_address[line3]
    optional, string, max chars=150
    Address line 3
    shipping_address[city]
    optional, string, max chars=50
    The name of the city.
    shipping_address[state_code]
    optional, string, max chars=50
    The ISO 3166-2 state/province code without the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set state_code as AZ (not US-AZ). For Tamil Nadu (India), set as TN (not IN-TN). For British Columbia (Canada), set as BC (not CA-BC).
    shipping_address[state]
    optional, string, max chars=50
    The state/province name. Is set by Chargebee automatically for US, Canada and India If state_code is provided.
    shipping_address[zip]
    optional, string, max chars=20
    Zip or postal code. The number of characters is validated according to the rules specified here.
    shipping_address[country]
    optional, string, max chars=50
    The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code.

    Note: If you enter an invalid country code, the system will return an error.

    Brexit

    If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom – Northern Ireland) is available as an option.

    shipping_address[validation_status]
    optional, enumerated string
    The address verification status.
    Possible values are
    not_validatedAddress is not yet validated.validAddress was validated successfully.partially_validThe address is valid for taxability but has not been validated for shipping.invalidAddress is invalid.
    +
    customer
    Parameters for customer
    pass parameters as customer[<param name>]
    customer[vat_number]
    optional, string, max chars=20
    The VAT/tax registration number for the customer. For customers with billing_address country as XI (which is United Kingdom - Northern Ireland), the first two characters of the full VAT number can be overridden by setting vat_number_prefix.
    customer[vat_number_prefix]
    optional, string, max chars=10
    An overridden value for the first two characters of the full VAT number. Only applicable specifically for customers with billing_address country as XI (which is United Kingdom - Northern Ireland).

    When you have enabled EU VAT in 2021 or have manually enabled the Brexit configuration, you have the option of setting billing_address country as XI. That’s the code for United Kingdom - Northern Ireland. The first two characters of the VAT number in such a case is XI by default. However, if the VAT number was registered in UK, the value should be GB. Set vat_number_prefix to GB for such cases.
    customer[entity_identifier_scheme]
    optional, string, max chars=50
    The Peppol BIS scheme associated with the vat_number of the customer. This helps identify the specific type of customer entity. For example, DE:VAT is used for a German business entity while DE:LWID45 is used for a German government entity. The value must be from the list of possible values and must correspond to the country provided under billing_address.country. See list of possible values.

    Tip:

    If there are additional entity identifiers for the customer not associated with the vat_number, they can be provided as the entity_identifiers[] array.

    customer[is_einvoice_enabled]
    optional, boolean
    Determines whether the customer is e-invoiced. When set to true or not set to any value, the customer is e-invoiced so long as e-invoicing is enabled for their country (billing_address.country). When set to false, the customer is not e-invoiced even if e-invoicing is enabled for their country.

    Tip:

    It is possible to set a value for this flag even when E-Invoicing is disabled. However, it comes into effect only when E-Invoicing is enabled.

    customer[einvoicing_method]
    optional, enumerated string
    Determines whether to send einvoice manually or automatic.
    Possible values are
    automaticUse this value to send e-invoice every time an invoice or credit note is created.manualWhen manual is selected the automatic e-invoice sending is disabled. Use this value to send e-invoice manually through UI or API.site_defaultThe default value of the site which can be overridden at the customer level.
    customer[entity_identifier_standard]
    optional, string, max chars=50
    The standard used for specifying the entity_identifier_scheme. Currently only iso6523-actorid-upis is supported and is used by default when not provided.

    Tip:

    If there are additional entity identifiers for the customer not associated with the vat_number, they can be provided as the entity_identifiers[] array.

    customer[business_customer_without_vat_number]
    optional, boolean
    Confirms that a customer is a valid business without an EU/UK VAT number.
    customer[registered_for_gst]
    optional, boolean
    Confirms that a customer is registered under GST. If set to true then the Reverse Charge Mechanism is applicable. This field is applicable only when Australian GST is configured for your site.
    +
    contract_term
    Parameters for contract_term
    pass parameters as contract_term[<param name>]
    contract_term[action_at_term_end]
    optional, enumerated string
    Action to be taken when the contract term completes.
    Possible values are
    renew
  • Contract term completes and a new contract term is started for the number of billing cycles specified in contract_billing_cycle_on_renewal.
  • The action_at_term_end for the new contract term is set to renew.
  • evergreenContract term completes and the subscription renews.cancelContract term completes and subscription is canceled.renew_onceUsed when you want to renew the contract term just once. Does the following:
  • Contract term completes and a new contract term is started for the number of billing cycles specified in contract_billing_cycle_on_renewal.
  • The action_at_term_end for the new contract term is set to cancel.
  • contract_term[cancellation_cutoff_period]
    optional, integer
    The number of days before contract_end, during which the customer is barred from canceling the contract term. The customer is allowed to cancel the contract term via the Self-Serve Portal only before this period. This allows you to have sufficient time for processing the contract term closure
    +
    subscription_items
    Parameters for subscription_items. Multiple subscription_items can be passed by specifying unique indices.
    pass parameters as subscription_items[<param name>][<idx:0..n>]
    subscription_items[item_price_id][0..n]
    required, string, max chars=100
    The unique identifier of the item price.
    subscription_items[quantity][0..n]
    optional, integer, min=1
    The quantity of the item purchased
    subscription_items[quantity_in_decimal][0..n]
    optional, string, max chars=33
    The decimal representation of the quantity of the item purchased. Can be provided for quantity-based item prices and only when multi-decimal pricing is enabled.
    subscription_items[unit_price][0..n]
    optional, in cents, min=0
    The price/per unit price of the item. When not provided, the value set for the item price is used. This is only applicable when the pricing_model of the item price is flat_fee or per_unit. Also, it is only allowed when price overriding is enabled for the site. The value depends on the type of currency. If changes_scheduled_at is in the past and a unit_price is not passed, then the item price’s current unit price is considered even if the item price did not exist on the date as of when the change is scheduled.
    subscription_items[unit_price_in_decimal][0..n]
    optional, string, max chars=39
    When price overriding is enabled for the site, the price or per-unit price of the item can be set here. The value set for the item price is used by default. Provide the value as a decimal string in major units of the currency. Can be provided only when multi-decimal pricing is enabled. If changes_scheduled_at is in the past and a unit_price_in_decimal is not passed, then the item price’s current unit price is considered even if the item price did not exist on the date as of when the change is scheduled.
    subscription_items[billing_cycles][0..n]
    optional, integer, min=0
    For the plan-item price:
    the value determines the number of billing cycles the subscription runs before canceling automatically. If not provided, then the value set for the plan-item price is used.

    For addon-item prices:
    If addon billing cycles are enabled then this is the number of subscription billing cycles for which the addon is included. If not provided, then the value set under attached addons is used. Further, if that value is not provided, then the value set for the addon-item price is used.
    subscription_items[trial_end][0..n]
    optional, timestamp(UTC) in seconds
    The date/time when the trial period of the item ends. Applies to plan-items and—-when enabled-—addon-items as well.
    subscription_items[service_period_days][0..n]
    optional, integer, min=1, max=730
    The service period of the item in days from the day of charge.
    subscription_items[charge_on_event][0..n]
    optional, enumerated string
    When charge_on_option option is set to on_event, this parameter specifies the event at which the charge-item is applied to the subscription. This parameter only applies to charge-items.
    Possible values are
    subscription_creationthe time of creation of the subscription.subscription_trial_startthe time when the trial period of the subscription begins.plan_activationsame as subscription activation, but also includes the case when the plan-item of the subscription is changed.subscription_activationthe moment a subscription enters an active or non-renewing state. Also includes reactivations of canceled subscriptions.contract_terminationwhen a contract term is terminated.
    subscription_items[charge_once][0..n]
    optional, boolean
    Indicates if the charge-item is to be charged only once or each time the charge_on_event occurs. This parameter only applies to charge-items.
    subscription_items[charge_on_option][0..n]
    optional, enumerated string
    Indicates when the charge-item is to be charged. This parameter only applies to charge-items.
    Possible values are
    immediatelyThe item is charged immediately on being added to the subscription.on_eventThe item is charged at the occurrence of the event specified as charge_on_event.
    +
    discounts
    Parameters for discounts. Multiple discounts can be passed by specifying unique indices.
    pass parameters as discounts[<param name>][<idx:0..n>]
    discounts[apply_on][0..n]
    required, enumerated string
    The amount on the invoice to which the discount is applied.
    Possible values are
    invoice_amountThe discount is applied to the invoice sub_total.specific_item_priceThe discount is applied to the invoice.line_item.amount that corresponds to the item price specified by item_price_id.
    discounts[duration_type][0..n]
    required, enumerated string
    Specifies the time duration for which this discount is attached to the subscription.
    Possible values are
    one_timeThe discount stays attached to the subscription till it is applied on an invoice once. It is removed after that from the subscription.foreverThe discount is attached to the subscription and applied on the invoices till it is explicitly removed.limited_periodThe discount is attached to the subscription and applied on the invoices for a limited duration. This duration starts from the point it is applied to an invoice for the first time and expires after a period specified by period and period_unit.
    discounts[percentage][0..n]
    optional, double, min=0.01, max=100.0
    The percentage of the original amount that should be deducted from it. Only applicable when discount.type is percentage.
    discounts[amount][0..n]
    optional, in cents, min=0
    The value of the discount. The format of this value depends on the kind of currency. This is only applicable when discount.type is fixed_amount.
    discounts[period][0..n]
    optional, integer, min=1
    The duration of time for which the discount is attached to the subscription, in period_units. Applicable only when duration_type is limited_period.
    discounts[period_unit][0..n]
    optional, enumerated string
    The unit of time for period. Applicable only when duration_type is limited_period.
    Possible values are
    dayA period of 24 hours.weekA period of 7 days.monthA period of 1 calendar month.yearA period of 1 calendar year.
    discounts[included_in_mrr][0..n]
    optional, boolean
    The discount is included in MRR calculations for your site. This attribute is only applicable when duration_type is one_time and when the feature is enabled in Chargebee. Also, If the site-level setting is to exclude one-time discounts from MRR calculations, this value is always returned false.
    discounts[item_price_id][0..n]
    optional, string, max chars=100
    The id of the item price in the subscription to which the discount is to be applied. Relevant only when apply_on = specific_item_price.
    discounts[operation_type][0..n]
    required, enumerated string
    The operation to be carried out for the discount.
    Possible values are
    addThe discount is attached to the subscription.removeThe discount (given by discounts[id]) is removed from the subscription. Subsequent invoices will no longer have the discount applied. Tip: If you want to replace a discount, remove it and add another in the same API call.
    discounts[id][0..n]
    optional, string, max chars=50
    The id of the discount to be removed. This parameter is only relevant when discounts[operation_type] is remove.
    +
    item_tiers
    Parameters for item_tiers. Multiple item_tiers can be passed by specifying unique indices.
    pass parameters as item_tiers[<param name>][<idx:0..n>]
    item_tiers[item_price_id][0..n]
    optional, string, max chars=100
    The id of the item price for which the tier price is being overridden.
    item_tiers[starting_unit][0..n]
    optional, integer, min=1
    The lowest value in the quantity tier.
    item_tiers[ending_unit][0..n]
    optional, integer
    The highest value in the quantity tier.
    item_tiers[price][0..n]
    optional, in cents, min=0
    The overridden price of the tier. The value depends on the type of currency.
    item_tiers[starting_unit_in_decimal][0..n]
    optional, string, max chars=33
    The decimal representation of the lowest value of quantity in this tier. This is zero for the lowest tier. For all other tiers, it is the same as ending_unit_in_decimal of the next lower tier. Returned only when the pricing_model is tiered, volume or stairstep and multi-decimal pricing is enabled.
    item_tiers[ending_unit_in_decimal][0..n]
    optional, string, max chars=33
    The decimal representation of the highest value of quantity in this tier. This attribute is not applicable for the highest tier. For all other tiers, it must be equal to the starting_unit_in_decimal of the next higher tier. Returned only when the pricing_model is tiered, volume or stairstep and multi-decimal pricing is enabled.
    item_tiers[price_in_decimal][0..n]
    optional, string, max chars=39
    The decimal representation of the per-unit price for the tier when the pricing_model is tiered or volume. When the pricing_model is stairstep, it is the decimal representation of the total price for the item. The value is in major units of the currency. Returned when the plan is quantity-based and multi-decimal pricing is enabled.
    always returned
    Resource object representing subscription
    always returned
    Resource object representing customer
    optional
    Resource object representing card
    optional
    Resource object representing invoice
    optional
    Resource object representing unbilled_charge
    optional
    Resource object representing credit_note

    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.
    • Confirm the UTC (Coordinated Universal Time) time zone selected in your Chargebee site matches with your country region.
    Sample Request
    curl  https://{site}.chargebee.com/api/v2/subscriptions/__test__8asukSOXdtByMK/change_term_end \
         -u {site_api_key}:\
         -d term_ends_at=1613413800
    copy
    curl  https://{site}.chargebee.com/api/v2/subscriptions/__test__8asukSOXdtByMK/change_term_end \
         -u {site_api_key}:\
         -d term_ends_at=1613413800

    Sample Response [ JSON ]

    Show more...
    { "customer": { "allow_direct_debit": false, "auto_collection": "off", "card_status": "no_card", "created_at": 1612890910, "deleted": false, "excess_payments": 0, "first_name": "John", "id": "__test__8asukSOXdt6gMH", "last_name": "Doe", "net_term_days": 0, "object": "customer", "pii_cleared": "active", "preferred_currency_code": "USD", "promotional_credits": 0, "refundable_credits": 0, "resource_version": 1612890910000, "taxability": "taxable", "unbilled_charges": 0, "updated_at": 1612890910 }, "subscription": { "activated_at": 1612890910, "billing_period": 1, "billing_period_unit": "month", "created_at": 1612890910, "currency_code": "USD", "current_term_end": 1613413800, "current_term_start": 1612890910, "customer_id": "__test__8asukSOXdt6gMH", "deleted": false, "due_invoices_count": 1, "due_since": 1612890910, "has_scheduled_changes": false, "id": "__test__8asukSOXdtByMK", "mrr": 0, "next_billing_at": 1613413800, "object": "subscription", "remaining_billing_cycles": 1, "resource_version": 1612890911000, "started_at": 1612890910, "status": "active", "subscription_items": [ { "amount": 1000, "billing_cycles": 1, "free_quantity": 0, "item_price_id": "basic-USD", "item_type": "plan", "object": "subscription_item", "quantity": 1, "unit_price": 1000 }, {..} ], "total_dues": 1100, "updated_at": 1612890911 } }

    URL Format POST

    https://{site}.chargebee.com/api/v2/subscriptions/{subscription_id}/change_term_end
    term_ends_at
    required, timestamp(UTC) in seconds
    The time at which the current term should end for this subscription.
    prorate
    optional, boolean
    Applicable for active / non_renewing subscriptions. If specified as true prorated charges / credits will be added during this operation.
    invoice_immediately
    optional, boolean
    If there are charges raised immediately for the subscription, this parameter specifies whether those charges are to be invoiced immediately or added to unbilled charges. The default value is as per the site settings.
    Note: invoice_immediately only affects charges that are raised at the time of execution of this API call. Any charges scheduled to be raised in the future are not affected by this parameter.
    .
    always returned
    Resource object representing subscription
    always returned
    Resource object representing customer
    optional
    Resource object representing card
    optional
    Resource object representing invoice
    optional
    Resource object representing unbilled_charge
    optional
    Resource object representing credit_note
    Note: This operation optionally supports 3DS verification flow. To achieve the same, create the Payment Intent and pass it as input parameter to this API.

    This API is used to reactivate a cancelled subscription. You may also optionally specify a trial end date, to move the subscription to In Trial state. If trial end is not specified, the subscription will be activated and any applicable charges will be initiated.

    Unless the billing cycle is specified, it will be set to plan's default billing cycle.

    During an in-term reactivation++, unless the billing cycle is specified, the subscription's remaining billing cycles will be restored. If a trial end date is specified, then the plan's default billing cycle is used.

    What is an "in-term reactivation"?
    An "in-term reactivation" happens when the billing term of the subscription is retained upon cancellation and reactivation is initiated within that term.

    When is the ‘billing term’ retained for a cancelled subscription?
    When dunning (payment failure retry settings) is configured with the last retry configured as

    • cancel subscription and mark invoice as ‘Not Paid’, or
    • cancel subscription and mark the invoice as ‘Voided’ and the case if any of the current term invoices is partially or fully paid, the invoice is not voided but instead Chargebee marks the invoices as ‘Not Paid’.

    Note : In both cases, the billing term is retained and upon reactivation the subscription will be moved to active state (if the plan does not have a trial period) and no invoice will be generated. Ensure that you collect any unpaid invoices.

    Example : A Subscription was billed from 1st to 31st of a month and it was cancelled on the 20th due to one of the above cases (billing term is not reset). If the reactivation happens on 25th then it is considered an in-term reactivation.

    Notes

    Reactivation of a subscription in non_renewing state has been deprecated. To remove a scheduled cancellation of a non_renewing Subscription, use Remove Scheduled Cancellation API.

    However, if you use reactivate API to remove scheduled cancellation for a non_renewing Subscription, then the status will be set to active and the billing cycle will be set to forever. If any value is passed for trial_end or billing cycle, an error will be thrown.

    If an invoice gets generated during this operation, available Credits and Excess Payments will be automatically applied.

    Additional Error Scenarios: If there is a need to create an immediate charge and the collection fails, an error will be thrown.

    Sample Request
    curl  https://{site}.chargebee.com/api/v2/subscriptions/__test__8asukSOXdwxyQE/reactivate \
         -X POST  \
         -u {site_api_key}:\
         -d invoice_immediately="true" \
         -d billing_cycles=4
    copy
    curl  https://{site}.chargebee.com/api/v2/subscriptions/__test__8asukSOXdwxyQE/reactivate \
         -X POST  \
         -u {site_api_key}:\
         -d invoice_immediately="true" \
         -d billing_cycles=4

    Sample Response [ JSON ]

    Show more...
    { "customer": { "allow_direct_debit": false, "auto_collection": "off", "card_status": "no_card", "created_at": 1612890924, "deleted": false, "excess_payments": 0, "first_name": "John", "id": "__test__8asukSOXdwsNQB", "last_name": "Doe", "net_term_days": 0, "object": "customer", "pii_cleared": "active", "preferred_currency_code": "USD", "promotional_credits": 0, "refundable_credits": 0, "resource_version": 1612890924000, "taxability": "taxable", "unbilled_charges": 0, "updated_at": 1612890924 }, "invoice": { "adjustment_credit_notes": [], "amount_adjusted": 0, "amount_due": 1100, "amount_paid": 0, "amount_to_collect": 1100, "applied_credits": [], "base_currency_code": "USD", "billing_address": { "first_name": "John", "last_name": "Doe", "object": "billing_address", "validation_status": "not_validated" }, "credits_applied": 0, "currency_code": "USD", "customer_id": "__test__8asukSOXdwsNQB", "date": 1612890925, "deleted": false, "due_date": 1612890925, "dunning_attempts": [], "exchange_rate": 1, "first_invoice": false, "has_advance_charges": false, "id": "__demo_inv__18", "is_gifted": false, "issued_credit_notes": [], "line_items": [ { "amount": 1000, "customer_id": "__test__8asukSOXdwsNQB", "date_from": 1612890925, "date_to": 1615310125, "description": "basic USD", "discount_amount": 0, "entity_id": "basic-USD", "entity_type": "plan_item_price", "id": "li___test__8asukSOXdxDQQP", "is_taxed": false, "item_level_discount_amount": 0, "object": "line_item", "pricing_model": "per_unit", "quantity": 1, "subscription_id": "__test__8asukSOXdwxyQE", "tax_amount": 0, "tax_exempt_reason": "tax_not_configured", "unit_amount": 1000 }, {..} ], "linked_orders": [], "linked_payments": [], "net_term_days": 0, "object": "invoice", "price_type": "tax_exclusive", "recurring": true, "resource_version": 1612890926000, "round_off_amount": 0, "status": "payment_due", "sub_total": 1100, "subscription_id": "__test__8asukSOXdwxyQE", "tax": 0, "term_finalized": true, "total": 1100, "updated_at": 1612890926, "write_off_amount": 0 }, "subscription": { "activated_at": 1612890925, "billing_period": 1, "billing_period_unit": "month", "created_at": 1612890924, "currency_code": "USD", "current_term_end": 1615310125, "current_term_start": 1612890925, "customer_id": "__test__8asukSOXdwsNQB", "deleted": false, "due_invoices_count": 2, "due_since": 1612890924, "has_scheduled_changes": false, "id": "__test__8asukSOXdwxyQE", "mrr": 0, "next_billing_at": 1615310125, "object": "subscription", "remaining_billing_cycles": 3, "resource_version": 1612890926000, "started_at": 1612890924, "status": "active", "subscription_items": [ { "amount": 1000, "billing_cycles": 3, "free_quantity": 0, "item_price_id": "basic-USD", "item_type": "plan", "object": "subscription_item", "quantity": 1, "unit_price": 1000 }, {..} ], "total_dues": 2200, "updated_at": 1612890926 } }

    URL Format POST

    https://{site}.chargebee.com/api/v2/subscriptions/{subscription_id}/reactivate
    trial_end
    optional, timestamp(UTC) in seconds
    Providing this parameter indicates that the subscription reactivates with an in_trial status and the trial period ends at the date provided. The value must not be earlier than reactivate_from. Note: This parameter can be backdated (set to a value in the past) only when reactivate_from has been backdated. Do this to keep a record of when the trial ended in case it ended at some point in the past. When trial_end is backdated, the subscription immediately goes into active or non_renewing status.
    billing_cycles
    optional, integer, min=0
    Number of cycles(plan interval) this subscription should be charged. After the billing cycles exhausted, the subscription will be cancelled.
    reactivate_from
    optional, timestamp(UTC) in seconds
    The date/time at which the subscription was reactivated. When not provided, the subscription is reactivated immediately on calling this API. The value of this parameter must always be in the past (backdating). Do this when the subscription has already been reactivated and the billing has been delayed. The following prerequisites must be met for this parameter to be passed:
    • The backdating feature has been enabled for subscription reactivation operations.
    • The current day of the month does not exceed the limit set in Chargebee for backdating such operations. This day is the day of the month by which the accounting for the previous month must be closed.
    • The date is not more than duration X into the past where X is the billing period of the plan. For example, if the period of the plan in the subscription is 2 months and today is 14th April, reactivate_from cannot be earlier than 14th February.
    .
    invoice_immediately
    optional, boolean
    If there are charges raised immediately for the subscription, this parameter specifies whether those charges are to be invoiced immediately or added to unbilled charges. The default value is as per the site settings.
    Note: invoice_immediately only affects charges that are raised at the time of execution of this API call. Any charges scheduled to be raised in the future are not affected by this parameter.
    .
    billing_alignment_mode
    optional, enumerated string
    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.
    Possible values are
    immediateSubscription period will be aligned with the configured billing date immediately, with credits or charges raised accordingly..delayedSubscription period will be aligned with the configured billing date at the next renewal.
    terms_to_charge
    optional, integer, min=1
    The number of subscription billing cycles to invoice in advance. If a new term is started for the subscription due to this API call, then terms_to_charge is inclusive of this new term. See description for the force_term_reset parameter to learn more about when a subscription term is reset.
    invoice_date
    optional, timestamp(UTC) in seconds
    The document date displayed on the invoice PDF. The default value is the current date. Provide this value to backdate the invoice. Backdating an invoice is done for reasons such as booking revenue for a previous date or when the subscription is effective as of a past date. Moreover, if create_pending_invoices is true, and if the site is configured to set invoice dates to the date of closing, then upon invoice closure, this date is changed to the invoice closing date. taxes and line_item_taxes are computed based on the tax configuration as of invoice_date. When passing this parameter, the following prerequisites must be met:
    • invoice_date must be in the past.
    • invoice_date is not more than one calendar month into the past. For example, if today is 13th January, then you cannot pass a value that is earlier than 13th December.
    • It is not earlier than reactivate_from or trial_end.
    • invoice_immediately is true.
    .
    contract_term_billing_cycle_on_renewal
    optional, integer, min=1, max=100
    Number of billing cycles the new contract term should run for, on contract renewal. The default value is the same as billing_cycles or a custom value depending on the site configuration.
    payment_initiator
    optional, enumerated string
    The type of initiator to be used for the payment request triggered by this operation.
    Possible values are
    customerPass this value to indicate that the request is initiated by the customermerchantPass this value to indicate that the request is initiated by the merchant
    +
    contract_term
    Parameters for contract_term
    pass parameters as contract_term[<param name>]
    contract_term[action_at_term_end]
    optional, enumerated string, default=cancel
    Action to be taken when the contract term completes.
    Possible values are
    renew
  • Contract term completes and a new contract term is started for the number of billing cycles specified in contract_billing_cycle_on_renewal.
  • The action_at_term_end for the new contract term is set to renew.
  • evergreenContract term completes and the subscription renews.cancelContract term completes and subscription is canceled.
    contract_term[cancellation_cutoff_period]
    optional, integer, default=0
    The number of days before contract_end, during which the customer is barred from canceling the contract term. The customer is allowed to cancel the contract term via the Self-Serve Portal only before this period. This allows you to have sufficient time for processing the contract term closure
    +
    payment_intent
    Parameters for payment_intent
    pass parameters as payment_intent[<param name>]
    payment_intent[id]
    optional, string, max chars=150
    Identifier for PaymentIntent generated by Chargebee.js. Applicable only when you are using Chargebee.js for completing the 3DS flow. The PaymentIntent should be in 'authorized' state while passing it here. You need not pass other PaymentIntent parameters if this is passed.
    payment_intent[gateway_account_id]
    required if payment intent token provided, string, max chars=50
    The gateway account used for performing the 3DS flow.
    payment_intent[gw_token]
    optional, string, max chars=65k
    Identifier for 3DS transaction/verification object at the gateway. Can be passed only after successfully completing the 3DS flow. Refer 3DS implementation in Chargebee to find out the gateway-specific gw_token format. Applicable when you are using gateway APIs directly for completing the 3DS flow.
    payment_intent[payment_method_type]
    optional, enumerated string
    The list of payment method types (For example, card, ideal, sofort, bancontact, etc.) this Payment Intent is allowed to use. If payment method type is empty, Card is taken as the default type for all gateways except Razorpay.
    Possible values are
    cardcardidealidealsofortsofortbancontactbancontact
    google_paygoogle_paydotpaydotpaygiropaygiropayapple_payapple_payupiupinetbanking_emandatesnetbanking_emandatespaypal_express_checkoutpaypal_express_checkoutdirect_debitdirect_debitboletoboletovenmoamazon_paymentsamazon_paymentspay_tofaster_paymentssepa_instant_transfer
    Show all values[+]
    payment_intent[reference_id]
    optional, string, max chars=65k
    Identifier for Braintree permanent token. Applicable when you are using Braintree APIs for completing the 3DS flow.
    payment_intent[additional_information]
    optional, jsonobject
    • checkout_com: While adding a new payment method using permanent token or passing raw card details to Checkout.com, document ID and country_of_residence are required to support payments through dLocal.
      • payer: User related information.
        • country_of_residence: This is required since the billing country associated with the user’s payment method may not be the same as their country of residence. Hence the user’s country of residence needs to be specified. The country code should be a two-character ISO code.
        • document: Document ID is the user’s identification number based on their country.
    • bluesnap: While passing raw card details to BlueSnap, if fraud_session_id is added, additional validation is performed to avoid fraudulent transactions.
      • fraud: Fraud identification related information.
    • braintree: While passing raw card details to Braintree, your fraud_merchant_id and the user’s device_session_id can be added to perform additional validation and avoid fraudulent transactions.
      • fraud: Fraud identification related information.
        • device_session_id: Session ID associated with the user's device.
        • fraud_merchant_id: Your merchant ID for fraud detection.
    • chargebee_payments: While passing raw card details to Chargebee Payments, if fraud_session_id is added, additional validation is performed to avoid fraudulent transactions.
      • fraud: Fraud identification related information.
        • fraud_session_id: Your Chargebee Payments fraud session ID required to perform anti-fraud validation.
    always returned
    Resource object representing subscription
    always returned
    Resource object representing customer
    optional
    Resource object representing card
    optional
    Resource object representing invoice
    optional
    Resource object representing unbilled_charge

    Adds a one time charge to the subscription which will be added to the invoice generated at the end of the current term. If there are any applicable coupons in the subscription, an appropriate discount will be applied.

    To collect a charge immediately, use this API.

    Notes

    If any subscription changes happen before the end of the current term, these charges will be collected along with it.

    Sample Request
    curl  https://{site}.chargebee.com/api/v2/subscriptions/__test__8asukSOXds3JLW/add_charge_at_term_end \
         -u {site_api_key}:\
         -d amount=300 \
         -d description="Service Charge"
    copy
    curl  https://{site}.chargebee.com/api/v2/subscriptions/__test__8asukSOXds3JLW/add_charge_at_term_end \
         -u {site_api_key}:\
         -d amount=300 \
         -d description="Service Charge"

    Sample Response [ JSON ]

    Show more...
    {"estimate": { "created_at": 1612890907, "invoice_estimate": { "amount_due": 1400, "amount_paid": 0, "credits_applied": 0, "currency_code": "USD", "customer_id": "__test__8asukSOXdrvyLT", "line_item_discounts": [], "line_item_taxes": [], "line_items": [ { "amount": 300, "customer_id": "__test__8asukSOXdrvyLT", "date_from": 1612890906, "date_to": 1612890906, "description": "Service Charge", "discount_amount": 0, "entity_type": "adhoc", "id": "li___test__8asukSOXdsHoLe", "is_taxed": false, "item_level_discount_amount": 0, "object": "line_item", "pricing_model": "flat_fee", "quantity": 1, "subscription_id": "__test__8asukSOXds3JLW", "tax_amount": 0, "unit_amount": 300 }, {..} ], "object": "invoice_estimate", "price_type": "tax_exclusive", "recurring": true, "round_off_amount": 0, "sub_total": 1400, "taxes": [], "total": 1400 }, "object": "estimate", "subscription_estimate": { "currency_code": "USD", "id": "__test__8asukSOXds3JLW", "next_billing_at": 1615310105, "object": "subscription_estimate", "status": "active" } }}

    URL Format POST

    https://{site}.chargebee.com/api/v2/subscriptions/{subscription_id}/add_charge_at_term_end
    amount
    optional, in cents, min=1
    The amount to be charged. The unit depends on the type of currency.
    description
    required, string, max chars=250
    Description for this charge.
    amount_in_decimal
    optional, string, max chars=39
    The decimal representation of the amount for the one-time charge. Provide the value in major units of the currency. Can be provided only when multi-decimal pricing is enabled.
    avalara_sale_type
    optional, enumerated string
    Indicates the type of sale carried out. This is applicable only if you use Chargebee’s AvaTax for Communications integration.
    Possible values are
    wholesaleTransaction is a sale to another company that will resell your product or service to another consumerretailTransaction is a sale to an end userconsumedTransaction is for an item that is consumed directlyvendor_useTransaction is for an item that is subject to vendor use tax
    avalara_transaction_type
    optional, integer
    Indicates the type of product to be taxed. Values for this field can be taken from Avalara. This is applicable only if you use Chargebee’s AvaTax for Communications integration.
    avalara_service_type
    optional, integer
    Indicates the type of service for the product to be taxed. Values for this field can be taken from Avalara. This is applicable only if you use Chargebee’s AvaTax for Communications integration.
    date_from
    optional, timestamp(UTC) in seconds
    The time when the service period for the charge starts.
    date_to
    optional, timestamp(UTC) in seconds
    The time when the service period for the charge ends.
    always returned
    Resource object representing estimate

    Creates an advance invoice or an advance invoicing schedule. When an advance invoice is generated, and auto_collection is on for the subscription, the payment_source associated with the subscription is charged. Any changes scheduled for the subscription are taken into account automatically while generating an advance invoice. Advance invoices are not generated for a subscription when it is in the paused status. Advance invoices are generated only for non-metered items in a subscription.

    Notes

    • This operation is supported only on select plans. To know more, take a look at our plans and pricing page.
    • This operation is not supported for non_renewing and cancelled 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/__test__8asukSOXdtV2MX/charge_future_renewals \
         -u {site_api_key}:\
         -d terms_to_charge=5
    copy
    curl  https://{site}.chargebee.com/api/v2/subscriptions/__test__8asukSOXdtV2MX/charge_future_renewals \
         -u {site_api_key}:\
         -d terms_to_charge=5

    Sample Response [ JSON ]

    Show more...
    { "customer": { "allow_direct_debit": false, "auto_collection": "off", "card_status": "no_card", "created_at": 1612890911, "deleted": false, "excess_payments": 0, "first_name": "John", "id": "__test__8asukSOXdtPJMU", "last_name": "Doe", "net_term_days": 0, "object": "customer", "pii_cleared": "active", "preferred_currency_code": "USD", "promotional_credits": 0, "refundable_credits": 0, "resource_version": 1612890911000, "taxability": "taxable", "unbilled_charges": 0, "updated_at": 1612890911 }, "invoice": { "adjustment_credit_notes": [], "amount_adjusted": 0, "amount_due": 5500, "amount_paid": 0, "amount_to_collect": 5500, "applied_credits": [], "base_currency_code": "USD", "billing_address": { "first_name": "John", "last_name": "Doe", "object": "billing_address", "validation_status": "not_validated" }, "credits_applied": 0, "currency_code": "USD", "customer_id": "__test__8asukSOXdtPJMU", "date": 1612890912, "deleted": false, "due_date": 1612890912, "dunning_attempts": [], "exchange_rate": 1, "first_invoice": false, "has_advance_charges": true, "id": "__demo_inv__6", "is_gifted": false, "issued_credit_notes": [], "line_items": [ { "amount": 1000, "customer_id": "__test__8asukSOXdtPJMU", "date_from": 1615310111, "date_to": 1617988511, "description": "basic USD", "discount_amount": 0, "entity_id": "basic-USD", "entity_type": "plan_item_price", "id": "li___test__8asukSOXdthZMf", "is_taxed": false, "item_level_discount_amount": 0, "object": "line_item", "pricing_model": "per_unit", "quantity": 1, "subscription_id": "__test__8asukSOXdtV2MX", "tax_amount": 0, "tax_exempt_reason": "tax_not_configured", "unit_amount": 1000 }, {..} ], "linked_orders": [], "linked_payments": [], "net_term_days": 0, "object": "invoice", "price_type": "tax_exclusive", "recurring": true, "resource_version": 1612890912000, "round_off_amount": 0, "status": "payment_due", "sub_total": 5500, "subscription_id": "__test__8asukSOXdtV2MX", "tax": 0, "term_finalized": true, "total": 5500, "updated_at": 1612890912, "write_off_amount": 0 }, "subscription": { "activated_at": 1612890911, "billing_period": 1, "billing_period_unit": "month", "created_at": 1612890911, "currency_code": "USD", "current_term_end": 1615310111, "current_term_start": 1612890911, "customer_id": "__test__8asukSOXdtPJMU", "deleted": false, "due_invoices_count": 2, "due_since": 1612890911, "has_scheduled_changes": false, "id": "__test__8asukSOXdtV2MX", "mrr": 0, "next_billing_at": 1628529311, "object": "subscription", "resource_version": 1612890911000, "started_at": 1612890911, "status": "active", "subscription_items": [ { "amount": 1000, "free_quantity": 0, "item_price_id": "basic-USD", "item_type": "plan", "object": "subscription_item", "quantity": 1, "unit_price": 1000 }, {..} ], "total_dues": 6600, "updated_at": 1612890911 } }

    URL Format POST

    https://{site}.chargebee.com/api/v2/subscriptions/{subscription_id}/charge_future_renewals
    terms_to_charge
    optional, integer, default=1, min=1
    • For schedule_type = immediate: the number of future billing cycles to be invoiced in advance. The invoicing is done for the remaining_billing_cycles of the subscription if that is less than terms_to_charge.
    • For schedule_type = fixed_intervals: The number of future billing cycles in one interval. The schedule is created such that the total number of billing cycles in the schedule does not exceed the remaining_billing_cycles of the subscription.
    .
    invoice_immediately
    optional, boolean
    Whether the charge should be invoiced immediately or added to unbilled_charges. Applicable only when schedule_type is immediate.
    schedule_type
    optional, enumerated string
    The type of advance invoice or advance invoicing schedule.
    Possible values are
    immediateCharge immediately for the number of billing cycles specified by terms_to_charge.specific_datesCharge on specific dates. For each date, specify the number of billing cycles to charge for. Up to 5 dates can be configured.fixed_intervalsCharge at fixed intervals of time. Specify the number of billing cycles that constitute an interval and the number of days before each interval that the invoice should be generated. Also specify when the schedule should end.
    +
    fixed_interval_schedule
    Parameters for fixed_interval_schedule
    pass parameters as fixed_interval_schedule[<param name>]
    fixed_interval_schedule[number_of_occurrences]
    optional, integer, min=1
    The number of advance invoices to generate. The schedule is created such that the total number of billing cycles in the schedule does not exceed the remaining_billing_cycles of the subscription. This parameter is applicable only when fixed_interval_schedule[end_schedule_on] = after_number_of_intervals
    fixed_interval_schedule[days_before_renewal]
    optional, integer, min=1
    The number of days before each interval that advance invoices are generated.
    fixed_interval_schedule[end_schedule_on]
    optional, enumerated string
    Specifies when the schedule should end.
    Possible values are
    after_number_of_intervalsAdvance invoices are generated a specified number of timesspecific_dateEnd the advance invoicing schedule on a specific date.subscription_endAdvance invoices are generated for as long as the subscription is active.
    fixed_interval_schedule[end_date]
    optional, timestamp(UTC) in seconds
    The date when the schedule should end. Advance invoices are not generated beyond this date. It must be at least 1 day before the start of the last billing cycle of the subscription and also within 5 years from the current date. This parameter is only applicable when fixed_interval_schedule[end_schedule_on] = specific_date.
    +
    specific_dates_schedule
    Parameters for specific_dates_schedule. Multiple specific_dates_schedule can be passed by specifying unique indices.
    pass parameters as specific_dates_schedule[<param name>][<idx:0..n>]
    specific_dates_schedule[terms_to_charge][0..n]
    optional, integer
    The number of billing cycles to charge for, on the date specified. Applicable only when schedule_type is specific_dates.
    specific_dates_schedule[date][0..n]
    optional, timestamp(UTC) in seconds
    The unique id of the member of the advance_invoice_schedule array which corresponds to the specific_dates_schedule that you intend to modify. Only applicable when schedule_type is specific_dates.
    always returned
    Resource object representing subscription
    always returned
    Resource object representing customer
    optional
    Resource object representing card
    optional
    Resource object representing invoice
    optional
    Resource object representing advance_invoice_schedule

    Modifies the advance invoicing schedule for a subscription.

    Sample Request
    curl  https://{site}.chargebee.com/api/v2/subscriptions/__test__KyVkmQSCX2vpB3C/edit_advance_invoice_schedule \
         -X POST  \
         -u {site_api_key}:\
         -d schedule_type="specific_dates" \
         -d specific_dates_schedule[id][0]="__test__KyVkmQSCX2vwe3Q" \
         -d specific_dates_schedule[terms_to_charge][0]=1
    copy

    Sample Response [ JSON ]

    URL Format POST

    https://{site}.chargebee.com/api/v2/subscriptions/{subscription_id}/edit_advance_invoice_schedule
    terms_to_charge
    optional, integer, min=1
    The number of billing cycles in one interval.
    schedule_type
    optional, enumerated string
    The type of advance invoice or advance invoicing schedule.
    Possible values are
    specific_datesCharge on specific dates. For each date, specify the number of billing cycles to charge for. Up to 5 dates can be configured.fixed_intervalsCharge at fixed intervals of time. Specify the number of billing cycles that constitute an interval and the number of days before each interval that the invoice should be generated. Also specify when the schedule should end.
    +
    fixed_interval_schedule
    Parameters for fixed_interval_schedule
    pass parameters as fixed_interval_schedule[<param name>]
    fixed_interval_schedule[number_of_occurrences]
    optional, integer, min=1
    The number of advance invoices to generate. The schedule is created such that the total number of billing cycles in the schedule does not exceed the remaining_billing_cycles of the subscription. This parameter is applicable only when fixed_interval_schedule[end_schedule_on] = after_number_of_intervals
    fixed_interval_schedule[days_before_renewal]
    optional, integer, min=1
    The number of days before each interval that advance invoices are generated.
    fixed_interval_schedule[end_schedule_on]
    optional, enumerated string
    Specifies when the schedule should end.
    Possible values are
    after_number_of_intervalsAdvance invoices are generated a specified number of timesspecific_dateEnd the advance invoicing schedule on a specific date.subscription_endAdvance invoices are generated for as long as the subscription is active.
    fixed_interval_schedule[end_date]
    optional, timestamp(UTC) in seconds
    The date when the schedule should end. Advance invoices are not generated beyond this date. It must be at least 1 day before the start of the last billing cycle of the subscription and also within 5 years from the current date. This parameter is only applicable when fixed_interval_schedule[end_schedule_on] = specific_date.
    +
    specific_dates_schedule
    Parameters for specific_dates_schedule. Multiple specific_dates_schedule can be passed by specifying unique indices.
    pass parameters as specific_dates_schedule[<param name>][<idx:0..n>]
    specific_dates_schedule[id][0..n]
    optional, string, max chars=50
    The unique id of the member of the advance_invoice_schedule array which corresponds to the specific_dates_schedule that you intend to modify. Only applicable when schedule_type is specific_dates.
    specific_dates_schedule[terms_to_charge][0..n]
    optional, integer
    The number of billing cycles to charge for, on the date specified. Applicable only when schedule_type is specific_dates.
    specific_dates_schedule[date][0..n]
    optional, timestamp(UTC) in seconds
    The unique id of the member of the advance_invoice_schedule array which corresponds to the specific_dates_schedule that you intend to modify. Only applicable when schedule_type is specific_dates.
    always returned
    Resource object representing advance_invoice_schedule

    Retrieves the advance_invoice_schedule for a subscription. Note that this endpoint is only applicable for schedule_type = specific_dates or fixed_intervals.

    Sample Request
    curl  https://{site}.chargebee.com/api/v2/subscriptions/__test__KyVkmQSCX2wPg43/retrieve_advance_invoice_schedule \
         -u {site_api_key}:
    copy
    curl  https://{site}.chargebee.com/api/v2/subscriptions/__test__KyVkmQSCX2wPg43/retrieve_advance_invoice_schedule \
         -u {site_api_key}:

    Sample Response [ JSON ]

    Show more...
    {"advance_invoice_schedules": [ { "id": "__test__KyVkmQSCX2wUp4H", "object": "advance_invoice_schedule", "schedule_type": "specific_dates", "specific_dates_schedule": { "date": 1518339710, "object": "specific_dates_schedule", "terms_to_charge": 2 } }, {..} ]}

    URL Format GET

    https://{site}.chargebee.com/api/v2/subscriptions/{subscription_id}/retrieve_advance_invoice_schedule
    always returned
    Resource object representing advance_invoice_schedule

    Deletes an advance invoicing schedule. When schedule_type = specific_dates, you also have the option of deleting a part of the schedule.

    Sample Request
    curl  https://{site}.chargebee.com/api/v2/subscriptions/__test__XpbBsG2SYV7ZMB2K/remove_advance_invoice_schedule \
         -X POST  \
         -u {site_api_key}:
    copy
    curl  https://{site}.chargebee.com/api/v2/subscriptions/__test__XpbBsG2SYV7ZMB2K/remove_advance_invoice_schedule \
         -X POST  \
         -u {site_api_key}:

    Sample Response [ JSON ]

    Show more...
    { "advance_invoice_schedules": [], "subscription": { "customer": { "allow_direct_debit": false, "auto_collection": "off", "card_status": "no_card", "created_at": 1622014982, "deleted": false, "excess_payments": 0, "first_name": "John", "id": "__test__XpbBsG2SYV7ZFJ2H", "last_name": "Doe", "net_term_days": 0, "object": "customer", "pii_cleared": "active", "preferred_currency_code": "USD", "promotional_credits": 0, "refundable_credits": 0, "resource_version": 1622014982000, "taxability": "taxable", "unbilled_charges": 0, "updated_at": 1622014982 }, "subscription": { "activated_at": 1622014983, "billing_period": 1, "billing_period_unit": "month", "created_at": 1622014983, "currency_code": "USD", "current_term_end": 1624693383, "current_term_start": 1622014983, "customer_id": "__test__XpbBsG2SYV7ZFJ2H", "deleted": false, "due_invoices_count": 1, "due_since": 1622014983, "has_scheduled_advance_invoices": false, "has_scheduled_changes": false, "id": "__test__XpbBsG2SYV7ZMB2K", "mrr": 0, "next_billing_at": 1624693383, "object": "subscription", "resource_version": 1622014983000, "started_at": 1622014983, "status": "active", "subscription_items": [ { "amount": 1000, "free_quantity": 0, "item_price_id": "basic-USD", "item_type": "plan", "object": "subscription_item", "quantity": 1, "unit_price": 1000 }, {..} ], "total_dues": 1100, "updated_at": 1622014983 } } }

    URL Format POST

    https://{site}.chargebee.com/api/v2/subscriptions/{subscription_id}/remove_advance_invoice_schedule
    +
    specific_dates_schedule
    Parameters for specific_dates_schedule. Multiple specific_dates_schedule can be passed by specifying unique indices.
    pass parameters as specific_dates_schedule[<param name>][<idx:0..n>]
    specific_dates_schedule[id][0..n]
    optional, string, max chars=50
    When schedule_type = specific_dates, pass the id of the specific_dates_schedule that you want to remove. If not passed, the entire advance_invoice_schedule is removed.
    always returned
    Resource object representing subscription
    optional
    Resource object representing advance_invoice_schedule

    Regenerates the current invoice for the subscription. The current invoice is that which includes non-metered items from the current term and metered items from the previous term of the subscription.

    prerequisites

    deleting an invoice

    Usages are also deleted when an invoice is deleted. Therefore, if the invoice was deleted, you may add or bulk import usages before regenerating an invoice.

    URL Format POST

    https://{site}.chargebee.com/api/v2/subscriptions/{subscription_id}/regenerate_invoice
    date_from
    optional, timestamp(UTC) in seconds
    The start date of the period being invoiced. The default value is current_term_start.
    date_to
    optional, timestamp(UTC) in seconds
    The end date of the period being invoiced. The default value is current_term_end.
    prorate
    optional, boolean
    Whether the charges should be prorated according to the term specified by date_from and date_to. Should not be passed without date_from and date_to.
    invoice_immediately
    optional, boolean
    Only applicable when Consolidated Invoicing is enabled for the customer. Set to false to leave the current term charge for the subscription as unbilled. Once you have done this for all suitable subscriptions of the customer, call Create an invoice for unbilled charges to invoice them.
    optional
    Resource object representing invoice
    optional
    Resource object representing unbilled_charge
    Import previous and active contract terms.

    For contract terms in active state, import is allowed only if the associated subscription is active, in_trial, future or non-renewing.
    This API is not enabled for live sites by default. Please contact support to get this enabled.
    Sample Request
    curl  https://{site}.chargebee.com/api/v2/subscriptions/__test__8asukSOXdvMNOv/import_contract_term \
         -X POST  \
         -u {site_api_key}:\
         -d contract_term[action_at_term_end]="cancel" \
         -d contract_term[billing_cycle]=5 \
         -d contract_term[contract_start]=1483245610 \
         -d contract_term[contract_end]=1493613610 \
         -d contract_term[status]="terminated" \
         -d contract_term[total_contract_value]="1000"
    copy
    curl  https://{site}.chargebee.com/api/v2/subscriptions/__test__8asukSOXdvMNOv/import_contract_term \
         -X POST  \
         -u {site_api_key}:\
         -d contract_term[action_at_term_end]="cancel" \
         -d contract_term[billing_cycle]=5 \
         -d contract_term[contract_start]=1483245610 \
         -d contract_term[contract_end]=1493613610 \
         -d contract_term[status]="terminated" \
         -d contract_term[total_contract_value]="1000"

    Sample Response [ JSON ]

    Show more...
    {"contract_term": { "action_at_term_end": "cancel", "billing_cycle": 5, "cancellation_cutoff_period": 0, "contract_end": 1493613610, "contract_start": 1483245610, "created_at": 1483245610, "id": "__test__8asukSOXdvULP3", "object": "contract_term", "status": "terminated", "total_contract_value": 1000 }}

    URL Format POST

    https://{site}.chargebee.com/api/v2/subscriptions/{subscription_id}/import_contract_term
    contract_term_billing_cycle_on_renewal
    optional, integer, min=1, max=100
    Number of billing cycles the new contract term should run for, on contract renewal. The default value is the same as billing_cycles or a custom value depending on the site configuration.
    +
    contract_term
    Parameters for contract_term
    pass parameters as contract_term[<param name>]
    contract_term[id]
    optional, string, max chars=50
    Id that uniquely identifies the contract term in the site.
    contract_term[created_at]
    optional, timestamp(UTC) in seconds
    The date when the contract term was created.
    contract_term[contract_start]
    optional, timestamp(UTC) in seconds
    The start date of the contract term
    contract_term[contract_end]
    optional, timestamp(UTC) in seconds
    The end date of the contract term
    contract_term[status]
    optional, enumerated string
    Current status of contract
    Possible values are
    activeAn actively running contract term.completedThe contract term has run its full duration.cancelledThe contract term was ended because: terminatedThe contract term was terminated ahead of completion.
    contract_term[total_amount_raised]
    optional, in cents, default=0, min=0
    The amount raised for the contract term till the time of importing the subscription. This amount is added to the total_contract_value
    contract_term[total_amount_raised_before_tax]
    optional, in cents, default=0, min=0
    The amount raised for the contract term till the time of importing the subscription excluding tax. This amount is added to the total_contract_value_before_tax
    contract_term[total_contract_value]
    optional, in cents, default=0, min=0
    The sum of the totals of all the invoices raised as part of the contract term. For active contract terms, this is a predicted value. The value depends on the type of currency. If the subscription was imported with the contract term, then this value includes the value passed for total_amount_raised.
    contract_term[total_contract_value_before_tax]
    optional, in cents, default=0, min=0
    It refers to the total amount of revenue that is expected to be generated from a specific contract term, calculated as the sum of all invoices raised during the term, regardless of payment status. It is based on past performance and the specified currency in the contract. If the subscription was imported, the value for total_amount_raised_before_tax is included in the calculation of the total contract value before tax. It's important to note that this value excludes any applicable taxes.
    contract_term[billing_cycle]
    optional, integer, min=0
    The number of billing cycles of the subscription that the contract term is for.
    contract_term[action_at_term_end]
    optional, enumerated string, default=renew
    Action to be taken when the contract term completes.
    Possible values are
    renew
  • Contract term completes and a new contract term is started for the number of billing cycles specified in contract_billing_cycle_on_renewal.
  • The action_at_term_end for the new contract term is set to renew.
  • evergreenContract term completes and the subscription renews.cancelContract term completes and subscription is canceled.renew_onceUsed when you want to renew the contract term just once. Does the following:
  • Contract term completes and a new contract term is started for the number of billing cycles specified in contract_billing_cycle_on_renewal.
  • The action_at_term_end for the new contract term is set to cancel.
  • contract_term[cancellation_cutoff_period]
    optional, integer
    The number of days before contract_end, during which the customer is barred from canceling the contract term. The customer is allowed to cancel the contract term via the Self-Serve Portal only before this period. This allows you to have sufficient time for processing the contract term closure
    always returned
    Resource object representing contract_term
    Imports unbilled charges into Chargebee.
    This API is not enabled for live sites by default. Please contact support to get this enabled.
    Sample Request
    curl  https://{site}.chargebee.com/api/v2/subscriptions/import_unbilled_charges/import_unbilled_charges \
         -u {site_api_key}:\
         -d unbilled_charges[date_from][1]=1517490271 \
         -d unbilled_charges[date_to][1]=1519909471 \
         -d unbilled_charges[description][1]="No Trial" \
         -d unbilled_charges[unit_amount][1]=4900 \
         -d unbilled_charges[quantity][1]=1 \
         -d unbilled_charges[entity_id][1]="no-trial" \
         -d unbilled_charges[entity_type][1]="plan_item_price"
    copy
    curl  https://{site}.chargebee.com/api/v2/subscriptions/import_unbilled_charges/import_unbilled_charges \
         -u {site_api_key}:\
         -d unbilled_charges[date_from][1]=1517490271 \
         -d unbilled_charges[date_to][1]=1519909471 \
         -d unbilled_charges[description][1]="No Trial" \
         -d unbilled_charges[unit_amount][1]=4900 \
         -d unbilled_charges[quantity][1]=1 \
         -d unbilled_charges[entity_id][1]="no-trial" \
         -d unbilled_charges[entity_type][1]="plan_item_price"

    Sample Response [ JSON ]

    Show more...
    {"unbilled_charges": [ { "id": "li___dev__8asq9TI2eBrV1", "customer_id": "active", "subscription_id": "active", "date_from": 1517490271, "date_to": 1519909471, "unit_amount": 4900, "pricing_model": "per_unit", "quantity": 1, "amount": 4900, "discount_amount": 0, "description": "No Trial", "entity_id": "no-trial", "is_voided": false, "updated_at": 1663736354, "deleted": false, "object": "unbilled_charge", "entity_type": "plan", "currency_code": "USD" }, {..} ]}

    URL Format POST

    https://{site}.chargebee.com/api/v2/subscriptions/{subscription_id}/import_unbilled_charges
    +
    unbilled_charges
    Parameters for unbilled_charges. Multiple unbilled_charges can be passed by specifying unique indices.
    pass parameters as unbilled_charges[<param name>][<idx:0..n>]
    unbilled_charges[id][0..n]
    optional, string, max chars=40
    Uniquely identifies an unbilled charge.
    unbilled_charges[date_from][0..n]
    required, timestamp(UTC) in seconds
    Start date of this charge.
    unbilled_charges[date_to][0..n]
    required, timestamp(UTC) in seconds
    End date of this charge.
    unbilled_charges[entity_type][0..n]
    required, enumerated string, default=adhoc
    Specifies the modelled entity this line item is based on.
    Possible values are
    adhocIndicates that this lineitem is not modelled. i.e created adhoc. So the 'entity_id' attribute will be null in this caseplan_item_priceIndicates that this line item is based on plan Item Priceaddon_item_priceIndicates that this line item is based on addon Item Pricecharge_item_priceIndicates that this line item is based on charge Item Price
    unbilled_charges[entity_id][0..n]
    optional, string, max chars=100
    The identifier of the modelled entity this charge is based on. Will be null for 'adhoc' entity type.
    unbilled_charges[description][0..n]
    optional, string, max chars=250
    Detailed description about this charge.
    unbilled_charges[unit_amount][0..n]
    optional, in cents, min=0
    Unit amount of the charge item.
    unbilled_charges[quantity][0..n]
    optional, integer, min=0
    Quantity of the item which is represented by this charge.
    unbilled_charges[amount][0..n]
    optional, in cents, min=0
    Total amount of this charge. Typically equals to unit amount x quantity.
    unbilled_charges[unit_amount_in_decimal][0..n]
    optional, string, max chars=39
    The decimal representation of the amount for the charge, in major units of the currency. Typically equals to unit_amount_in_decimal x quantity_in_decimal. Returned when multi-decimal pricing is enabled.
    unbilled_charges[quantity_in_decimal][0..n]
    optional, string, max chars=33
    The decimal representation of the quantity of this entity. Returned when the entity is quantity-based and multi-decimal pricing is enabled.
    unbilled_charges[amount_in_decimal][0..n]
    optional, string, max chars=39
    The decimal representation of the unit amount for the entity. The value is in major units of the currency. Returned when the entity is quantity-based and multi-decimal pricing is enabled.
    unbilled_charges[discount_amount][0..n]
    optional, in cents, min=0
    Total discounts for this charge.
    unbilled_charges[use_for_proration][0..n]
    optional, boolean, default=false
    If the unbilled charge falls within the subscription's current term it will be used for proration.
    unbilled_charges[is_advance_charge][0..n]
    optional, boolean, default=false
    The value of this parameter will be true if it is a recurring unbilled charge for a future term.
    +
    discounts
    Parameters for discounts. Multiple discounts can be passed by specifying unique indices.
    pass parameters as discounts[<param name>][<idx:0..n>]
    discounts[unbilled_charge_id][0..n]
    optional, string, max chars=40
    Uniquely identifies an unbilled charge.
    discounts[entity_type][0..n]
    optional, enumerated string
    The type of deduction and the amount to which it is applied.
    Possible values are
    item_level_couponThe deduction is due to a coupon applied to line item. The coupon id is passed as entity_id.document_level_couponThe deduction is due to a coupon applied to the invoice sub_total. The coupon id is passed as entity_id.item_level_discountThe deduction is due to a discount applied to a line item of the invoice. The discount id is available as the entity_id. document_level_discountThe deduction is due to a discount applied to the invoice sub_total. The discount id is available as the entity_id.
    discounts[entity_id][0..n]
    optional, string, max chars=100
    When the deduction is due to a coupon, then this is the id of the coupon. Is required when discounts[entity_type] is item_level_coupon or document_level_coupon.
    discounts[description][0..n]
    optional, string, max chars=250
    Description for this deduction.
    discounts[amount][0..n]
    required, in cents, min=0
    The amount deducted. The format of this value depends on the kind of currency.
    +
    tiers
    Parameters for tiers. Multiple tiers can be passed by specifying unique indices.
    pass parameters as tiers[<param name>][<idx:0..n>]
    tiers[unbilled_charge_id][0..n]
    required, string, max chars=40
    Uniquely identifies an unbilled charge.
    tiers[starting_unit][0..n]
    optional, integer, min=0
    The lower limit of a range of units for the tier
    tiers[ending_unit][0..n]
    optional, integer
    The upper limit of a range of units for the tier
    tiers[quantity_used][0..n]
    optional, integer, min=0
    The number of units purchased in a range.
    tiers[unit_amount][0..n]
    optional, in cents, min=0
    The price of the tier if the charge model is a stairtstep pricing , or the price of each unit in the tier if the charge model is tiered/volume pricing.
    tiers[starting_unit_in_decimal][0..n]
    optional, string, max chars=33
    The decimal representation of the the lowest value of quantity in this tier. This is zero for the lowest tier. For all other tiers, it is the same as ending_unit_in_decimal of the next lower tier. Returned only when the line_items.pricing_model is tiered, volume or stairstep and multi-decimal pricing is enabled.
    tiers[ending_unit_in_decimal][0..n]
    optional, string, max chars=33
    The decimal representation of the highest value of quantity in this tier. This attribute is not applicable for the highest tier. For all other tiers, it must be equal to the starting_unit_in_decimal of the next higher tier. Returned only when the line_items.pricing_model is tiered, volume or stairstep and multi-decimal pricing is enabled.
    tiers[quantity_used_in_decimal][0..n]
    optional, string, max chars=33
    The decimal representation of the quantity purchased from this tier. Returned when the line_item is quantity-based and multi-decimal pricing is enabled.
    tiers[unit_amount_in_decimal][0..n]
    optional, string, max chars=40
    The decimal representation of the per-unit price for the tier when the pricing_model is tiered or volume. When the pricing_model is stairstep, it is the decimal representation of the total price for line_item. The value is in major units of the currency. Returned when the line_item is quantity-based and multi-decimal pricing is enabled.
    always returned
    Resource object representing unbilled_charge

    Imports a subscription into Chargebee.

    This API is not enabled for live sites by default. Please contact support to get this enabled.
    Sample Request
    curl  https://{site}.chargebee.com/api/v2/customers/__test__8at19S2Bx82rKy/import_for_items \
         -u {site_api_key}:\
         -d subscription_items[item_price_id][0]="basic-USD" \
         -d subscription_items[quantity][0]=1 \
         -d status="active" \
         -d charged_items[item_price_id][0]="ssl-charge-USD" \
         -d charged_items[last_charged_at][0]=1516297094 \
         -d current_term_end=1593541800
    copy
    curl  https://{site}.chargebee.com/api/v2/customers/__test__8at19S2Bx82rKy/import_for_items \
         -u {site_api_key}:\
         -d subscription_items[item_price_id][0]="basic-USD" \
         -d subscription_items[quantity][0]=1 \
         -d status="active" \
         -d charged_items[item_price_id][0]="ssl-charge-USD" \
         -d charged_items[last_charged_at][0]=1516297094 \
         -d current_term_end=1593541800

    Sample Response [ JSON ]

    Show more...
    { "customer": { "allow_direct_debit": false, "auto_collection": "off", "card_status": "no_card", "created_at": 1517505319, "deleted": false, "excess_payments": 0, "first_name": "John", "id": "__test__8asukSOXdvWPP6", "last_name": "Doe", "net_term_days": 0, "object": "customer", "pii_cleared": "active", "preferred_currency_code": "USD", "promotional_credits": 0, "refundable_credits": 0, "resource_version": 1517505319325, "taxability": "taxable", "unbilled_charges": 0, "updated_at": 1517505319 }, "subscription": { "activated_at": 1517505319, "billing_period": 1, "billing_period_unit": "month", "charged_items": [ { "item_price_id": "ssl-charge-USD", "last_charged_at": 1516295719, "object": "charged_item" }, {..} ], "created_at": 1517505319, "currency_code": "USD", "current_term_end": 1614018600, "current_term_start": 1517505319, "customer_id": "__test__8asukSOXdvWPP6", "deleted": false, "due_invoices_count": 0, "has_scheduled_changes": false, "id": "__test__8asukSOXdvbfP9", "mrr": 0, "next_billing_at": 1614018600, "object": "subscription", "resource_version": 1517505319739, "started_at": 1517505319, "status": "active", "subscription_items": [ { "amount": 1000, "free_quantity": 0, "item_price_id": "basic-USD", "item_type": "plan", "object": "subscription_item", "quantity": 1, "unit_price": 1000 }, {..} ], "updated_at": 1517505319 } }

    URL Format POST

    https://{site}.chargebee.com/api/v2/customers/{customer_id}/import_for_items
    id
    optional, string, max chars=50
    A unique and immutable identifier for the subscription. If not provided, it is autogenerated.
    trial_end
    optional, timestamp(UTC) in seconds
    End of the trial period for the subscription. This overrides the trial period set for the plan-item. The value must be later than start_date. Set it to 0 to have no trial period.
    billing_cycles
    optional, integer, min=0
    The number of billing cycles the subscription runs before canceling. If not provided, then the billing cycles set for the plan-item price is used.
    net_term_days
    optional, integer
    Defines Net D for the subscription. Net D is the number of days within which any invoice raised for the subscription must be paid.
    • If a value is provided: Net D is set explicitly for the subscription to the value provided. The value must be one among those defined in the site configuration.
    • If not provided: The attribute is not set and therefore not returned by the API. In this case, when an invoice is raised – whether now or later – the net_term_days defined at the customer level is considered.
    .
    start_date
    optional, timestamp(UTC) in seconds
    The date/time at which the subscription is to start or has started. If not provided, the subscription starts immediately.
    auto_collection
    optional, enumerated string
    Defines whether payments need to be collected automatically for this subscription. Overrides customer's auto-collection property.
    Possible values are
    onWhenever an invoice is created for this subscription, an automatic charge will be attempted on the payment method available.offAutomatic collection of charges will not be made for this subscription. Use this for offline payments.
    po_number
    optional, string, max chars=100
    Purchase order number for this subscription.
    coupon_ids[0..n]
    optional, list of string
    List of coupons to be applied to this subscription. You can provide coupon ids or coupon codes.
    payment_source_id
    optional, string, max chars=40
    Id of the payment source to be attached to this subscription.
    status
    required, enumerated string
    Current state of the subscription.
    Possible values are
    futureThe subscription is scheduled to start at a future date.in_trialThe subscription is in trial.activeThe subscription is active and will be charged for automatically based on the items in it.non_renewingThe subscription will be canceled at the end of the current term.pausedThe subscription is paused. The subscription will not renew while in this state.cancelledThe subscription has been canceled and is no longer in service.
    current_term_end
    optional, timestamp(UTC) in seconds
    End of the current billing term. Subscription is renewed immediately after this. If not given, this will be calculated based on plan billing cycle.

    Note:

    For subscription status: non_renewing, active, and paused, current_term_end is required.

    .
    current_term_start
    optional, timestamp(UTC) in seconds
    Start of the current billing period of the subscription. This is required when the subscription status is paused. When the status is active or non_renewing, it defaults to the current time.
    trial_start
    optional, timestamp(UTC) in seconds
    Start of the trial period for the subscription. When not passed, it is assumed to be current time. When passed for a future subscription, it implies that the subscription goes into in_trial when it starts.
    cancelled_at
    optional, timestamp(UTC) in seconds
    Time at which subscription was cancelled or is set to be cancelled.
    started_at
    optional, timestamp(UTC) in seconds
    Time at which the subscription was started. Is null for futuresubscriptions as it is yet to be started.
    activated_at
    optional, timestamp(UTC) in seconds

    The time at which the subscription was activated. A subscription is “activated” when its status changes from any other, to either active or non_renewing.

    The following conditions must be satisfied when passing this parameter:

    • When status is active, non_renewing, or paused, activated_at must be on or after trial_end or started_at. Additionally, activated_at must be on or before current_term_start.
    • When status is in_trial, activated_at must precede trial_start

    Note:

    This parameter should not be provided when passing status as future or cancelled.

    pause_date
    optional, timestamp(UTC) in seconds
    When a pause has been scheduled, it is the date/time of scheduled pause. When the subscription is in the paused state, it is the date/time when the subscription was paused.
    resume_date
    optional, timestamp(UTC) in seconds
    For a paused subscription, it is the date/time when the subscription is scheduled to resume. If the pause is for an indefinite period, this value is not returned.
    contract_term_billing_cycle_on_renewal
    optional, integer, min=1, max=100
    Number of billing cycles the new contract term should run for, on contract renewal. The default value is the same as billing_cycles or a custom value depending on the site configuration.
    create_current_term_invoice
    optional, boolean, default=false
    Set as true if you want an invoice to be created for the subscription.
    • The invoice will be created for the subscription only if it has an active or non_renewing status.
    • The period of the invoice is from current_term_start to current_term_end.
    • The invoice will not be generated if the subscription amount is zero dollars (for that period) and 'Hide Zero Value Line Items' option is enabled in site settings.
    invoice_notes
    optional, string, max chars=2000
    A customer-facing note added to all invoices associated with this subscription. This note is one among all the notes displayed on the invoice PDF.
    meta_data
    optional, jsonobject
    A set of key-value pairs stored as additional information for the subscription. Learn more.
    cancel_reason_code
    optional, string, max chars=100
    Reason code for canceling the subscription. Must be one from a list of reason codes set in the Chargebee app in Settings > Configure Chargebee > Reason Codes > Subscriptions > Subscription Cancellation. Must be passed if set as mandatory in the app. The codes are case-sensitive.
    create_pending_invoices
    optional, boolean

    Indicates whether the invoices for this subscription are generated with a pending status. This attribute is set to true automatically when the subscription has item prices that belong to metered items.

    You can also set this to true explicitly using the create/update subscription operations. This is useful in the following scenarios:

    • When tracking usages and calculating usage-based charges on your end. You can then add them to the subscription as a one-time charge at the end of the billing term.
    • When you need to inspect all charges before closing invoices for this subscription.

    Applicable only when Metered Billing is enabled for the site

    .
    auto_close_invoices
    optional, boolean
    Set to false to override for this subscription, the site-level setting for auto-closing invoices. Only applicable when auto-closing invoices has been enabled for the site. This attribute has a higher precedence than the same attribute at the customer level.
    +
    contract_term
    Parameters for contract_term
    pass parameters as contract_term[<param name>]
    contract_term[id]
    optional, string, max chars=50
    Id that uniquely identifies the contract term in the site.
    contract_term[created_at]
    optional, timestamp(UTC) in seconds
    The date when the contract term was created.
    contract_term[contract_start]
    optional, timestamp(UTC) in seconds
    The start date of the contract term
    contract_term[billing_cycle]
    optional, integer, min=0
    The number of billing cycles of the subscription that the contract term is for.
    contract_term[total_amount_raised]
    optional, in cents, default=0, min=0
    The amount raised for the contract term till the time of importing the subscription. This amount is added to the total_contract_value
    contract_term[total_amount_raised_before_tax]
    optional, in cents, default=0, min=0
    The amount raised for the contract term till the time of importing the subscription excluding tax. This amount is added to the total_contract_value_before_tax
    contract_term[action_at_term_end]
    optional, enumerated string, default=renew
    Action to be taken when the contract term completes.
    Possible values are
    renew
  • Contract term completes and a new contract term is started for the number of billing cycles specified in contract_billing_cycle_on_renewal.
  • The action_at_term_end for the new contract term is set to renew.
  • evergreenContract term completes and the subscription renews.cancelContract term completes and subscription is canceled.renew_onceUsed when you want to renew the contract term just once. Does the following:
  • Contract term completes and a new contract term is started for the number of billing cycles specified in contract_billing_cycle_on_renewal.
  • The action_at_term_end for the new contract term is set to cancel.
  • contract_term[cancellation_cutoff_period]
    optional, integer, default=0
    The number of days before contract_end, during which the customer is barred from canceling the contract term. The customer is allowed to cancel the contract term via the Self-Serve Portal only before this period. This allows you to have sufficient time for processing the contract term closure
    +
    transaction
    Parameters for transaction
    pass parameters as transaction[<param name>]
    transaction[amount]
    optional, in cents, min=1
    The payment transaction amount. This parameter should be passed only if the invoice is created for current term.
    transaction[payment_method]
    optional, enumerated string, default=card
    The payment method of this transaction. This parameter should be passed only if the invoice is created for current term.
    Possible values are
    cashCashcheckCheck
    bank_transferBank TransferotherPayment Methods other than the above typescustomCustom
    Show all values[+]
    transaction[reference_number]
    optional, string, max chars=100
    The reference number for this transaction. For example, check number in case of check payment_method. This parameter should be passed only if the invoice is created for current term.
    transaction[date]
    optional, timestamp(UTC) in seconds
    The date of occurence of the transaction. This parameter should be passed only if the invoice is created for current term.
    +
    shipping_address
    Parameters for shipping_address
    pass parameters as shipping_address[<param name>]
    shipping_address[first_name]
    optional, string, max chars=150
    The first name of the contact.
    shipping_address[last_name]
    optional, string, max chars=150
    The last name of the contact.
    shipping_address[email]
    optional, string, max chars=70
    The email address.
    shipping_address[company]
    optional, string, max chars=250
    The company name.
    shipping_address[phone]
    optional, string, max chars=50
    The phone number.
    shipping_address[line1]
    optional, string, max chars=150
    Address line 1
    shipping_address[line2]
    optional, string, max chars=150
    Address line 2
    shipping_address[line3]
    optional, string, max chars=150
    Address line 3
    shipping_address[city]
    optional, string, max chars=50
    The name of the city.
    shipping_address[state_code]
    optional, string, max chars=50
    The ISO 3166-2 state/province code without the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set state_code as AZ (not US-AZ). For Tamil Nadu (India), set as TN (not IN-TN). For British Columbia (Canada), set as BC (not CA-BC).
    shipping_address[state]
    optional, string, max chars=50
    The state/province name. Is set by Chargebee automatically for US, Canada and India If state_code is provided.
    shipping_address[zip]
    optional, string, max chars=20
    Zip or postal code. The number of characters is validated according to the rules specified here.
    shipping_address[country]
    optional, string, max chars=50
    The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code.

    Note: If you enter an invalid country code, the system will return an error.

    Brexit

    If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom – Northern Ireland) is available as an option.

    shipping_address[validation_status]
    optional, enumerated string, default=not_validated
    The address verification status.
    Possible values are
    not_validatedAddress is not yet validated.validAddress was validated successfully.partially_validThe address is valid for taxability but has not been validated for shipping.invalidAddress is invalid.
    +
    subscription_items
    Parameters for subscription_items. Multiple subscription_items can be passed by specifying unique indices.
    pass parameters as subscription_items[<param name>][<idx:0..n>]
    subscription_items[item_price_id][0..n]
    required, string, max chars=100
    The unique identifier of the item price.
    subscription_items[quantity][0..n]
    optional, integer, min=1
    The quantity of the item purchased
    subscription_items[quantity_in_decimal][0..n]
    optional, string, max chars=33
    The decimal representation of the quantity of the item purchased. Can be provided for quantity-based item prices and only when multi-decimal pricing is enabled.
    subscription_items[unit_price][0..n]
    optional, in cents, min=0
    The price/per unit price of the item. When not provided, the value set for the item price is used. This is only applicable when the pricing_model of the item price is flat_fee or per_unit. Also, it is only allowed when price overriding is enabled for the site. The value depends on the type of currency. If changes_scheduled_at is in the past and a unit_price is not passed, then the item price’s current unit price is considered even if the item price did not exist on the date as of when the change is scheduled.
    subscription_items[unit_price_in_decimal][0..n]
    optional, string, max chars=39
    When price overriding is enabled for the site, the price or per-unit price of the item can be set here. The value set for the item price is used by default. Provide the value as a decimal string in major units of the currency. Can be provided only when multi-decimal pricing is enabled.
    subscription_items[billing_cycles][0..n]
    optional, integer, min=0
    For the plan-item price:
    the value determines the number of billing cycles the subscription runs before canceling automatically. If not provided, then the value set for the plan-item price is used.

    For addon-item prices:
    If addon billing cycles are enabled then this is the number of subscription billing cycles for which the addon is included. If not provided, then the value set under attached addons is used. Further, if that value is not provided, then the value set for the addon-item price is used.
    subscription_items[trial_end][0..n]
    optional, timestamp(UTC) in seconds
    The date/time when the trial period of the item ends. Applies to plan-items and—-when enabled-—addon-items as well.
    subscription_items[service_period_days][0..n]
    optional, integer, min=1, max=730
    The service period of the item in days from the day of charge.
    subscription_items[charge_on_event][0..n]
    optional, enumerated string
    When charge_on_option option is set to on_event, this parameter specifies the event at which the charge-item is applied to the subscription. This parameter only applies to charge-items.
    Possible values are
    subscription_creationthe time of creation of the subscription.subscription_trial_startthe time when the trial period of the subscription begins.plan_activationsame as subscription activation, but also includes the case when the plan-item of the subscription is changed.subscription_activationthe moment a subscription enters an active or non-renewing state. Also includes reactivations of canceled subscriptions.contract_terminationwhen a contract term is terminated.
    subscription_items[charge_once][0..n]
    optional, boolean
    Indicates if the charge-item is to be charged only once or each time the charge_on_event occurs. This parameter only applies to charge-items.
    +
    discounts
    Parameters for discounts. Multiple discounts can be passed by specifying unique indices.
    pass parameters as discounts[<param name>][<idx:0..n>]
    discounts[apply_on][0..n]
    required, enumerated string
    The amount on the invoice to which the discount is applied.
    Possible values are
    invoice_amountThe discount is applied to the invoice sub_total.specific_item_priceThe discount is applied to the invoice.line_item.amount that corresponds to the item price specified by item_price_id.
    discounts[duration_type][0..n]
    required, enumerated string, default=forever
    Specifies the time duration for which this discount is attached to the subscription.
    Possible values are
    one_timeThe discount stays attached to the subscription till it is applied on an invoice once. It is removed after that from the subscription.foreverThe discount is attached to the subscription and applied on the invoices till it is explicitly removed.limited_periodThe discount is attached to the subscription and applied on the invoices for a limited duration. This duration starts from the point it is applied to an invoice for the first time and expires after a period specified by period and period_unit.
    discounts[percentage][0..n]
    optional, double, min=0.01, max=100.0
    The percentage of the original amount that should be deducted from it. Only applicable when discount.type is percentage.
    discounts[amount][0..n]
    optional, in cents, min=0
    The value of the discount. The format of this value depends on the kind of currency. This is only applicable when discount.type is fixed_amount.
    discounts[period][0..n]
    optional, integer, min=1
    The duration of time for which the discount is attached to the subscription, in period_units. Applicable only when duration_type is limited_period.
    discounts[period_unit][0..n]
    optional, enumerated string
    The unit of time for period. Applicable only when duration_type is limited_period.
    Possible values are
    dayA period of 24 hours.weekA period of 7 days.monthA period of 1 calendar month.yearA period of 1 calendar year.
    discounts[included_in_mrr][0..n]
    optional, boolean
    The discount is included in MRR calculations for your site. This attribute is only applicable when duration_type is one_time and when the feature is enabled in Chargebee. Also, If the site-level setting is to exclude one-time discounts from MRR calculations, this value is always returned false.
    discounts[item_price_id][0..n]
    optional, string, max chars=100
    The id of the item price in the subscription to which the discount is to be applied. Relevant only when apply_on = specific_item_price.
    +
    charged_items
    Parameters for charged_items. Multiple charged_items can be passed by specifying unique indices.
    pass parameters as charged_items[<param name>][<idx:0..n>]
    charged_items[item_price_id][0..n]
    optional, string, max chars=100
    A unique ID for your system to identify the item price.
    charged_items[last_charged_at][0..n]
    optional, timestamp(UTC) in seconds
    Timestamp indicating when this charge item_price was last charged for this subscription.
    +
    item_tiers
    Parameters for item_tiers. Multiple item_tiers can be passed by specifying unique indices.
    pass parameters as item_tiers[<param name>][<idx:0..n>]
    item_tiers[item_price_id][0..n]
    optional, string, max chars=100
    The id of the item price for which the tier price is being overridden.
    item_tiers[starting_unit][0..n]
    optional, integer, min=1
    The lowest value in the quantity tier.
    item_tiers[ending_unit][0..n]
    optional, integer
    The highest value in the quantity tier.
    item_tiers[price][0..n]
    optional, in cents, default=0, min=0
    The overridden price of the tier. The value depends on the type of currency.
    item_tiers[starting_unit_in_decimal][0..n]
    optional, string, max chars=33
    The decimal representation of the the lowest value of quantity in this tier. This is zero for the lowest tier. For all other tiers, it is the same as ending_unit_in_decimal of the next lower tier. Returned only when the pricing_model is tiered, volume or stairstep and multi-decimal pricing is enabled.
    item_tiers[ending_unit_in_decimal][0..n]
    optional, string, max chars=33
    The decimal representation of the highest value of quantity in this tier. This attribute is not applicable for the highest tier. For all other tiers, it must be equal to the starting_unit_in_decimal of the next higher tier. Returned only when the pricing_model is tiered, volume or stairstep and multi-decimal pricing is enabled.
    item_tiers[price_in_decimal][0..n]
    optional, string, max chars=39
    The decimal representation of the per-unit price for the tier when the pricing_model is tiered or volume. When the pricing_model is stairstep, it is the decimal representation of the total price for the item. The value is in major units of the currency. Returned when the plan is quantity-based and multi-decimal pricing is enabled.
    always returned
    Resource object representing subscription
    always returned
    Resource object representing customer
    optional
    Resource object representing card
    optional
    Resource object representing invoice

    Assigns the payment source and sets auto collection state for the subscription.

    Notes

    When you don't pass any input param for this API, payment source and auto collection for the subscription will be the same as the customer's default settings.

    Sample Request
    curl  https://{site}.chargebee.com/api/v2/subscriptions/__test__8asukSOXdw1vPR/override_billing_profile \
         -X POST  \
         -u {site_api_key}:\
         -d payment_source_id="pm___test__8asukSOXdwAuPa" \
         -d auto_collection="on"
    copy
    curl  https://{site}.chargebee.com/api/v2/subscriptions/__test__8asukSOXdw1vPR/override_billing_profile \
         -X POST  \
         -u {site_api_key}:\
         -d payment_source_id="pm___test__8asukSOXdwAuPa" \
         -d auto_collection="on"

    Sample Response [ JSON ]

    Show more...
    { "payment_source": { "card": { "brand": "american_express", "expiry_month": 12, "expiry_year": 2022, "funding_type": "not_known", "iin": "378282", "last4": "0005", "masked_number": "***********0005", "object": "card" }, "created_at": 1612890921, "customer_id": "__test__8asukSOXdvwzPO", "deleted": false, "gateway": "chargebee", "gateway_account_id": "gw___test__8astDSOXdqwz1y", "id": "pm___test__8asukSOXdwAuPa", "object": "payment_source", "reference_id": "tok___test__8asukSOXdwAqPZ", "resource_version": 1612890921000, "status": "valid", "type": "card", "updated_at": 1612890921 }, "subscription": { "activated_at": 1612890921, "auto_collection": "on", "billing_period": 1, "billing_period_unit": "month", "created_at": 1612890921, "currency_code": "USD", "current_term_end": 1615310121, "current_term_start": 1612890921, "customer_id": "__test__8asukSOXdvwzPO", "deleted": false, "due_invoices_count": 0, "has_scheduled_changes": false, "id": "__test__8asukSOXdw1vPR", "mrr": 0, "next_billing_at": 1615310121, "object": "subscription", "payment_source_id": "pm___test__8asukSOXdwAuPa", "remaining_billing_cycles": 1, "resource_version": 1612890921000, "started_at": 1612890921, "status": "active", "subscription_items": [ { "amount": 1000, "billing_cycles": 1, "free_quantity": 0, "item_price_id": "basic-USD", "item_type": "plan", "object": "subscription_item", "quantity": 1, "unit_price": 1000 }, {..} ], "updated_at": 1612890921 } }

    URL Format POST

    https://{site}.chargebee.com/api/v2/subscriptions/{subscription_id}/override_billing_profile
    payment_source_id
    optional, string, max chars=40
    Unique identifier of the payment source to be attached to this subscription.
    auto_collection
    optional, enumerated string
    Defines whether payments need to be collected automatically for this subscription. Overrides customer's auto-collection property.
    Possible values are
    onWhenever an invoice is created for this subscription, an automatic charge will be attempted on the payment method available.offAutomatic collection of charges will not be made for this subscription. Use this for offline payments.
    always returned
    Resource object representing subscription
    optional
    Resource object representing payment_source

    Deletes the subscription resource.

    Notes

    This operation is irreversible - all data related to the subscription, such as invoices, transactions, and reports, will be deleted.

    Note: This operation schedules the subscription resource for deletion. It will be deleted in a few minutes.

    Sample Request
    curl  https://{site}.chargebee.com/api/v2/subscriptions/__test__8asukSOXdv6kOj/delete \
         -X POST  \
         -u {site_api_key}:
    copy
    curl  https://{site}.chargebee.com/api/v2/subscriptions/__test__8asukSOXdv6kOj/delete \
         -X POST  \
         -u {site_api_key}:

    Sample Response [ JSON ]

    Show more...
    { "customer": { "allow_direct_debit": false, "auto_collection": "off", "card_status": "no_card", "created_at": 1612890917, "deleted": false, "excess_payments": 0, "first_name": "John", "id": "__test__8asukSOXdv0dOg", "last_name": "Doe", "net_term_days": 0, "object": "customer", "pii_cleared": "active", "preferred_currency_code": "USD", "promotional_credits": 0, "refundable_credits": 0, "resource_version": 1612890917000, "taxability": "taxable", "unbilled_charges": 0, "updated_at": 1612890917 }, "subscription": { "activated_at": 1612890917, "billing_period": 1, "billing_period_unit": "month", "created_at": 1612890917, "currency_code": "USD", "current_term_end": 1615310117, "current_term_start": 1612890917, "customer_id": "__test__8asukSOXdv0dOg", "deleted": false, "due_invoices_count": 1, "due_since": 1612890917, "has_scheduled_changes": false, "id": "__test__8asukSOXdv6kOj", "mrr": 0, "next_billing_at": 1615310117, "object": "subscription", "remaining_billing_cycles": 1, "resource_version": 1612890918000, "started_at": 1612890917, "status": "active", "subscription_items": [ { "amount": 1000, "billing_cycles": 1, "free_quantity": 0, "item_price_id": "basic-USD", "item_type": "plan", "object": "subscription_item", "quantity": 1, "unit_price": 1000 }, {..} ], "total_dues": 1100, "updated_at": 1612890918 } }

    URL Format POST

    https://{site}.chargebee.com/api/v2/subscriptions/{subscription_id}/delete
    always returned
    Resource object representing subscription
    always returned
    Resource object representing customer
    optional
    Resource object representing card

    Pauses the subscription, changing its status to paused. This prevents the subscription from getting renewed. No new charges are created until the subscription is resumed.

    Note:

    • Applicable only for active/non-renewing subscriptions.
    • If paused indefinitely, the subscription is cancelled on the cancelled_at date.
    • Advance charges, if any, are refunded as credits.
    Sample Request
    # pauses the subscription on end of term.
    curl  https://{site}.chargebee.com/api/v2/subscriptions/__test__8asukSOXdwKMPo/pause \
         -X POST  \
         -u {site_api_key}:\
         -d pause_option="end_of_term"
    copy
    # pauses the subscription on end of term.
    curl  https://{site}.chargebee.com/api/v2/subscriptions/__test__8asukSOXdwKMPo/pause \
         -X POST  \
         -u {site_api_key}:\
         -d pause_option="end_of_term"

    Sample Response [ JSON ]

    Show more...
    { "customer": { "allow_direct_debit": false, "auto_collection": "off", "card_status": "no_card", "created_at": 1612890922, "deleted": false, "excess_payments": 0, "first_name": "John", "id": "__test__8asukSOXdwFjPl", "last_name": "Doe", "net_term_days": 0, "object": "customer", "pii_cleared": "active", "preferred_currency_code": "USD", "promotional_credits": 0, "refundable_credits": 0, "resource_version": 1612890922000, "taxability": "taxable", "unbilled_charges": 0, "updated_at": 1612890922 }, "subscription": { "activated_at": 1612890922, "billing_period": 1, "billing_period_unit": "month", "created_at": 1612890922, "currency_code": "USD", "current_term_end": 1615310122, "current_term_start": 1612890922, "customer_id": "__test__8asukSOXdwFjPl", "deleted": false, "due_invoices_count": 1, "due_since": 1612890922, "has_scheduled_changes": false, "id": "__test__8asukSOXdwKMPo", "mrr": 0, "object": "subscription", "pause_date": 1615310122, "remaining_billing_cycles": 1, "resource_version": 1612890923000, "started_at": 1612890922, "status": "active", "subscription_items": [ { "amount": 1000, "billing_cycles": 1, "free_quantity": 0, "item_price_id": "basic-USD", "item_type": "plan", "object": "subscription_item", "quantity": 1, "unit_price": 1000 }, {..} ], "total_dues": 1100, "updated_at": 1612890923 } }

    URL Format POST

    https://{site}.chargebee.com/api/v2/subscriptions/{subscription_id}/pause
    pause_option
    optional, enumerated string
    List of options to pause the subscription.
    Possible values are
    immediatelyPause immediatelyend_of_termPause at the end of current termspecific_datePause on a specific datebilling_cycles

    Pause at the end of the current term, and resume automatically after the set number of billing cycles (in skip_billing_cycles) have been skipped

    pause_date
    optional, timestamp(UTC) in seconds

    Date on which the subscription will be paused. Applicable when specific_date option is chosen in the pause_option field.

    For non-renewing subscriptions, pause_date should be before the cancellation date.

    unbilled_charges_handling
    optional, enumerated string

    Applicable when unbilled charges are present for the subscription and pause_option is set as immediately. Note: On the invoice raised, an automatic charge is attempted on the payment method available, if customer's auto-collection property is set to on.

    Possible values are
    no_action

    Retain as unbilled

    If no_action is chosen, charges are added to the resumption invoice.

    invoice

    Invoice charges

    If invoice is chosen, an automatic charge is attempted on the payment method available if the customer has enabled auto-collection. If a payment collection fails or when auto-collection is not enabled, the invoice is closed as unpaid.

    invoice_dunning_handling
    optional, enumerated string

    Handles dunning for invoices already in the dunning cycle when a subscription is paused. Applicable when pause_option is set as immediately.

    If invoice is in the dunning cycle, invoice_dunning_handing allows you to stop or continue dunning.

    Possible values are
    continueContinue dunningstopStop dunning
    skip_billing_cycles
    optional, integer, min=1
    The number of subscription billing cycles that will be skipped. The subscription resumes after the set number of billing cycles have been skipped. This is applicable only when the value of of pause_option is billing_cycles.
    resume_date
    optional, timestamp(UTC) in seconds

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

    For non-renewing subscriptions,resume_date should be before the cancellation date.

    always returned
    Resource object representing subscription
    always returned
    Resource object representing customer
    optional
    Resource object representing card
    optional
    Resource object representing invoice
    optional
    Resource object representing unbilled_charge
    optional
    Resource object representing credit_note

    Cancels the subscription.

    Canceling contract terms

    • Subscriptions with contract terms can only be canceled by  terminating the contract term.
    • When canceling a contract term, the default value for the following parameters is taken from the site settings for contract terms instead of the site settings for subscription cancellation.
      • credit_option_for_current_term_charges
      • unbilled_charges_option
      • account_receivables_handling
      • refundable_credits_handling
    • From among the parameters for this request, end_of_term or cancel_at should not be passed when using contract terms; use contract_term_cancel_option instead.
    • The subscription_items parameter is used to override price or quantity for the termination fee. To use this parameter, the following two conditions must be met:
      • contract_term_cancel_option must be set to terminate_now.
      • the subscription must have a subscription_items attribute with charge_on_event set to contract_term_termination.
    Sample Request
    # cancels the subscription after the term ends.
    curl  https://{site}.chargebee.com/api/v2/subscriptions/__test__KyVnZKS5y28bL9/cancel_for_items \
         -X POST  \
         -u {site_api_key}:\
         -d end_of_term="true"
    copy

    Sample Response [ JSON ]

    URL Format POST

    https://{site}.chargebee.com/api/v2/subscriptions/{subscription_id}/cancel_for_items
    end_of_term
    optional, boolean, default=false
    Set this to true if you want to cancel the subscription at the end of the current subscription billing cycle. The subscription status changes to non_renewing.
    cancel_at
    optional, timestamp(UTC) in seconds
    Specify the date/time at which you want to cancel the subscription. This parameter should not be provided when end_of_term is passed as true. cancel_at can be set to a value in the past. This is called backdating. Use backdating when the subscription has been canceled already but its billing has been delayed. The following prerequisites must be met to allow backdating:
    • Backdating must be enabled for subscription cancellation.
    • The current day of the month does not exceed the limit set in Chargebee for backdating subscription cancellation. This limit is typically the day of the month by which the accounting for the previous month must be closed.
    • The date is on or after current_term_start.
    • The date is on or after the last date/time any of the following changes were made:
      • Changes in the recurring items or their prices.
      • Addition of non-recurring items.
    • The date is not more than duration X into the past where X is the billing period of the plan. For example, if the period of the subscription’s plan is 2 months and today is 14th April, changes_scheduled_at cannot be earlier than 14th February.
    .
    credit_option_for_current_term_charges
    optional, enumerated string
    For immediate cancellation (end_of_term = false), specify how to provide credits for current term charges. When not provided, the site default is considered.
    Possible values are
    noneNo credits notes are created.prorateProrated credits are issued.fullCredits are issues for the full value of the current term charges.
    unbilled_charges_option
    optional, enumerated string
    For immediate cancellation (end_of_term = false), specify how to handle any unbilled charges. When not provided, the site default is considered.
    Possible values are
    invoiceAn invoice is generated immediately with the unbilled charges.deleteThe unbilled charges are deleted.
    account_receivables_handling
    optional, enumerated string
    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.
    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
    optional, enumerated string
    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.
    Possible values are
    no_actionNo action is taken. schedule_refundInitiates refund of the remaining credits.
    contract_term_cancel_option
    optional, enumerated string
    Cancels the current contract term.
    • terminate_immediately immediately does the following:
    • end_of_contract_term Sets the contract_term[action_at_term_end] to cancel. In other words, the contract term is not renewed and the subscription is canceled at the end of the contract term.
    .
    Possible values are
    terminate_immediatelyTerminate immediatelyend_of_contract_termEnd of contract term
    invoice_date
    optional, timestamp(UTC) in seconds
    The document date displayed on the invoice PDF. The default value is the current date. Provide this value to backdate the invoice. Backdating an invoice is done for reasons such as booking revenue for a previous date or when the subscription is effective as of a past date. Moreover, if create_pending_invoices is true, and if the site is configured to set invoice dates to date of closing, then upon invoice closure, this date is changed to the invoice closing date. taxes and line_item_taxes are computed based on the tax configuration as of invoice_date. When passing this parameter, the following prerequisites must be met:
    • invoice_date must be in the past.
    • invoice_date is not more than one calendar month into the past. For example, if today is 13th January, then you cannot pass a value that is earlier than 13th December.
    • It is not earlier than cancel_at.
    .
    cancel_reason_code
    optional, string, max chars=100
    Reason code for canceling the subscription. Must be one from a list of reason codes set in the Chargebee app in Settings > Configure Chargebee > Reason Codes > Subscriptions > Subscription Cancellation. Must be passed if set as mandatory in the app. The codes are case-sensitive.
    +
    subscription_items
    Parameters for subscription_items. Multiple subscription_items can be passed by specifying unique indices.
    pass parameters as subscription_items[<param name>][<idx:0..n>]
    subscription_items[item_price_id][0..n]
    optional, string, max chars=100
    The unique id of the charge item_price that represents the termination fee.
    subscription_items[quantity][0..n]
    optional, integer, min=1
    The quantity associated with the termination fee. Applicable only when the item_price for the termination charge is quantity-based.
    subscription_items[quantity_in_decimal][0..n]
    optional, string, max chars=33
    The decimal representation of the quantity of the item purchased. Can be provided for quantity-based item prices and only when multi-decimal pricing is enabled.
    subscription_items[unit_price][0..n]
    optional, in cents, min=0
    The termination fee. In case it is quantity-based, this is the fee per unit.
    subscription_items[unit_price_in_decimal][0..n]
    optional, string, max chars=39
    When price overriding is enabled for the site, the price or per-unit price of the item can be set here. The value set for the item price is used by default. Provide the value as a decimal string in major units of the currency. Can be provided only when multi-decimal pricing is enabled.
    subscription_items[service_period_days][0..n]
    optional, integer, min=1, max=730
    The service period of the termination fee—expressed in days—starting from the current date.
    always returned
    Resource object representing subscription
    always returned
    Resource object representing customer
    optional
    Resource object representing card
    optional
    Resource object representing invoice
    optional
    Resource object representing unbilled_charge
    optional
    Resource object representing credit_note
    Note: This operation optionally supports 3DS verification flow. To achieve the same, create the Payment Intent and pass it as input parameter to this API.

    This API is used to resume a paused subscription. On resumption the subscription will be activated and any applicable charges will be initiated.

    You could schedule the resumption by passing specific_date parameter in resume_option. If scheduled, the subscription will be resumed on the specific_date and moved to Active state.

    For in-term resumption, unless there are scheduled changes, unbilled charges will not be charged.

    What is an "in-term resumption"?
    An “in-term resumption” is when the pause and resumption happens within the billing term of the subscription.

    Example : A subscription was billed from 1st to 31st of a month. It was paused on the 20th and resumed before 31st. This is an in-term resumption.

    UNPAID INVOICES

    Specifying unpaid_invoices allows you to close invoices of the subscription which have amounts due. The invoices are chosen for payment collection after applying the available credits and excess payments.

    If specified as schedule_payment_collection, payment collection for the amount due of past invoices will be attempted. The payment method available will be charged if auto-collection is enabled for the customer, and appropriate payment collection(payment succeeded or payment failed) events will be triggered. If the payment collection fails, no further retries will be made on the invoices.

    Note: If the invoices of the subscription are consolidated, and any of the subscriptions in the consolidated invoice are cancelled, these invoices will not be selected for collection.

    Sample Request
    # resumes a subscription immediately by scheduling payment collection for unpaid
    # invoices.
    curl  https://{site}.chargebee.com/api/v2/subscriptions/__test__8asukSOXdznTS0/resume \
         -X POST  \
         -u {site_api_key}:\
         -d resume_option="immediately" \
         -d unpaid_invoices_handling="schedule_payment_collection"
    copy
    # resumes a subscription immediately by scheduling payment collection for unpaid
    # invoices.
    curl  https://{site}.chargebee.com/api/v2/subscriptions/__test__8asukSOXdznTS0/resume \
         -X POST  \
         -u {site_api_key}:\
         -d resume_option="immediately" \
         -d unpaid_invoices_handling="schedule_payment_collection"

    Sample Response [ JSON ]

    Show more...
    { "customer": { "allow_direct_debit": false, "auto_collection": "off", "card_status": "no_card", "created_at": 1612890935, "deleted": false, "excess_payments": 0, "first_name": "John", "id": "__test__8asukSOXdziiRx", "last_name": "Doe", "net_term_days": 0, "object": "customer", "pii_cleared": "active", "preferred_currency_code": "USD", "promotional_credits": 0, "refundable_credits": 0, "resource_version": 1612890935000, "taxability": "taxable", "unbilled_charges": 0, "updated_at": 1612890935 }, "subscription": { "activated_at": 1612890935, "billing_period": 1, "billing_period_unit": "month", "created_at": 1612890935, "currency_code": "USD", "current_term_end": 1615310135, "current_term_start": 1612890935, "customer_id": "__test__8asukSOXdziiRx", "deleted": false, "due_invoices_count": 1, "due_since": 1612890935, "has_scheduled_changes": false, "id": "__test__8asukSOXdznTS0", "mrr": 0, "next_billing_at": 1615310135, "object": "subscription", "remaining_billing_cycles": 1, "resource_version": 1612890936000, "started_at": 1612890935, "status": "active", "subscription_items": [ { "amount": 1000, "billing_cycles": 1, "free_quantity": 0, "item_price_id": "basic-USD", "item_type": "plan", "object": "subscription_item", "quantity": 1, "unit_price": 1000 }, {..} ], "total_dues": 1100, "updated_at": 1612890936 } }

    URL Format POST

    https://{site}.chargebee.com/api/v2/subscriptions/{subscription_id}/resume
    resume_option
    optional, enumerated string
    List of options to resume the subscription.
    Possible values are
    immediatelyResume immediatelyspecific_dateResume on a specific date
    resume_date
    optional, timestamp(UTC) in seconds
    Date on which the subscription will be resumed. Applicable when resume_option is set as 'specific_date'.
    charges_handling
    optional, enumerated string
    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.
    Possible values are
    invoice_immediatelyInvoice immediatelyadd_to_unbilled_chargesAdd to unbilled charges
    unpaid_invoices_handling
    optional, enumerated string
    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.
    Possible values are
    no_actionRetain as unpaidschedule_payment_collectionCollect payment
    payment_initiator
    optional, enumerated string
    The type of initiator to be used for the payment request triggered by this operation.
    Possible values are
    customerPass this value to indicate that the request is initiated by the customermerchantPass this value to indicate that the request is initiated by the merchant
    +
    payment_intent
    Parameters for payment_intent
    pass parameters as payment_intent[<param name>]
    payment_intent[id]
    optional, string, max chars=150
    Identifier for PaymentIntent generated by Chargebee.js. Applicable only when you are using Chargebee.js for completing the 3DS flow. The PaymentIntent should be in 'authorized' state while passing it here. You need not pass other PaymentIntent parameters if this is passed.
    payment_intent[gateway_account_id]
    required if payment intent token provided, string, max chars=50
    The gateway account used for performing the 3DS flow.
    payment_intent[gw_token]
    optional, string, max chars=65k
    Identifier for 3DS transaction/verification object at the gateway. Can be passed only after successfully completing the 3DS flow. Refer 3DS implementation in Chargebee to find out the gateway-specific gw_token format. Applicable when you are using gateway APIs directly for completing the 3DS flow.
    payment_intent[payment_method_type]
    optional, enumerated string
    The list of payment method types (For example, card, ideal, sofort, bancontact, etc.) this Payment Intent is allowed to use. If payment method type is empty, Card is taken as the default type for all gateways except Razorpay.
    Possible values are
    cardcardidealidealsofortsofortbancontactbancontact
    google_paygoogle_paydotpaydotpaygiropaygiropayapple_payapple_payupiupinetbanking_emandatesnetbanking_emandatespaypal_express_checkoutpaypal_express_checkoutdirect_debitdirect_debitboletoboletovenmoamazon_paymentsamazon_paymentspay_tofaster_paymentssepa_instant_transfer
    Show all values[+]
    payment_intent[reference_id]
    optional, string, max chars=65k
    Identifier for Braintree permanent token. Applicable when you are using Braintree APIs for completing the 3DS flow.
    payment_intent[additional_information]
    optional, jsonobject
    • checkout_com: While adding a new payment method using permanent token or passing raw card details to Checkout.com, document ID and country_of_residence are required to support payments through dLocal.
      • payer: User related information.
        • country_of_residence: This is required since the billing country associated with the user’s payment method may not be the same as their country of residence. Hence the user’s country of residence needs to be specified. The country code should be a two-character ISO code.
        • document: Document ID is the user’s identification number based on their country.
    • bluesnap: While passing raw card details to BlueSnap, if fraud_session_id is added, additional validation is performed to avoid fraudulent transactions.
      • fraud: Fraud identification related information.
    • braintree: While passing raw card details to Braintree, your fraud_merchant_id and the user’s device_session_id can be added to perform additional validation and avoid fraudulent transactions.
      • fraud: Fraud identification related information.
        • device_session_id: Session ID associated with the user's device.
        • fraud_merchant_id: Your merchant ID for fraud detection.
    • chargebee_payments: While passing raw card details to Chargebee Payments, if fraud_session_id is added, additional validation is performed to avoid fraudulent transactions.
      • fraud: Fraud identification related information.
        • fraud_session_id: Your Chargebee Payments fraud session ID required to perform anti-fraud validation.
    always returned
    Resource object representing subscription
    always returned
    Resource object representing customer
    optional
    Resource object representing card
    optional
    Resource object representing invoice
    optional
    Resource object representing unbilled_charge

    If the subscription is in Active or Non Renewing state and is also scheduled to pause at the end_of_term/specific_date, this API can be used to remove the scheduled pause.

    Sample Request
    curl  https://{site}.chargebee.com/api/v2/subscriptions/__test__8asukSOXdz1ERW/remove_scheduled_pause \
         -X POST  \
         -u {site_api_key}:
    copy
    curl  https://{site}.chargebee.com/api/v2/subscriptions/__test__8asukSOXdz1ERW/remove_scheduled_pause \
         -X POST  \
         -u {site_api_key}:

    Sample Response [ JSON ]

    Show more...
    { "customer": { "allow_direct_debit": false, "auto_collection": "off", "card_status": "no_card", "created_at": 1612890932, "deleted": false, "excess_payments": 0, "first_name": "John", "id": "__test__8asukSOXdywZRT", "last_name": "Doe", "net_term_days": 0, "object": "customer", "pii_cleared": "active", "preferred_currency_code": "USD", "promotional_credits": 0, "refundable_credits": 0, "resource_version": 1612890932000, "taxability": "taxable", "unbilled_charges": 0, "updated_at": 1612890932 }, "subscription": { "activated_at": 1612890932, "billing_period": 1, "billing_period_unit": "month", "created_at": 1612890932, "currency_code": "USD", "current_term_end": 1615310132, "current_term_start": 1612890932, "customer_id": "__test__8asukSOXdywZRT", "deleted": false, "due_invoices_count": 1, "due_since": 1612890932, "has_scheduled_changes": false, "id": "__test__8asukSOXdz1ERW", "mrr": 0, "next_billing_at": 1615310132, "object": "subscription", "remaining_billing_cycles": 1, "resource_version": 1612890933000, "started_at": 1612890932, "status": "active", "subscription_items": [ { "amount": 1000, "billing_cycles": 1, "free_quantity": 0, "item_price_id": "basic-USD", "item_type": "plan", "object": "subscription_item", "quantity": 1, "unit_price": 1000 }, {..} ], "total_dues": 1100, "updated_at": 1612890933 } }

    URL Format POST

    https://{site}.chargebee.com/api/v2/subscriptions/{subscription_id}/remove_scheduled_pause
    always returned
    Resource object representing subscription
    always returned
    Resource object representing customer
    optional
    Resource object representing card

    If the subscription is in Paused state and is scheduled to resume on a specific_date, this API can be used to remove the scheduled resumption. When the scheduled resumption is removed, the subscription will remain Paused.

    Sample Request
    curl  https://{site}.chargebee.com/api/v2/subscriptions/__test__8asukSOXdzOFRl/remove_scheduled_resumption \
         -X POST  \
         -u {site_api_key}:
    copy
    curl  https://{site}.chargebee.com/api/v2/subscriptions/__test__8asukSOXdzOFRl/remove_scheduled_resumption \
         -X POST  \
         -u {site_api_key}:

    Sample Response [ JSON ]

    Show more...
    { "customer": { "allow_direct_debit": false, "auto_collection": "off", "card_status": "no_card", "created_at": 1612890933, "deleted": false, "excess_payments": 0, "first_name": "John", "id": "__test__8asukSOXdzJFRi", "last_name": "Doe", "net_term_days": 0, "object": "customer", "pii_cleared": "active", "preferred_currency_code": "USD", "promotional_credits": 0, "refundable_credits": 0, "resource_version": 1612890933000, "taxability": "taxable", "unbilled_charges": 0, "updated_at": 1612890933 }, "subscription": { "activated_at": 1612890934, "billing_period": 1, "billing_period_unit": "month", "created_at": 1612890934, "currency_code": "USD", "current_term_end": 1615310134, "current_term_start": 1612890934, "customer_id": "__test__8asukSOXdzJFRi", "deleted": false, "due_invoices_count": 1, "due_since": 1612890934, "has_scheduled_changes": false, "id": "__test__8asukSOXdzOFRl", "mrr": 0, "object": "subscription", "pause_date": 1612890934, "remaining_billing_cycles": 1, "resource_version": 1612890935000, "started_at": 1612890934, "status": "paused", "subscription_items": [ { "amount": 1000, "billing_cycles": 1, "free_quantity": 0, "item_price_id": "basic-USD", "item_type": "plan", "object": "subscription_item", "quantity": 1, "unit_price": 1000 }, {..} ], "total_dues": 1100, "updated_at": 1612890935 } }

    URL Format POST

    https://{site}.chargebee.com/api/v2/subscriptions/{subscription_id}/remove_scheduled_resumption
    always returned
    Resource object representing subscription
    always returned
    Resource object representing customer
    optional
    Resource object representing card