Skip to content
Lark
Join our SlackContact usGet started
API Reference
Rate Cards

Get Rate Card

rate_cards.retrieve(strrate_card_id) -> RateCardResource
get/rate-cards/{rate_card_id}

Get Rate Card

ParametersExpand Collapse
rate_card_id: str
ReturnsExpand Collapse
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.

Get Rate Card
from lark import Lark

client = Lark(
    api_key="My API Key",
)
rate_card_resource = client.rate_cards.retrieve(
    "rate_card_id",
)
print(rate_card_resource.id)
{
  "id": "rc_jQK2n0wutCj6bBcAIrL6o07g",
  "billing_interval": "monthly",
  "created_at": "2025-11-01T00:00:00Z",
  "fixed_rates": [
    {
      "id": "fr_04EjnYJoQLC7gtLKI6mPzZny",
      "description": "description",
      "name": "Base Rate",
      "price": {
        "amount": {
          "currency_code": "usd",
          "value": "2500"
        },
        "price_type": "flat"
      }
    }
  ],
  "metadata": {},
  "name": "Pro Plan",
  "updated_at": "2025-11-01T00:00:00Z",
  "usage_based_rates": [
    {
      "id": "ubr_zoXOJrDXlGGJWRNq3HqFYhbP",
      "description": "description",
      "included_units": 30,
      "name": "Compute Hours",
      "price": {
        "amount": {
          "currency_code": "usd",
          "value": "100"
        },
        "price_type": "flat"
      },
      "pricing_metric_id": "pmtr_GlX5Tcm2HOn00CoRTFxw2Amw",
      "usage_based_rate_type": "simple"
    }
  ],
  "description": "For production applications with moderate usage."
}
Returns Examples
{
  "id": "rc_jQK2n0wutCj6bBcAIrL6o07g",
  "billing_interval": "monthly",
  "created_at": "2025-11-01T00:00:00Z",
  "fixed_rates": [
    {
      "id": "fr_04EjnYJoQLC7gtLKI6mPzZny",
      "description": "description",
      "name": "Base Rate",
      "price": {
        "amount": {
          "currency_code": "usd",
          "value": "2500"
        },
        "price_type": "flat"
      }
    }
  ],
  "metadata": {},
  "name": "Pro Plan",
  "updated_at": "2025-11-01T00:00:00Z",
  "usage_based_rates": [
    {
      "id": "ubr_zoXOJrDXlGGJWRNq3HqFYhbP",
      "description": "description",
      "included_units": 30,
      "name": "Compute Hours",
      "price": {
        "amount": {
          "currency_code": "usd",
          "value": "100"
        },
        "price_type": "flat"
      },
      "pricing_metric_id": "pmtr_GlX5Tcm2HOn00CoRTFxw2Amw",
      "usage_based_rate_type": "simple"
    }
  ],
  "description": "For production applications with moderate usage."
}