SubscriptionContractSubscriptionStatus

The contract is active and continuing per its policies.

The contract was ended by an unplanned customer action.

The contract has ended per the expected circumstances. All billing and deliverycycles of the subscriptions were executed.

The contract ended because billing failed and no further billing attempts are expected.

The contract is temporarily paused and is expected to resume in the future.

The input fields for filtering subscription billing cycles in bulk actions.

A subscription contract that defines recurring purchases for a customer. Each contract specifies what products to deliver, when to bill and ship them, and at what price.

The contract includes SubscriptionBillingPolicy and SubscriptionDeliveryPolicy that control the frequency of charges and fulfillments. SubscriptionLine items define the products, quantities, and pricing for each recurring Order. The contract tracks SubscriptionBillingAttempt records, payment status, and generated orders throughout its lifecycle. App instances manage contracts through various status transitions including active, paused, failed, cancelled, or expired states.

Learn more about building subscription contracts and updating subscription contracts.

The SubscriptionDraft object represents a draft version of a subscription contract before it's committed. It serves as a staging area for making changes to an existing subscription or creating a new one. The draft allows you to preview and modify various aspects of a subscription before applying the changes.

Use the SubscriptionDraft object to:

• Add, remove, or modify subscription lines and their quantities
• Manage discounts (add, remove, or update manual and code-based discounts)
• Configure delivery options and shipping methods
• Set up billing and delivery policies
• Manage customer payment methods
• Add custom attributes and notes to generated orders
• Configure billing cycles and next billing dates
• Preview the projected state of the subscription

Each SubscriptionDraft object maintains a projected state that shows how the subscription will look after the changes are committed. This allows you to preview the impact of your modifications before applying them. The draft can be associated with an existing subscription contract (for modifications) or used to create a new subscription.

The draft remains in a draft state until it's committed, at which point the changes are applied to the subscription contract and the draft is no longer accessible.

Learn more about how subscription contracts work and how to build, update, and combine subscription contracts.

The input fields required to create a Subscription Draft.