Skip to main content
GET
/
organizations
/
{orgId}
/
counterpricings
List CounterPricing
curl --request GET \
  --url https://api.m3ter.com/organizations/{orgId}/counterpricings \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "<string>",
      "version": 123,
      "dtCreated": "2023-11-07T05:31:56Z",
      "dtLastModified": "2023-11-07T05:31:56Z",
      "createdBy": "<string>",
      "lastModifiedBy": "<string>",
      "planId": "<string>",
      "planTemplateId": "<string>",
      "cumulative": true,
      "startDate": "2023-11-07T05:31:56Z",
      "endDate": "2023-11-07T05:31:56Z",
      "code": "<string>",
      "description": "<string>",
      "accountingProductId": "<string>",
      "pricingBands": [
        {
          "lowerLimit": 1,
          "fixedPrice": 123,
          "unitPrice": 123,
          "id": "<string>",
          "creditTypeId": "<string>"
        }
      ],
      "counterId": "<string>",
      "runningTotalBillInAdvance": true,
      "proRateRunningTotal": true,
      "proRateAdjustmentDebit": true,
      "proRateAdjustmentCredit": true
    }
  ],
  "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

UUID of the Organization. The Organization represents your company as a direct customer of the m3ter.

Query Parameters

​
pageSize
integer<int32>

Number of CounterPricings to retrieve per page.

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

nextToken for multi page retrievals.

​
date
string

Date on which to retrieve active CounterPricings.

​
planId
string

UUID of the Plan to retrieve CounterPricings for.

​
planTemplateId
string

UUID of the Plan Template to retrieve CounterPricings for.

​
ids
string[]

List of CounterPricing IDs to retrieve.

Response

Returns the list of requested CounterPricings

​
data
object[]
​
nextToken
string