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

List

API Reference
V1
Contracts
Rate Cards
List rate cards
client.v1.contracts.rateCards.list(RateCardListParamsparams?, RequestOptionsoptions?): CursorPage<idstringcreated_atstringcreated_bystringnamestringaliasesarraycredit_type_conversionsarraycustom_fieldsRecord<string, string>descriptionstringfiat_credit_typeCreditTypeDataRateCardListResponse>
post/v1/contract-pricing/rate-cards/list

List rate cards NOTE: Use /contract-pricing/rate-cards/getRates to retrieve rate card rates.

Parameters
paramslimitnumbernext_pagestringbodyunknownRateCardListParams
Hide ParametersShow Parameters
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.

bodyunknown
optional

Body param:

Returns
RateCardListResponse
Hide ParametersShow Parameters
idstring
formatuuid
created_atstring
formatdate-time
created_bystring
namestring
aliasesarray
optional
Array<Alias>
Hide ParametersShow Parameters
namestring
ending_beforestring
optional
formatdate-time
starting_atstring
optional
formatdate-time
credit_type_conversionsarray
optional
Array<CreditTypeConversion>
Hide ParametersShow Parameters
custom_credit_typeidstringnamestringCreditTypeData
fiat_per_custom_creditstring
custom_fieldsRecord<string, string>
optional
descriptionstring
optional
fiat_credit_typeidstringnamestringCreditTypeData
optional
import Metronome from '@metronome/sdk';

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

// Automatically fetches more pages as needed.
for await (const rateCardListResponse of client.v1.contracts.rateCards.list()) {
  console.log(rateCardListResponse.id);
}
200 Example
{
  "data": [
    {
      "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "created_at": "2019-12-27T18:11:19.117Z",
      "created_by": "created_by",
      "name": "name",
      "aliases": [
        {
          "name": "name",
          "ending_before": "2019-12-27T18:11:19.117Z",
          "starting_at": "2019-12-27T18:11:19.117Z"
        }
      ],
      "credit_type_conversions": [
        {
          "custom_credit_type": {
            "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
            "name": "name"
          },
          "fiat_per_custom_credit": "fiat_per_custom_credit"
        }
      ],
      "custom_fields": {
        "foo": "string"
      },
      "description": "description",
      "fiat_credit_type": {
        "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
        "name": "name"
      }
    }
  ],
  "next_page": "next_page"
}