Skip to main content
GET
Get subscription status

Authorizations

Authorization
string
header
required

WorkOS JWT token. Obtain via WorkOS AuthKit authentication flow. The token must include organization_id claim for organization-scoped endpoints.

Response

OK

Summary of subscription status including plan, period end, cancellation date, and whether a subscription exists

status
string
required

Current subscription status (active, canceled, past_due, etc.).

plan_id
string | null
required

Polar product ID for the subscribed plan.

current_period_end
string<date-time> | null
required

End timestamp of the current billing period.

cancel_at
string<date-time> | null
required

Scheduled cancellation timestamp, if set.

has_subscription
boolean
required

Whether the organization has a subscription record