Change Plan

POST

/api/v1/users/me/subscription/change-plan

POST

/api/v1/users/me/subscription/change-plan

$ curl -X POST https://api.onepin.ai/api/v1/users/me/subscription/change-plan \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "new_plan_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
> }'

1 {
2   "data": {
3     "id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
4     "plan": {
5       "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
6       "name": "Pro Plan",
7       "tier": "paid",
8       "limits": {},
9       "billing_interval": "monthly",
10       "amount": 2999,
11       "currency": "USD",
12       "display_order": 2,
13       "plan_details": {
14         "sections": [
15           {
16             "title": "Features",
17             "items": [
18               {
19                 "label": "Projects",
20                 "value": "Unlimited"
21               },
22               {
23                 "label": "Storage",
24                 "value": "100 GB"
25               }
26             ]
27           }
28         ]
29       }
30     },
31     "status": "active",
32     "current_period_start": "2024-01-15T09:30:00Z",
33     "current_period_end": "2024-02-15T09:30:00Z",
34     "cancel_at_period_end": false,
35     "canceled_at": "null",
36     "scheduled_plan": {
37       "id": "4b825dc6-8a0f-4f3a-9f3a-1a2b3c4d5e6f",
38       "name": "Enterprise Plan",
39       "tier": "custom",
40       "limits": {},
41       "billing_interval": "yearly",
42       "amount": 29999,
43       "currency": "USD",
44       "display_order": 3,
45       "plan_details": {
46         "sections": [
47           {
48             "title": "Features",
49             "items": [
50               {
51                 "label": "Projects",
52                 "value": "Unlimited"
53               },
54               {
55                 "label": "Storage",
56                 "value": "1 TB"
57               },
58               {
59                 "label": "Support",
60                 "value": "24/7 Priority"
61               }
62             ]
63           }
64         ]
65       }
66     },
67     "scheduled_at": "2024-02-01T00:00:00Z"
68   },
69   "meta": {
70     "request_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
71     "timestamp": "2024-01-15T09:30:00Z"
72   }
73 }

Switch the current user's subscription to a different plan.

Authentication

AuthorizationBearer

Clerk JWT token

Request

This endpoint expects an object.

new_plan_idstringRequiredformat: "uuid"

Response

Successful Response

dataobject

metaobject

Errors

422

Unprocessable Entity Error