List Rates In Catalog

get/rate-catalogs/{rate_catalog_id}/rates

Path ParametersExpand Collapse

rate_catalog_id: string

Query ParametersExpand Collapse

limit: optional number

maximum100

minimum1

offset: optional number

minimum0

ReturnsExpand Collapse

has_more: boolean

rates: array of object { id, interval, rate_catalog_id, 3 more }

id: string

interval: "monthly" or "yearly"

Accepts one of the following:

"monthly"

"yearly"

rate_catalog_id: string

type: "fixed" or "usage_based"

Accepts one of the following:

"fixed"

"usage_based"

fixed: optional object { id, code, description, 2 more }

id: string

code: 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"

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"

usage_based: optional object { id, code, description, 5 more } or object { id, code, description, 6 more }

Accepts one of the following:

Simple = object { id, code, description, 5 more }

id: string

code: 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"

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"

pricing_metric_id: string

usage_based_rate_type: optional "simple"

Dimensional = object { id, code, description, 6 more }

id: string

code: 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"

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"

pricing_metric_id: string

usage_based_rate_type: optional "dimensional"

List Rates In Catalog

curl https://api.uselark.ai/rate-catalogs/$RATE_CATALOG_ID/rates \
    -H "X-API-Key: $LARK_API_KEY"

{
  "has_more": true,
  "rates": [
    {
      "id": "rate_AJWMxR81jxoRlli6p13uf3JB",
      "interval": "monthly",
      "rate_catalog_id": "rcat_AJWMxR81jxoRlli6p13uf3JB",
      "type": "usage_based",
      "fixed": {
        "id": "id",
        "code": "code",
        "description": "description",
        "name": "name",
        "price": {
          "amount": {
            "currency_code": "usd",
            "value": "2500"
          },
          "price_type": "flat"
        }
      },
      "usage_based": {
        "id": "ubr_AJWMxR81jxoRlli6p13uf3JB",
        "code": "compute_hours",
        "description": "Compute hours usage",
        "included_units": 0,
        "name": "Compute Hours",
        "price": {
          "amount": {
            "currency_code": "usd",
            "value": "100"
          },
          "price_type": "flat"
        },
        "pricing_metric_id": "pmtr_GlX5Tcm2HOn00CoRTFxw2Amw",
        "usage_based_rate_type": "simple"
      }
    }
  ]
}

Returns Examples

{
  "has_more": true,
  "rates": [
    {
      "id": "rate_AJWMxR81jxoRlli6p13uf3JB",
      "interval": "monthly",
      "rate_catalog_id": "rcat_AJWMxR81jxoRlli6p13uf3JB",
      "type": "usage_based",
      "fixed": {
        "id": "id",
        "code": "code",
        "description": "description",
        "name": "name",
        "price": {
          "amount": {
            "currency_code": "usd",
            "value": "2500"
          },
          "price_type": "flat"
        }
      },
      "usage_based": {
        "id": "ubr_AJWMxR81jxoRlli6p13uf3JB",
        "code": "compute_hours",
        "description": "Compute hours usage",
        "included_units": 0,
        "name": "Compute Hours",
        "price": {
          "amount": {
            "currency_code": "usd",
            "value": "100"
          },
          "price_type": "flat"
        },
        "pricing_metric_id": "pmtr_GlX5Tcm2HOn00CoRTFxw2Amw",
        "usage_based_rate_type": "simple"
      }
    }
  ]
}