List Pricings

Retrieve a list of Pricings filtered by date/time, Plan ID, PlanTemplate ID, or Pricing ID.

GET /organizations/{orgId}/pricings

List Pricings

cURL

curl --request GET \
  --url https://api.m3ter.com/organizations/{orgId}/pricings \
  --header 'Authorization: Bearer <token>'

200

{
  "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>"
        }
      ],
      "aggregationId": "<string>",
      "compoundAggregationId": "<string>",
      "type": "DEBIT",
      "segment": {},
      "tiersSpanPlan": true,
      "minimumSpend": 123,
      "minimumSpendDescription": "<string>",
      "minimumSpendBillInAdvance": true,
      "aggregationType": "SIMPLE",
      "segmentString": "<string>",
      "overagePricingBands": [
        {
          "lowerLimit": 1,
          "fixedPrice": 123,
          "unitPrice": 123,
          "id": "<string>",
          "creditTypeId": "<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

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

Query Parameters

pageSize · integer<int32>

Number of Pricings to retrieve per page.

Required range: 1 <= x <= 100

nextToken · string

nextToken for multi-page retrievals.

date · string

Date/Time (in ISO-8601 format) to retrieve active Pricings for.

planId · string

UUID of the Plan to retrieve Pricings for.

planTemplateId · string

UUID of the PlanTemplate to retrieve Pricings for.

aggregationId · string

UUID of the Aggregation to retrieve pricings for

ids · string[]

List of Pricing IDs to retrieve.

Response

200

application/json

Returns the list of requested Pricings

data · object[]

Show child attributes

nextToken · string