subscriptionContractCreate mutation

Creates a Subscription Contract.

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 subscriptionContractCreate($input: SubscriptionContractCreateInput!) { subscriptionContractCreate(input: $input) { 
  1. <font style="color:#1F61A0;">draft</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>
} } { “input”: { 
  1. <font style="color:#8B2BB9;">"customerId"</font><font style="color:#555555;">:</font> <font style="color:#D64292;">"Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE="</font><font style="color:#555555;">,</font>
  3. <font style="color:#8B2BB9;">"nextBillingDate"</font><font style="color:#555555;">:</font> <font style="color:#D64292;">"placeholder"</font><font style="color:#555555;">,</font>
  5. <font style="color:#8B2BB9;">"currencyCode"</font><font style="color:#555555;">:</font> <font style="color:#D64292;">"placeholder"</font><font style="color:#555555;">,</font>
  7. <font style="color:#8B2BB9;">"contract"</font><font style="color:#555555;">:</font> <font style="color:#555555;">{}</font>
} }

Arguments

Argument Description
input
(
[SubscriptionContractCreateInput!](https://shopify.dev/docs/admin-api/graphql/reference/orders/subscriptioncontractcreateinput)

) REQUIRED		 The properties of the new Subscription Contract.

SubscriptionContractCreateInput fields

  • contract ([SubscriptionDraftInput!](https://shopify.dev/docs/admin-api/graphql/reference/orders/subscriptiondraftinput)) REQUIRED
    The attributes used as input for the Subscription Draft.
  • currencyCode ([CurrencyCode!](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/currencycode)) REQUIRED
    The currency used for the subscription contract.
  • customerId ([ID!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#id-2021-01)) REQUIRED
    The ID of the customer to associate with the subscription contract.
  • nextBillingDate ([DateTime!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#datetime-2021-01)) REQUIRED
    The next billing date for the subscription contract.

Return fields

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