POST /subscriptions/{subscription-id}/import_contract_term

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.

Warning

This API will return an error when multi-frequency billing is enabled.

Servers

{protocol}://{site}.{environment}:{port}/api/v2
{protocol}://{site}-test.{environment}:{port}/api/v2

Path parameters

Name	Type	Required	Description
`subscription-id`	String	Yes

Request headers

Name	Type	Required	Description
`chargebee-request-origin-device`	String	No	The device from which the customer has made the request
`Content-Type`	String	Yes	The media type of the request body. Default value: "application/x-www-form-urlencoded"
`chargebee-event-webhook`	String	No	skip only webhooks Valid values: `"all-disabled"`
`chargebee-business-entity-id`	String	No	If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.
`chargebee-event-actions`	String	No	skip all actions to be done on the events Valid values: `"all-disabled"`
`chargebee-request-origin-user`	String	No	The email address of your customer/user. Use this when the email address has only ASCII characters.
`chargebee-request-origin-ip`	String	No	The IP address of the customer where the request originated
`chargebee-request-origin-user-encoded`	String	No	The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.
`chargebee-event-email`	String	No	skip only emails Valid values: `"all-disabled"`

Request body fields

Name	Type	Required	Description
`contract_term`	Object	No	Parameters for contract_term
`contract_term.id`	String	No	Id that uniquely identifies the contract term in the site.
`contract_term.contract_start`	Integer	No	The start date of the contract term
`contract_term.total_contract_value`	Integer	No	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`. Default value: 0
`contract_term.total_contract_value_before_tax`	Integer	No	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. Default value: 0
`contract_term.total_amount_raised_before_tax`	Integer	No	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` Default value: 0
`contract_term.action_at_term_end`	String	No	Action to be taken when the contract term completes. evergreen - Contract term completes and the subscription renews. renew_once - Used 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`. cancel - Contract term completes and subscription is canceled. 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`. Valid values: `"renew_once"` `"evergreen"` `"cancel"` `"renew"` Default value: "renew"
`contract_term.status`	String	No	Current status of contract * active - An actively running contract term. * completed - The contract term has run its full duration. * cancelled - The contract term was ended because: a change in the subscription caused a subscription term reset. the subscription was cancelled due to non-payment. * terminated - The contract term was terminated ahead of completion. Valid values: `"terminated"` `"active"` `"completed"` `"cancelled"`
`contract_term.created_at`	Integer	No	The date when the contract term was created.
`contract_term.total_amount_raised`	Integer	No	The amount raised for the contract term till the time of importing the subscription. This amount is added to the `total_contract_value` Default value: 0
`contract_term.contract_end`	Integer	No	The end date of the contract term
`contract_term.cancellation_cutoff_period`	Integer	No	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.
`contract_term.billing_cycle`	Integer	No	The number of billing cycles of the subscription that the contract term is for.
`contract_term_billing_cycle_on_renewal`	Integer	No	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.

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.