subscriptionDraftLineRemove

mutation

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

Removes a subscription line from a subscription draft.

Arguments

Anchor to draftIddraftId • ID!required: The gid of the Subscription Contract draft to remove a subscription line from.
Anchor to lineIdlineId • ID!required: The gid of the Subscription Line to remove.

Was this section helpful?

Anchor to SubscriptionDraftLineRemovePayload returnsSubscriptionDraftLineRemovePayload returns

Anchor to discountsUpdateddiscountsUpdated • [SubscriptionManualDiscount!]: The list of updated subscription discounts impacted by the removed line.
Anchor to draftdraft • SubscriptionDraft: The Subscription Contract draft object.
Anchor to lineRemovedlineRemoved • SubscriptionLine: The removed Subscription Line.
Anchor to userErrorsuserErrors • [SubscriptionDraftUserError!]!non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Mutation Reference

1mutation subscriptionDraftLineRemove($draftId: ID!, $lineId: ID!) {
2  subscriptionDraftLineRemove(draftId: $draftId, lineId: $lineId) {
3    discountsUpdated {
4      # SubscriptionManualDiscount fields
5    }
6    draft {
7      # SubscriptionDraft fields
8    }
9    lineRemoved {
10      # SubscriptionLine fields
11    }
12    userErrors {
13      field
14      message
15    }
16  }
17}

Input

1{
2  "draftId": "gid://shopify/<objectName>/10079785100",
3  "lineId": "gid://shopify/<objectName>/10079785100"
4}

{
  "draftId": "gid://shopify/<objectName>/10079785100",
  "lineId": "gid://shopify/<objectName>/10079785100"
}