API Documentation
Admin Endpoints
User Endpoints
Plan Endpoint
Icon Endpoint
User Endpoints
Retrieve own profile
User Endpoints
Retrieve own profile
Retrieve the profile of the currently authenticated user.
GET
/
user
{
"id": "78c30460ebbbdb349567a39a10a2c845",
"name": "John Doe",
"email": "john.doe@example.com",
"image": "https://example.com/image.png",
"role": "admin",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"userPlan": {
"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
Response
200
application/json
User profile retrieved successfully
The response is of type object
.
Was this page helpful?
{
"id": "78c30460ebbbdb349567a39a10a2c845",
"name": "John Doe",
"email": "john.doe@example.com",
"image": "https://example.com/image.png",
"role": "admin",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"userPlan": {
"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"
}
}
}