Get a rate schedule

curl --request POST \
  --url https://api.metronome.com/v1/contract-pricing/rate-cards/getRateSchedule \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "rate_card_id": "f3d51ae8-f283-44e1-9933-a3cf9ad7a6fe",
  "starting_at": "2024-01-01T00:00:00.000Z",
  "selectors": [
    {
      "product_id": "d6300dbb-882e-4d2d-8dec-5125d16b65d0",
      "partial_pricing_group_values": {
        "region": "us-west-2",
        "cloud": "aws"
      }
    }
  ]
}
'

{
  "data": [
    {
      "product_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "product_name": "<string>",
      "product_tags": [
        "<string>"
      ],
      "product_custom_fields": {},
      "starting_at": "2023-11-07T05:31:56Z",
      "entitled": true,
      "rate": {
        "rate_type": "FLAT",
        "price": 123,
        "custom_rate": {},
        "use_list_prices": true,
        "quantity": 123,
        "is_prorated": true,
        "tiers": [
          {
            "price": 123,
            "size": 123
          }
        ],
        "pricing_group_values": {},
        "credit_type": {
          "name": "<string>",
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        }
      },
      "pricing_group_values": {},
      "ending_before": "2023-11-07T05:31:56Z",
      "commit_rate": {
        "rate_type": "FLAT",
        "price": 123,
        "tiers": [
          {
            "price": 123,
            "size": 123
          }
        ]
      },
      "billing_frequency": "MONTHLY"
    }
  ],
  "next_page": "<string>"
}

Rate cards

Get a rate schedule

A rate card defines the prices that you charge for your products. Rate cards support scheduled changes over time, to allow you to easily roll out pricing changes and new product launches across your customer base. Use this endpoint to understand the rate schedule starting_at a given date, optionally filtering the list of rates returned based on product id or pricing group values. For example, you may want to display a schedule of upcoming price changes for a given product in your product experience - use this endpoint to fetch that information from its source of truth in Metronome.

If you want to understand the rates for a specific customer’s contract, inclusive of contract-level overrides, use the getContractRateSchedule endpoint.

POST

contract-pricing

rate-cards

getRateSchedule

Get a rate schedule

curl --request POST \
  --url https://api.metronome.com/v1/contract-pricing/rate-cards/getRateSchedule \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "rate_card_id": "f3d51ae8-f283-44e1-9933-a3cf9ad7a6fe",
  "starting_at": "2024-01-01T00:00:00.000Z",
  "selectors": [
    {
      "product_id": "d6300dbb-882e-4d2d-8dec-5125d16b65d0",
      "partial_pricing_group_values": {
        "region": "us-west-2",
        "cloud": "aws"
      }
    }
  ]
}
'

{
  "data": [
    {
      "product_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "product_name": "<string>",
      "product_tags": [
        "<string>"
      ],
      "product_custom_fields": {},
      "starting_at": "2023-11-07T05:31:56Z",
      "entitled": true,
      "rate": {
        "rate_type": "FLAT",
        "price": 123,
        "custom_rate": {},
        "use_list_prices": true,
        "quantity": 123,
        "is_prorated": true,
        "tiers": [
          {
            "price": 123,
            "size": 123
          }
        ],
        "pricing_group_values": {},
        "credit_type": {
          "name": "<string>",
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        }
      },
      "pricing_group_values": {},
      "ending_before": "2023-11-07T05:31:56Z",
      "commit_rate": {
        "rate_type": "FLAT",
        "price": 123,
        "tiers": [
          {
            "price": 123,
            "size": 123
          }
        ]
      },
      "billing_frequency": "MONTHLY"
    }
  ],
  "next_page": "<string>"
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

limit

integer

Max number of results that should be returned

Required range: 1 <= x <= 100

next_page

string

Cursor that indicates where the next page of results should start.

Body

application/json

Rate schedule filter options.

rate_card_id

string<uuid>

required

ID of the rate card to get the schedule for

starting_at

string<date-time>

required

inclusive starting point for the rates schedule

ending_before

string<date-time>

optional exclusive end date for the rates schedule. When not specified rates will show all future schedule segments.

selectors

object[]

List of rate selectors, rates matching ANY of the selector will be included in the response Passing no selectors will result in all rates being returned.

Show child attributes

selectors.billing_frequency

enum<string>

Subscription rates matching the billing frequency will be included in the response.

Available options:

MONTHLY,

Monthly,

monthly,

QUARTERLY,

Quarterly,

quarterly,

ANNUAL,

Annual,

annual,

WEEKLY,

Weekly,

weekly

selectors.product_id

string<uuid>

Rates matching the product id will be included in the response.

selectors.pricing_group_values

object

List of pricing group key value pairs, rates matching all of the key / value pairs will be included in the response.

Show child attributes

selectors.pricing_group_values.{key}

string

selectors.partial_pricing_group_values

object

List of pricing group key value pairs, rates containing the matching key / value pairs will be included in the response.

Show child attributes

selectors.partial_pricing_group_values.{key}

string

Response

200 - application/json

Success

data

object[]

required

Show child attributes

data.product_id

string<uuid>

required

data.product_name

string

required

data.product_tags

string[]

required

data.product_custom_fields

object

required

Custom fields to be added eg. { "key1": "value1", "key2": "value2" }

Show child attributes

data.product_custom_fields.{key}

string

data.starting_at

string<date-time>

required

data.entitled

boolean

required

data.rate

object

required

Show child attributes

data.rate.price

number

Default price. For FLAT rate_type, this must be >=0. For PERCENTAGE rate_type, this is a decimal fraction, e.g. use 0.1 for 10%; this must be >=0 and <=1.

data.rate.use_list_prices

boolean

Only set for PERCENTAGE rate_type. Defaults to false. If true, rate is computed using list prices rather than the standard rates for this product on the contract.

data.rate.tiers

object[]

Only set for TIERED rate_type.

Show child attributes

data.rate.tiers.price

number

required

data.rate.tiers.size

number

data.rate.pricing_group_values

object

if pricing groups are used, this will contain the values used to calculate the price

Show child attributes

data.rate.pricing_group_values.{key}

string

data.rate.credit_type

object

Show child attributes

data.rate.credit_type.name

string

required

data.rate.credit_type.id

string<uuid>

required

data.pricing_group_values

object

Show child attributes

data.pricing_group_values.{key}

string

data.ending_before

string<date-time>

data.commit_rate

object

A distinct rate on the rate card. You can choose to use this rate rather than list rate when consuming a credit or commit.

Show child attributes

data.commit_rate.rate_type

enum<string>

required

Available options:

FLAT,

flat,

TIERED,

tiered

data.commit_rate.price

number

Commit rate price. For FLAT rate_type, this must be >=0.

data.commit_rate.tiers

object[]

Only set for TIERED rate_type.

Show child attributes

data.commit_rate.tiers.price

number

required

data.commit_rate.tiers.size

number

data.billing_frequency

enum<string>

Available options:

MONTHLY,

QUARTERLY,

ANNUAL,

WEEKLY

next_page

string | null

Get rates

Update a rate card

⌘I

GET STARTED

ESSENTIALS

ENDPOINTS

Get a rate schedule

Authorizations

Query Parameters

Body

Response