API version 2021-01 Release candidate
API version 2020-10 Latest
API version 2020-07
API version 2020-04
API version 2020-01
API version 2019-10 Unsupported
API version 2019-07 Unsupported

subscriptionDraftLineRemove mutation

Version 2021-01 (Release candidate)

Removes a subscription line from a subscription draft.

Required access

write_own_subscription_contracts access scope.

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.


draftId ( ID! ) required

The gid of the Subscription Contract draft to remove a subscription line from.

lineId ( ID! ) required

The gid of the Subscription Line to remove.

Return fields

discountsUpdated ([SubscriptionManualDiscount!])

The list of updated subscription discounts impacted by the removed line.

draft (SubscriptionDraft)

The Subscription Contract draft object.

lineRemoved (SubscriptionLine)

The removed Subscription Line.

userErrors ([SubscriptionDraftUserError!]!)

List of errors that occurred executing the mutation.