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

Get a customer charge

GET/v1/organizations/{orgId}/billing/charges/{chargeId}
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
chargeIdstringrequired
min length 1 · max length 128 · matches ^[A-Za-z0-9_-]+$
orgIdstringrequired
min length 1 · max length 128 · matches ^[A-Za-z0-9_-]+$
Responses
200

Success

dataobjectrequired
Show properties
amountintegerrequired
min -9007199254740991 · max 9007199254740991
billedQuantitystring | nullrequired
billedTimeobject | nullrequired
Show properties
Any of:
object
billedMinutesintegerrequired
min 0 · max 9007199254740991
incrementMinutesintegerrequired
min 1 · max 9007199254740991
recordedMinutesintegerrequired
min 0 · max 9007199254740991
null
null
currencystringrequired
matches ^[A-Z]{3}$
customerServiceIdstringrequired
min length 1 · max length 128 · matches ^[A-Za-z0-9_-]+$
currentRevisionintegerrequired
max 9007199254740991
idstringrequired
min length 1 · max length 128 · matches ^[A-Za-z0-9_-]+$
originalServiceDatestring<date>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])))$
revisionsobject[]required
Show properties
Array of object
amountintegerrequired
min -9007199254740991 · max 9007199254740991
correctionKindstringrequired
Allowed:originalcorrected_totaldifferencecredit
currencystringrequired
matches ^[A-Z]{3}$
recordedAtstring<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))$
revisionintegerrequired
max 9007199254740991
servicePeriodIdstring | nullrequired
Show properties
Any of:
string
string
null
null
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/charges/string' \
  -H 'Authorization: Basic YOUR_CREDENTIALS' \
  -H 'Accept: application/json'
Response
{
  "data": {
    "amount": -9007199254740991,
    "billedQuantity": "string",
    "billedTime": {
      "billedMinutes": 0,
      "incrementMinutes": 1,
      "recordedMinutes": 0
    },
    "currency": "string",
    "customerServiceId": "string",
    "currentRevision": 1,
    "id": "string",
    "originalServiceDate": "2019-08-24",
    "revisions": [
      {
        "amount": -9007199254740991,
        "correctionKind": "original",
        "currency": "string",
        "recordedAt": "2019-08-24T14:15:22Z",
        "revision": 1
      }
    ],
    "servicePeriodId": "string"
  },
  "meta": {
    "requestId": "string"
  }
}

Was this page helpful?