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

Get the current billing period

GET/v1/organizations/{orgId}/billing/current-period
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
asOfstring<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))$
currencystringrequired
matches ^[A-Z]{3}$
chargesobjectrequired
Show properties
reasonstringrequired
statusstringrequired
creditobjectrequired
Show properties
One of:
object
balanceobjectrequired
Show properties
amountintegerrequired
min -9007199254740991 · max 9007199254740991
currencystringrequired
matches ^[A-Z]{3}$
statusstringrequired
object
reasonstringrequired
statusstringrequired
openBillobjectrequired
Show properties
One of:
object
amountsobjectrequired
Show properties
amountDueintegerrequired
min -9007199254740991 · max 9007199254740991
amountRemainingintegerrequired
min -9007199254740991 · max 9007199254740991
currencystringrequired
matches ^[A-Z]{3}$
subtotalintegerrequired
min -9007199254740991 · max 9007199254740991
totalintegerrequired
min -9007199254740991 · max 9007199254740991
basisstringrequired
invoiceIdstringrequired
max length 255 · matches ^in_[A-Za-z0-9_]+$
stagestringrequired
object
amountsobjectrequired
Show properties
amountDueintegerrequired
min -9007199254740991 · max 9007199254740991
amountRemainingintegerrequired
min -9007199254740991 · max 9007199254740991
currencystringrequired
matches ^[A-Z]{3}$
subtotalintegerrequired
min -9007199254740991 · max 9007199254740991
totalintegerrequired
min -9007199254740991 · max 9007199254740991
basisstringrequired
invoiceIdstringrequired
max length 255 · matches ^in_[A-Za-z0-9_]+$
stagestringrequired
statusstringrequired
Allowed:openpaiduncollectiblevoid
object
amountsobjectrequired
Show properties
amountDueintegerrequired
min -9007199254740991 · max 9007199254740991
amountRemainingintegerrequired
min -9007199254740991 · max 9007199254740991
currencystringrequired
matches ^[A-Z]{3}$
subtotalintegerrequired
min -9007199254740991 · max 9007199254740991
totalintegerrequired
min -9007199254740991 · max 9007199254740991
basisstringrequired
stagestringrequired
object
reasonstringrequired
Allowed:ambiguous_invoicecurrency_mismatchinvoice_scan_incompleteno_upcoming_invoiceno_verified_periodno_verified_subscriptionunrecognized_invoice_stateupcoming_period_mismatch
stagestringrequired
organizationIdstringrequired
min length 1 · max length 128 · matches ^[A-Za-z0-9_-]+$
pendingItemsobjectrequired
Show properties
One of:
object
amountobjectrequired
Show properties
amountintegerrequired
min -9007199254740991 · max 9007199254740991
currencystringrequired
matches ^[A-Z]{3}$
itemCountintegerrequired
min 0 · max 9007199254740991
statusstringrequired
object
reasonstringrequired
Allowed:currency_mismatchother_subscriptionscan_incomplete
statusstringrequired
periodobjectrequired
Show properties
One of:
object
endDatestring<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])))$
endsAtstring<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))$
idstringrequired
min length 1 · max length 128 · matches ^[A-Za-z0-9_-]+$
startDatestring<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])))$
startsAtstring<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))$
statusstringrequired
object
reasonstringrequired
Allowed:ambiguous_periodbinding_mismatchno_verified_period
statusstringrequired
serviceDatestring<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])))$
totalobjectrequired
Show properties
incompleteComponentsstring[]required
min items 1
statusstringrequired
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/current-period' \
  -H 'Authorization: Basic YOUR_CREDENTIALS' \
  -H 'Accept: application/json'
Response
{
  "data": {
    "asOf": "2019-08-24T14:15:22Z",
    "currency": "string",
    "charges": {
      "reason": "charges_not_available",
      "status": "incomplete"
    },
    "credit": {
      "balance": {
        "amount": -9007199254740991,
        "currency": "string"
      },
      "status": "known"
    },
    "openBill": {
      "amounts": {
        "amountDue": -9007199254740991,
        "amountRemaining": -9007199254740991,
        "currency": "string",
        "subtotal": -9007199254740991,
        "total": -9007199254740991
      },
      "basis": "known",
      "invoiceId": "string",
      "stage": "draft"
    },
    "organizationId": "string",
    "pendingItems": {
      "amount": {
        "amount": -9007199254740991,
        "currency": "string"
      },
      "itemCount": 0,
      "status": "known"
    },
    "period": {
      "endDate": "2019-08-24",
      "endsAt": "2019-08-24T14:15:22Z",
      "id": "string",
      "startDate": "2019-08-24",
      "startsAt": "2019-08-24T14:15:22Z",
      "status": "verified"
    },
    "serviceDate": "2019-08-24",
    "total": {
      "incompleteComponents": [
        "charges"
      ],
      "status": "incomplete"
    }
  },
  "meta": {
    "requestId": "string"
  }
}

Was this page helpful?