---
title: "Credit balance and plan"
method: GET
path: "/api/v1/account"
tags: ["Account"]
---

# Credit balance and plan

`GET /api/v1/account`

## Request

- Base URL: `https://pixly.app`
- URL: `https://pixly.app/api/v1/account`
- Auth: one of:
  - HTTP bearer
  - OAuth 2 (authorization code, authorization URL `https://pixly.app/oauth/authorize`, token URL `https://pixly.app/api/oauth/token`, scopes: `tools`)

## Response `200`

The account

- Account
  - `creditsRemaining` number
  - `creditsTotal` number
  - `plan` string, nullable
  - `canUseCredits` boolean: False = no active plan; tools answer 402

## Other responses

- `401`: Missing/invalid credential
- `429`: Rate limited — see Retry-After (120 req/min, 30/min for generations)

---

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