Docs

Log in to read the version of docs relevant to your site, or use the dropdown versions

Subscription Contract Terms

FieldDescription
Action At Term EndWhen the contract term is completed, action will be taken. Possible values are renew, evergreen, cancel, and renew_once.
Cancellation Cut-Off PeriodThe number of days before the contract end date, during which the customer is barred from canceling the contract term via the Self-Serve Portal.
Subscription IDThe ID of the subscription for which this contract term is for.
StatusStatus of the contract. Possible values are active, completed, canceled, and terminated.
Remaining Billing CyclesThe number of subscription billing cycles remaining after the current one for the contract term.
Customer IDCustomer ID associated with the contract.
Currency CodeCurrency in which the contract is set up.
Created AtDate of creation of the contract term.
Contract Start DateStart date of the contract term.
Contract IDUnique ID of the contract term.
Contract End DateEnd date of the contract term.
Billing CyclesThe number of billing cycles of the subscription that the contract term is for.
Total Contract ValueThe sum of the total 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 the total_amount_raised.

Was this article helpful?