Skip to main content
POST
cURL
Top up a subscription’s balance. Charges the customer’s payment method for the specified amount.

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-08-27

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
Required range: x <= 9007199254740991

Response

Success

amount
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
object
string
required
Allowed value: "balance_topup"
livemode
boolean
required