Skip to main content
POST
cURL
Grant monetary credit in one currency. Credit is applied FIFO before tax to eligible recurring invoices.

Autorizaciones

x-api-key
string
header
requerido

Encabezados

Idempotency-Key
string

Unique key used to safely retry this write for 24 hours without applying it twice.

Required string length: 1 - 200
Commet-Version
string
predeterminado:2026-08-27

API version used by this reference. Send this header to select this contract explicitly.

Parámetros de ruta

id
string
requerido

Cuerpo

application/json
amount
integer
requerido

Amount in the currency's smallest unit.

Rango requerido: x <= 9007199254740991
currency
enum<string>
requerido
Opciones disponibles:
usd,
ars,
brl,
clp,
cop,
pen,
uyu,
pyg,
bob,
mxn,
cad,
eur,
gbp,
jpy,
cny,
krw,
hkd,
sgd,
twd,
inr,
thb
reason
string
requerido
Required string length: 1 - 500
expiresAt
string<date-time> | null

Respuesta

Success

id
string
requerido
amount
integer
requerido

Original grant amount in the currency's smallest unit.

Rango requerido: -9007199254740991 <= x <= 9007199254740991
appliedAmount
integer
requerido
Rango requerido: -9007199254740991 <= x <= 9007199254740991
reversedAmount
integer
requerido
Rango requerido: -9007199254740991 <= x <= 9007199254740991
revokedAmount
integer
requerido
Rango requerido: -9007199254740991 <= x <= 9007199254740991
remainingAmount
integer
requerido
Rango requerido: -9007199254740991 <= x <= 9007199254740991
currency
string
requerido
reason
string
requerido
source
enum<string>
requerido
Opciones disponibles:
dashboard,
api,
plan_change,
migration
expiresAt
string<date-time> | null
requerido
createdAt
string<date-time>
requerido
object
string
requerido
Allowed value: "customer_credit"
livemode
boolean
requerido