---
title: "GET /api/v1/billing/status"
method: GET
path: "/api/v1/billing/status"
tags: ["billing"]
---

# GET /api/v1/billing/status

`GET /api/v1/billing/status`

## Request

- Base URL: `https://api.clerkchat.co` (the document declares no server; this is the origin it was published from)
- URL: `https://api.clerkchat.co/api/v1/billing/status`
- Auth: none required

## Response `200`

BillingStatus

- BillingStatusEncoded
  - `plan` 'free' | 'hobby' | 'standard' | 'pro', required
  - `credits` BillingCreditsStatusEncoded, required
    - `used` union, required
      - number
      - 'Infinity' | '-Infinity' | 'NaN'
    - `limit` union, required
      - number
      - 'Infinity' | '-Infinity' | 'NaN'
    - `resetAt` union, required
      - number
      - 'Infinity' | '-Infinity' | 'NaN'
  - `planSelection` union, required
    - object
      - `provider` 'stripe', required
    - object
      - `provider` 'shopify', required
      - `url` string, required
  - `purchasedCreditsAvailable` union, required
    - number
    - 'Infinity' | '-Infinity' | 'NaN'
  - `promotionalCreditsAvailable` union, required
    - number
    - 'Infinity' | '-Infinity' | 'NaN'
  - `canPurchaseCredits` boolean, required

## Other responses

- `400`: BadRequest
- `401`: Unauthorized
- `403`: Forbidden
- `503`: PersistenceUnavailable

---

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