Skip to main content
POST
Top up balance
This reference describes API version 2026-07-31. Send Commet-Version: 2026-07-31 with your request.

Authorizations

x-api-key
string
header
required

Headers

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
default:2026-07-31

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

Path Parameters

id
string
required

Body

application/json
amount
integer
required

The amount to add, in minor units of the subscription currency (cents; whole units for zero-decimal currencies).

Required range: x <= 9007199254740991

Response

Success

amount
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
status
enum<string>
required

succeeded when the payment was confirmed and the balance was added. processing when the payment method confirms later: the balance is added once the payment is confirmed, and nothing is added if it is declined.

Available options:
succeeded,
processing
object
string
required
Allowed value: "balance_topup"
livemode
boolean
required