Create

API Reference

V1

Contracts

Rate Cards

Create a rate card

v1.contracts.rate_cards.create(**kwargs) -> dataIDRateCardCreateResponse

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

Create a new rate card

Parameters

nameString

Used only in UI/API. It is not exposed to end customers.

aliasesarray

optional

Array[{ name, ending_before, starting_at}]

Reference this alias when creating a contract. If the same alias is assigned to multiple rate cards, it will reference the rate card to which it was most recently assigned. It is not exposed to end customers.

Hide ParametersShow Parameters

nameString

ending_beforeTime

optional

formatdate-time

starting_atTime

optional

formatdate-time

credit_type_conversionsarray

optional

Array[{ custom_credit_type_id, fiat_per_custom_credit}]

Required when using custom pricing units in rates.

Hide ParametersShow Parameters

custom_credit_type_idString

formatuuid

fiat_per_custom_creditFloat

custom_fieldshash

optional

Hash[Symbol, String]

descriptionString

optional

fiat_credit_type_idString

optional

The Metronome ID of the credit type to associate with the rate card, defaults to USD (cents) if not passed.

formatuuid

Returns

RateCardCreateResponseclass

Hide ParametersShow Parameters

dataidStringID

HTTPTypeScriptPythonGoRubyTerraform

require "metronome_sdk"

metronome = MetronomeSDK::Client.new(bearer_token: "My Bearer Token")

rate_card = metronome.v1.contracts.rate_cards.create(name: "My Rate Card")

puts(rate_card)

200 Example

{
  "data": {
    "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
  }
}