---
title: "Credit packs and prices"
method: GET
path: "/v1/billing/credit-packages"
tags: ["Catalogue"]
---

# Credit packs and prices

`GET /v1/billing/credit-packages`

## Request

- Base URL: `https://api.kawaa.com`
- URL: `https://api.kawaa.com/v1/billing/credit-packages`
- Auth: one of:
  - API key in header `X-Api-Key`
  - HTTP bearer
  - OAuth 2 (authorization code, authorization URL `https://api.kawaa.com/oauth/authorize`, token URL `https://api.kawaa.com/oauth/token`, scopes: `billing:read`)

One-off credit packs. Needs a valid API key.

Prices are quoted in `currency`, which defaults to USD and is set by the query parameter. Each pack has a price in every supported currency, so this returns one currency's prices, not all of them. A currency Kawaa cannot price is a `400`, not a silent fallback to USD: quoting dollar amounts under another currency's label is how a buyer ends up comparing the wrong numbers.

## Query parameters

- `currency` string

## Response `200`

The packs, priced in the requested currency.

- object
  - `success` unknown, required
  - `data` object, required
    - `packages` object[], required: Every pack, smallest first. The list is fixed; only the prices move with `currency`.
      - `package_id` string, required: The value `POST /v1/billing/purchase-credits` takes as `package_id`.
      - `name` string, required: A display name built from the credit count.
      - `credits` integer, required: Credits added on purchase. They do not expire with a billing period.
      - `price` number, required: One-off charge in `currency`, in whole currency units (not cents).
      - `currency` 'usd' | 'eur' | 'gbp' | 'brl' | 'inr', required: LOWER-CASE here, unlike the plan catalogue, which reports it upper-case. Same value, two spellings: compare case-insensitively.
      - `savings_percent` integer, nullable, required: Discount against the smallest pack's per-credit rate, as a whole number. `null` for the smallest pack, which is the baseline.
      - `popular` boolean, required: A display hint for the pack Kawaa highlights. Not an entitlement and not a price.

## Other responses

- `400`: The request is malformed, or names a field this endpoint does not accept. Retrying it unchanged will fail identically.
- `401`: No credential, or one that is not accepted. `code` distinguishes `API_KEY_SUSPENDED` (subscription ended; restartable) from `API_KEY_REVOKED`, `SESSION_EXPIRED` and `OAUTH_TOKEN_EXPIRED` (a connected app's one-hour access token lapsed: refresh it and retry, or sign in again if no refresh token was issued or the refresh is refused).
- `403`: Refused, and **the code says which of three problems it is**, and they need different remedies: - `INSUFFICIENT_SCOPE`: the credential is valid but not scoped for this route. With an API key, issue one that carries the scope named in the message. With an OAuth access token, connect the app again asking for that scope as well as the ones it has, unless the message says a connected app can never be given it; then use an API key with every scope the message names, or have the account owner do it in the dashboard. - `PLAN_UPGRADE_REQUIRED`: the account's plan does not include the feature. **No key of any scope reaches it**, so issuing another is wasted work; the remedy is a plan change. Returned by the verification routes for `options.enrich`, and by the finder, the monitors, the audit log, auto-clean and the white-label routes. - `PLAN_LIMIT_EXCEEDED`: the plan includes the feature and the account is at its ceiling (webhook endpoints, team seats, integrations, auto-clean lists). Delete one or upgrade. - `FORBIDDEN`: refused for a reason none of the above covers. `ErrorCode` is an open set, so branch on the code with a default rather than exhaustively.
- `429`: Too many requests. When the server knows how long to wait, `Retry-After` says so and `error.retry_after_seconds` carries the same number; the `X-RateLimit-*` headers say where you stand.
- `default`: Any status this operation does not list. Kawaa's own errors carry the error envelope. The gateway in front of the API can answer any operation with its own bare body (`GatewayError`): a `503` after about 29 seconds, when the request may still have run and been charged, a `413` for a body over about 6 MB, or a `400` for a path with malformed percent-encoding.

---

[API](https://skmtc.dev/kawaa/apis/kawaa-api.md) · [All operations](https://skmtc.dev/kawaa/apis/kawaa-api/llms.txt) · [OpenAPI document](https://skmtc.dev/kawaa/apis/kawaa-api/revisions/d27c9c33f6ba?raw)