subscriptionDraftLineRemove
mutation

Choose a version:

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

Removes a subscription line from a subscription draft.

Anchor to section titled 'Arguments'

Arguments

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

Was this section helpful?

Anchor to section titled 'SubscriptionDraftLineRemovePayload returns'

SubscriptionDraftLineRemovePayload returns

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

Was this section helpful?

Code examples for MUTATION: subscriptionDraftLineRemove

Query Reference for MUTATION: subscriptionDraftLineRemove

"mutation subscriptionDraftLineRemove($draftId: ID!, $lineId: ID!) {\n  subscriptionDraftLineRemove(draftId: $draftId, lineId: $lineId) {\n    discountsUpdated {\n      # SubscriptionManualDiscount fields\n    }\n    draft {\n      # SubscriptionDraft fields\n    }\n    lineRemoved {\n      # SubscriptionLine fields\n    }\n    userErrors {\n      field\n      message\n    }\n  }\n}"

Input Reference for MUTATION: subscriptionDraftLineRemove

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

Schema Reference for MUTATION: subscriptionDraftLineRemove

""

Display Examples for MUTATION: subscriptionDraftLineRemove

[]

subscriptionDraftLineRemovemutation

Arguments

SubscriptionDraftLineRemovePayload returns

subscriptionDraftLineRemove
mutation