comecerodocs
Usage rate plans

Get a rate plan version

GET
/usage/rate_plans/{rate_plan_id}/versions/{version}

One version of a rate plan. Secret and trusted tokens may call it; a limited token may not (403).

Authorization

headerAuthorizationBearer <token>

A secret, trusted or limited token. See Authentication.

Path Parameters

rate_plan_id*string

The rate plan id.

version*integer

The version.

Response Body

Success.

application/json
  1. response

The price of one metric in one currency. Each version is fixed once saved.

object?string

Always rate_plan.

rate_plan_id?string

Your id, or rate_ plus 32 characters.

version?integer

1 or more. Never changes once saved.

metric_id?string

The metric it prices.

currency?string

Three letters. Must be the currency of the agreements that use it.

pricing_model?string

How billable units are priced.

Value in"flat_per_unit""package""tiered_volume""tiered_graduated"
included_allowance?number

Units included in each period before any charge.

overage_price?number

Price per billable unit for flat_per_unit and package.

tiers?array<>

Required for the tiered models.

effective_from?string

Kept with the plan.

Formatdate-time
effective_to?string

Kept with the plan.

Formatdate-time
billing_region?string

Billing region. Defaults to us.

Value in"us""uk""eu"
test?boolean

Test or live.

Example Request
curl -X GET 'https://api.comecero.com/api/v1/usage/rate_plans/string/versions/0'
Example Response
{  "object": "rate_plan",  "rate_plan_id": "ai_tokens_standard",  "version": 1,  "metric_id": "met_ai_tokens",  "currency": "USD",  "pricing_model": "flat_per_unit",  "included_allowance": 100000,  "overage_price": 0.00002,  "tiers": [],  "billing_region": "us",  "test": false}

Create a rate plan version POST

Prices a metric. A saved version never changes: to change a price, save a new `version` with the same `rate_plan_id`. Tiers and package sizes price only the units above the included allowance. Secret and trusted tokens may call it; a limited token may not (`403`). The plan is not checked against an agreement's currency here: use a plan in the agreement's currency, or its billing run fails with `currency_mismatch`.

Overview

Next Page