Preview Plan Change

GET

/api/v1/billing/plans/:plan_id/preview

GET

/api/v1/billing/plans/:plan_id/preview

$ curl https://api.onepin.ai/api/v1/billing/plans/plan_id/preview \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json"

1 {
2   "data": {
3     "current_plan": {
4       "id": "a3f1c9e2-4b7d-4f8a-9c3e-2d5b7f6a1e9c",
5       "name": "Basic Plan",
6       "tier": "free",
7       "limits": {
8         "projects": 3,
9         "storage_gb": 5
10       },
11       "billing_interval": "monthly",
12       "amount": 0,
13       "currency": "USD",
14       "display_order": 1,
15       "plan_details": {
16         "sections": [
17           {
18             "title": "Features",
19             "items": [
20               {
21                 "label": "Max Projects",
22                 "value": "3"
23               },
24               {
25                 "label": "Storage",
26                 "value": "5 GB"
27               }
28             ]
29           }
30         ]
31       }
32     },
33     "new_plan": {
34       "id": "b7d2e4f9-8c3a-4d1b-9f7e-5a6c8d2b3f4e",
35       "name": "Pro Plan",
36       "tier": "paid",
37       "limits": {
38         "projects": 50,
39         "storage_gb": 100,
40         "priority_support": true
41       },
42       "billing_interval": "monthly",
43       "amount": 2999,
44       "currency": "USD",
45       "display_order": 2,
46       "plan_details": {
47         "sections": [
48           {
49             "title": "Features",
50             "items": [
51               {
52                 "label": "Max Projects",
53                 "value": "50"
54               },
55               {
56                 "label": "Storage",
57                 "value": "100 GB"
58               },
59               {
60                 "label": "Support",
61                 "value": "Priority Support"
62               }
63             ]
64           }
65         ]
66       }
67     },
68     "type": "upgrade",
69     "proration_amount": 1500,
70     "effective_at": "2024-06-01T00:00:00Z",
71     "currency": "USD"
72   },
73   "meta": {
74     "request_id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
75     "timestamp": "2024-04-27T14:45:00Z"
76   }
77 }

Preview the cost of changing to the given plan.

Authentication

AuthorizationBearer

Clerk JWT token

Path parameters

plan_idstringRequiredformat: "uuid"

Response

Successful Response

dataobject

metaobject

Errors

422

Unprocessable Entity Error