subscriptionDraftCommit mutation

Commits the updates of a Subscription Contract draft.

Required access

write_own_subscription_contracts access scope.

On this page

Interactive example

This is an example mutation query. Use the embedded interactive tool below to edit the query.

Hint: use Ctrl + Space for autocompleting fields.

mutation subscriptionDraftCommit($draftId: ID!) { subscriptionDraftCommit(draftId: $draftId) { 
  1. <font style="color:#1F61A0;">contract</font> <font style="color:#555555;">{</font>
  3.   <font style="color:#1F61A0;">id</font>
  5. <font style="color:#555555;">}</font>
  7. <font style="color:#1F61A0;">userErrors</font> <font style="color:#555555;">{</font>
  9.   <font style="color:#1F61A0;">code</font>
  11.   <font style="color:#1F61A0;">field</font>
  13.   <font style="color:#1F61A0;">message</font>
  15. <font style="color:#555555;">}</font>
} } { “draftId”: “Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE=” }

Arguments

Argument Description
draftId
(
[ID!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#id-2021-01)

) REQUIRED		 The gid of the Subscription Contract draft to commit.

Return fields

  • contract ([SubscriptionContract](https://shopify.dev/docs/admin-api/graphql/reference/orders/subscriptioncontract))
    The updated Subscription Contract object.
  • userErrors ([[SubscriptionDraftUserError!]!](https://shopify.dev/docs/admin-api/graphql/reference/orders/subscriptiondraftusererror))
    List of errors that occurred executing the mutation.