Retrieve Rate Schedule

API Reference

Contracts

Get the rate schedule for a contract

client.v1.contracts.retrieveRateSchedule(, ?):

post/v1/contracts/getContractRateSchedule

Get the rate schedule for the rate card on a given contract.

Parameters

params

Hide ParametersShow Parameters

contract_idstring

Body param: ID of the contract to get the rate schedule for.

formatuuid

customer_idstring

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

formatuuid

limitnumber

optional

Query param: Max number of results that should be returned

minimum1

maximum100

next_pagestring

optional

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

atstring

optional

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

formatdate-time

selectorsarray

optional

Array<Selector>

Body param: 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.

Hide ParametersShow Parameters

billing_frequencyunion

optional

"MONTHLY" | "QUARTERLY" | "ANNUAL" | "WEEKLY"

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

Hide ParametersShow Parameters

"MONTHLY"

"QUARTERLY"

"ANNUAL"

"WEEKLY"

partial_pricing_group_valuesRecord<string, string>

optional

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

pricing_group_valuesRecord<string, string>

optional

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

product_idstring

optional

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

formatuuid

product_tagsarray

optional

Array<string>

List of product tags, rates matching any of the tags will be included in the response.

Returns

ContractRetrieveRateScheduleResponse

Hide ParametersShow Parameters

dataarray

Array<Data>

Hide ParametersShow Parameters

entitledboolean

list_rate

product_custom_fieldsRecord<string, string>

product_idstring

formatuuid

product_namestring

product_tagsarray

Array<string>

rate_card_idstring

formatuuid

starting_atstring

formatdate-time

billing_frequencyunion

optional

"MONTHLY" | "QUARTERLY" | "ANNUAL" | "WEEKLY"

Hide ParametersShow Parameters

"MONTHLY"

"QUARTERLY"

"ANNUAL"

"WEEKLY"

commit_rate

optional

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

Hide ParametersShow Parameters

rate_typeunion

"FLAT" | "PERCENTAGE" | "SUBSCRIPTION" | 2 more

Hide ParametersShow Parameters

"FLAT"

"PERCENTAGE"

"SUBSCRIPTION"

"TIERED"

"CUSTOM"

pricenumber

optional

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

tiersarray

optional

Array<>

Only set for TIERED rate_type.

Hide ParametersShow Parameters

pricenumber

sizenumber

optional

ending_beforestring

optional

formatdate-time

override_rate

optional

pricing_group_valuesRecord<string, string>

optional

next_pageunion

optional

string | null

import Metronome from '@metronome/sdk';

const client = new Metronome({
  bearerToken: 'My Bearer Token',
});

const response = await client.v1.contracts.retrieveRateSchedule({
  contract_id: 'd7abd0cd-4ae9-4db7-8676-e986a4ebd8dc',
  customer_id: '13117714-3f05-48e5-a6e9-a66093f13b4d',
  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' },
    },
  ],
});

console.log(response.data);

200 Example

{
  "data": [
    {
      "entitled": true,
      "list_rate": {
        "rate_type": "FLAT",
        "credit_type": {
          "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
          "name": "name"
        },
        "custom_rate": {
          "foo": "bar"
        },
        "is_prorated": true,
        "price": 0,
        "pricing_group_values": {
          "foo": "string"
        },
        "quantity": 0,
        "tiers": [
          {
            "price": 0,
            "size": 0
          }
        ],
        "use_list_prices": true
      },
      "product_custom_fields": {
        "foo": "string"
      },
      "product_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "product_name": "product_name",
      "product_tags": [
        "string"
      ],
      "rate_card_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "starting_at": "2019-12-27T18:11:19.117Z",
      "billing_frequency": "MONTHLY",
      "commit_rate": {
        "rate_type": "FLAT",
        "price": 0,
        "tiers": [
          {
            "price": 0,
            "size": 0
          }
        ]
      },
      "ending_before": "2019-12-27T18:11:19.117Z",
      "override_rate": {
        "rate_type": "FLAT",
        "credit_type": {
          "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
          "name": "name"
        },
        "custom_rate": {
          "foo": "bar"
        },
        "is_prorated": true,
        "price": 0,
        "pricing_group_values": {
          "foo": "string"
        },
        "quantity": 0,
        "tiers": [
          {
            "price": 0,
            "size": 0
          }
        ],
        "use_list_prices": true
      },
      "pricing_group_values": {
        "foo": "string"
      }
    }
  ],
  "next_page": "next_page"
}