Skip to main content
PUT
Set a credit unit's selling price

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

Credit unit ID

currency
string
required

ISO 4217 currency code

Body

application/json

The new price of one credit in a currency.

unit_price
string
required

Major units of the currency per credit, as a decimal string: positive, at most 12 decimal places.

Response

The active price

What one credit sells for in a currency. A price is never edited: setting a new one for the same currency archives it.

created_at
string<date-time>
required

When the price was set.

currency
string
required

ISO 4217 code of the currency the unit sells in.

id
string
required

The price's id (cup_…).

unit_price
string
required

Major units of currency per credit, as a decimal string (e.g. "0.001").

archived_at
string<date-time> | null

When a newer price, or its removal, replaced it; absent while active.