Imports a subscription into Chargebee.
Sample Request
URL Format
Input Parameters
Id for the new subscription. If not given, this will be auto-generated.
Indicates the Client profile id for the customer. This is applicable only if you use Chargebee's AvaTax for Communications integration.
The decimal representation of the quantity of the plan purchased. Can be provided for quantity-based plans and only when multi-decimal pricing is enabled.
Amount that will override the Plan's default price. The unit depends on the type of currency .
When price overriding is enabled for the site, the price or per-unit price of the plan can be set here. The value set for the plan is used by default. Provide the value as a decimal string in major units of the currency. Can be provided only when multi-decimal pricing is enabled.
Amount that will override the default setup fee. The unit depends on the type of currency .
The time at which the trial ends for this subscription. Can be specified to override the default trial period.If '0' is passed, the subscription will be activated immediately.
Number of cycles(plan interval) this subscription should be charged. After the billing cycles exhausted, the subscription will be cancelled.
The date/time at which the subscription is to start or has started. If not provided, the subscription starts immediately.
Defines whether payments need to be collected automatically for this subscription. Overrides customer's auto-collection property.
Whenever an invoice is created for this subscription, an automatic charge will be attempted on the payment method available.
Automatic collection of charges will not be made for this subscription. Use this for offline payments.
List of coupons to be applied to this subscription. You can provide coupon ids or coupon codes.
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
.
Current state of the subscription.
The subscription is scheduled to start at a future date.
The subscription is in trial.
The subscription is active and will be charged for automatically based on the items in it.
The subscription will be canceled at the end of the current term.
The subscription is paused. The subscription will not renew while in this state.
The subscription has been canceled and is no longer in service.
The subscription has been transferred to another business entity within the organization.
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.
.
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.
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.
Time at which subscription was cancelled or is set to be cancelled.
Time at which the subscription was started. Is null
for future
subscriptions as it is yet to be started.
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
statusisactive,non_renewing, orpaused,activated_atmust be on or aftertrial_endorstarted_at. Additionally,activated_atmust be on or beforecurrent_term_start. - When
statusisin_trial,activated_atmust precedetrial_start
Note:
This parameter should not be provided when passing status as future or cancelled.
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.
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.
Set as true
if you want an invoice to be created for the subscription.
- The invoice will be created for the subscription only if it has an
activeornon_renewingstatus. - The period of the invoice is from
current_term_starttocurrent_term_end. - The invoice will not be generated if the subscription amount is zero dollars (for that period) and 'Hide Zero Value Line Items' option is enabled in site settings.
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.
A collection of key-value pairs that provides extra information about the subscription.
Note: There's a character limit of 65,535.
shipping_address[<param name>]addons[<param name>][<idx:0..n>]event_based_addons[<param name>][<idx:0..n>]