Skip to main content
GET
/
organizations
/
{orgId}
/
commitments
List Commitments
curl --request GET \
  --url https://api.m3ter.com/organizations/{orgId}/commitments \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "<string>",
      "version": 123,
      "accountId": "<string>",
      "billingPlanId": "<string>",
      "productIds": [
        "<string>"
      ],
      "startDate": "2023-12-25",
      "endDate": "2023-12-25",
      "currency": "<string>",
      "amount": 123,
      "amountPrePaid": 123,
      "amountFirstBill": 123,
      "amountSpent": 123,
      "overageSurchargePercent": 123,
      "separateOverageUsage": true,
      "billingInterval": 123,
      "billingOffset": 123,
      "commitmentFeeDescription": "<string>",
      "commitmentUsageDescription": "<string>",
      "overageDescription": "<string>",
      "commitmentFeeBillInAdvance": true,
      "billEpoch": "2023-12-25",
      "contractId": "<string>",
      "accountingProductId": "<string>",
      "feesAccountingProductId": "<string>",
      "drawdownsAccountingProductId": "<string>",
      "feeDates": [
        {
          "date": "2023-12-25",
          "amount": 1,
          "servicePeriodStartDate": "2023-11-07T05:31:56Z",
          "servicePeriodEndDate": "2023-11-07T05:31:56Z"
        }
      ],
      "childBillingMode": "PARENT_SUMMARY",
      "lineItemTypes": [
        "STANDING_CHARGE"
      ],
      "dtCreated": "2023-11-07T05:31:56Z",
      "dtLastModified": "2023-11-07T05:31:56Z",
      "createdBy": "<string>",
      "lastModifiedBy": "<string>"
    }
  ],
  "nextToken": "<string>"
}

Authorizations

​
Authorization
string
header
required

m3ter supports machine to machine authentication using the clientCredentials OAuth2 flow.

The authorizationCode flow controls access for human users via the m3ter Console application.

Path Parameters

​
orgId
string
required

The unique identifier (UUID) for your Organization. The Organization represents your company as a direct customer of our service.

Query Parameters

​
pageSize
integer<int32>

Specifies the maximum number of Commitments to retrieve per page.

Required range: 1 <= x <= 100
​
nextToken
string

The nextToken for multi-page retrievals. It is used to fetch the next page of Commitments in a paginated list.

​
accountId
string

The unique identifier (UUID) for the Account. This parameter helps filter the Commitments related to a specific end-customer Account.

​
productId
string

The unique identifier (UUID) for the Product. This parameter helps filter the Commitments related to a specific Product.

​
date
string

A date (in ISO-8601 format) to filter Commitments which are active on this specific date.

​
endDateStart
string

A date (in ISO-8601 format) used to filter Commitments. Only Commitments with end dates on or after this date will be included.

​
endDateEnd
string

A date (in ISO-8601 format) used to filter Commitments. Only Commitments with end dates before this date will be included.

​
ids
string[]

A list of unique identifiers (UUIDs) for the Commitments to retrieve. Use this to fetch specific Commitments in a single request.

​
contractId
string | null
Maximum string length: 36

Response

Returns a list of Commitments

​
data
object[]
​
nextToken
string