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

# GET /api/v1/billing

`GET /api/v1/billing`

## 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`
- Auth: none required

## Response `200`

Success

- object
  - `status` BillingStatusEncoded, required
    - `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
  - `removeBranding` RemoveBrandingStatusEncoded, required
    - `eligibility` 'included' | 'purchasable' | 'unavailable', required
    - `state` 'included' | 'none' | 'pending' | 'active', required
    - `purchaseBillingCycle` 'monthly' | 'yearly', nullable, required
    - `billingCycle` 'monthly' | 'yearly', nullable, required
    - `effectiveAt` union, required
      - number
      - 'Infinity' | '-Infinity' | 'NaN'
    - `endsAt` union, required
      - number
      - 'Infinity' | '-Infinity' | 'NaN'
  - `subscriptionLifecycle` BillingSubscriptionLifecycleEncoded, required
    - `plan` 'free' | 'hobby' | 'standard' | 'pro', required
    - `interval` 'day' | 'week' | 'month' | 'year', nullable, required
    - `lifecycle` 'free' | 'trialing' | 'active' | 'past_due' | 'paused' | 'canceling' | 'canceled', required
    - `renewalAt` union, required
      - number
      - 'Infinity' | '-Infinity' | 'NaN'
    - `trialEndsAt` union, required
      - number
      - 'Infinity' | '-Infinity' | 'NaN'
    - `endsAt` union, required
      - number
      - 'Infinity' | '-Infinity' | 'NaN'
    - `effectiveAt` union, required
      - number
      - 'Infinity' | '-Infinity' | 'NaN'
    - `scheduledDowngrade` ScheduledBillingSubscriptionDowngradeEncoded, required
      - `targetPlan` 'hobby' | 'standard' | 'pro', required
      - `effectiveAt` union, required
        - number
        - 'Infinity' | '-Infinity' | 'NaN'
    - `providerState` 'current' | 'pending' | 'stale', required
  - `creditPurchases` BillingCreditPurchaseListEncoded, required
    - `purchases` BillingCreditPurchaseEncoded[], required
      - `id` string, required
      - `amountDollars` union, required
        - number
        - 'Infinity' | '-Infinity' | 'NaN'
      - `credits` union, required
        - number
        - 'Infinity' | '-Infinity' | 'NaN'
      - `status` 'pending' | 'completed' | 'failed' | 'refunded', required
      - `createdAt` union, required
        - number
        - 'Infinity' | '-Infinity' | 'NaN'
      - `completedAt` union, required
        - number
        - 'Infinity' | '-Infinity' | 'NaN'
  - `autoCharge` BillingCreditAutoChargeSettingsEncoded, required
    - `enabled` boolean, required
    - `amountDollars` union, required
      - number
      - 'Infinity' | '-Infinity' | 'NaN'
    - `spendingCapDollars` union, required
      - number
      - 'Infinity' | '-Infinity' | 'NaN'
    - `updatedAt` union, required
      - number
      - 'Infinity' | '-Infinity' | 'NaN'

## 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)