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

# GET /api/consumer/billing/status

`GET /api/consumer/billing/status`

## Request

- Base URL: `https://idkrx.com`
- URL: `https://idkrx.com/api/consumer/billing/status`
- Auth: API key in cookie `authjs.session-token`

This account's IdkRx+ plan and subscription, read-only. Buying and managing happen on the website

## Response `200`

Billing status

- ConsumerBillingStatus
  - `billingConfigured` boolean, required
  - `tier` 'free' | 'plus', required
  - `hasCustomer` boolean, required
  - `subscription` object, nullable, required
    - `status` 'incomplete' | 'incomplete_expired' | 'trialing' | 'active' | 'paused' | 'past_due' | 'canceled' | 'unpaid', required
    - `planId` string, nullable, required
    - `interval` 'monthly' | 'yearly', required
    - `currentPeriodEnd` union
      - string
      - string, date-time
    - `cancelAt` union
      - string
      - string, date-time
    - `cancelAtPeriodEnd` boolean, nullable
    - `accessGraceEndsAt` union
      - string
      - string, date-time
    - `accessRevokedAt` union
      - string
      - string, date-time
    - `hasAccess` boolean, required
  - `plans` object[], required
    - `planId` string, required
    - `tier` 'plus', required
    - `productName` string, required
    - `description` string, required
    - `cycle` 'monthly' | 'yearly', required
    - `cycleLabel` 'Monthly' | 'Yearly', required
    - `interval` 'month' | 'year', required
    - `amountCents` integer, required
    - `currency` string, required
    - `stripePriceId` string, required

## Other responses

- `401`: Unauthorized

---

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