subscriptionDraftLineAdd mutation

Adds a subscription line to a subscription 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 subscriptionDraftLineAdd($draftId: ID!, $input: SubscriptionLineInput!) { subscriptionDraftLineAdd(draftId: $draftId, 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;">lineAdded</font> <font style="color:#555555;">{</font>
  9.   <font style="color:#1F61A0;">id</font>
  11. <font style="color:#555555;">}</font>
  13. <font style="color:#1F61A0;">userErrors</font> <font style="color:#555555;">{</font>
  15.   <font style="color:#1F61A0;">code</font>
  17.   <font style="color:#1F61A0;">field</font>
  19.   <font style="color:#1F61A0;">message</font>
  21. <font style="color:#555555;">}</font>
} } { “draftId”: “Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE=”, “input”: { 
  1. <font style="color:#8B2BB9;">"productVariantId"</font><font style="color:#555555;">:</font> <font style="color:#D64292;">"Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE="</font><font style="color:#555555;">,</font>
  3. <font style="color:#8B2BB9;">"quantity"</font><font style="color:#555555;">:</font> <font style="color:#2882F9;">1</font><font style="color:#555555;">,</font>
  5. <font style="color:#8B2BB9;">"currentPrice"</font><font style="color:#555555;">:</font> <font style="color:#D64292;">"placeholder"</font>
} }

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 add a subscription line to.
input
(
[SubscriptionLineInput!](https://shopify.dev/docs/admin-api/graphql/reference/orders/subscriptionlineinput)

) REQUIRED		 The properties of the new Subscription Line.

SubscriptionLineInput fields

  • currentPrice ([Decimal!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#decimal-2021-01)) REQUIRED
    The price of the product.
  • customAttributes ([[AttributeInput!]](https://shopify.dev/docs/admin-api/graphql/reference/orders/attributeinput))
    The custom attributes for this subscription line.
  • pricingPolicy ([SubscriptionPricingPolicyInput](https://shopify.dev/docs/admin-api/graphql/reference/orders/subscriptionpricingpolicyinput))
    Describes expected price changes of the subscription line over time.
  • productVariantId ([ID!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#id-2021-01)) REQUIRED
    The ID of the product variant the subscription line refers to.
  • quantity ([Int!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#int-2021-01)) REQUIRED
    The quantity of the product.
  • sellingPlanId ([ID](https://shopify.dev/docs/admin-api/graphql/reference/scalar#id-2021-01))
    The selling plan for the subscription line.
  • sellingPlanName ([String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01))
    The selling plan name for the subscription line.
    Defaults to using the selling plan’s current name when not specified.

Return fields

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