Credits
Void credit
Void credit
POST
/
credits
/
{credit_id}
/
void
Authorizations
Authorization
string
headerrequiredBearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
credit_id
string
requiredResponse
200 - application/json
accountId
string
requiredpurpose
string
requiredapplicableEntityIds
string[]
List of entity ids for which the credit is applicable. If null or empty, the credit is applicable to all ids. This list can accept special values like: - ALL_USAGE_METER_RATE_CARDS: To apply the credit to all usage meter rate cards - ALL_FIXED_FEE_RATE_CARDS: To apply the credit to all fixed fee rate cards
effectiveFrom
string
requiredeffectiveUntil
string
creditAmount
number
priority
integer
requiredgrantorId
string
The entity through which the credit has been granted
idempotencyKey
string
The idempotency key for uniqueness of the credit record
id
string
requiredIdentifier of credits
customerId
string
requiredstatus
enum<string>
requiredAvailable options:
ACTIVE
, CONSUMED
, EXPIRED
, VOIDED
creditUnit
string
holdAmount
number
consumedAmount
number
createdAt
string
requiredupdatedAt
string