Skip to main content
GET
Get subscription

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

object | null

OK

Subscription resource representing an organization's billing plan. Managed through Polar integration with statuses like active, canceled, past_due.

id
string
required

Internal subscription record ID.

organization_id
string
required

WorkOS organization ID that owns the subscription.

polar_subscription_id
string | null
required

Polar subscription ID for this subscription.

polar_customer_id
string | null
required

Polar customer ID associated with the organization.

status
string
required

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

plan_id
string | null
required

Polar product ID for the subscribed plan.

plan_tier_id
string | null
required

Internal plan tier ID mapped to the subscription.

seats_purchased
integer
required

Total number of seats purchased in the subscription.

Required range: -9007199254740991 <= x <= 9007199254740991
seats_used
integer
required

Current number of seats in use by the organization.

Required range: -9007199254740991 <= x <= 9007199254740991
current_period_start
string<date-time> | null
required

Start timestamp of the current billing period.

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.

created_at
string<date-time>
required

Timestamp when the subscription record was created.

updated_at
string<date-time>
required

Timestamp when the subscription record was last updated.