Get customer credit
GET
/v1/organizations/{orgId}/billing/creditAuthorization
AuthorizationBasic auth · headerrequiredRegistered confidential integration credentials. Keep the secret server-side.
or
CookieAPI key · headerrequiredConsole-managed Vault session cookie; secure cookie naming may vary by environment.
or
AuthorizationBearer token (Vault organization API key) · headerrequiredOrganization-owned credential with immutable mode and Read-only or Read/write permissions. Only explicitly declared ordinary customer operations accept it. Test business access refuses until shared Test composition is available; no staff, team, key-management or protocol authority is granted.
Path parameters
orgIdstringrequiredmin length 1 · max length 128 · matches ^[A-Za-z0-9_-]+$
Responses
200
Success
dataobjectrequiredShow propertiesHide properties
creditobjectrequiredShow propertiesHide properties
One of:
object
balanceobjectrequiredShow propertiesHide properties
amountintegerrequiredmin -9007199254740991 · max 9007199254740991
currencystringrequiredmatches ^[A-Z]{3}$
statusstringrequiredobject
reasonstringrequiredstatusstringrequiredorganizationIdstringrequiredmin length 1 · max length 128 · matches ^[A-Za-z0-9_-]+$
metaobjectrequiredShow propertiesHide properties
requestIdstringrequireddefault
Error
errorobjectrequiredShow propertiesHide properties
codestringrequiredAllowed:
forbiddeninternal_errornot_foundprovider_data_invalidprovider_outcome_unknownprovider_unavailablerate_limitedstate_conflictunauthenticatedvalidation_errorwarehouse_not_readyfieldsobject[]Show propertiesHide properties
Array of
objectcodestringrequiredmessagestringrequiredpathstringrequiredmessagestringrequiredoperationIdstringmetaobjectrequiredShow propertiesHide properties
requestIdstringrequired