List

API Reference

V1

Contracts

Rate Cards

List rate cards

v1.contracts.rate_cards.list(RateCardListParams**kwargs) -> SyncCursorPage[idstrcreated_atdatetimecreated_bystrnamestraliaseslistcredit_type_conversionslistcustom_fieldsDict[str, str]descriptionstrfiat_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

limitint

optional

Max number of results that should be returned

minimum1

maximum100

next_pagestr

optional

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

bodyobject

optional

Returns

RateCardListResponseclass

Hide ParametersShow Parameters

idstr

formatuuid

created_atdatetime

formatdate-time

created_bystr

namestr

aliaseslist

optional

Optional[List[Alias]]

Hide ParametersShow Parameters

namestr

ending_beforedatetime

optional

formatdate-time

starting_atdatetime

optional

formatdate-time

credit_type_conversionslist

optional

Optional[List[CreditTypeConversion]]

Hide ParametersShow Parameters

custom_credit_typeidstrnamestrCreditTypeData

fiat_per_custom_creditstr

custom_fieldsDict[str, str]

optional

Optional[Dict[str, str]]

descriptionstr

optional

fiat_credit_typeCreditTypeData

optional

HTTPTypeScriptPythonGoRubyTerraform

from metronome import Metronome

client = Metronome(
    bearer_token="My Bearer Token",
)
page = client.v1.contracts.rate_cards.list()
page = page.data[0]
print(page.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"
}