---
title: "Get credit balance"
method: GET
path: "/credits"
tags: ["Account"]
---

# Get credit balance

`GET /credits`

## Request

- Base URL: `https://www.rainbrand.com/api/v1`
- URL: `https://www.rainbrand.com/api/v1/credits`
- Auth: one of:
  - API key in header `x-api-key`
  - HTTP bearer
  - OAuth 2
    - Authorization code: `https://www.rainbrand.com/api/auth/oauth2/authorize`
    - Token URL: `https://www.rainbrand.com/api/auth/oauth2/token`

Read the credit balance and action costs for your personal account or a team. See [Credits and limits](/api/usage-limits) for billing and recovery.

## Query parameters

- `workspaceId` string: Team ID from GET /workspaces. Omit to check your personal account.

## Response `200`

OK

- object
  - `data` object, required
    - `balance` number, required
    - `unlimited` boolean, required
    - `pricing_version` integer, required: The workspace's pricing version. Credit amounts are comparable only within one version.
    - `credit_costs` object, required: Credits each action costs this workspace. 0 means the action is free right now. Selected-model generations are priced per request and aren't listed.
      - `brand_creation` number, required
      - `brand_edit` number, required
      - `brief` number, required
      - `review` number, required
      - `image_2k` number, required: Compatibility pricing field for 2K images; not a selected-model generation price.
      - `image_4k` number, required: Compatibility pricing field for 4K images; not a selected-model generation price.
    - `free_brand_creations` integer, required: Brand creations the workspace can still make without spending credits

## Other responses

- `401`: 401
- `403`: 403
- `404`: 404
- `429`: 429
- `500`: 500

---

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