---
title: "Billing Overview Handler"
method: GET
path: "/payments/billing"
---

# Billing Overview Handler

`GET /payments/billing`

## Headers

- `x-api-key` string

## Cookies

- `lmnt-auth0` string, nullable

## Response `200`

Successful Response

- BillingOverviewResponse
  - `subscription` SubscriptionResponse, required
    - `price_id` string, nullable
    - `status` string, nullable
    - `current_period_end` integer, nullable
    - `cancel_at_period_end` boolean
    - `scheduled_change` ScheduledChange
      - `price_id` string, required
      - `plan_name` string, nullable
      - `effective_at` integer, required
  - `payment_method` PaymentMethodResponse
    - `brand` string, required
    - `last4` string, required
  - `invoices` InvoiceItem[]
    - `id` string, required
    - `number` string, nullable
    - `amount_paid` integer, required
    - `currency` string, required
    - `status` string, nullable
    - `created` integer, required
    - `hosted_invoice_url` string, nullable
    - `invoice_pdf` string, nullable

## Other responses

- `422` — Validation Error

---

[API](https://skmtc.net/lmnt/apis/yapster.md) · [All operations](https://skmtc.net/lmnt/apis/yapster/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/lmnt/yapster/versions/f153248e1350/schema)