Billing

Get usage of the tenant for specific region

Fetch usage of a tenant in specific date range for a specific region. If no query parameters are specified, usage from start date of the month to current date is returned.

Note: This API is not applicable for system tenants.

get/_api/billing/region/{region}/usage

Request

The document declares no server URL.
Auth
- API key in header Authorization
- or HTTP bearer
TypeScript
https://skmtc.dev/macrometa/apis/macrometa-api-reference/docs/_api/billing/region/:region/usage/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

regionstring string required

Name of the region.

Query parameters

startDatestring string

Start date in 'YYYY-MM-DD' format.

endDatestring string

End date in 'YYYY-MM-DD' format.

Headers

tenantstring string

Tenant name. If not set it uses the tenant invoking the request.

Response

Successfully fetched usage of tenant.

codeinteger

HTTP response code.

errorboolean

Flag if there is an error in response. False for this response.

Example response

{
  "code": 200,
  "data": [
    {
      "_key": "key",
      "tenant": "tenant1",
      "region": "region1"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.