---
title: "Get your subscription"
method: GET
path: "/v1/billing"
tags: ["billing"]
---

# Get your subscription

`GET /v1/billing`

## Request

- Base URL: `https://api.pomerado.ai`
- URL: `https://api.pomerado.ai/v1/billing`
- Auth: HTTP bearer

Returns your Personal account's plan and Premium subscription, any free Premium period from a redeemed code (promotion), and what checkout and the billing portal offer.

## Response `200`

Your subscription

- Billing
  - `plan` 'free' | 'premium', required
  - `status` 'free' | 'active' | 'trialing' | 'canceling' | 'past_due' | 'payment_failed', required: canceling: Premium until current_period_end, then Free. past_due: still Premium while a failed payment is retried. payment_failed: the first payment failed, so still Free
  - `interval` 'monthly' | 'yearly', nullable, required
  - `current_period_end` string, nullable, required: When the current period ends: the next renewal, the end of a trial, or when Premium ends
  - `live` boolean, required: False when Stripe couldn't be read, so this is the last stored subscription
  - `portal` boolean, required: The billing portal can open
  - `checkout` object, required: Which Premium intervals checkout offers
    - `monthly` boolean, required
    - `yearly` boolean, required
  - `yearly_switch` object, required
    - `available` boolean, required: A monthly subscription can switch to yearly at its next renewal
    - `scheduled` object, nullable, required
      - `schedule_id` string, required
      - `starts_at` string, required
    - `needs_support` boolean, required: The subscription has a scheduled change Pomerado didn't make; contact support
  - `promotion` PromotionSummary, required
    - `offer_name` string, required: The offer, such as 6 months of Premium
    - `ends_at` string, required: When the free Premium period ends (ISO 8601)
    - `billing_resumes_at` string, nullable, required: When Stripe bills again (ISO 8601), for an account that also pays through Stripe; else null

## Other responses

- `400`: invalid_request
- `401`: unauthorized, reauthentication_required
- `403`: billing_unavailable, forbidden
- `500`: internal_error
- `503`: temporarily_unavailable

---

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