Skip to main content
Anchor to SubscriptionCommittedContract

SubscriptionCommittedContract

union

Requires the read_own_subscription_contracts or write_own_subscription_contracts scope.

The committed result of a subscription contract calculation.

Anchor to Possible typesPossible types

Anchor to SubscriptionBillingCycleEditedContractSubscriptionBillingCycleEditedContract
•OBJECT

Represents a subscription contract with billing cycles.

Anchor to SubscriptionContractSubscriptionContract
•OBJECT

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.

Was this section helpful?