---
title: "List all list prices"
method: GET
path: "/list-prices"
tags: ["List Prices"]
---

# List all list prices

`GET /list-prices`

List all list prices

## Query parameters

- `currency` string
- `productId` string
- `billingFrequency` string
- `includeArchived` boolean
- `limit` integer
- `after` string
- `before` string

## Headers

- `Authorization` string, required
- `sequence-version` '2024-07-30'

## Response `200`

OK

- ListListPricesEndpointResponseModel
  - `items` ListPrice[], required — List prices
    - `id` string, required — Unique ID
    - `productId` string, required — The related product ID
    - `name` string, required — The customer-facing name of this list price
    - `currency` 'AED' | 'ARS' | 'AUD' | 'BRL' | 'BGN' | 'CAD' | 'CHF' | 'CLP' | 'CNY' | 'COP' | 'CZK' | 'DKK' | 'EGP' | 'EUR' | 'GBP' | 'HKD' | 'ILS' | 'INR' | 'ISK' | 'JPY' | 'KRW' | 'MXN' | 'NOK' | 'NZD' | 'PLN' | 'SAR' | 'SEK' | 'SGD' | 'THB' | 'USD' | 'UYU' | 'ZAR', required
    - `structure` union, required
      - GraduatedPricingStructure1 — The pricing structure
        - `tiers` GraduatedUsageTier[], required — A list of contiguous pricing tiers
          - `upperBound` string — The upper bound of usage for this tier. Set to null to if this is a final tier and is unbounded. The lower bound is set by the previous tier or 0 if it's the first one.
          - `price` string, required — The rate to apply to usage for this product in this tier. In the case of percentage pricing where `isPricePercentage` is set to `true`, a value of 1 represents 100%.
          - `fee` string — The nominal fee associated with usage at this tier
          - `isPricePercentage` boolean, required — Indicate whether the price attribute is to be considered as a percentage or an absolute value.
        - `usageMetricId` string, required — The usage metric associated to this pricing structure
        - `usageCalculationMode` 'BILLING_PERIOD' | 'CUMULATIVE' | 'PERIODIC', required
        - `pricingType` 'GRADUATED', required
      - VolumePricingStructure1 — The pricing structure
        - `tiers` VolumeUsageTier[], required — A list of contiguous pricing tiers
          - `upperBound` string — The upper bound of usage for this tier. Set to null to if this is a final tier and is unbounded. The lower bound is set by the previous tier or 0 if it's the first one.
          - `price` string, required — The rate to apply to usage for this product in this tier. In the case of percentage pricing where `isPricePercentage` is set to `true`, a value of 1 represents 100%.
          - `fee` string — The nominal fee associated with usage at this tier
          - `isPricePercentage` boolean, required — Indicate whether the price attribute is to be considered as a percentage or an absolute value.
          - `maxPrice` string — Maximum Price to Charge for each Unit if Price is Percentage Based
          - `minPrice` string — Minimum Price to Charge for each Unit if Price is Percentage Based
        - `usageMetricId` string, required — The usage metric associated to this tier
        - `pricingType` 'VOLUME', required
      - SeatBasedPricingStructure1 — The pricing structure
        - `seatMetricId` string, required — Seat metric associated to this pricing structure
        - `pricePerSeat` string, required — Price charged per seat per full billing period
        - `prorationStrategy` 'USE_MAXIMUM' | 'PRORATE_INCREMENTS' | 'PRORATE_ALL_CHANGES', required
        - `contractedMinimumSeats` integer, required — The number of contractually agreed minimum seats
        - `overagesBillingFrequency` 'NONE' | 'MONTHLY' | 'QUARTERLY' | 'HALF_YEARLY' | 'YEARLY'
        - `tiers` SeatUsageTier[], required — A list of contiguous pricing tiers
          - `upperBound` string — The upper bound of usage for this tier. Set to null to if this is a final tier and is unbounded. The lower bound is set by the previous tier or 0 if it's the first one.
          - `price` string, required — The rate to apply to usage for this product in this tier. In the case of percentage pricing where `isPricePercentage` is set to `true`, a value of 1 represents 100%.
          - `fee` string — The nominal fee associated with usage at this tier
        - `prorateFlatFees` boolean — If set any flat fees will be pro-rated if the invoice service period length does not match the billing frequency
        - `pricingType` 'SEAT_BASED', required
      - PackagePricingStructure1 — The pricing structure
        - `packageSize` string, required — The amount of usage allowed for the price in this structure
        - `pricePerPackage` string, required — The price charged for each package
        - `usageMetricId` string, required — The usage metric associated to this tier
        - `pricingType` 'PACKAGE', required
      - LinearPricingStructure1 — The pricing structure
        - `pricePerUnit` string, required — The per unit rate to apply to usage for this product. In the case of percentage pricing where `isPricePercentage` is set to `true`, a value of 1 represents 100%.
        - `usageMetricId` string, required — Usage metric associated to this pricing structure
        - `isPricePercentage` boolean, required — Indicate whether the price attribute is to be considered as a percentage or an absolute value.
        - `pricingType` 'LINEAR', required
      - FixedPricingStructure1 — The pricing structure
        - `price` string, required — A fixed amount that is charged once every billing period.
        - `pricingType` 'FIXED', required
      - OneTimePricingStructure1 — The pricing structure
        - `price` string, required — A fixed amount that is charged once.
        - `pricingType` 'ONE_TIME', required
    - `billingFrequency` 'ON_DEMAND' | 'ONE_TIME' | 'MONTHLY' | 'QUARTERLY' | 'HALF_YEARLY' | 'YEARLY' | 'PER_EVENT', required
    - `usageCalculationPeriod` UsageCalculationPeriod1 — The period over which usage is aggregated. This value is only taken into consideration and required with graduated pricing structures with a usage calculation mode of 'PERIOD'. It will be ignored for all non-graduated prices.
      - `frequency` 'MONTHLY' | 'QUARTERLY' | 'HALF_YEARLY' | 'YEARLY', required
      - `interval` integer, required — Interval determines the time period over which usage is aggregated. For example, if the frequency is MONTHLY and the interval is 3, the usage is aggregated over 3 months before starting at 0 again.
    - `billingType` 'IN_ARREARS' | 'IN_ADVANCE', required
    - `createdAt` string, required — Creation timestamp. Formatted as an ISO 8601 timestamp.
    - `updatedAt` string, required — Timestamp when price was last updated. Formatted as an ISO 8601 timestamp.
    - `integrationIds` IntegrationId2[], required — Alternate IDs for this price in third-party integration systems
      - `service` 'Amazon_Redshift' | 'GoCardless' | 'Google_BigQuery' | 'Google_Sheets' | 'HubSpot' | 'NetSuite' | 'QuickBooks_Online' | 'Salesforce' | 'Slack' | 'Snowflake' | 'Stripe' | 'Xero' | 'Avalara' | 'Anrok' | 'Attio' | 'Numeral' | 'Rillet' | 'Sphere', required
      - `id` string, required
      - `isPending` boolean, required
    - `customMetricParameters` PriceParameter1[], required — Specific parameters to influence usage calculation for this price, and are only required when using a custom metric. Please speak to your Sequence contacts for further information prior to usage.
      - `parameterId` string, required — Custom metric parameter ID
      - `value` string, required — Parameter value
  - `pagination` PaginationMeta, required — Results pagination
    - `after` string — Cursor for the page after this (if it exists)
    - `before` string — Cursor for the page before this (if it exists)
    - `totalResultSize` integer — Total number of entries across all pages

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `500` — Internal Server Error

---

[API](https://skmtc.net/sequencehq/apis/sequence.md) · [All operations](https://skmtc.net/sequencehq/apis/sequence/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/sequencehq/sequence/versions/cae64b02699f/schema)