Rate Cards

Create Rate Card

client.RateCards.New(ctx, body) (*RateCardResource, error)

post/rate-cards

List Rate Cards

client.RateCards.List(ctx, query) (*RateCardListResponse, error)

get/rate-cards

Get Rate Card

client.RateCards.Get(ctx, rateCardID) (*RateCardResource, error)

get/rate-cards/{rate_card_id}

ModelsExpand Collapse

type AmountInput struct{…}

CurrencyCode string

The currency code of the amount.

Value AmountInputValueUnion

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

Accepts one of the following:

float64

string

type FlatPriceInput struct{…}

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

Amount AmountInput

CurrencyCode string

The currency code of the amount.

Value AmountInputValueUnion

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

Accepts one of the following:

float64

string

PriceType FlatPriceInputPriceTypeoptional

Accepts one of the following:

const FlatPriceInputPriceTypeFlat FlatPriceInputPriceType = "flat"

type FlatPriceOutput struct{…}

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

Amount AmountOutput

CurrencyCode string

The currency code of the amount.

Value string

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

PriceType FlatPriceOutputPriceTypeoptional

Accepts one of the following:

const FlatPriceOutputPriceTypeFlat FlatPriceOutputPriceType = "flat"

type PackagePriceInput struct{…}

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

CurrencyCode string

The currency code of the amount.

Value AmountInputValueUnion

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

Accepts one of the following:

float64

string

PackageUnits int64

RoundingBehavior PackagePriceInputRoundingBehavior

Accepts one of the following:

const PackagePriceInputRoundingBehaviorRoundUp PackagePriceInputRoundingBehavior = "round_up"

const PackagePriceInputRoundingBehaviorRoundDown PackagePriceInputRoundingBehavior = "round_down"

PriceType PackagePriceInputPriceTypeoptional

Accepts one of the following:

const PackagePriceInputPriceTypePackage PackagePriceInputPriceType = "package"

type PackagePriceOutput struct{…}

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

CurrencyCode string

The currency code of the amount.

Value string

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

PackageUnits int64

RoundingBehavior PackagePriceOutputRoundingBehavior

Accepts one of the following:

const PackagePriceOutputRoundingBehaviorRoundUp PackagePriceOutputRoundingBehavior = "round_up"

const PackagePriceOutputRoundingBehaviorRoundDown PackagePriceOutputRoundingBehavior = "round_down"

PriceType PackagePriceOutputPriceTypeoptional

Accepts one of the following:

const PackagePriceOutputPriceTypePackage PackagePriceOutputPriceType = "package"

type RateCardResource struct{…}

ID string

The ID of the rate card.

BillingInterval RateCardResourceBillingInterval

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

Accepts one of the following:

const RateCardResourceBillingIntervalMonthly RateCardResourceBillingInterval = "monthly"

const RateCardResourceBillingIntervalYearly RateCardResourceBillingInterval = "yearly"

CreatedAt Time

The date and time the rate card was created.

formatdate-time

FixedRates []RateCardResourceFixedRate

The fixed rates of the rate card.

ID string

Description string

Name string

Price RateCardResourceFixedRatePriceUnion

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

Accepts one of the following:

type FlatPriceOutput struct{…}

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

Amount AmountOutput

CurrencyCode string

The currency code of the amount.

Value string

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

PriceType FlatPriceOutputPriceTypeoptional

Accepts one of the following:

const FlatPriceOutputPriceTypeFlat FlatPriceOutputPriceType = "flat"

type PackagePriceOutput struct{…}

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

CurrencyCode string

The currency code of the amount.

Value string

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

PackageUnits int64

RoundingBehavior PackagePriceOutputRoundingBehavior

Accepts one of the following:

const PackagePriceOutputRoundingBehaviorRoundUp PackagePriceOutputRoundingBehavior = "round_up"

const PackagePriceOutputRoundingBehaviorRoundDown PackagePriceOutputRoundingBehavior = "round_down"

PriceType PackagePriceOutputPriceTypeoptional

Accepts one of the following:

const PackagePriceOutputPriceTypePackage PackagePriceOutputPriceType = "package"

Metadata map[string, string]

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

Name string

The name of the rate card.

UpdatedAt Time

The date and time the rate card was last updated.

formatdate-time

UsageBasedRates []RateCardResourceUsageBasedRateUnion

The usage based rates of the rate card.

Accepts one of the following:

type RateCardResourceUsageBasedRateSimple struct{…}

ID string

Description string

IncludedUnits int64

Name string

Price RateCardResourceUsageBasedRateSimplePriceUnion

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

Accepts one of the following:

type FlatPriceOutput struct{…}

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

Amount AmountOutput

CurrencyCode string

The currency code of the amount.

Value string

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

PriceType FlatPriceOutputPriceTypeoptional

Accepts one of the following:

const FlatPriceOutputPriceTypeFlat FlatPriceOutputPriceType = "flat"

type PackagePriceOutput struct{…}

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

CurrencyCode string

The currency code of the amount.

Value string

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

PackageUnits int64

RoundingBehavior PackagePriceOutputRoundingBehavior

Accepts one of the following:

const PackagePriceOutputRoundingBehaviorRoundUp PackagePriceOutputRoundingBehavior = "round_up"

const PackagePriceOutputRoundingBehaviorRoundDown PackagePriceOutputRoundingBehavior = "round_down"

PriceType PackagePriceOutputPriceTypeoptional

Accepts one of the following:

const PackagePriceOutputPriceTypePackage PackagePriceOutputPriceType = "package"

PricingMetricID string

UsageBasedRateType stringoptional

Accepts one of the following:

const RateCardResourceUsageBasedRateSimpleUsageBasedRateTypeSimple RateCardResourceUsageBasedRateSimpleUsageBasedRateType = "simple"

type RateCardResourceUsageBasedRateDimensional struct{…}

ID string

Description string

Dimensions []RateCardResourceUsageBasedRateDimensionalDimension

Description string

Key string

Values []string

IncludedUnits int64

Name string

PricingMatrix RateCardResourceUsageBasedRateDimensionalPricingMatrix

Cells []RateCardResourceUsageBasedRateDimensionalPricingMatrixCell

DimensionCoordinates map[string, string]

Price RateCardResourceUsageBasedRateDimensionalPricingMatrixCellPriceUnion

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

Accepts one of the following:

type FlatPriceOutput struct{…}

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

Amount AmountOutput

CurrencyCode string

The currency code of the amount.

Value string

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

PriceType FlatPriceOutputPriceTypeoptional

Accepts one of the following:

const FlatPriceOutputPriceTypeFlat FlatPriceOutputPriceType = "flat"

type PackagePriceOutput struct{…}

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

CurrencyCode string

The currency code of the amount.

Value string

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

PackageUnits int64

RoundingBehavior PackagePriceOutputRoundingBehavior

Accepts one of the following:

const PackagePriceOutputRoundingBehaviorRoundUp PackagePriceOutputRoundingBehavior = "round_up"

const PackagePriceOutputRoundingBehaviorRoundDown PackagePriceOutputRoundingBehavior = "round_down"

PriceType PackagePriceOutputPriceTypeoptional

Accepts one of the following:

const PackagePriceOutputPriceTypePackage PackagePriceOutputPriceType = "package"

PricingMetricID string

UsageBasedRateType stringoptional

Accepts one of the following:

const RateCardResourceUsageBasedRateDimensionalUsageBasedRateTypeDimensional RateCardResourceUsageBasedRateDimensionalUsageBasedRateType = "dimensional"

Description stringoptional

The description of the rate card.