# GET /billing/plan

**Resource:** [Billing](./billing.md)  
**Scopes:** `billing:read`  
**Write operation:** no

Get the company billing plan, subscription status, seat count, trial window, and plan gating flags.

## Response example

```json
{
  "example": {
    "id": "ca7359da-...",
    "status": "trialing",
    "billing_interval": "monthly",
    "seat_count": 1,
    "credit_balance": 500,
    "current_period_start": "2026-04-21T00:00:00Z",
    "current_period_end": "2026-05-21T00:00:00Z",
    "trial_end": "2026-05-05T00:00:00Z",
    "cancel_at_period_end": false,
    "billing_plans": {
      "id": "...",
      "plan_key": "pro",
      "plan_name": "Pro",
      "price_monthly": 99,
      "price_annual": 990,
      "credits_per_cycle": 5000,
      "trial_credit_grant": 500,
      "is_permissions_locked": false,
      "features": [
        "Full CRM access",
        "AI tools",
        "Automations"
      ],
      "feature_access": [
        "crm",
        "automations",
        "inbox",
        "tools"
      ]
    }
  }
}
```

## Notes

- status values: trialing (no-card 14-day Pro trial), active, past_due, canceled.
- billing_plans.is_permissions_locked: true on the Free plan -- the Permissions settings page is locked and role scopes cannot be edited.
- billing_plans.trial_credit_grant: credits automatically granted when a trial starts.
- billing_plans.plan_key: free, pro, or enterprise.
- trial_end: ISO timestamp when the no-card trial expires. Null for non-trial subscriptions.
- Free plan restriction: API access is blocked entirely for free plan workspaces. Every request (including GET /billing/plan) returns HTTP 403 with error code PLAN_REQUIRED and an upgrade_url. Use the Portal UI at /settings/billing to view billing for free plan workspaces.
- Trial continuity: when a user on a no-card trial calls create_checkout, remaining trial days carry over to the Stripe subscription rather than granting a fresh 14 days.

---
Base URL: `https://api.trustpager.com/functions/v1/api/v1` — Auth: `Authorization: Bearer YOUR_API_KEY`