CumulusDocs
Open Studio
On this page

Get your rate card

Read your environment’s active rates. configured: false means metered pricing has not been installed.

Operation ID: usage.rate_card.

Request

GET /api/v1/usage/rate-card

  • TypeScript SDK: client.usage.rate_card (path arguments use path).
  • MCP tool: sdk_client_call with operationId: "usage.rate_card" (path arguments use input.path). Legacy alias: usage_rate_card. Connect to your authenticated /mcp endpoint with an API key for the same environment.
  • Minimum API key role: viewer.
  • Idempotency: No idempotency header required.

Read resource IDs from earlier responses and use a key for the same environment.

Request example

Set each path variable to an ID returned by an earlier API request.

Set CUMULUS_BASE_URL to your workspace API URL and CUMULUS_API_KEY to a key for that environment. Example values are synthetic.

cURL

curl
curl --fail-with-body -sS "${CUMULUS_BASE_URL%/}/api/v1/usage/rate-card" \
  -H "Authorization: Bearer $CUMULUS_API_KEY"

TypeScript

typescript
import { Cumulus } from "@cumulus/sdk";

const baseUrl = process.env.CUMULUS_BASE_URL;
const apiKey = process.env.CUMULUS_API_KEY;
if (!baseUrl || !apiKey) throw new Error("Set CUMULUS_BASE_URL and CUMULUS_API_KEY");
const client = new Cumulus({ baseUrl, apiKey });

const response = await client.usage.rate_card({});

Input schema

Path, query and header parameters

No path or query parameters.

JSON request body

This operation has no JSON request body.

Complete OpenAPI schema
OpenAPI JSON
{
  "parameters": [],
  "requestBody": null
}

Responses

HTTP 200

Read the customer rates of the tenant's active pricing (configured: false until metered pricing is installed)

application/json

FieldType or valuesRequiredDescription and limits
configuredbooleanRequired—
rate_card_idstring or nullRequiredminLength: 1.
currency"USD"Required—
period_startstring (date-time) or nullRequiredpattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:.\d+)?(?:Z|(+-:[0-5]\d)))$.
period_endstring (date-time) or nullRequiredpattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:.\d+)?(?:Z|(+-:[0-5]\d)))$.
ratesarray of objectRequired—
rates[].rate_idstringRequiredminLength: 1.
rates[].meter"telephony.connected_ms" · "stt.audio_ms" · "tts.characters" · "tts.audio_ms"Required—
rates[].unit"ms" · "character"Required—
rates[].usd_per_unitstringRequiredpattern: ^(0|[1-9][0-9]*)(.[0-9]{1,18})?$.
rates[].display_unit"minute" · "1000_characters"Required—
rates[].usd_per_display_unitstringRequiredpattern: ^(0|[1-9][0-9]*)(.[0-9]{1,18})?$.

Error responses

HTTPDescription
4XXTyped error (ApiError)
5XXTyped error (ApiError)

Errors use the shared error envelope. Inspect error.code, retryable, outcome and details before retrying.

Complete OpenAPI schema
OpenAPI JSON
{
  "200": {
    "description": "Read the customer rates of the tenant's active pricing (configured: false until metered pricing is installed)",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/UsageRateCardResponse200"
        }
      }
    }
  },
  "4XX": {
    "description": "Typed error (ApiError)",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/ApiError"
        }
      }
    }
  },
  "5XX": {
    "description": "Typed error (ApiError)",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/ApiError"
        }
      }
    }
  }
}

Referenced schemas

Expand the complete OpenAPI definitions for integrations that generate their own clients.

Complete OpenAPI schema
OpenAPI JSON
{
  "components": {
    "schemas": {
      "UsageRateCardResponse200": {
        "type": "object",
        "properties": {
          "configured": {
            "type": "boolean"
          },
          "rate_card_id": {
            "nullable": true,
            "type": "string",
            "minLength": 1
          },
          "currency": {
            "type": "string",
            "enum": [
              "USD"
            ]
          },
          "period_start": {
            "nullable": true,
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
          },
          "period_end": {
            "nullable": true,
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
          },
          "rates": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "rate_id": {
                  "type": "string",
                  "minLength": 1
                },
                "meter": {
                  "type": "string",
                  "enum": [
                    "telephony.connected_ms",
                    "stt.audio_ms",
                    "tts.characters",
                    "tts.audio_ms"
                  ]
                },
                "unit": {
                  "type": "string",
                  "enum": [
                    "ms",
                    "character"
                  ]
                },
                "usd_per_unit": {
                  "type": "string",
                  "pattern": "^(0|[1-9][0-9]*)(\\.[0-9]{1,18})?$"
                },
                "display_unit": {
                  "type": "string",
                  "enum": [
                    "minute",
                    "1000_characters"
                  ]
                },
                "usd_per_display_unit": {
                  "type": "string",
                  "pattern": "^(0|[1-9][0-9]*)(\\.[0-9]{1,18})?$"
                }
              },
              "required": [
                "rate_id",
                "meter",
                "unit",
                "usd_per_unit",
                "display_unit",
                "usd_per_display_unit"
              ],
              "additionalProperties": false
            }
          }
        },
        "required": [
          "configured",
          "rate_card_id",
          "currency",
          "period_start",
          "period_end",
          "rates"
        ],
        "additionalProperties": false
      },
      "ApiError": {
        "type": "object",
        "properties": {
          "error": {
            "type": "object",
            "properties": {
              "code": {
                "type": "string",
                "enum": [
                  "unauthenticated",
                  "forbidden",
                  "not_found",
                  "conflict",
                  "invalid_request",
                  "idempotency_conflict",
                  "policy_denied",
                  "capability_unavailable",
                  "provider_unavailable",
                  "knowledge_unavailable",
                  "publication_invalid",
                  "run_not_active",
                  "rate_limited",
                  "outcome_unknown",
                  "internal"
                ]
              },
              "message": {
                "type": "string"
              },
              "retryable": {
                "type": "boolean"
              },
              "outcome": {
                "type": "string",
                "enum": [
                  "none",
                  "unknown"
                ]
              },
              "details": {
                "type": "object",
                "additionalProperties": {}
              }
            },
            "required": [
              "code",
              "message",
              "retryable",
              "outcome"
            ],
            "additionalProperties": false
          }
        },
        "required": [
          "error"
        ],
        "additionalProperties": false
      }
    }
  }
}

Errors and recovery

See API error handling and Troubleshooting.

Content version 3a13827fCustomer SDKMarkdown source
Get your rate card · Cumulus developer docs