Customers & catalog · Products
Create product
Adds a product or service to your catalog. The product belongs to the account of the API key you use.
Send multipart/form-data to upload images, or JSON without them. image takes one file and workSamples up to 10, one field per file (JPEG, PNG or WebP). In multipart every value is text, so send prices and metadata as JSON text.
Authorization
HeaderSend Authorization: Bearer <accessToken>, the token from Create token.
Body parameters
title string Required
The product's name.type enum Required
PRODUCT or SERVICE. sku and stock apply to PRODUCT only.unitPrice number Required
Price per unit in the product's currency, e.g. 150 or 49.99. Can't be negative. For a RECURRING product, the price of each interval.status enum Required
ACTIVE or INACTIVE.visibility enum Required
PUBLIC or PRIVATE. Only a PUBLIC product can be opened on its public page.description string
A short description.currency enum
USD (default), EUR, GBP, CAD, AUD, AED, SGD, INR, BDT or BRL.chargeType enum
FIXED (default), HOURLY, CUSTOM or RECURRING.interval enum
HOUR, DAY, WEEK, MONTH or YEAR. Required when chargeType is RECURRING.intervalCount integer
1 to 52, default 1. Bills every intervalCount intervals: 3 with MONTH is quarterly.trialDays integer
Free-trial days for a RECURRING product, 0 to 3650.prices array
Several recurring prices, e.g. monthly and yearly, as a JSON array: [{"amount":49,"interval":"MONTH"},{"amount":490,"interval":"YEAR"}]. Each also takes intervalCount, trialDays and nickname. The first is the default price. When sent, it is used instead of unitPrice, intervalCount and trialDays; interval is still required with chargeType RECURRING.taxable boolean
true or false (default).taxRate string
Tax percentage as a number string, e.g. "8.25".sku string
Your stock code, PRODUCT only. It must be unique among your products (409 if not).stock integer
Units in stock, PRODUCT only.categoryIds string[]
Category ids from List categories (GET /merchant/category, see Categories). In multipart, send categoryIds[] once per id; in JSON, an array. In this form, separate them with commas.deliveryTime string
Delivery time shown to buyers, e.g. "5 days".revision string
Revision policy shown to buyers, e.g. "2 revisions included".metadata object
Your own key-value data, returned as you send it. A multipart request stores it as the text you send.