Skip to main content
GET
/
subscriptions
Get subscription
curl --request GET \
  --url https://app.usechar.ai/api/subscriptions \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "organization_id": "<string>",
  "polar_subscription_id": "<string>",
  "polar_customer_id": "<string>",
  "status": "<string>",
  "plan_id": "<string>",
  "plan_tier_id": "<string>",
  "seats_purchased": 0,
  "seats_used": 0,
  "current_period_start": "2023-11-07T05:31:56Z",
  "current_period_end": "2023-11-07T05:31:56Z",
  "cancel_at": "2023-11-07T05:31:56Z",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Documentation Index

Fetch the complete documentation index at: https://docs.usechar.com/llms.txt

Use this file to discover all available pages before exploring further.

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.