View Billing Overview

Return organization billing status, saved payment methods, subscription state, history items, and invoice links that the caller is allowed to manage.

Authorization

BearerAuth

AuthorizationBearer <token>

In: header

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/billing/overview"

{  "success": true,  "data": {    "summary": {      "active_membership_count": 1,      "active_addon_count": 2,      "active_subscription_count": 3,      "mrr": 87,      "currency": "GBP"    },    "payment_methods": [      {        "payment_method_id": "payment_method_docs_invalid",        "gateway": "airwallex",        "brand": "visa",        "last4": "4242",        "default": true,        "exp_month": 9,        "exp_year": 2028      }    ],    "payment_recovery": {      "gateway": "airwallex",      "recurring_retry_strategy": "Automated payment recovery for failed recurring payments.",      "daily": "One retry around 2 hours after failure.",      "short_cycle": "Retry daily for 2 to 6 day billing cycles.",      "long_cycle": "Retry every 2 days for up to 14 days on weekly, monthly, and yearly cycles."    },    "subscriptions": [      {        "subscription_id": "ad3095e4-4628-43d0-8e47-d8996c7daf0d",        "addon_slug": "release-smartlinks",        "addon_name": "Release Smartlinks",        "status": "active",        "amount": 19,        "currency": "GBP",        "cycle": "monthly",        "next_billing_at": "2026-08-01T09:00:00+00:00"      }    ],    "history": [      {        "checkout_id": "39b189c1-8f8e-4df2-8632-176f87f791a1",        "created_at": "2026-07-04T10:15:00+00:00",        "type": "addon_subscription",        "label": "Release Smartlinks Monthly",        "customer": "Maya Chen",        "gateway": "airwallex",        "status": "success",        "amount": 19,        "currency": "GBP",        "invoice_pdf_url": "/api/v1/billing/invoices/39b189c1-8f8e-4df2-8632-176f87f791a1/pdf"      }    ]  }}

Authorization

Response Body

200application/json

401application/json

403application/json

429application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`