---
title: "List Pricing"
method: GET
path: "/organizations/{orgId}/pricings"
tags: ["Pricing"]
---

# List Pricing

`GET /organizations/{orgId}/pricings`

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

## Path parameters

- `orgId` string, required

## Query parameters

- `pageSize` integer
- `nextToken` string
- `date` string
- `planId` string
- `planTemplateId` string
- `aggregationId` string
- `ids` string[]

## Response `200`

Returns the list of requested Pricings

- PaginatedPricingResponseData
  - `data` PricingResponse[]
    - `id` string, required — The UUID of the entity.
    - `version` integer — 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.
    - `dtCreated` string, date-time — The DateTime when this item was created *(in ISO-8601 format)*.
    - `dtLastModified` string, date-time — The DateTime when this item was last modified *(in ISO-8601 format)*.
    - `createdBy` string — The ID of the user who created this item.
    - `lastModifiedBy` string — The ID of the user who last modified this item.
    - `planId` string — UUID of the Plan the Pricing is created for.
    - `planTemplateId` string — UUID of the Plan Template the Pricing was created for.
    - `cumulative` boolean — Controls whether or not charge rates under a set of pricing bands configured for a Pricing are applied according to each separate band or at the highest band reached. The default value is **TRUE**. * When TRUE, at billing charge rates are applied according to each separate band. * When FALSE, at billing charge rates are applied according to highest band reached.
    - `startDate` string, date-time — The start date *(in ISO-8601 format)* for when the Pricing starts to be active for the Plan of Plan Template.
    - `endDate` string, date-time — The end date *(in ISO-8601 format)* for when the Pricing ceases to be active for the Plan or Plan Template. If not specified, the Pricing remains active indefinitely.
    - `code` string — Unique short code for the Pricing.
    - `description` string — Displayed on Bill line items.
    - `accountingProductId` string
    - `pricingBands` PricingBand[]
      - `id` string — The ID for the Pricing band.
      - `lowerLimit` number, double, required — Lower limit for the Pricing band.
      - `fixedPrice` number, double, required — Fixed price charged for the Pricing band.
      - `unitPrice` number, double, required — Unit price charged for the Pricing band.
      - `creditTypeId` string — **OBSOLETE - this is deprecated and no longer used.**
    - `aggregationId` string — UUID of the Aggregation used to create the Pricing. Use this when creating a Pricing for a segmented aggregation.
    - `compoundAggregationId` string — UUID of the Compound Aggregation used to create the Pricing.
    - `type` 'DEBIT' | 'PRODUCT_CREDIT' | 'GLOBAL_CREDIT' — * **DEBIT**. Default setting. The amount calculated using the Pricing is added to the bill as a debit. * **PRODUCT_CREDIT**. The amount calculated using the Pricing is added to the bill as a credit *(negative amount)*. To prevent negative billing, the bill will be capped at the total of other line items for the *same* Product. * **GLOBAL_CREDIT**. The amount calculated using the Pricing is added to the bill as a credit *(negative amount)*. To prevent negative billing, the bill will be capped at the total of other line items for the entire bill, which might include other Products the Account consumes.
    - `segment` object — Name of the segment for which you are defining a Pricing. For each segment in a segmented aggregation, make a separate call using `aggregationId` parameter to update a Pricing.
    - `tiersSpanPlan` boolean — The default value is **FALSE**. * If TRUE, usage accumulates over the entire period the priced Plan is active for the account, and is not reset for pricing band rates at the start of each billing period. * If FALSE, usage does not accumulate, and is reset for pricing bands at the start of each billing period.
    - `minimumSpend` number, double — The minimum spend amount per billing cycle for end customer Accounts on a Plan to which the Pricing is applied.
    - `minimumSpendDescription` string — Minimum spend description *(displayed on the bill line item)*.
    - `minimumSpendBillInAdvance` boolean — The default value is **FALSE**. * When TRUE, minimum spend is billed at the start of each billing period. * When FALSE, minimum spend is billed at the end of each billing period. *(Optional)*. Overrides the setting at Organization level for minimum spend billing in arrears/in advance.
    - `aggregationType` 'SIMPLE' | 'COMPOUND'
    - `segmentString` string
    - `overagePricingBands` PricingBand[] — The Prepayment/Balance overage pricing in pricing bands for the case of a **Tiered** pricing structure.
      - `id` string — The ID for the Pricing band.
      - `lowerLimit` number, double, required — Lower limit for the Pricing band.
      - `fixedPrice` number, double, required — Fixed price charged for the Pricing band.
      - `unitPrice` number, double, required — Unit price charged for the Pricing band.
      - `creditTypeId` string — **OBSOLETE - this is deprecated and no longer used.**
  - `nextToken` string

## Other responses

- `4XX` — Error message
- `5XX` — Error message

---

[API](https://skmtc.net/m3ter-com/apis/m3ter-api.md) · [All operations](https://skmtc.net/m3ter-com/apis/m3ter-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/m3ter-com/m3ter-api/revisions/ac93d1a9e6d9/schema)