API ReferenceProducts
Products
Manage product catalog for payment links and hosted checkout.
POST
/v1/productsCreate a product
Parameters
| Name | Type | In | Required | Description |
|---|---|---|---|---|
name | string | body | Required | Product name |
description | string | body | Optional | Product description |
prices | array | body | Required | Array of price objects |
Response Codes
201Product created400Invalid parameters
1{
2 "id": "prod_abc123",
3 "object": "product",
4 "name": "Pro Plan",
5 "prices": [
6 { "id": "price_m1", "amount": 4900, "currency": "USD", "interval": "month" },
7 { "id": "price_y1", "amount": 49000, "currency": "USD", "interval": "year" }
8 ],
9 "created_at": "2026-05-01T16:00:00Z"
10}
GET
/v1/productsList all products
Parameters
| Name | Type | In | Required | Description |
|---|---|---|---|---|
limit | integer | query | Optional | Number of results |
active | boolean | query | Optional | Filter by active status |
Response Codes
200Products listed
1{
2 "object": "list",
3 "data": [
4 { "id": "prod_abc123", "name": "Pro Plan", "active": true }
5 ],
6 "has_more": false
7}
DELETE
/v1/products/{id}Archive a product
Parameters
| Name | Type | In | Required | Description |
|---|---|---|---|---|
id | string | path | Required | Product ID |
Response Codes
200Product archived404Product not found
1{
2 "id": "prod_abc123",
3 "object": "product",
4 "active": false,
5 "archived_at": "2026-05-03T10:00:00Z"
6}