GetBillingDimensionMapping
Retrieve billing dimension mappings for supported usage metering API endpoints. Specify active or all mappings with optional month filters, updated monthly for parent-level organizations.
Instructions
Get a mapping of billing dimensions to the corresponding keys for the supported usage metering public API endpoints. Mapping data is updated on a monthly cadence.
This endpoint is only accessible to parent-level organizations.
Query Parameters:
filter[month]: Datetime in ISO-8601 format, UTC, and for mappings beginning this month. Defaults to the current month.
filter[view]: String to specify whether to retrieve active billing dimension mappings for the contract or for all available mappings. Allowed views have the string
activeorall. Defaults toactive.
Responses:
200 (Success): OK
Content-Type:
application/json;datetime-format=rfc3339Response Properties:
Example:
400: Bad Request
Content-Type:
application/json;datetime-format=rfc3339Response Properties:
errors: A list of errors.
Example:
403: Forbidden - User is not authorized
Content-Type:
application/json;datetime-format=rfc3339Response Properties:
errors: A list of errors.
Example:
429: Too many requests
Content-Type:
application/json;datetime-format=rfc3339Response Properties:
errors: A list of errors.
Example:
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| filter[month] | No | Datetime in ISO-8601 format, UTC, and for mappings beginning this month. Defaults to the current month. | |
| filter[view] | No | String to specify whether to retrieve active billing dimension mappings for the contract or for all available mappings. Allowed views have the string `active` or `all`. Defaults to `active`. | active |