Skip to content
Stashtab Docs
Esc
↑↓navigate↵open⌘Jpreview

Get customer credit

GET/v1/organizations/{orgId}/billing/credit
Authorization
AuthorizationBasic auth · headerrequired

Registered confidential integration credentials. Keep the secret server-side.

or
CookieAPI key · headerrequired

Console-managed Vault session cookie; secure cookie naming may vary by environment.

or
AuthorizationBearer token (Vault organization API key) · headerrequired

Organization-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
orgIdstringrequired
min length 1 · max length 128 · matches ^[A-Za-z0-9_-]+$
Responses
200

Success

dataobjectrequired
Show properties
creditobjectrequired
Show properties
One of:
object
balanceobjectrequired
Show properties
amountintegerrequired
min -9007199254740991 · max 9007199254740991
currencystringrequired
matches ^[A-Z]{3}$
statusstringrequired
object
reasonstringrequired
statusstringrequired
organizationIdstringrequired
min length 1 · max length 128 · matches ^[A-Za-z0-9_-]+$
metaobjectrequired
Show properties
requestIdstringrequired
default

Error

errorobjectrequired
Show properties
codestringrequired
Allowed:forbiddeninternal_errornot_foundprovider_data_invalidprovider_outcome_unknownprovider_unavailablerate_limitedstate_conflictunauthenticatedvalidation_errorwarehouse_not_ready
fieldsobject[]
Show properties
Array of object
codestringrequired
messagestringrequired
pathstringrequired
messagestringrequired
operationIdstring
metaobjectrequired
Show properties
requestIdstringrequired
Request
curl -X GET '/v1/organizations/string/billing/credit' \
  -H 'Authorization: Basic YOUR_CREDENTIALS' \
  -H 'Accept: application/json'
Response
{
  "data": {
    "credit": {
      "balance": {
        "amount": -9007199254740991,
        "currency": "string"
      },
      "status": "known"
    },
    "organizationId": "string"
  },
  "meta": {
    "requestId": "string"
  }
}

Was this page helpful?