Import a subscription

Specifies the IDs of coupons to be marked as exhausted. This parameter accepts a list of IDs, which must correspond to coupons with a duration_type of one_time. Ensure that the IDs included in this parameter do not match any IDs provided in the coupon_ids parameter.

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

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.

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.

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

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.

Purchase order number for this subscription.

List of coupons to be applied to this subscription. You can provide coupon ids or coupon codes .

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

Current state of the subscription.

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

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.

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.

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 .

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.
• You may pass transaction details to record an offline payment against that invoice.

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 set of key-value pairs stored as additional information for the subscription. Learn more .

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.

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 .

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 .