POST
/
credits
/
{credit_id}
/
void

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

credit_id
string
required

Response

200 - application/json

Payload to grant Credits

accountId
string
required
createdAt
string
required
customerId
string
required
effectiveFrom
string
required
id
string
required

Identifier of credits

Maximum length: 50
priority
integer
required
purpose
string
required
status
enum<string>
required
Available options:
ACTIVE,
CONSUMED,
EXPIRED,
VOIDED
applicableEntityIds
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

consumedAmount
number
creditAmount
number
creditUnit
string
effectiveUntil
string
grantorId
string

The entity through which the credit has been granted

holdAmount
number
idempotencyKey
string

The idempotency key for uniqueness of the credit record

updatedAt
string