Cancel Subscription

POST

/api/v1/users/me/subscription/cancel

POST

/api/v1/users/me/subscription/cancel

$ curl -X POST https://api.onepin.ai/api/v1/users/me/subscription/cancel \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json" \
>      -d '{}'

1 {
2   "data": {
3     "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4     "plan": {
5       "id": "b1a7f8d2-4c3e-4f9a-9d2e-1a2b3c4d5e6f",
6       "name": "Pro Plan",
7       "tier": "paid",
8       "limits": {
9         "projects": 50,
10         "users": 10,
11         "storage_gb": 100
12       },
13       "billing_interval": "monthly",
14       "amount": 2999,
15       "currency": "USD",
16       "display_order": 2,
17       "plan_details": {
18         "sections": [
19           {
20             "title": "Features",
21             "items": [
22               {
23                 "label": "Max Projects",
24                 "value": "50"
25               },
26               {
27                 "label": "Max Users",
28                 "value": "10"
29               },
30               {
31                 "label": "Storage",
32                 "value": "100 GB"
33               }
34             ]
35           }
36         ]
37       }
38     },
39     "status": "active",
40     "current_period_start": "2024-04-01T00:00:00Z",
41     "current_period_end": "2024-04-30T23:59:59Z",
42     "cancel_at_period_end": true,
43     "canceled_at": "2024-04-15T12:00:00Z",
44     "scheduled_plan": {
45       "id": "d2f7e8c9-5b3a-4e7f-8a1c-9b0d1e2f3a4b",
46       "name": "Basic Plan",
47       "tier": "paid",
48       "limits": {
49         "projects": 10,
50         "users": 3,
51         "storage_gb": 20
52       },
53       "billing_interval": "monthly",
54       "amount": 999,
55       "currency": "USD",
56       "display_order": 1,
57       "plan_details": {
58         "sections": [
59           {
60             "title": "Features",
61             "items": [
62               {
63                 "label": "Max Projects",
64                 "value": "10"
65               },
66               {
67                 "label": "Max Users",
68                 "value": "3"
69               },
70               {
71                 "label": "Storage",
72                 "value": "20 GB"
73               }
74             ]
75           }
76         ]
77       }
78     },
79     "scheduled_at": "2024-04-15T12:00:00Z"
80   },
81   "meta": {
82     "request_id": "7f9c2ba4-1d3e-4f6a-8b2c-9d0e1f2a3b4c",
83     "timestamp": "2024-04-15T12:00:01Z"
84   }
85 }

Cancel the current user's subscription at period end.

Authentication

AuthorizationBearer

Clerk JWT token

Response

Successful Response

dataobject

metaobject

Errors

422

Unprocessable Entity Error