Skip to main content
GET
/
user
/
plan
{
  "planType": "FREE",
  "planName": "Pro",
  "planStatus": "ACTIVE",
  "customerId": "cus_1234567890",
  "orderId": "1234567",
  "paymentProvider": "STRIPE",
  "subscription": {
    "id": "3a71d6b5c6728b0404745c80a22a92a6",
    "userPlanId": "aa2d7970f320d412bc8560607f3dfb24",
    "subscriptionId": "sub_1234567890",
    "planId": "Pro",
    "expiresAt": "2023-11-07T05:31:56Z",
    "trialEndsAt": "2023-11-07T05:31:56Z",
    "trialStartedAt": "2023-11-07T05:31:56Z",
    "isTrialing": true,
    "trialEndingNotificationSent": true,
    "cancelAtPeriodEnd": true,
    "currentPeriodEnd": "2023-11-07T05:31:56Z",
    "currentPeriodStart": "2023-11-07T05:31:56Z",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  }
}

Authorizations

​
Better-Auth Session
string
cookie
required

Response

Subscription plan retrieved successfully

The user's subscription plan details

​
planType
enum<string>

The type of the plan, e.g. FREE, SUBSCRIPTION, ONE_TIME

Available options:
FREE,
SUBSCRIPTION,
ONE_TIME
​
planName
string

The name of the plan, declared in the config file

Example:

"Pro"

​
planStatus
enum<string>

The status of the plan, e.g. ACTIVE, INACTIVE, PAST_DUE, CANCELED, UNPAID, TRIALING, DELETED, EXPIRED

Available options:
ACTIVE,
INACTIVE,
PAST_DUE,
CANCELED,
UNPAID,
TRIALING,
DELETED,
EXPIRED
​
customerId
string

The customer ID of the user

Example:

"cus_1234567890"

​
orderId
string

The order ID of the user

Example:

"1234567"

​
paymentProvider
string

The payment provider e.g. STRIPE, LEMON_SQUEEZY

Example:

"STRIPE"

​
subscription
object