AM
EN
Get Started Free
Menu

Contents

Payments and subscriptions

GET/api/payments/{payment_id}

Retrieve a payment by its ID. Returns payment amount, status, and associated metadata. More Subscriptions

Responses
200application/json
OK
schemaobject
dataPaymentrequired
A payment record tracking a monetary transaction for an account. Includes amount, currency, status, and external payment provider references.
idstringrequired
Unique identifier for a payment.
account_idstringrequired
Unique identifier for an account.
amount_centsnumberrequired
currencystringrequired
statusrequired
paid_atstring | nullrequired
payment_methodstring | nullrequired
external_idstring | nullrequired
external_customer_idstring | nullrequired
external_datarequired
linksobjectrequired
selfstringrequired
URL of the current resource
400application/problem+jsonValidationProblemDetails
Bad Request
typestring · urirequired
titlestringrequired
statusintegerrequired
detailstring
instancestring · uri
codestring
invalid_paramsarray
itemobjectrequired
instring
pathstring
typestring
expectedstring
receivedstring
defaultapplication/problem+jsonProblemDetails
HTTP Error
typestring · urirequired
titlestringrequired
statusintegerrequired
detailstring
instancestring · uri
codestring
PATCH/api/payments/{payment_id}

Update payment metadata using JSON Merge Patch (RFC 7396). Useful for associating payments with services, offers, or custom tracking. More Subscriptions

Body application/json
idstring | null
Unique identifier for a payment.
account_idstring | null
Unique identifier for an account.
amount_centsnumber | null
currencystring | null
status
paid_atstring | null
payment_methodstring | null
external_idstring | null
external_customer_idstring | null
external_data
Responses
200application/json
OK
schemaobject
dataPaymentrequired
A payment record tracking a monetary transaction for an account. Includes amount, currency, status, and external payment provider references.
idstringrequired
Unique identifier for a payment.
account_idstringrequired
Unique identifier for an account.
amount_centsnumberrequired
currencystringrequired
statusrequired
paid_atstring | nullrequired
payment_methodstring | nullrequired
external_idstring | nullrequired
external_customer_idstring | nullrequired
external_datarequired
linksobjectrequired
selfstringrequired
URL of the current resource
400application/problem+jsonValidationProblemDetails
Bad Request
typestring · urirequired
titlestringrequired
statusintegerrequired
detailstring
instancestring · uri
codestring
invalid_paramsarray
itemobjectrequired
instring
pathstring
typestring
expectedstring
receivedstring
defaultapplication/problem+jsonProblemDetails
HTTP Error
typestring · urirequired
titlestringrequired
statusintegerrequired
detailstring
instancestring · uri
codestring
DELETE/api/products/{product_id}

Delete a merchant product and all associated prices and features. This is irreversible. More

Responses
204
Product deleted
400application/problem+jsonValidationProblemDetails
Bad Request
typestring · urirequired
titlestringrequired
statusintegerrequired
detailstring
instancestring · uri
codestring
invalid_paramsarray
itemobjectrequired
instring
pathstring
typestring
expectedstring
receivedstring
404application/problem+jsonProblemDetails
Not Found
typestring · urirequired
titlestringrequired
statusintegerrequired
detailstring
instancestring · uri
codestring
defaultapplication/problem+jsonProblemDetails
HTTP Error
typestring · urirequired
titlestringrequired
statusintegerrequired
detailstring
instancestring · uri
codestring
GET/api/products/{product_id}

Retrieve a merchant product by ID. More

Responses
200application/json
OK
schemaobject
dataMerchantProductrequired
A product offered by a merchant. Products have prices with different intervals (monthly, yearly, etc.).
idstringrequired
Unique identifier for a merchant product.
merchant_idstringrequired
Unique identifier for a merchant.
product_keystring | nullrequired
external_product_idstring | nullrequired
upgrades_toarray | nullrequired
itemstringrequired
downgrades_toarray | nullrequired
itemstringrequired
linksobjectrequired
selfstringrequired
URL of the current resource
400application/problem+jsonValidationProblemDetails
Bad Request
typestring · urirequired
titlestringrequired
statusintegerrequired
detailstring
instancestring · uri
codestring
invalid_paramsarray
itemobjectrequired
instring
pathstring
typestring
expectedstring
receivedstring
404application/problem+jsonProblemDetails
Not Found
typestring · urirequired
titlestringrequired
statusintegerrequired
detailstring
instancestring · uri
codestring
defaultapplication/problem+jsonProblemDetails
HTTP Error
typestring · urirequired
titlestringrequired
statusintegerrequired
detailstring
instancestring · uri
codestring
GET/api/products/{product_id}/prices

