Anchor to section titled 'undefined'

subscriptionDraftCommit
mutation

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

Commits the updates of a Subscription Contract draft.

Anchor to section titled 'Arguments'

Arguments

Anchor to draftId
draftId
ID!
required

The gid of the Subscription Contract draft to commit.

Was this section helpful?
Anchor to section titled 'SubscriptionDraftCommitPayload returns'

SubscriptionDraftCommitPayload returns

Anchor to SubscriptionDraftCommitPayload.contract
contract
SubscriptionContract

The updated Subscription Contract object.

Anchor to SubscriptionDraftCommitPayload.userErrors
userErrors
[SubscriptionDraftUserError!]!
non-null

The list of errors that occurred from executing the mutation.

Was this section helpful?
Hide code
Mutation reference
Copy
mutation subscriptionDraftCommit($draftId: ID!) {
  subscriptionDraftCommit(draftId: $draftId) {
    contract {
      # SubscriptionContract fields
    }
    userErrors {
      field
      message
    }
  }
}
Hide code
Input
Copy
{
  "draftId": "gid://shopify/<objectName>/10079785100"
}