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

List credit transactions

GET/v1/organizations/{orgId}/billing/credit/transactions
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_-]+$
Query parameters
cursorstring
min length 1 · max length 2048
limitinteger
min 1 · max 100 · default: 50
Responses
200

Success

dataobject[]required
Show properties
Array of object
amountintegerrequired
min -9007199254740991 · max 9007199254740991
createdAtstring<date-time>required
matches ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
creditNoteIdstring | nullrequired
currencystringrequired
matches ^[A-Z]{3}$
endingCreditintegerrequired
min -9007199254740991 · max 9007199254740991
idstringrequired
invoiceIdstring | nullrequired
typestringrequired
Allowed:adjustmentapplied_to_invoicecredit_noteinitialinvoice_overpaidinvoice_too_largeinvoice_too_smallmigrationunapplied_from_invoiceunspent_receiver_creditother
metaobjectrequired
Show properties
requestIdstringrequired
nextCursorstring | nullrequired
previousCursorstring | nullrequired
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/transactions' \
  -H 'Authorization: Basic YOUR_CREDENTIALS' \
  -H 'Accept: application/json'
Response
{
  "data": [
    {
      "amount": -9007199254740991,
      "createdAt": "2019-08-24T14:15:22Z",
      "creditNoteId": "string",
      "currency": "string",
      "endingCredit": -9007199254740991,
      "id": "string",
      "invoiceId": "string",
      "type": "adjustment"
    }
  ],
  "meta": {
    "requestId": "string",
    "nextCursor": "string",
    "previousCursor": "string"
  }
}

Was this page helpful?