Skip to content
Metronome Docs
  • Auto
  • Light
  • Dark
Talk to an expert

Retrieve Rate Schedule

API Reference
V1
Contracts
Get the rate schedule for a contract
post/v1/contracts/getContractRateSchedule

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

Query Parameters
limitnumber
optional

Max number of results that should be returned

minimum1
maximum100
next_pagestring
optional

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

Body Parameters
contract_idstring

ID of the contract to get the rate schedule for.

formatuuid
customer_idstring

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

formatuuid
atstring
optional

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

formatdate-time
selectorsarray of object
optional

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_frequencyenum
optional
"MONTHLY" OR "QUARTERLY" OR "ANNUAL" OR "WEEKLY"

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

Hide ParametersShow Parameters
"MONTHLY"
"QUARTERLY"
"ANNUAL"
"WEEKLY"
partial_pricing_group_valuesmap
optional

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

pricing_group_valuesmap
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 of string
optional

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

Returns
dataarray of object
Hide ParametersShow Parameters
entitledboolean
list_raterate_typeenumcredit_typeCreditTypeDatacustom_ratemapis_proratedbooleanpricenumberpricing_group_valuesmapquantitynumbertiersarray of Tieruse_list_pricesbooleanRate
product_custom_fieldsmap
product_idstring
formatuuid
product_namestring
product_tagsarray of string
rate_card_idstring
formatuuid
starting_atstring
formatdate-time
billing_frequencyenum
optional
"MONTHLY" OR "QUARTERLY" OR "ANNUAL" OR "WEEKLY"
Hide ParametersShow Parameters
"MONTHLY"
"QUARTERLY"
"ANNUAL"
"WEEKLY"
commit_rateobject
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_typeenum
"FLAT" OR "PERCENTAGE" OR "SUBSCRIPTION" OR 2 more
Hide ParametersShow Parameters
"FLAT"
"PERCENTAGE"
"SUBSCRIPTION"
"TIERED"
"CUSTOM"
pricenumber
optional

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

tiersarray of pricenumbersizenumberTier
optional

Only set for TIERED rate_type.

ending_beforestring
optional
formatdate-time
override_raterate_typeenumcredit_typeCreditTypeDatacustom_ratemapis_proratedbooleanpricenumberpricing_group_valuesmapquantitynumbertiersarray of Tieruse_list_pricesbooleanRate
optional
pricing_group_valuesmap
optional
next_pagestring
optional
curl https://api.metronome.com/v1/contracts/getContractRateSchedule \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $METRONOME_BEARER_TOKEN" \
    -d '{
          "contract_id": "d7abd0cd-4ae9-4db7-8676-e986a4ebd8dc",
          "customer_id": "13117714-3f05-48e5-a6e9-a66093f13b4d"
        }'
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"
}