Skip to main content
GET
/
organizations
/
{orgId}
/
commitments
/
search
Search Commitments
curl --request GET \
  --url https://api.m3ter.com/organizations/{orgId}/commitments/search \
  --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) of your Organization. The Organization represents your company as a direct customer of our service.

Query Parameters

​
searchQuery
string

Query for data using special syntax:

  • Query parameters should be delimited using $ (dollar sign).
  • Allowed comparators are:
    • (greater than) >
    • (greater than or equal to) >=
    • (equal to) :
    • (less than) <
    • (less than or equal to) <=
    • (match phrase/prefix) ~
  • Allowed parameters: startDate, endDate, contractId, accountId, productId, productIds, id, createdBy, dtCreated, lastModifiedBy, ids.
  • Query example:
    • searchQuery=startDate>2023-01-01$accountId:062085ab-a301-4f21-a081-411020864452.
    • This query is translated into: find commitments where the startDate is older than 2023-01-01 AND the accountId is equal to 062085ab-a301-4f21-a081-411020864452.

Note: Using the ~ match phrase/prefix comparator. For best results, we recommend treating this as a "starts with" comparator for your search query.

​
fromDocument
integer<int32>

fromDocument for multi page retrievals.

​
pageSize
integer<int32>

Number of Commitments to retrieve per page.

NOTE: If not defined, default is 10.

Required range: 1 <= x <= 100
​
operator
enum<string>

Search Operator to be used while querying search.

Available options:
AND,
OR
​
sortBy
string

Name of the parameter on which sorting is performed. Use any field available on the Commitment entity to sort by, such as accountId, endDate, and so on.

​
sortOrder
enum<string>

Sorting order.

Available options:
ASC,
DESC

Response

Return the Commitments that match the search criteria

​
data
object[]
​
nextToken
string