Retrieve

API Reference

V1

Contracts

Rate Cards

Get a rate card

post/v1/contract-pricing/rate-cards/get

Get a specific rate card NOTE: Use /contract-pricing/rate-cards/getRates to retrieve rate card rates.

Body Parameters

idstring

formatuuid

Returns

dataobject

Hide ParametersShow Parameters

idstring

formatuuid

created_atstring

formatdate-time

created_bystring

namestring

aliasesarray of object

optional

Hide ParametersShow Parameters

namestring

ending_beforestring

optional

formatdate-time

starting_atstring

optional

formatdate-time

credit_type_conversionsarray of object

optional

Hide ParametersShow Parameters

custom_credit_typeidstringnamestringCreditTypeData

fiat_per_custom_creditstring

custom_fieldsmap

optional

descriptionstring

optional

fiat_credit_typeidstringnamestringCreditTypeData

optional

HTTPTypeScriptPythonGoRubyTerraform

curl https://api.metronome.com/v1/contract-pricing/rate-cards/get \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $METRONOME_BEARER_TOKEN" \
    -d '{
          "id": "f3d51ae8-f283-44e1-9933-a3cf9ad7a6fe"
        }'

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"
    }
  }
}