Skip to main content
Anchor to subscriptionContractCreate

subscriptionContractCreate

mutation

Requires write_own_subscription_contracts access scope. Also: The user must have manage_orders_information permission.

Creates a subscription contract draft, which is an intention to create a new subscription. The draft lets you incrementally build and modify subscription details before committing them to create the actual SubscriptionContract.

The mutation requires Customer information, billing details, and contract configuration including the SubscriptionBillingPolicy and SubscriptionDeliveryPolicy. You can specify the CustomerPaymentMethod, the MailingAddress for shipping, and subscription intervals.

After you create the draft, you can either modify it with the subscriptionDraftUpdate mutation or finalize and create the active subscription contract with subscriptionDraftCommit.

Learn more about building subscription contracts.

•SubscriptionContractCreateInput!
required

The properties of the new Subscription Contract.


Was this section helpful?

Anchor to SubscriptionContractCreatePayload returnsSubscriptionContractCreatePayload returns

•SubscriptionDraft

The Subscription Contract object.

•[SubscriptionDraftUserError!]!
non-null

The list of errors that occurred from executing the mutation.


Was this section helpful?