Skip to main content
POST
Revoke remaining customer credit
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
creditId
string
required

Response

Success

id
string
required
remainingAmount
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
revokedAmount
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
currency
string
required
object
string
required
Allowed value: "customer_credit"
livemode
boolean
required