Skip to main content
POST
Preview an item for an autoship profile

Authorizations

Authorization
string
header
required

Bearer token authentication

Body

application/json
subscription_tokens
string[]
required

The member tokens of the profile, as the client last read them.

Minimum array length: 2
variant_id
integer
required

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

quantity
integer
required

How many units each renewal ships.

Required range: x >= 1

Response

What joining the profile would change, and the confirmation the add takes back.

What joining an autoship profile would change for an item.

quote
object
required

What an item would take on when it joins an autoship profile: the profile's plan cadence, address, card and next bill date, and the price one unit renews at.

meta
object
required