Get the rate schedule for a contract

curl --request POST \
  --url https://api.metronome.com/v1/contracts/getContractRateSchedule \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "customer_id": "13117714-3f05-48e5-a6e9-a66093f13b4d",
  "contract_id": "d7abd0cd-4ae9-4db7-8676-e986a4ebd8dc",
  "at": "2020-01-01T00:00:00.000Z",
  "selectors": [
    {
      "product_id": "d6300dbb-882e-4d2d-8dec-5125d16b65d0",
      "partial_pricing_group_values": {
        "region": "us-west-2",
        "cloud": "aws"
      }
    }
  ]
}
'

{
  "data": [
    {
      "rate_card_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "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,
      "list_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"
        }
      },
      "ending_before": "2023-11-07T05:31:56Z",
      "pricing_group_values": {},
      "override_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"
        }
      },
      "commit_rate": {
        "rate_type": "FLAT",
        "price": 123,
        "tiers": [
          {
            "price": 123,
            "size": 123
          }
        ]
      },
      "billing_frequency": "MONTHLY"
    }
  ],
  "next_page": "<string>"
}

Contracts

Get the rate schedule for a contract

For a specific customer and contract, get the rates at a specific point in time. This endpoint takes the contract’s rate card into consideration, including scheduled changes. It also takes into account overrides on the contract.

For example, if you want to show your customer a summary of the prices they are paying, inclusive of any negotiated discounts or promotions, use this endpoint. This endpoint only returns rates that are entitled.

POST

contracts

getContractRateSchedule

Get the rate schedule for a contract

curl --request POST \
  --url https://api.metronome.com/v1/contracts/getContractRateSchedule \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "customer_id": "13117714-3f05-48e5-a6e9-a66093f13b4d",
  "contract_id": "d7abd0cd-4ae9-4db7-8676-e986a4ebd8dc",
  "at": "2020-01-01T00:00:00.000Z",
  "selectors": [
    {
      "product_id": "d6300dbb-882e-4d2d-8dec-5125d16b65d0",
      "partial_pricing_group_values": {
        "region": "us-west-2",
        "cloud": "aws"
      }
    }
  ]
}
'

{
  "data": [
    {
      "rate_card_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "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,
      "list_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"
        }
      },
      "ending_before": "2023-11-07T05:31:56Z",
      "pricing_group_values": {},
      "override_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"
        }
      },
      "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

Contract rate schedule filter options.

customer_id

string<uuid>

required

ID of the customer for whose contract to get the rate schedule for.

contract_id

string<uuid>

required

ID of the contract to get the rate schedule for.

string<date-time>

optional timestamp which overlaps with the returned rate schedule segments. When not specified, the current timestamp will be used.

selectors

object[]

List of rate selectors, rates matching ANY of the selectors 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.product_tags

string[]

List of product tags, rates matching any of the tags 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.rate_card_id

string<uuid>

required

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.list_rate

object

required

Show child attributes

data.list_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.list_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.list_rate.tiers

object[]

Only set for TIERED rate_type.

Show child attributes

data.list_rate.tiers.price

number

required

data.list_rate.tiers.size

number

data.list_rate.pricing_group_values

object

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

Show child attributes

data.list_rate.pricing_group_values.{key}

string

data.list_rate.credit_type

object

Show child attributes

data.list_rate.credit_type.name

string

required

data.list_rate.credit_type.id

string<uuid>

required

data.ending_before

string<date-time>

data.pricing_group_values

object

Show child attributes

data.pricing_group_values.{key}

string

data.override_rate

object

Show child attributes

data.override_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.override_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.override_rate.tiers

object[]

Only set for TIERED rate_type.

Show child attributes

data.override_rate.tiers.price

number

required

data.override_rate.tiers.size

number

data.override_rate.pricing_group_values

object

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

Show child attributes

data.override_rate.pricing_group_values.{key}

string

data.override_rate.credit_type

object

Show child attributes

data.override_rate.credit_type.name

string

required

data.override_rate.credit_type.id

string<uuid>

required

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

List customer contracts (v1)

List seat balances

⌘I

GET STARTED

ESSENTIALS

ENDPOINTS

Get the rate schedule for a contract

Authorizations

Query Parameters

Body

Response