Amount due, cost so far and the estimated bill

GET

https://billing.ezghcloud.com/v1/organizations/{orgId}/billing/summary

View as Markdown

Authorization

apiKeyoptionalHTTP
oauthoptionalHTTP
sessionCookieoptionalAPI key in cookie

Path parameters

orgIdstringrequired
format: uuid

Returns

200

OK

JSON

organizationIdstringrequired
currencystringrequired
amountDueMicrosstringrequired
What's owed on issued invoices, in micros.

pattern: ^-?[0-9]+(\.[0-9]+)?$
costSoFarMicrosstringrequired
The open billing period's charges so far, in micros.

pattern: ^-?[0-9]+(\.[0-9]+)?$
estimatedBillCentsstringrequired
The upcoming invoice's total, in cents.

pattern: ^-?[0-9]+(\.[0-9]+)?$
periodobjectrequired
The open billing period.
3 properties
- startstringrequired
  format: date-time
- endstringrequired
  Exclusive.
  
  format: date-time
- issuesAtstringrequired
  When the period's invoice is issued.
  
  format: date-time
openInvoicesintegerrequired
overdueInvoicesintegerrequired
overdueCentsstringrequired
What's overdue, in cents.

pattern: ^-?[0-9]+(\.[0-9]+)?$

401

unauthenticated: no valid credential.

JSON

errorobjectrequired
3 properties
- codestringrequired
  What went wrong, for programs: branch on this, never on message.
- messagestringrequired
  What went wrong, for people.
- issuesoptionalarray ofobject
  With invalid_request: each invalid field.
  
  2 properties
  pathstringrequired
  messagestringrequired

403

access_denied: the caller isn't allowed to (the message names the action); forbidden_origin: a cookie-authenticated write from another site.

JSON

errorobjectrequired
3 properties
- codestringrequired
  What went wrong, for programs: branch on this, never on message.
- messagestringrequired
  What went wrong, for people.
- issuesoptionalarray ofobject
  With invalid_request: each invalid field.
  
  2 properties
  pathstringrequired
  messagestringrequired

404

not_found: the organization (or one the caller doesn't belong to), or the resource, doesn't exist.

JSON

errorobjectrequired
3 properties
- codestringrequired
  What went wrong, for programs: branch on this, never on message.
- messagestringrequired
  What went wrong, for people.
- issuesoptionalarray ofobject
  With invalid_request: each invalid field.
  
  2 properties
  pathstringrequired
  messagestringrequired

429

too_many_requests: slow down.

JSON

errorobjectrequired
3 properties
- codestringrequired
  What went wrong, for programs: branch on this, never on message.
- messagestringrequired
  What went wrong, for people.
- issuesoptionalarray ofobject
  With invalid_request: each invalid field.
  
  2 properties
  pathstringrequired
  messagestringrequired

500

internal_error: a bug; the details are in the logs, under the request ID.

JSON

errorobjectrequired
3 properties
- codestringrequired
  What went wrong, for programs: branch on this, never on message.
- messagestringrequired
  What went wrong, for people.
- issuesoptionalarray ofobject
  With invalid_request: each invalid field.
  
  2 properties
  pathstringrequired
  messagestringrequired

503

unavailable, ledger_unavailable or payments_unavailable: retry later.

JSON

errorobjectrequired
3 properties
- codestringrequired
  What went wrong, for programs: branch on this, never on message.
- messagestringrequired
  What went wrong, for people.
- issuesoptionalarray ofobject
  With invalid_request: each invalid field.
  
  2 properties
  pathstringrequired
  messagestringrequired

Amount due, cost so far and the estimated bill

curl --request GET \
  --url https://billing.ezghcloud.com/v1/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/billing/summary \
  --header 'Authorization: Bearer <token>'

const url = 'https://billing.ezghcloud.com/v1/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/billing/summary';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

import requests

url = "https://billing.ezghcloud.com/v1/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/billing/summary"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

Response example

{
  "organizationId": "string",
  "currency": "string",
  "amountDueMicros": "string",
  "costSoFarMicros": "string",
  "estimatedBillCents": "string",
  "period": {
    "start": "2019-08-24T14:15:22Z",
    "end": "2019-08-24T14:15:22Z",
    "issuesAt": "2019-08-24T14:15:22Z"
  },
  "openInvoices": 0,
  "overdueInvoices": 0,
  "overdueCents": "string"
}

{
  "error": {
    "code": "string",
    "message": "string",
    "issues": [
      {
        "path": "string",
        "message": "string"
      }
    ]
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "issues": [
      {
        "path": "string",
        "message": "string"
      }
    ]
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "issues": [
      {
        "path": "string",
        "message": "string"
      }
    ]
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "issues": [
      {
        "path": "string",
        "message": "string"
      }
    ]
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "issues": [
      {
        "path": "string",
        "message": "string"
      }
    ]
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "issues": [
      {
        "path": "string",
        "message": "string"
      }
    ]
  }
}