---
title: "Get the account's credit balance and plan"
method: GET
path: "/v1/users/{userID}/credits"
---

# Get the account's credit balance and plan

`GET /v1/users/{userID}/credits`

## Request

- Base URL: `https://api.plori.ai`
- URL: `https://api.plori.ai/v1/users/{userID}/credits`
- Auth: HTTP bearer

`userID` must be the authenticated account's own id (anything else is 403). Check the balance before taking on long work.

## Path parameters

- `userID` string, uuid, required

## Response `200`

Balance, plan, and purchase options.

- Credits
  - `balance` integer: Wallet balance in micro-USD (µ$), where 1,000,000 µ$ = $1. The wallet keeps the name 'credits' but every amount is US dollars.
  - `low_credit_threshold` integer: Low-balance threshold, in micro-USD (µ$).
  - `peg_cents` integer: Deprecated. Amounts are micro-USD (µ$), where 1,000,000 µ$ = $1; use that conversion rather than a credits-per-dollar rate.
  - `packs` object[]
    - `id` string
    - `usd_cents` integer: Purchase price in whole US cents.
    - `credits` integer: Balance granted, in micro-USD (µ$). Packs are flat: the µ$ granted equals usd_cents × 10,000.
  - `plans` object[]
    - `id` string
    - `usd_cents` integer: Monthly price in whole US cents.
    - `monthly_credits` integer: Monthly usage allowance, in micro-USD (µ$).
  - `active_plan` object, nullable
    - `sku` string
    - `monthly_credits` integer: Monthly usage allowance, in micro-USD (µ$).
    - `status` string
    - `current_period_end` string, date-time
    - `cancel_at_period_end` boolean
  - `can_manage_billing` boolean
  - `audience` 'anon' | 'registered_free' | 'subscribed'

## Other responses

- `401`: Missing or invalid credential.
- `403`: The resource belongs to another account.

---

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