Skip to main content
POST
cURL
Adjust a subscription’s balance or credits by a signed amount. Positive adds, negative subtracts.

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
Rango requerido: -9007199254740991 <= x <= 9007199254740991
reason
string
type
enum<string>
predeterminado:balance
Opciones disponibles:
credits,
balance

Respuesta

Success

amount
integer
requerido
Rango requerido: -9007199254740991 <= x <= 9007199254740991
newBalance
integer
requerido
Rango requerido: -9007199254740991 <= x <= 9007199254740991
reason
string | null
requerido
object
string
requerido
Allowed value: "balance_transaction"
livemode
boolean
requerido