API

Products API

Create, list, retrieve and update the products in your catalogue.

On this page

Overview
The product object
Create a product
List products
Get a product
Update a product
Errors

Overview#

Products are the items in your catalogue (dashboard: Products), used on invoices, hosted checkout pages and debit order mandates. Keep them in sync with your own system through this API. Products can't be deleted through the API; disable them with enabled: false. Subscription pricing lives in plans, not products.

The product object#

Product

{
  "id": "cmg4r7q6p0004prd0001abcd",
  "object": "product",
  "sku": "SUP-HR",
  "name": "Support hour",
  "description": "One hour of remote support",
  "amount": 650,
  "currency": "ZAR",
  "billingType": "once",
  "frequency": null,
  "taxable": true,
  "enabled": true,
  "createdAt": "2026-09-28T08:00:00.000Z",
  "updatedAt": "2026-09-28T08:00:00.000Z"
}

Product fields
Field	Type	Description
`id`required	string	Product ID.
`object`required	string	`product`
`sku`required	string \| null	Your stock-keeping code (up to 50 characters).
`name, description`required	string, string \| null	Up to 100 and 2000 characters.
`amount, currency`required	number, string	Price (rounded to cents) and ISO 4217 currency.
`billingType`required	string	`once` or `recurring`.
`frequency`required	string \| null	Recurring products: `monthly`, `quarterly`, `biannually` or `annually`; otherwise null.
`taxable`required	boolean	Whether tax applies (see Tax & PDFs).
`enabled`required	boolean	Disabled products are hidden from new sales.
`createdAt, updatedAt`required	string

Create a product#

POST/api/v1/products

Create product fields
Field	Type	Description
`name`required	string	1–100 characters.
`amount`required	number	Greater than 0, up to 100 000 000.
`sku`optional	string \| null	Up to 50 characters.
`description`optional	string \| null	Up to 2000 characters.
`currency`optional	string	3-letter ISO 4217 code, default ZAR.
`billingType`optional	string	`once` (default) or `recurring`. Recurring needs a `frequency` and Recurring billing in your plan.
`frequency`optional	string \| null	Required for recurring products.
`taxable`optional	boolean	Default true.
`enabled`optional	boolean	Default true.

curl -X POST "https://app.centrapoint.co.za/api/v1/products" \
  -H "Authorization: Bearer $CENTRAPOINT_API_KEY" \
  -H "Idempotency-Key: 8d1e4b2a-6c3f-4a7e-9b0d-1f2e3a4b5c6d" \
  -H "Content-Type: application/json" \
  -d '{
    "sku": "SUP-HR",
    "name": "Support hour",
    "description": "One hour of remote support",
    "amount": 650
  }'

Returns 201 with the product. Unknown fields are rejected. Supports the Idempotency-Key header.

List products#

GET/api/v1/products

List query parameters
Field	Type	Description
`enabled`optional	string	`true` or `false`.
`billingType`optional	string	`once` or `recurring`; anything else returns 400.
`limit`optional	integer	1–100, default 50.

Returns { "data": [ … ] } in name order.

curl -X GET "https://app.centrapoint.co.za/api/v1/products?enabled=true" \
  -H "Authorization: Bearer $CENTRAPOINT_API_KEY"

Get a product#

GET/api/v1/products/{id}

curl -X GET "https://app.centrapoint.co.za/api/v1/products/cmg4r7q6p0004prd0001abcd" \
  -H "Authorization: Bearer $CENTRAPOINT_API_KEY"

Update a product#

PATCH/api/v1/products/{id}

Partial update with the same fields as create. null clears sku or description. Switching to recurring needs a frequency (sent or already stored) and Recurring billing; switching to once clears the frequency. Unknown fields are rejected. The Idempotency-Key header is not used.

curl -X PATCH "https://app.centrapoint.co.za/api/v1/products/cmg4r7q6p0004prd0001abcd" \
  -H "Authorization: Bearer $CENTRAPOINT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "amount": 700
  }'

Errors#

Product errors
Status	error	When
400	`invalid_request`	Validation failed, unknown field, invalid currency, recurring without frequency or without Recurring billing.
403	`plan_restricted / account_restricted`	No API access, or the account is read-only (writes).
404	`not_found`	No product with this ID in your organisation.
409	`idempotency_conflict`	Idempotency-Key reused with a different body (POST).
401 / 429 / 500	`unauthorized` / `rate_limited` / `internal_error`	See Errors