usage
Get credits
The current balance plus each grant with its remaining amount and expiry.
GET/v1/credits
Requires account:read. Costs nothing.
Authorizations
Authorizationbearerin headerrequired
Retrieve the credit balance and every grant
dataobjectrequired
Show child attributes
data.balanceintegerrequiredrange: -9007199254740991–9007199254740991
data.grantsobject[]required
Show child attributes
data.grants.idstringrequired
data.grants.typestringrequired
data.grants.amountintegerrequiredrange: -9007199254740991–9007199254740991
data.grants.usedintegerrequiredrange: -9007199254740991–9007199254740991
data.grants.remainingintegerrequiredrange: -9007199254740991–9007199254740991
data.grants.granted_atstringnullrequired
data.grants.expires_atstringnullrequired
Possible codes: invalid_request, unknown_field, invalid_parameter, invalid_cursor
errorobjectrequired
Show child attributes
error.messagestringrequired
error.docs_urlstringrequired
error.action_urlstring<uri>
error.detailsRecord<string, object>
Possible codes: authentication_required, invalid_api_key, api_key_expired, api_key_revoked
errorobjectrequired
Show child attributes
error.messagestringrequired
error.docs_urlstringrequired
error.action_urlstring<uri>
error.detailsRecord<string, object>
Possible codes: insufficient_credits
errorobjectrequired
Show child attributes
error.messagestringrequired
error.docs_urlstringrequired
error.action_urlstring<uri>
error.detailsRecord<string, object>
Possible codes: insufficient_scope, feature_not_available, admin_required
errorobjectrequired
Show child attributes
error.messagestringrequired
error.docs_urlstringrequired
error.action_urlstring<uri>
error.detailsRecord<string, object>
Possible codes: resource_not_found
errorobjectrequired
Show child attributes
error.messagestringrequired
error.docs_urlstringrequired
error.action_urlstring<uri>
error.detailsRecord<string, object>
Possible codes: conflict, result_not_ready, idempotency_key_reused
errorobjectrequired
Show child attributes
error.messagestringrequired
error.docs_urlstringrequired
error.action_urlstring<uri>
error.detailsRecord<string, object>
Possible codes: result_expired
errorobjectrequired
Show child attributes
error.messagestringrequired
error.docs_urlstringrequired
error.action_urlstring<uri>
error.detailsRecord<string, object>
Possible codes: request_too_large
errorobjectrequired
Show child attributes
error.messagestringrequired
error.docs_urlstringrequired
error.action_urlstring<uri>
error.detailsRecord<string, object>
Possible codes: request_too_large_for_plan
errorobjectrequired
Show child attributes
error.messagestringrequired
error.docs_urlstringrequired
error.action_urlstring<uri>
error.detailsRecord<string, object>
Possible codes: rate_limited
errorobjectrequired
Show child attributes
error.messagestringrequired
error.docs_urlstringrequired
error.action_urlstring<uri>
error.detailsRecord<string, object>
Possible codes: internal_error
errorobjectrequired
Show child attributes
error.messagestringrequired
error.docs_urlstringrequired
error.action_urlstring<uri>
error.detailsRecord<string, object>
Possible codes: service_unavailable
errorobjectrequired
Show child attributes
error.messagestringrequired
error.docs_urlstringrequired
error.action_urlstring<uri>
error.detailsRecord<string, object>