Create a price

Creates a new Price for an existing Product.

Authorization

api-key

AuthorizationBearer <token>

API key for merchant integrations. Send as Authorization: Bearer <your key>.

In: header

Query Parameters

productId*string

Product ID

Length1 <= length

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name?|

Price name

description?|

Price description

currency?|

Currency

Value in

"EGP"
"USD"
"EUR"
"GBP"
"SAR"
"AED"
"QAR"
"KWD"
"JOD"
"OMR"
"BHD"
"LYD"
"AUD"
"CAD"
"CNY"

unitAmount?|

Unit amount in smallest currency unit (e.g., piasters for EGP). Required for ONE_TIME and RECURRING prices, and must be omitted for CUSTOM prices (whose amount the customer enters at checkout). May be 0.

Range0 <= value <= 2147483647

type?|

Price type

Value in

"ONE_TIME"
"RECURRING"
"CUSTOM"

recurring?|

Recurring configuration (required for RECURRING type)

customUnitAmount?|

Custom unit amount configuration — required to scope customer-entered amounts for CUSTOM prices. Only allowed when type is CUSTOM.

stock?|

Remaining stock. Omit or set null for unlimited. When set, checkout blocks new sales once stock reaches 0.

Range0 <= value <= 2147483647

startDate?|

YYYY-MM-DD starts at the beginning of that date in Africa/Cairo. A timestamp with an offset specifies an exact instant.

expirationDate?|

YYYY-MM-DD includes the full date in Africa/Cairo (exclusive cutoff at the start of the next day). A timestamp with an offset specifies an exact exclusive cutoff.

active?boolean

Whether the price is active

metadata?|

Custom metadata

Response Body

`application/json`

curl -X POST "https://example.com/prices?productId=string" \  -H "Content-Type: application/json" \  -d '{}'

{  "id": "price_abc123",  "object": "price",  "name": "string",  "description": "string",  "currency": "EGP",  "unitAmount": 0,  "type": "ONE_TIME",  "recurring": {    "interval": "DAY",    "intervalCount": 0  },  "customUnitAmount": {    "minimum": 0,    "maximum": 0,    "preset": 0  },  "stock": 0,  "startDate": "string",  "expirationDate": "string",  "active": true,  "createdAt": "string",  "updatedAt": "string",  "productId": "string"}

Authorization

Query Parameters

Request Body

Response Body

201application/json

400application/json

401application/json

403application/json

404application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`