Users

Get User Subscription

Returns the active organization's subscription: plan, status, renewal dates, billing period, and next-charge amount and currency.

get/v1/users/me/subscription

Request

  • Base URL: https://api.fettle.sh (the document declares no server; this is the origin it was published from)
  • URL: https://api.fettle.sh/v1/users/me/subscription
  • Auth: API key in header Authorization

Headers

X-Organization-Idstring uuid nullable

Response

Successful Response

plan'FREE' | 'PLUS' | 'PRO' | 'MAX' | 'ENTERPRISE' required

Subscription tier of an organization; gates feature/usage limits.

status'ACTIVE' | 'TRIALING' | 'PAST_DUE' | 'CANCELED' | 'INCOMPLETE' | 'INCOMPLETE_EXPIRED' | 'UNPAID'

Lifecycle state of a user's paid subscription.

Member name == value (UPPER_SNAKE_CASE) to match the project's enum convention and the persisted DB labels. Polar emits lowercase status strings on the wire; that translation lives in SubscriptionService.

cancel_at_period_endboolean
renews_atstring date-time nullable
expires_atstring date-time nullable
trial_ends_atstring date-time nullable
billing_period'MONTH' | 'YEAR'

How often a subscription renews.

Polar models monthly and yearly billing as separate products, so the period is part of what a checkout selects. Member name == value to match the project's enum convention and the persisted DB labels.

amountinteger nullable
currencystring nullable

Changes

No recorded changes to this operation across all 1 revision of this API.