subscriptionDraftLineAdd
mutation

Choose a version:

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

Adds a subscription line to a subscription draft.

Anchor to section titled 'Arguments'

Arguments

Anchor to draftId draftId ID! required: The gid of the Subscription Contract draft to add a subscription line to.
Anchor to input input SubscriptionLineInput! required: The properties of the new Subscription Line.

Was this section helpful?

Anchor to section titled 'SubscriptionDraftLineAddPayload returns'

SubscriptionDraftLineAddPayload returns

Anchor to SubscriptionDraftLineAddPayload.draft draft SubscriptionDraft: The Subscription Contract draft object.
Anchor to SubscriptionDraftLineAddPayload.lineAdded lineAdded SubscriptionLine: The added Subscription Line.
Anchor to SubscriptionDraftLineAddPayload.userErrors userErrors [SubscriptionDraftUserError!]! non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Code examples for MUTATION: subscriptionDraftLineAdd

Query Reference for MUTATION: subscriptionDraftLineAdd

"mutation subscriptionDraftLineAdd($draftId: ID!, $input: SubscriptionLineInput!) {\n  subscriptionDraftLineAdd(draftId: $draftId, input: $input) {\n    draft {\n      # SubscriptionDraft fields\n    }\n    lineAdded {\n      # SubscriptionLine fields\n    }\n    userErrors {\n      field\n      message\n    }\n  }\n}"

Input Reference for MUTATION: subscriptionDraftLineAdd

"{\n  \"draftId\": \"gid://shopify/<objectName>/10079785100\",\n  \"input\": {\n    \"currentPrice\": \"29.99\",\n    \"customAttributes\": [\n      {\n        \"key\": \"<your-key>\",\n        \"value\": \"<your-value>\"\n      }\n    ],\n    \"pricingPolicy\": {\n      \"basePrice\": \"29.99\",\n      \"cycleDiscounts\": [\n        {\n          \"adjustmentType\": \"FIXED_AMOUNT\",\n          \"adjustmentValue\": {\n            \"fixedValue\": \"29.99\",\n            \"percentage\": 1.1\n          },\n          \"afterCycle\": 1,\n          \"computedPrice\": \"29.99\"\n        }\n      ]\n    },\n    \"productVariantId\": \"gid://shopify/<objectName>/10079785100\",\n    \"quantity\": 1,\n    \"sellingPlanId\": \"gid://shopify/<objectName>/10079785100\",\n    \"sellingPlanName\": \"<your-sellingPlanName>\"\n  }\n}"

Schema Reference for MUTATION: subscriptionDraftLineAdd

"input SubscriptionLineInput {\n  currentPrice: Decimal!\n  customAttributes: [AttributeInput!]\n  pricingPolicy: SubscriptionPricingPolicyInput\n  productVariantId: ID!\n  quantity: Int!\n  sellingPlanId: ID\n  sellingPlanName: String\n}\n\ninput AttributeInput {\n  key: String!\n  value: String!\n}\n\ninput SubscriptionPricingPolicyInput {\n  basePrice: Decimal!\n  cycleDiscounts: [SubscriptionPricingPolicyCycleDiscountsInput!]!\n}\n"

Display Examples for MUTATION: subscriptionDraftLineAdd

[]

subscriptionDraftLineAddmutation

Arguments

SubscriptionDraftLineAddPayload returns

subscriptionDraftLineAdd
mutation