logo-darkPipe0
Credits

Get credit balance

Get the credits your organization has left. The API key tells pipe0 which organization you mean, so the request takes no parameters. A production run is refused before it starts when its estimated cost meets or exceeds this balance. Sandbox runs don't use credits.

balance is the total you can spend. purchased_balance is the part of it you bought as one-off credit purchases. Plan credits are spent first.

GET
/v1/credit-balance

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/v1/credit-balance"
{  "balance": 0,  "purchased_balance": 0}
{  "type": "invalid-input",  "title": "Invalid Input",  "status": 400,  "detail": "Name must be a string"}
{  "type": "invalid-input",  "title": "Invalid Input",  "status": 400,  "detail": "Name must be a string"}