List all prices for a product. More

Responses
200application/json
OK
schemaobject
dataarrayrequired
itemMerchantPricerequired
A price for a merchant product. The external_price_id stores the provider's price identifier (e.g., Stripe's price_xxx).
idstringrequired
Unique identifier for a merchant price.
product_idstringrequired
Unique identifier for a merchant product.
price_keystring | nullrequired
external_price_idstring | nullrequired
intervalrequired
amount_centsnumberrequired
currencystringrequired
is_defaultbooleanrequired
linksobjectrequired
selfstringrequired
URL of the current page
nextstring
URL of the next page
400application/problem+jsonValidationProblemDetails
Bad Request
typestring · urirequired
titlestringrequired
statusintegerrequired
detailstring
instancestring · uri
codestring
invalid_paramsarray
itemobjectrequired
instring
pathstring
typestring
expectedstring
receivedstring
404application/problem+jsonProblemDetails
Not Found
typestring · urirequired
titlestringrequired
statusintegerrequired
detailstring
instancestring · uri
codestring
defaultapplication/problem+jsonProblemDetails
HTTP Error
typestring · urirequired
titlestringrequired
statusintegerrequired
detailstring
instancestring · uri
codestring
POST/api/products/{product_id}/prices

Create a new price for a product. Prices are unique per price_key within the product. More

Body application/json
idstring
Unique identifier for a merchant price.
price_keystringrequired
external_price_idstring | null
interval
amount_centsnumberrequired
currencystringrequired
is_defaultboolean
Responses
201application/json
Price created
schemaobject
dataMerchantPricerequired
A price for a merchant product. The external_price_id stores the provider's price identifier (e.g., Stripe's price_xxx).
idstringrequired
Unique identifier for a merchant price.
product_idstringrequired
Unique identifier for a merchant product.
price_keystring | nullrequired
external_price_idstring | nullrequired
intervalrequired
amount_centsnumberrequired
currencystringrequired
is_defaultbooleanrequired
linksobjectrequired
selfstringrequired
URL of the created resource
400application/problem+jsonValidationProblemDetails
Bad Request
typestring · urirequired
titlestringrequired
statusintegerrequired
detailstring
instancestring · uri
codestring
invalid_paramsarray
itemobjectrequired
instring
pathstring
typestring
expectedstring
receivedstring
404application/problem+jsonProblemDetails
Not Found
typestring · urirequired
titlestringrequired
statusintegerrequired
detailstring
instancestring · uri
codestring
409
Price key already exists
defaultapplication/problem+jsonProblemDetails
HTTP Error
typestring · urirequired
titlestringrequired
statusintegerrequired
detailstring
instancestring · uri
codestring

Models

MerchantPrice
idstringrequired
Unique identifier for a merchant price.
product_idstringrequired
Unique identifier for a merchant product.
price_keystring | nullrequired
external_price_idstring | nullrequired
intervalrequired
amount_centsnumberrequired
currencystringrequired
is_defaultbooleanrequired
MerchantProduct
idstringrequired
Unique identifier for a merchant product.
merchant_idstringrequired
Unique identifier for a merchant.
product_keystring | nullrequired
external_product_idstring | nullrequired
upgrades_toarray | nullrequired
itemstringrequired
downgrades_toarray | nullrequired
itemstringrequired
Payment
idstringrequired
Unique identifier for a payment.
account_idstringrequired
Unique identifier for an account.
amount_centsnumberrequired
currencystringrequired
statusrequired
paid_atstring | nullrequired
payment_methodstring | nullrequired
external_idstring | nullrequired
external_customer_idstring | nullrequired
external_datarequired
ProblemDetails
typestring · urirequired
titlestringrequired
statusintegerrequired
detailstring
instancestring · uri
codestring
ValidationProblemDetails
typestring · urirequired
titlestringrequired
statusintegerrequired
detailstring
instancestring · uri
codestring
invalid_paramsarray
itemobjectrequired
instring
pathstring
typestring
expectedstring
receivedstring

Features

Types