Update a price

Updates the specified price by setting the values of the parameters passed. Any parameters not provided are left unchanged.

  Updates the specified price by setting the values of the parameters passed.
  Any parameters not provided are left unchanged.

Authorization

api-key

AuthorizationBearer <token>

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

In: header

id*string

Price ID

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name?string

Price name

description?string

Price description

currency?string

Currency

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

unitAmount?number

Unit amount in smallest currency unit (e.g., piasters for EGP). Must be omitted when updating to type CUSTOM.

type?string

Price type

Value in"ONE_TIME" | "RECURRING" | "CUSTOM"

recurring?

Recurring configuration (required for RECURRING type)

customUnitAmount?

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

stock?|

Remaining stock. Set null to mark unlimited. When set, checkout blocks new sales once stock reaches 0.

startDate?|

Start date (before which the price is not usable in checkout)

expirationDate?|

Expiration date (at/after which the price is not usable in checkout)

active?boolean

Whether the price is active

metadata?object

Custom metadata

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

Empty