For the complete documentation index, see llms.txt. This page is also available as Markdown.

addNextOrderOnlyProduct

Adds a free gift or free one-off add-on to a subscription's next generated order

The product is added with quantity 1, which cannot be changed, and a zero customer price, then automatically removed from the subscription after that order is created.

Arguments

Argument
Description

Parameters for AddNextOrderOnlyProduct

AddNextOrderOnlyProductInput Arguments

Argument
Description

subscriptionId (ID!)

ID of the subscription whose next order should include the product.

productId (ID!)

ID of the product to add as a gift or free one-off add-on.

Return fields

errors ([ModelValidationError!]!)

Validation errors that prevented the next-order-only product from being added.

orderedProduct (OrderedProduct)

The free ordered product that will be removed after the next order is generated.

subscription (Subscription)

The subscription receiving the next-order-only product.

Last updated

Was this helpful?