Skip to main content

SubscriptionLineAddInput

The input fields for adding a subscription line.

input SubscriptionLineAddInput {
  productVariantId: SharedGlobalID!
  quantity: NonZeroCount!
  scheduleNextOrderSynchronously: Boolean
  subscriptionId: GlobalID!
}

Fields​

SubscriptionLineAddInput.productVariantId ● SharedGlobalID! non-null scalar types​

The ID of the product variant to add. It must be one of the subscription plan group's products.

SubscriptionLineAddInput.quantity ● NonZeroCount! non-null scalar types​

The quantity to add.

SubscriptionLineAddInput.scheduleNextOrderSynchronously ● Boolean scalar types​

Whether to update the next subscription order before the mutation returns. Later orders update in the background.

SubscriptionLineAddInput.subscriptionId ● GlobalID! non-null scalar types​

The ID of the subscription to add the line to.

Member Of​

subscriptionLineAdd mutation