Skip to main content
POST
Charge credits

Authorizations

Authorization
string
header
required

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

Body

application/json
credits
number
required

Number of credits to charge

Required range: x >= 1
Example:

5

creditFor
enum<string>
required

What the credits are being charged for

Available options:
SMS,
CAL_AI_PHONE_CALL,
AI_AGENT
Example:

"AI_AGENT"

externalRef
string

Unique external reference for idempotency

Example:

"agent-thread-123-1711432800000"

Response

200 - application/json

The response is of type object.