Skip to main content
POST
Add Product

Authorizations

X-Zaymo-API-Key
string
header
required

Zaymo will authenticate requests using the API key you provide

Body

application/json

Product and customer information for adding to order

email
string<email>
required

The email address of the customer

product_id
string
required

The unique identifier for the selected product (from the get products endpoint)

quantity
integer
default:1

The quantity of the product to add to the order

Required range: x >= 1
discount_code
string

Optional discount code to apply to the product/subscription.

one_time
boolean
default:false

If true, the product will only be added to the next subscription billing cycle. Default is false.

Response

Product successfully added to order

success
boolean
required

Indicates if the request was successful

Example:

true