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

subscriptionDraftLineUpdate mutation

Version 2021-01 (Release candidate)

Updates a subscription line on 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 update a subscription line from.

input ( SubscriptionLineUpdateInput! ) required

The properties of the new Subscription Line.

lineId ( ID! ) required

The gid of the Subscription Line to update.

SubscriptionLineUpdateInput fields

currentPrice (Decimal)

The price of the product.

customAttributes ([AttributeInput!])

The custom attributes for this subscription line.

productVariantId (ID)

The ID of the product variant the subscription line refers to.

quantity (Int)

The quantity of the product.

sellingPlanId (ID)

The selling plan for the subscription line.

sellingPlanName (String)

The selling plan name for the subscription line.

Return fields

draft (SubscriptionDraft)

The Subscription Contract draft object.

lineUpdated (SubscriptionLine)

The updated Subscription Line.

userErrors ([SubscriptionDraftUserError!]!)

List of errors that occurred executing the mutation.