---
title: "Preview a credit top-up"
method: POST
path: "/billing/usage-top-up/preview"
tags: ["Billing"]
---

# Preview a credit top-up

`POST /billing/usage-top-up/preview`

## Request

- Base URL: `https://api.cactal.ai/v1`
- URL: `https://api.cactal.ai/v1/billing/usage-top-up/preview`
- Auth: HTTP bearer

Projects the price of a prepaid `credits` top-up (minimum 400) without charging anything. Requires active billing and the organization owner.

## Request body

- object
  - `organizationId` string, required
  - `credits` integer, required
  - `successUrl` string
  - `idempotencyKey` string

## Response `200`

Price projection for the top-up.

- object: Read-only price projection. Nothing is charged or changed.
  - `total` number, nullable, required: Total amount due now; `null` when the provider does not return one.
  - `currency` string, nullable, required: ISO currency code, e.g. `usd`.
  - `lineItems` object[], required: Itemized charges that make up the total.
    - `title` string: Line item title.
    - `description` string: Line item detail text.
    - `amount` number: Line item amount.
    - `quantity` number: Line item quantity.

## Other responses

- `400`: Validation failed. The response `message` names the first invalid field.
- `401`: Missing, invalid, expired, or revoked API key.
- `403`: The authenticated principal lacks the required capability.
- `404`: The resource does not exist or is outside the principal’s access scope.
- `429`: Rate limit exceeded. Retry after the number of seconds in the `Retry-After` header.

---

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