openapi: 3.0.1
info:
title: m3ter Account StatementDefinition API
description: "If you are using Postman, you can:\n- Use the **Download** button above to download the m3ter Open API spec JSON file and then import this file as the **m3ter API Collection** into your Workspace. See [Importing the m3ter Open API](https://www.m3ter.com/docs/guides/m3ter-apis/getting-started-with-api-calls#importing-the-m3ter-open-api) in our main user Documentation for details.\n- Copy this link: [m3ter-Template API Collection](https://www.datocms-assets.com/78893/1672846767-m3ter-template-api-collection-postman_collection.json) and use it to import the **m3ter-Template API Collection** into your Workspace. See [Importing the m3ter Template API Collection](https://www.m3ter.com/docs/guides/m3ter-apis/getting-started-with-api-calls#importing-the-m3ter-template-api-collection) in our main user Documentation for details.\n\n---\n\n# Introduction\nThe m3ter platform supports two HTTP-based REST APIs returning JSON encoded responses:\n- The **Ingest API**, which you can use for submitting raw data measurements. *(See the [Submit Measurements](https://www.m3ter.com/docs/api#tag/Measurements/operation/SubmitMeasurements) endpoint in this API Reference.)*\n- The **Config API**, which you can use for configuration and management. *(All other endpoints in this API Reference.)* \n\n## Authentication and Authorization\nOur APIs use an industry-standard authorization protocol known as the OAuth 2.0 specification.\n\nOAuth2 supports several grant types, each designed for a specific use case. m3ter uses the following two grant types:\n - **Authorization Code**: Used for human login access via the m3ter Console.\n - **Client Credentials**: Used for machine-to-machine communication and API access.\n\nComplete the following flow for API access:\n\n1. **Create a Service User and add Permissions**: Log in to the m3ter Console, go to **Settings**, **Access** then **Service Users** tab, and create a Service User. To enable API calls, grant the user **Administrator** permissions. \n \n2. **Generate Access Keys**: In the Console, open the *Overview* page for the Service User by clicking on the name. Generate an **Access Key id** and **Api Secret**. Make sure you copy the **Api Secret** because it is only visible at the time of creation. \n\nSee [Service Authentication](https://www.m3ter.com/docs/guides/authenticating-with-the-platform/service-authentication) for detailed instructions and an example.\n\n3. **Obtain a Bearer Token using Basic Auth**: We implement the OAuth 2.0 Client Credentials Grant authentication flow for Service User Authentication. Submit a request to the m3ter OAuth Client Credentials authentication flow, using your concatenated **Access Key id** and **Api Secret** to obtain a Bearer Token for your Service User. *See examples below.* \n \n4. **Bearer Token Usage**: Use the HTTP 'Authorization' header with the bearer token to authorise all subsequent API requests. \n\n> Warning: The Bearer Token is valid for 18,000 seconds or 5 hours. When the token has expired, you must obtain a new one.\n\nBelow are two examples for obtaining a Bearer Token using Basic Auth: the first in cURL and the second as a Python script. \n\n### cURL Example\n1. Open your terminal or command prompt. \n2. Use the following `cURL` command to obtain a Bearer Token:\n\n```bash\ncurl -X POST https://api.m3ter.com/oauth/token \\\n -H 'Content-Type: application/x-www-form-urlencoded' \\\n -u your_access_key_id:your_api_secret \\\n -d 'grant_type=client_credentials'\n```\n\nReplace `your_access_key_id` and `your_api_secret` with your actual **Access Key id** and **Api Secret**.\n\n3. Run the command, and if successful, it will return a JSON response containing the Bearer Token. The response will look like this:\n\n```json\n{\n \"access_token\": \"your_bearer_token\",\n \"token_type\": \"Bearer\",\n \"expires_in\": 18000\n}\n```\n\nYou can then use the Bearer Token *(the value of `\"access_token\"`)* for subsequent API calls to m3ter.\n\n### Python Example\n1. Install the `requests` library if you haven't already:\n\n```bash\npip install requests\n```\n\n2. Use the following Python script to obtain a Bearer Token:\n\n```python\nimport requests\nimport base64\n\n# Replace these with your Access Key id and Api Secret\naccess_key_id = 'your_access_key_id'\napi_secret = 'your_api_secret'\n\n# Encode the Access Key id and Api Secret in base64 format\ncredentials = base64.b64encode(f'{access_key_id}:{api_secret}'.encode('utf-8')).decode('utf-8')\n\n# Set the m3ter token endpoint URL\ntoken_url = 'https://api.m3ter.com/oauth/token'\n\n# Set the headers for the request\nheaders = {\n 'Authorization': f'Basic {credentials}',\n 'Content-Type': 'application/x-www-form-urlencoded'\n}\n\n# Set the payload for the request\npayload = {\n 'grant_type': 'client_credentials'\n}\n\n# Send the request to obtain the Bearer Token\nresponse = requests.post(token_url, headers=headers, data=payload)\n\n# Check if the request was successful\nif response.status_code == 200:\n # Extract the Bearer Token from the response\n bearer_token = response.json()['access_token']\n print(f'Bearer Token: {bearer_token}')\nelse:\n print(f'Error: {response.status_code} - {response.text}')\n```\n\nReplace `your_access_key_id` and `your_api_secret` with your actual **Access Key id** and **Api Secret**. \n\n3. Run the script, and if successful, it will print the Bearer Token. You can then use this Bearer Token for subsequent API calls to m3ter.\n\n## Submitting Personally Identifiable Information (PII)\n**IMPORTANT!** Under the [Data Processing Agreement](https://www.m3ter.com/docs/legal/dpa), the only fields permissible for use in submitting any of your end-customer PII data in m3ter are the ``name``, ``address``, and ``emailAddress`` fields on the **Account** entity - see the details for [Create Account](https://www.m3ter.com/docs/api#operation/PostAccount). See also section 4.2 of the [Terms of Service](https://www.m3ter.com/docs/legal/terms-of-service).\n\n## Rate and Payload Limits\n### Config API Request Rate Limits\nSee [Config API Limits](https://www.m3ter.com/docs/guides/m3ter-apis/config-api-limits).\n\n### Data Explorer API Request Rate Limits\nSee [Data Explorer Request Rate Limits](https://www.m3ter.com/docs/guides/m3ter-apis/config-api-limits#date-explorer-request-rate-limits).\n\n### Ingest API Request Rate and Payload Limits\nSee [Ingest API Limits](https://www.m3ter.com/docs/guides/m3ter-apis/ingest-api-limits) for more information.\n\n## Pagination\n**List Endpoints**\nAPI endpoints that have a List resources request support cursor-based pagination - for example, the `List Accounts` request. These List calls support pagination by taking the two parameters `pageSize` and `nextToken`. \n\nThe response of a List API call is a single page list. If the `nextToken` parameter is not supplied, the first page returned contains the newest objects chronologically. Specify a `nextToken` to retrieve the page of older objects that occur immediately after the last object on the previous page.\n\nUse `pageSize` to limit the list results per page, typically this allows up to a maximum of 100 or 200 per page.\n\n**Search Endpoints**\nAPI endpoints that have a Search resources request support cursor-based pagination - for example, the `Search Accounts` request. These Search calls support pagination by taking the two parameters `pageSize` and `fromDocument`.\n\nThe response of a Search API call is a single page list. If the `fromDocument` parameter is not supplied, the first page returned contains the newest objects chronologically. Specify a `fromDocument` to retrieve the page of older objects that occur immediately after the last object on the previous page.\n\nUse `pageSize` to limit the list results per page, typically this allows up to a maximum of 100 or 200 per page. Default is 10.\n\n## API Quick Start\nSee [Getting Started with API Calls](https://www.m3ter.com/docs/guides/m3ter-apis/getting-started-with-api-calls) for detailed guidance on how to use our API to:\n* Create a Service User and add permissions.\n* Generate access keys for the Service User.\n* Use basic authentication to obtain a Bearer Token.\n\nFor further guidance, also see [Creating and Configuring Service Users](https://www.m3ter.com/docs/guides/organization-and-access-management/managing-users/creating-and-configuring-service-users).\n\n## Other Languages\nIf you want to work with the m3ter REST APIs using other languages such as:\n* Python\n* JavaScript\n* C++\n\nPlease see the [Developer Tools](https://www.m3ter.com/docs/guides/developer-tools) topic in our main documentation for information about available SDKs.\n\n\n# Authentication\n<!-- ReDoc-Inject: <security-definitions> -->"
version: '1.0'
x-logo:
url: https://console.m3ter.com/m3ter-logo-black.svg
servers:
- url: https://api.m3ter.com
security:
- OAuth2: []
tags:
- name: StatementDefinition
description: 'Endpoints for listing, creating, updating, retrieving, or deleting Statement Definitions.
Bill statements are informative backing sheets to invoices. They provide a breakdown of the usage charges that appear on the bill, helping your end customers better understand those charges, and gain a clearer picture of their usage over the billing period.
Statement Definitions specify the way billed usage will be aggregated and compiled in the Statement. For example, if you are billing customers monthly, you might want to breakdown the usage responsible for the monthly charge on a Bill into weekly portions in Bill statements.'
paths:
/organizations/{orgId}/statementdefinitions/{id}:
get:
tags:
- StatementDefinition
summary: Retrieve StatementDefinition
description: 'Retrieve a StatementDefinition with the given UUID.
Retrieves the details of a specific StatementDefinition for the specified Organization, using its unique identifier (UUID). This endpoint is useful when you want to retrieve the complete details of a single StatementDefinition.'
operationId: GetStatementDefinition
parameters:
- name: orgId
in: path
description: The unique identifier (UUID) of your Organization. The Organization represents your company as a direct customer of our service.
required: true
style: simple
explode: false
schema:
type: string
deprecated: true
x-stainless-deprecation-message: the org id should be set at the client level instead
- name: id
in: path
description: The unique identifier (UUID) of the StatementDefinition to retrieve.
required: true
style: simple
explode: false
schema:
type: string
responses:
'200':
description: Returns the StatementDefinition
content:
application/json:
schema:
$ref: '#/components/schemas/StatementDefinitionResponse'
4XX:
$ref: '#/components/responses/Error'
5XX:
$ref: '#/components/responses/Error'
put:
tags:
- StatementDefinition
summary: Update StatementDefinition
description: 'Update StatementDefinition for the given UUID.
Update the details of a specific StatementDefinition for the specified Organization, using its unique identifier (UUID). The updated details for the StatementDefinition should be sent in the request body. '
operationId: PutStatementDefinition
parameters:
- name: orgId
in: path
description: The unique identifier (UUID) of your Organization. The Organization represents your company as a direct customer of our service.
required: true
style: simple
explode: false
schema:
type: string
deprecated: true
x-stainless-deprecation-message: the org id should be set at the client level instead
- name: id
in: path
description: ''
required: true
style: simple
explode: false
schema:
type: string
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/StatementDefinitionRequest'
required: true
responses:
'200':
description: Returns the updated StatementDefinition
content:
application/json:
schema:
$ref: '#/components/schemas/StatementDefinitionResponse'
4XX:
$ref: '#/components/responses/Error'
5XX:
$ref: '#/components/responses/Error'
delete:
tags:
- StatementDefinition
summary: Delete StatementDefinition
description: 'Delete a StatementDefinition with the given UUID.
This endpoint deletes a specific StatementDefinition within a specified Organization, using the StatementDefinition UUID.'
operationId: DeleteStatementDefinition
parameters:
- name: orgId
in: path
description: The unique identifier (UUID) of your Organization. The Organization represents your company as a direct customer of our service.
required: true
style: simple
explode: false
schema:
type: string
deprecated: true
x-stainless-deprecation-message: the org id should be set at the client level instead
- name: id
in: path
description: The unique identifier (UUID) of the StatementDefinition to delete.
required: true
style: simple
explode: false
schema:
type: string
responses:
'200':
description: Returns the deleted StatementDefinition
content:
application/json:
schema:
$ref: '#/components/schemas/StatementDefinitionResponse'
4XX:
$ref: '#/components/responses/Error'
5XX:
$ref: '#/components/responses/Error'
/organizations/{orgId}/statementdefinitions:
get:
tags:
- StatementDefinition
summary: List StatementDefinitions
description: 'Retrieve a list of StatementDefinitions.
This endpoint retrieves a list of all the StatementDefinitions within a specified Organization. The list can be paginated for easier management.'
operationId: ListStatementDefinitions
parameters:
- name: orgId
in: path
description: The unique identifier (UUID) of your Organization. The Organization represents your company as a direct customer of our service.
required: true
style: simple
explode: false
schema:
type: string
deprecated: true
x-stainless-deprecation-message: the org id should be set at the client level instead
- name: pageSize
in: query
description: Specifies the maximum number of StatementDefinitions to retrieve per page.
required: false
allowEmptyValue: true
style: form
explode: true
schema:
maximum: 100
minimum: 1
type: integer
format: int32
- name: nextToken
in: query
description: The `nextToken` for multi-page retrievals. It is used to fetch the next page of StatementDefinitions in a paginated list.
required: false
allowEmptyValue: true
style: form
explode: true
schema:
type: string
responses:
'200':
description: Returns the list of requested StatementDefinitions
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedStatementDefinitionResponseData'
4XX:
$ref: '#/components/responses/Error'
5XX:
$ref: '#/components/responses/Error'
post:
tags:
- StatementDefinition
summary: Create StatementDefinition
description: 'Create a new StatementDefinition.
This endpoint creates a new StatementDefinition within the specified Organization. The details of the StatementDefinition are provided in the request body.'
operationId: PostStatementDefinition
parameters:
- name: orgId
in: path
description: The unique identifier (UUID) of your Organization. The Organization represents your company as a direct customer of our service.
required: true
style: simple
explode: false
schema:
type: string
deprecated: true
x-stainless-deprecation-message: the org id should be set at the client level instead
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/StatementDefinitionRequest'
required: true
responses:
'200':
description: Returns the created StatementDefinition
content:
application/json:
schema:
$ref: '#/components/schemas/StatementDefinitionResponse'
4XX:
$ref: '#/components/responses/Error'
5XX:
$ref: '#/components/responses/Error'
components:
schemas:
StatementDefinitionResponse:
type: object
description: ''
allOf:
- $ref: '#/components/schemas/AbstractResponse'
- properties:
id:
type: string
description: 'The unique identifier (UUID) of the StatementDefinition. '
name:
type: string
description: Descriptive name for the StatementDefinition providing context and information.
version:
type: integer
description: The version number. Default value when newly created is one.
format: int64
x-stainless-terraform-configurability: computed
x-stainless-terraform-always-send: true
aggregationFrequency:
description: This specifies how often the Statement should aggregate data.
$ref: '#/components/schemas/AggregationFrequency'
includePricePerUnit:
type: boolean
description: 'A Boolean indicating whether to include the price per unit in the Statement.
* TRUE - includes the price per unit.
* FALSE - excludes the price per unit.'
dimensions:
type: array
description: An array of objects, each representing a Dimension data field from a Meter *(for Meters that have Dimensions setup)*.
items:
$ref: '#/components/schemas/Dimension'
measures:
type: array
description: An array of objects, each representing a Measure data field from a Meter.
items:
$ref: '#/components/schemas/Measure'
generateSlimStatements:
type: boolean
description: ''
dtCreated:
type: string
description: The date and time *(in ISO-8601 format)* when the StatementDefinition was created.
format: date-time
x-stainless-skip:
- terraform
dtLastModified:
type: string
description: The date and time *(in ISO-8601 format)* when the StatementDefinition was last modified.
format: date-time
x-stainless-skip:
- terraform
createdBy:
type: string
description: The unique identifier (UUID) of the user who created this StatementDefinition.
x-stainless-skip:
- terraform
lastModifiedBy:
type: string
description: The unique identifier (UUID) of the user who last modified this StatementDefinition.
x-stainless-skip:
- terraform
Measure:
type: object
properties:
meterId:
type: string
description: The unique identifier (UUID) of the Meter containing this Measure.
name:
type: string
description: The name of a Measure data field *(or blank to indicate a wildcard, i.e. all fields)*. Default value is blank.
aggregations:
maxItems: 7
type: array
description: A list of Aggregations to apply to the Measure.
items:
$ref: '#/components/schemas/Aggregation'
description: ''
AggregationFrequency:
type: string
description: This specifies how often the data should be aggregated.
enum:
- DAY
- WEEK
- MONTH
- QUARTER
- YEAR
- WHOLE_PERIOD
Dimension:
required:
- filter
- name
type: object
properties:
meterId:
type: string
description: The unique identifier (UUID) of the Meter containing this Dimension.
name:
minLength: 1
type: string
description: The name of the Dimension to target in the Meter.
attributes:
type: array
description: The Dimension attribute to target.
items:
type: string
filter:
minItems: 1
type: array
description: The value of a Dimension to use as a filter. Use "*" as a wildcard to filter on all Dimension values.
items:
type: string
description: A Dimension belonging to a Meter.
Aggregation:
type: string
description: 'Specifies the computation method applied to usage data collected in `targetField`. Aggregation unit value depends on the **Category** configured for the selected targetField.
* **SUM**. Adds the values. Can be applied to a **Measure**, **Income**, or **Cost** `targetField`.
* **MIN**. Uses the minimum value. Can be applied to a **Measure**, **Income**, or **Cost** `targetField`.
* **MAX**. Uses the maximum value. Can be applied to a **Measure**, **Income**, or **Cost** `targetField`.
* **COUNT**. Counts the number of values. Can be applied to a **Measure**, **Income**, or **Cost** `targetField`.
* **LATEST**. Uses the most recent value. Can be applied to a **Measure**, **Income**, or **Cost** `targetField`. Note: Based on the timestamp `ts` value of usage data measurement submissions. If using this method, please ensure *distinct* `ts` values are used for usage data measurement submissions.
* **MEAN**. Uses the arithmetic mean of the values. Can be applied to a **Measure**, **Income**, or **Cost** `targetField`.
* **UNIQUE**. Uses unique values and returns a count of the number of unique values. Can be applied to a **Metadata** `targetField`.'
enum:
- SUM
- MIN
- MAX
- COUNT
- LATEST
- MEAN
- UNIQUE
- CUSTOM_SQL
AbstractResponse:
required:
- id
type: object
properties:
id:
type: string
description: 'The UUID of the entity. '
version:
type: integer
description: 'The version number:
- **Create:** On initial Create to insert a new entity, the version is set at 1 in the response.
- **Update:** On successful Update, the version is incremented by 1 in the response.'
format: int64
x-stainless-terraform-configurability: computed
x-stainless-terraform-always-send: true
description: ''
PaginatedStatementDefinitionResponseData:
type: object
properties:
data:
type: array
description: ''
items:
$ref: '#/components/schemas/StatementDefinitionResponse'
nextToken:
type: string
description: ''
description: ''
StatementDefinitionRequest:
type: object
description: ''
allOf:
- $ref: '#/components/schemas/AbstractRequest'
- required:
- aggregationFrequency
properties:
name:
type: string
description: Descriptive name for the StatementDefinition providing context and information.
aggregationFrequency:
description: This specifies how often the Statement should aggregate data.
$ref: '#/components/schemas/AggregationFrequency'
includePricePerUnit:
type: boolean
description: 'A Boolean indicating whether to include the price per unit in the Statement.
* TRUE - includes the price per unit.
* FALSE - excludes the price per unit.'
dimensions:
type: array
description: An array of objects, each representing a Dimension data field from a Meter *(for Meters that have Dimensions setup)*.
items:
$ref: '#/components/schemas/Dimension'
measures:
type: array
description: An array of objects, each representing a Measure data field from a Meter.
items:
$ref: '#/components/schemas/Measure'
generateSlimStatements:
type: boolean
description: ''
AbstractRequest:
type: object
properties:
version:
type: integer
description: 'The version number of the entity:
- **Create entity:** Not valid for initial insertion of new entity - *do not use for Create*. On initial Create, version is set at 1 and listed in the response.
- **Update Entity:** On Update, version is required and must match the existing version because a check is performed to ensure sequential versioning is preserved. Version is incremented by 1 and listed in the response.'
format: int64
x-stainless-terraform-configurability: computed
x-stainless-terraform-always-send: true
description: ''
responses:
Error:
description: Error message
content:
application/json:
schema:
type: object
properties:
message:
type: string
securitySchemes:
OAuth2:
type: oauth2
description: "m3ter supports machine to machine authentication using the `clientCredentials` OAuth2 flow.\n\nThe `authorizationCode` flow controls access for human users via the m3ter Console application. \n"
flows:
clientCredentials:
tokenUrl: /oauth/token
scopes:
m3ter-resources/m3ter-scope: m3ter resources
measurements:upload: Upload measurements
measurements:fileUpload: Upload file
measurements:retrieve: Retrieve measurements
authorizationCode:
authorizationUrl: https://m3ter.auth.us-east-1.amazoncognito.com/oauth2/authorize
tokenUrl: https://m3ter.auth.us-east-1.amazoncognito.com/oauth2/token
scopes:
m3ter-resources/m3ter-scope: m3ter resources
openid: OpenID
email: email
measurements:upload: Upload measurements
measurements:fileUpload: Upload file
measurements:retrieve: Retrieve measurements