Skip to main content
POST
Create a catalog price

Authorizations

Authorization
string
header
required

Merchant API key bearer token.

Headers

Idempotency-Key
string
required

Client-supplied unique key for safe retries of this mutating request. Scoped per merchant or resource as documented on each endpoint.

Example:

"idem-01"

Body

application/json

Create payload with merchant scope, money fields, and optional product link. Supply idempotency via the Idempotency-Key header.

merchantId
string
required
amount
integer
required
Required range: 0 < x <= 9007199254740991
currency
string
required

Supported currency code (USD, CAD)

Required string length: 3
productId
string
type
enum<string>
default:one_time
Available options:
one_time,
recurring
interval
string

Response

An existing active price with the same fingerprint was returned.

priceId
string
required
merchantId
string
required
amount
integer
required
Required range: 0 < x <= 9007199254740991
currency
string
required

Supported currency code (USD, CAD)

Required string length: 3
type
enum<string>
required
Available options:
one_time,
recurring
createdAt
string<date-time>
required
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
productId
string
interval
string
archivedAt
string<date-time>
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$