API referenceEndpoints

Apply billing top-up

Requires the dedicated billing service credential. Generated from the production route registered in `internal/features/billing/inbound/http_topups.go`.

POST/v1/billing/topups

Requires the dedicated billing service credential. Generated from the production route registered in internal/features/billing/inbound/http_topups.go.

Authorization

billingToken
AuthorizationBearer <token>

Dedicated platform billing service credential.

In: header

Header Parameters

Idempotency-Key*string

Required, with no length limit enforced; missing is 400. The comparison is byte-for-byte over the raw request body: same key, identical body — the original top-up, unchanged, with an Idempotent-Replayed: true response header; same key, a different body — 409 {"error":{"type":"idempotency_key_reuse","message":"Idempotency-Key was already used with a different request body"}}.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v1/billing/topups" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{}'
{}