Skip to main content
POST
/
api
/
user
/
stripe
/
plan
Get current subscription plan
curl --request POST \
  --url https://pria.praxislxp.com/api/user/stripe/plan \
  --header 'x-access-token: <api-key>'
{
  "plan": "pro",
  "status": "active",
  "trial_end": 1700000000,
  "cancel_at_period_end": false,
  "current_period_end": 1700000000,
  "canceled_at": 123,
  "subscription": true
}

Authorizations

​
x-access-token
string
header
required

JWT token passed in x-access-token header

Response

Plan retrieved successfully

​
plan
string

Plan name derived from the Stripe price ID (empty string if none)

Example:

"pro"

​
status
enum<string>

Stripe subscription status

Available options:
incomplete,
incomplete_expired,
trialing,
active,
past_due,
canceled,
unpaid
Example:

"active"

​
trial_end
integer | null

Unix timestamp when the trial ends (null if no trial)

Example:

1700000000

​
cancel_at_period_end
boolean

Whether the subscription is set to cancel at the end of the current period

Example:

false

​
current_period_end
integer | null

Unix timestamp when the current billing period ends

Example:

1700000000

​
canceled_at

Unix timestamp when the subscription was canceled, or empty string if not canceled

​
subscription
boolean

Whether the user has an active Stripe subscription

Example:

true