Skip to main content

GetSubscription retrieves the organization's current subscription details.

GET 
/api/v1/billing/subscription

Returns the complete subscription object including plan details, billing info, current period dates, and all subscription items. Use this for the billing dashboard or account settings page.

Authorization​

Requires billing:read permission. Organization ID extracted from JWT.

Response​

Returns the full Subscription object with:

  • Current plan details (embedded Plan object)
  • Billing period start/end dates
  • Trial information (if applicable)
  • Cancellation details (if cancelled)
  • All subscription items (seats, add-ons, etc.)

Errors​

  • NOT_FOUND: Organization has no subscription (new org, needs to subscribe)
  • UNAUTHENTICATED: Missing or invalid authentication token
  • PERMISSION_DENIED: Caller lacks billing:read permission

Responses​

A successful response.