API Reference

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Rate Cards

Create Rate Card

rate_cards.create(RateCardCreateParams**kwargs) -> RateCardResource

post/rate-cards

List Rate Cards

rate_cards.list(RateCardListParams**kwargs) -> RateCardListResponse

get/rate-cards

Get Rate Card

rate_cards.retrieve(strrate_card_id) -> RateCardResource

get/rate-cards/{rate_card_id}

ModelsExpand Collapse

class AmountInput: …

currency_code: str

The currency code of the amount.

value: Union[float, str]

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

Accepts one of the following:

ValueUnionMember0 = float

ValueUnionMember1 = str

class FlatPriceInput: …

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

amount: AmountInput

currency_code: str

The currency code of the amount.

value: Union[float, str]

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

Accepts one of the following:

ValueUnionMember0 = float

ValueUnionMember1 = str

price_type: Optional[Literal["flat"]]

Accepts one of the following:

"flat"

class FlatPriceOutput: …

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

amount: AmountOutput

currency_code: str

The currency code of the amount.

value: str

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

price_type: Optional[Literal["flat"]]

Accepts one of the following:

"flat"

class PackagePriceInput: …

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: str

The currency code of the amount.

value: Union[float, str]

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

Accepts one of the following:

ValueUnionMember0 = float

ValueUnionMember1 = str

package_units: int

rounding_behavior: Literal["round_up", "round_down"]

Accepts one of the following:

"round_up"

"round_down"

price_type: Optional[Literal["package"]]

Accepts one of the following:

"package"

class PackagePriceOutput: …

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: str

The currency code of the amount.

value: str

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

package_units: int

rounding_behavior: Literal["round_up", "round_down"]

Accepts one of the following:

"round_up"

"round_down"

price_type: Optional[Literal["package"]]

Accepts one of the following:

"package"

class RateCardResource: …

id: str

The ID of the rate card.

billing_interval: Literal["monthly", "yearly"]

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

Accepts one of the following:

"monthly"

"yearly"

created_at: datetime

The date and time the rate card was created.

formatdate-time

fixed_rates: List[FixedRate]

The fixed rates of the rate card.

id: str

description: Optional[str]

name: str

price: FixedRatePrice

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

Accepts one of the following:

class FlatPriceOutput: …

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

amount: AmountOutput

currency_code: str

The currency code of the amount.

value: str

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

price_type: Optional[Literal["flat"]]

Accepts one of the following:

"flat"

class PackagePriceOutput: …

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: str

The currency code of the amount.

value: str

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

package_units: int

rounding_behavior: Literal["round_up", "round_down"]

Accepts one of the following:

"round_up"

"round_down"

price_type: Optional[Literal["package"]]

Accepts one of the following:

"package"

metadata: Dict[str, str]

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

name: str

The name of the rate card.

updated_at: datetime

The date and time the rate card was last updated.

formatdate-time

usage_based_rates: List[UsageBasedRate]

The usage based rates of the rate card.

Accepts one of the following:

class UsageBasedRateSimpleUsageBasedRateInterface: …

id: str

description: Optional[str]

included_units: int

name: str

price: UsageBasedRateSimpleUsageBasedRateInterfacePrice

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

Accepts one of the following:

class FlatPriceOutput: …

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

amount: AmountOutput

currency_code: str

The currency code of the amount.

value: str

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

price_type: Optional[Literal["flat"]]

Accepts one of the following:

"flat"

class PackagePriceOutput: …

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: str

The currency code of the amount.

value: str

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

package_units: int

rounding_behavior: Literal["round_up", "round_down"]

Accepts one of the following:

"round_up"

"round_down"

price_type: Optional[Literal["package"]]

Accepts one of the following:

"package"

pricing_metric_id: str

usage_based_rate_type: Optional[Literal["simple"]]

Accepts one of the following:

"simple"

class UsageBasedRateDimensionalUsageBasedRateInterface: …

id: str

description: Optional[str]

dimensions: List[UsageBasedRateDimensionalUsageBasedRateInterfaceDimension]

description: Optional[str]

key: str

values: List[str]

included_units: int

name: str

pricing_matrix: UsageBasedRateDimensionalUsageBasedRateInterfacePricingMatrix

cells: List[UsageBasedRateDimensionalUsageBasedRateInterfacePricingMatrixCell]

dimension_coordinates: Dict[str, str]

price: UsageBasedRateDimensionalUsageBasedRateInterfacePricingMatrixCellPrice

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

Accepts one of the following:

class FlatPriceOutput: …

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

amount: AmountOutput

currency_code: str

The currency code of the amount.

value: str

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

price_type: Optional[Literal["flat"]]

Accepts one of the following:

"flat"

class PackagePriceOutput: …

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: str

The currency code of the amount.

value: str

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

package_units: int

rounding_behavior: Literal["round_up", "round_down"]

Accepts one of the following:

"round_up"

"round_down"

price_type: Optional[Literal["package"]]

Accepts one of the following:

"package"

pricing_metric_id: str

usage_based_rate_type: Optional[Literal["dimensional"]]

Accepts one of the following:

"dimensional"

description: Optional[str]

The description of the rate card.