Skip to main content
POST
Add an item to 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
request_key
string
required

Identifies this add. The client generates one per add and sends it again on a retry.

Required string length: 1 - 255
confirmation
string

The quote.confirmation from the preview of these terms. Required when the preview's outcome is align_required.

Response

The item was added, or an earlier request with the same request_key already added it.

The autoship profile after an item joined it, and the new item's token. profile is null only when the profile cannot be derived after the add.

profile
object | null
required

The autoship profile this subscription belongs to: the subscriptions that renew as one order and also share a payment method, a plan cadence and a timezone, so they stay together after each shipment. Derived from the subscriptions on every read and never stored.

subscription_token
string
required

The token of the subscription the add created, or created on the first request with the same request_key.

meta
object
required