subscriptionDraftLineAdd mutation

Adds a subscription line to a subscription draft.

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.

Arguments

SubscriptionLineInput fields

• currentPrice (Decimal!) Required

  The price of the product.

• customAttributes ([AttributeInput!])

  The custom attributes for this subscription line.

• pricingPolicy (SubscriptionPricingPolicyInput)

  Describes expected price changes of the subscription line over time.

• productVariantId (ID!) Required

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

• quantity (Int!) Required

  The quantity of the product.

• sellingPlanId (ID)

  The selling plan for the subscription line.

• sellingPlanName (String)

  The selling plan name for the subscription line.

  Defaults to using the selling plan's current name when not specified.

Return fields

• draft (SubscriptionDraft)

  The Subscription Contract draft object.

• lineAdded (SubscriptionLine)

  The added Subscription Line.

• userErrors ([SubscriptionDraftUserError!]!)

  List of errors that occurred executing the mutation.