---
title: "Read the effective Stripe subscription"
method: GET
path: "/billing/subscription"
tags: ["Billing"]
---

# Read the effective Stripe subscription

`GET /billing/subscription`

## Request

- Base URL: `https://api.flashdata.dev/v2`
- URL: `https://api.flashdata.dev/v2/billing/subscription`
- Auth: API key in cookie `__Host-fd_session`

## Response `200`

Subscription or PAYG entitlement

- Subscription: Effective entitlement projection. `status=payg` and `id=null` means no billing subscription record exists.
  - `id` string, nullable
  - `status` 'payg' | 'trialing' | 'active' | 'past_due' | 'grace' | 'cancelled', required
  - `plan` Plan, required
    - `id` string, required
    - `slug` string, required
    - `name` string, required
    - `description` string, required
    - `includedCredits` number, required: Credits included in each paid subscription cycle; zero for Pay As You Go.
    - `limits` PlanLimits, required
      - `concurrency` integer, required
      - `maxBatchSize` integer, required
      - `maxPendingJobs` integer, required
    - `prices` PlanPrice[], required
      - `id` string, required
      - `currency` 'USD', required
      - `unitAmount` integer, required: USD cents
      - `credits` number, required: Credits granted by a successful one-time top-up; zero for recurring prices.
      - `type` 'recurring' | 'one_time', required
      - `interval` 'month' | 'year' | 'null', nullable, required
    - `features` string[], required
    - `usagePrices` PlanUsagePrices, required
      - `googlePer1kCents` integer, required: Google request price per 1,000 successful requests, in USD cents.
      - `youtubePer1kCents` integer, required: Standard YouTube request price per 1,000 successful requests, in USD cents.
      - `downloadPerTbCents` integer, required: Download price per decimal TB (1,000,000,000,000 bytes), in USD cents.
  - `usageRates` object, required: Account-specific configured credit rates. Query rates come from the account entitlement, not the public plan catalog. One TB is 1,000,000,000,000 bytes; download charges are settled against actual bytes and rounded per result.
    - `customized` boolean, required: True when an administrator configured rates for this account.
    - `queries` object[], required
      - `source` string, required
      - `name` string, required
      - `creditsPerRequest` number, required
    - `downloadCreditsPerTb` number, required
  - `currentPeriodStart` string, date-time, nullable
  - `currentPeriodEnd` string, date-time, nullable
  - `cancelAtPeriodEnd` boolean, required
  - `graceEndsAt` string, date-time, nullable

## Other responses

- `401`: Authentication required or invalid

---

[API](https://skmtc.dev/flashdata/apis/flashdata-customer-api.md) · [All operations](https://skmtc.dev/flashdata/apis/flashdata-customer-api/llms.txt) · [OpenAPI document](https://skmtc.dev/flashdata/apis/flashdata-customer-api/revisions/109179fe9313?raw)