Skip to main content
GET
/
subscriptions
/
status
Get subscription status
curl --request GET \
  --url https://app.usechar.ai/api/subscriptions/status \
  --header 'Authorization: Bearer <token>'
{
  "status": "<string>",
  "plan_id": "<string>",
  "current_period_end": "2023-11-07T05:31:56Z",
  "cancel_at": "2023-11-07T05:31:56Z",
  "has_subscription": true
}

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