Get Rate Card

client.rateCards.retrieve(, ?): RateCardResource { id, billing_interval, created_at, 6 more }

get/rate-cards/{rate_card_id}

Get Rate Card

ParametersExpand Collapse

rateCardID: string

ReturnsExpand Collapse

RateCardResource { id, billing_interval, created_at, 6 more }

id: string

The ID of the rate card.

billing_interval: "monthly" | "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<FixedRate>

The fixed rates of the rate card.

id: string

description: string | null

price: FlatPriceOutput { amount, price_type } | 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 { 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?: "flat"

Accepts one of the following:

"flat"

PackagePriceOutput { 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" | "round_down"

Accepts one of the following:

"round_up"

"round_down"

price_type?: "package"

Accepts one of the following:

"package"

metadata: Record<string, 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<SimpleUsageBasedRateInterface { id, description, included_units, 4 more } | DimensionalUsageBasedRateInterface { id, description, dimensions, 5 more } >

The usage based rates of the rate card.

Accepts one of the following:

SimpleUsageBasedRateInterface { id, description, included_units, 4 more }

id: string

description: string | null

included_units: number

price: FlatPriceOutput { amount, price_type } | 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 { 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?: "flat"

Accepts one of the following:

"flat"

PackagePriceOutput { 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" | "round_down"

Accepts one of the following:

"round_up"

"round_down"

price_type?: "package"

Accepts one of the following:

"package"

pricing_metric_id: string

usage_based_rate_type?: "simple"

Accepts one of the following:

"simple"

DimensionalUsageBasedRateInterface { id, description, dimensions, 5 more }

id: string

description: string | null

dimensions: Array<Dimension>

description: string | null

key: string

values: Array<string>

included_units: number

pricing_matrix: PricingMatrix { cells }

cells: Array<Cell>

dimension_coordinates: Record<string, string>

price: FlatPriceOutput { amount, price_type } | 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 { 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?: "flat"

Accepts one of the following:

"flat"

PackagePriceOutput { 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" | "round_down"

Accepts one of the following:

"round_up"

"round_down"

price_type?: "package"

Accepts one of the following:

"package"

pricing_metric_id: string

usage_based_rate_type?: "dimensional"

Accepts one of the following:

"dimensional"

description?: string | null

The description of the rate card.

Get Rate Card

import Lark from 'lark-billing';

const client = new Lark({
  apiKey: 'My API Key',
});

const rateCardResource = await client.rateCards.retrieve('rate_card_id');

console.log(rateCardResource.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."
}