Rate Cards

Create Rate Card

post/rate-cards

List Rate Cards

get/rate-cards

Get Rate Card

get/rate-cards/{rate_card_id}

ModelsExpand Collapse

AmountInput = object { currency_code, value }

currency_code: string

The currency code of the amount.

value: number or string

The value of the amount in the smallest unit of the currency.

Accepts one of the following:

UnionMember0 = number

UnionMember1 = string

FlatPriceInput = object { amount, price_type }

Flat price is a price that linearly scales with the quantity.

amount: AmountInput { currency_code, value }

currency_code: string

The currency code of the amount.

value: number or string

The value of the amount in the smallest unit of the currency.

Accepts one of the following:

UnionMember0 = number

UnionMember1 = string

price_type: optional "flat"

Accepts one of the following:

"flat"

FlatPriceOutput = object { amount, price_type }

Flat price is a price that linearly scales with the quantity.

amount: AmountOutput { currency_code, value }

currency_code: string

The currency code of the amount.

value: string

The value of the amount in the smallest unit of the currency.

price_type: optional "flat"

Accepts one of the following:

"flat"

PackagePriceInput = object { amount, package_units, rounding_behavior, price_type }

Package price is a price that is charged for a fixed number of units. For example, $10 per 1000 units. If the quantity is not a multiple of the package units, the rounding behavior will be applied.

amount: AmountInput { currency_code, value }

currency_code: string

The currency code of the amount.

value: number or string

The value of the amount in the smallest unit of the currency.

Accepts one of the following:

UnionMember0 = number

UnionMember1 = string

package_units: number

rounding_behavior: "round_up" or "round_down"

Accepts one of the following:

"round_up"

"round_down"

price_type: optional "package"

Accepts one of the following:

"package"

PackagePriceOutput = object { amount, package_units, rounding_behavior, price_type }

Package price is a price that is charged for a fixed number of units. For example, $10 per 1000 units. If the quantity is not a multiple of the package units, the rounding behavior will be applied.

amount: AmountOutput { currency_code, value }

currency_code: string

The currency code of the amount.

value: string

The value of the amount in the smallest unit of the currency.

package_units: number

rounding_behavior: "round_up" or "round_down"

Accepts one of the following:

"round_up"

"round_down"

price_type: optional "package"

Accepts one of the following:

"package"

RateCardResource = object { id, billing_interval, created_at, 6 more }

id: string

The ID of the rate card.

billing_interval: "monthly" or "yearly"

How often the customer will be billed for this rate card.

Accepts one of the following:

"monthly"

"yearly"

created_at: string

The date and time the rate card was created.

formatdate-time

fixed_rates: array of object { id, description, name, price }

The fixed rates of the rate card.

id: string

description: string

price: FlatPriceOutput { amount, price_type } or PackagePriceOutput { amount, package_units, rounding_behavior, price_type }

Flat price is a price that linearly scales with the quantity.

Accepts one of the following:

FlatPriceOutput = object { amount, price_type }

Flat price is a price that linearly scales with the quantity.

amount: AmountOutput { currency_code, value }

currency_code: string

The currency code of the amount.

value: string

The value of the amount in the smallest unit of the currency.

price_type: optional "flat"

Accepts one of the following:

"flat"

PackagePriceOutput = object { amount, package_units, rounding_behavior, price_type }

Package price is a price that is charged for a fixed number of units. For example, $10 per 1000 units. If the quantity is not a multiple of the package units, the rounding behavior will be applied.

amount: AmountOutput { currency_code, value }

currency_code: string

The currency code of the amount.

value: string

The value of the amount in the smallest unit of the currency.

package_units: number

rounding_behavior: "round_up" or "round_down"

Accepts one of the following:

"round_up"

"round_down"

price_type: optional "package"

Accepts one of the following:

"package"

metadata: map[string]

Additional metadata about the rate card. You may use this to store any custom data about the rate card.

The name of the rate card.

updated_at: string

The date and time the rate card was last updated.

formatdate-time

usage_based_rates: array of object { id, description, included_units, 4 more } or object { id, description, dimensions, 5 more }

The usage based rates of the rate card.

Accepts one of the following:

Simple = object { id, description, included_units, 4 more }

id: string

description: string

included_units: number

price: FlatPriceOutput { amount, price_type } or PackagePriceOutput { amount, package_units, rounding_behavior, price_type }

Flat price is a price that linearly scales with the quantity.

Accepts one of the following:

FlatPriceOutput = object { amount, price_type }

Flat price is a price that linearly scales with the quantity.

amount: AmountOutput { currency_code, value }

currency_code: string

The currency code of the amount.

value: string

The value of the amount in the smallest unit of the currency.

price_type: optional "flat"

Accepts one of the following:

"flat"

PackagePriceOutput = object { amount, package_units, rounding_behavior, price_type }

Package price is a price that is charged for a fixed number of units. For example, $10 per 1000 units. If the quantity is not a multiple of the package units, the rounding behavior will be applied.

amount: AmountOutput { currency_code, value }

currency_code: string

The currency code of the amount.

value: string

The value of the amount in the smallest unit of the currency.

package_units: number

rounding_behavior: "round_up" or "round_down"

Accepts one of the following:

"round_up"

"round_down"

price_type: optional "package"

Accepts one of the following:

"package"

pricing_metric_id: string

usage_based_rate_type: optional "simple"

Accepts one of the following:

"simple"

Dimensional = object { id, description, dimensions, 5 more }

id: string

description: string

dimensions: array of object { description, key, values }

description: string

key: string

values: array of string

included_units: number

pricing_matrix: object { cells }

cells: array of object { dimension_coordinates, price }

dimension_coordinates: map[string]

price: FlatPriceOutput { amount, price_type } or PackagePriceOutput { amount, package_units, rounding_behavior, price_type }

Flat price is a price that linearly scales with the quantity.

Accepts one of the following:

FlatPriceOutput = object { amount, price_type }

Flat price is a price that linearly scales with the quantity.

amount: AmountOutput { currency_code, value }

currency_code: string

The currency code of the amount.

value: string

The value of the amount in the smallest unit of the currency.

price_type: optional "flat"

Accepts one of the following:

"flat"

PackagePriceOutput = object { amount, package_units, rounding_behavior, price_type }

Package price is a price that is charged for a fixed number of units. For example, $10 per 1000 units. If the quantity is not a multiple of the package units, the rounding behavior will be applied.

amount: AmountOutput { currency_code, value }

currency_code: string

The currency code of the amount.

value: string

The value of the amount in the smallest unit of the currency.

package_units: number

rounding_behavior: "round_up" or "round_down"

Accepts one of the following:

"round_up"

"round_down"

price_type: optional "package"

Accepts one of the following:

"package"

pricing_metric_id: string

usage_based_rate_type: optional "dimensional"

Accepts one of the following:

"dimensional"

description: optional string

The description of the rate card.