Skip to main content
PUT

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"

Path Parameters

​
productId
string
required

Product TypeID (prod_...) whose active price set should be replaced.

Example:

"prod_01hxy8m1nqk9g3x3y3p0azq2bg"

Body

application/json

Replacement price payload with merchant scope and money/type fields. Supply idempotency via the Idempotency-Key header.

​
merchantId
string
required

Merchant TypeID (mer_...) that owns the product and replacement price.

​
amount
integer
required

Price amount in minor units (for example cents).

Required range: 0 < x <= 9007199254740991
​
currency
string
required

ISO 4217 uppercase currency code for the replacement price.

Required string length: 3
​
type
enum<string>
default:one_time

Price type. Use one_time for single-charge pricing or recurring for subscription-like pricing.

Available options:
one_time,
recurring
​
interval
string

Recurring interval label (for example month) required when type=recurring; omit for one_time.

Response

Replacement active price in canonical response shape. Previously active prices for this product are archived.

​
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))$