A draft subscription contract is a temporary, editable copy of a subscription contract. You create it from an existing subscription contract, add, update, or remove line items, and review the recalculated totals. When you commit it, the changes apply to the subscription contract from the next billing cycle onward. Each line item, discount, and additional fee shows how it changed compared to the subscription contract.
Additional fees, each with its source and whether it's applied.
Billing address and contact details, with how they changed compared to the subscription contract.
Business location for the next billing cycle. Copied from the subscription contract.
Buyer information, with how it changed compared to the subscription contract.
Identity that created the draft subscription contract.
Only this identity can retrieve, update, commit, or delete the draft subscription contract.
Date and time the draft subscription contract was created.
Currency used for the draft subscription contract's pricing, as a three-letter currency code in ISO-4217 alphabetic format.
Discounts, each with its source and whether it's applied.
Custom field data for the draft subscription contract object.
Extended fields must be configured in the app dashboard before they can be accessed with API calls.
Copied from the subscription contract when the draft subscription contract is created. Committing the draft subscription contract doesn't change the subscription contract's extended fields.
Draft subscription contract ID.
Line items, each with how it changed compared to the subscription contract.
Removed line items are returned with changeType set to REMOVED.
In a draft subscription contract, lineItem.subscriptionInfo.cycleNumber is 0.
Summary of the platform fees of the order created at checkout, including totals by charge type and a breakdown of individual fees.
Copied from the subscription contract. Not recalculated in the draft subscription contract.
Price summary for the next billing cycle.
Recalculated and saved each time the draft subscription contract changes and when it's committed.
Retrieving a draft subscription contract with the DRAFT status also recalculates it.
For a draft subscription contract with the COMMITTED status, this is the price summary applied to the subscription contract.
Recipient address and contact details, with how they changed compared to the subscription contract.
Draft subscription contract settings.
Shipping info, with how it changed compared to the subscription contract.
Status of the draft subscription contract.
ID of the subscription contract that the draft subscription contract was created from.
Billing schedule of the subscription contract.
Line items that you add to the draft subscription contract get these settings.
Tags assigned to the draft subscription contract.
Billing cycles that the draft subscription contract applies to.
Tax information for the next billing cycle.
Recalculated and saved each time the draft subscription contract changes and when it's committed.
Retrieving a draft subscription contract with the DRAFT status also recalculates it.
For a draft subscription contract with the COMMITTED status, this is the tax information at the time of the commit.
Date and time the draft subscription contract was updated.
A draft subscription contract with the DRAFT status expires 24 hours after this time.
Weight measurement unit.