Skip to main content
POST
Add a one-time item to a subscription's next order

Authorizations

Authorization
string
header
required

Bearer token authentication

Path Parameters

token
string
required

Body

application/json
variant_id
integer
required

The variant to send. It must belong to the company.

quantity
integer
default:1
Required range: 1 <= x <= 100
pricing
enum<string>
default:catalog

catalog charges the variant's one-time price in the subscription's market; gift is free.

Available options:
catalog,
gift
volume_policy
enum<string>

Whether the line earns the variant's catalog volume. Defaults to catalog for catalog pricing and zero for a gift.

Available options:
zero,
catalog

Response

The planned item

milestone_item
object
required

A Subscription Pro milestone item of a subscription, from the milestone grant ledger.

meta
object | null
required