---
title: "Get billing summary for the current viewer"
method: GET
path: "/v1/billing/summary"
tags: ["Billing"]
---

# Get billing summary for the current viewer

`GET /v1/billing/summary`

## Request

- Base URL: `https://api.lizzflix.xyz` (the document declares no server; this is the origin it was published from)
- URL: `https://api.lizzflix.xyz/v1/billing/summary`
- Auth: none declared

## Response `200`

Billing summary

- BillingSummary
  - `plan` string, nullable, required
  - `planStatus` string, required
  - `paymentState` string, required
  - `currentPeriodStart` string, nullable, required
  - `currentPeriodEnd` string, nullable, required
  - `availableCredits` number, required
  - `availablePoints` number, required
  - `reservedCredits` number, required
  - `reservedPoints` number, required
  - `monthlyCreditsRemaining` number, required
  - `monthlyPointsRemaining` number, required
  - `purchasedCreditsRemaining` number, required
  - `purchasedPointsRemaining` number, required
  - `pendingDowngradePlan` string, nullable, required
  - `viewerRole` string, nullable, required
  - `billingExempt` boolean, required
  - `recentUsage` BillingRecentUsageItem[], required
    - `id` string, required
    - `provider` string, nullable, required
    - `modelKey` string, nullable, required
    - `feature` string, nullable, required
    - `billableCategory` string, nullable, required
    - `providerCostUsd` number, required
    - `chargedCredits` number, required
    - `chargedPoints` number, required
    - `createdAt` string, required
  - `plans` BillingPlan[], required
    - `key` string, required
    - `name` string, required
    - `priceUsd` number, required
    - `monthlyCredits` number, required
    - `monthlyPoints` number, required
    - `interval` string, nullable, required
  - `topups` BillingTopup[], required
    - `key` string, required
    - `name` string, required
    - `priceUsd` number, required
    - `grantedCredits` number, required
    - `grantedPoints` number, required
  - `pricingRules` BillingPricingRule[], required
    - `key` string, required
    - `category` string, required
    - `multiplier` number, required
    - `minimumCredits` number, required
    - `minimumPoints` number, required
    - `riskBuffer` number, required
    - `roundingIncrement` number, nullable, required
  - `stripeConfigured` boolean, required
  - `publishableKeyConfigured` boolean, required
  - `consumerRights` ConsumerRights, required
    - `checkoutConsentRequired` boolean, required
    - `consentVersion` string, required
    - `withdrawalEnabled` boolean, required
    - `withdrawalWindowDays` number, required
    - `withdrawalStatementVersion` string, required
    - `planCancellationEnabled` boolean, required
    - `subscription` object, nullable, required
      - `status` string, required
      - `cancelAtPeriodEnd` boolean, required
      - `currentPeriodEnd` string, nullable, required
  - `standing` BillingSummaryStanding
    - `status` string, required
    - `suspendedReason` string, nullable, required

## Other responses

- `401`: Unauthorized

---

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