The prices in force, per SKU

GET

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

View as Markdown

Authorization

apiKeyoptionalHTTP
oauthoptionalHTTP
sessionCookieoptionalAPI key in cookie

Path parameters

orgIdstringrequired
format: uuid

Query parameters

serviceoptionalstring
regionoptionalstring
Global (*) SKUs are always included.
atoptionalstring
A date or UTC time; default now.

Returns

200

OK

JSON

organizationIdstringrequired
currencystringrequired
atstringrequired
format: date-time
priceBookobjectornullrequired
Null when no price book is in force yet.
2 variants
One of the following:
object
null
pricesarray ofobjectrequired
17 properties
- skustringrequired
- servicestringrequired
- serviceNamestringrequired
- meterstringrequired
- meterNamestringrequired
- regionstringrequired
  A region, or * for global SKUs.
- displayNamestringrequired
- dimensionsmap ofstringrequired
- modelstringrequired
  flat, graduated or volume.
- unitstringrequired
- perstringrequired
  unitPrice is per this many of unit.
  
  pattern: ^-?[0-9]+(\.[0-9]+)?$
- displayUnitstringrequired
  per of unit, in words: hour, GB-hour, million requests.
- tiersarray ofobjectrequired
  3 properties
  upTostring | nullrequired
  In unit; null for the last tier.
  
  upToDisplaystring | nullrequired
  In display units; null for the last tier.
  
  unitPricestringrequired
  Dollars per displayUnit.
  
  pattern: ^-?[0-9]+(\.[0-9]+)?$
- accumulatorstringrequired
  SKUs sharing it count together toward tiers and the free allowance.
- freeQuantitystringrequired
  Free each billing period, in unit.
  
  pattern: ^-?[0-9]+(\.[0-9]+)?$
- freeQuantityDisplaystringrequired
- freePeriodbilling_periodrequired

400

invalid_request: the request is malformed (with issues), or invalid_cursor.

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

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

The prices in force, per SKU

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

const url = 'https://billing.ezghcloud.com/v1/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/pricing';
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/pricing"

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

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

print(response.text)

Response example

{
  "organizationId": "string",
  "currency": "string",
  "at": "2019-08-24T14:15:22Z",
  "priceBook": {
    "book": "string",
    "version": 0,
    "effectiveFrom": "2019-08-24T14:15:22Z"
  },
  "prices": [
    {
      "sku": "string",
      "service": "string",
      "serviceName": "string",
      "meter": "string",
      "meterName": "string",
      "region": "string",
      "displayName": "string",
      "dimensions": {
        "property1": "string",
        "property2": "string"
      },
      "model": "string",
      "unit": "string",
      "per": "string",
      "displayUnit": "string",
      "tiers": [
        {
          "upTo": "string",
          "upToDisplay": "string",
          "unitPrice": "string"
        }
      ],
      "accumulator": "string",
      "freeQuantity": "string",
      "freeQuantityDisplay": "string",
      "freePeriod": "billing_period"
    }
  ]
}

{
  "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"
      }
    ]
  }
}

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