Get a price
The prices.get operation: GET /api/v1/prices/{id} in the REST API and the prices_get tool in the MCP server.
GET
/api/v1/prices/{id}Returns one price of the brand's catalog in the request's mode, archived or not. used says whether a
checkout session or payment has referenced it (then what it charges can't change).
At a glance
- REST:
GET /api/v1/prices/{id} - MCP tool:
prices_get - Operation ID:
prices.get - Scope: Brand
- Permission:
catalog:read - Risk tier:
read - Dry run: Not supported
- Idempotency: Not needed (read only)
- Modes: Test and live
- Authentication: API key with the
catalog:readscope - Since: M4
Request
Path parameters
| Field | Type | Description |
|---|---|---|
id | price_… ID |
Query parameters
This operation takes no query parameters.
Response
200 OK with a JSON object:
| Field | Type | Description |
|---|---|---|
id | price_… ID | |
object | "price" | |
brandId | brd_… ID | |
livemode | boolean | |
productId | prod_… ID | |
nickname | string or null | |
lookupKey | string or null | |
type | one of one_time, recurring, credit_pack | |
currency | string | |
taxBehavior | one of inclusive, exclusive | |
amount | money or null | Fixed one-time or credit-pack amount. |
customAmount | object or null | The range a buyer may choose from (custom-amount prices). |
creditPack | object or null | |
recurring | object or null | |
active | boolean | |
used | boolean | A checkout session or payment referenced the price: what it charges can no longer change. |
usedAt | date-time or null | |
metadata | object | |
createdAt | date-time | |
updatedAt | date-time |
Examples
A monthly per-seat price
HTTP
GET /api/v1/prices/price_01m4tx5nj8emwbyf7y9vcf47y2
Authorization: Bearer or_test_…
Response (200):
JSON
{
"id": "price_01m4tx5nj8emwbyf7y9vcf47y2",
"object": "price",
"brandId": "brd_01m4tx5nj8emwbyf7y9vcf47x4",
"livemode": false,
"productId": "prod_01m4tx5nj8emwbyf7y9vcf47y0",
"nickname": "Pro monthly, per seat",
"lookupKey": "pro_monthly",
"type": "recurring",
"currency": "EUR",
"taxBehavior": "inclusive",
"amount": null,
"customAmount": null,
"creditPack": null,
"recurring": {
"interval": "month",
"intervalCount": 1,
"usageType": "licensed",
"billingScheme": "tiered",
"unitAmount": null,
"tiersMode": "graduated",
"tiers": [
{
"upTo": 10,
"unitAmountMicros": "12000000",
"flatAmount": null
},
{
"upTo": "inf",
"unitAmountMicros": "9000000",
"flatAmount": null
}
],
"trialDays": 14,
"includedCredits": null,
"metered": null
},
"active": true,
"used": false,
"usedAt": null,
"metadata": {},
"createdAt": "2026-10-13T12:00:00.000Z",
"updatedAt": "2026-10-13T12:00:00.000Z"
}
Errors
| Code | HTTP status | When | What to do |
|---|---|---|---|
resource_not_found | 404 | No price with this ID is visible to the request. | Check the ID and that your credentials are scoped to the right organization, entity, brand and mode. |
permission_denied | 403 | You can't see this brand's catalog. | Ask an organization owner or admin for a role or scope that allows this action. |
It can also return these common errors: validation_failed, api_version_unsupported, authentication_required, api_key_invalid, scope_required, dry_run_not_supported, rate_limited, internal_error.