Cancel Scheduled Change

POST

/api/v1/users/me/subscription/cancel-scheduled-change

POST

/api/v1/users/me/subscription/cancel-scheduled-change

$ curl -X POST https://api.onepin.ai/api/v1/users/me/subscription/cancel-scheduled-change \
>      -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         "storage_gb": 100
11       },
12       "billing_interval": "monthly",
13       "amount": 2999,
14       "currency": "USD",
15       "display_order": 2,
16       "plan_details": {
17         "sections": [
18           {
19             "title": "Features",
20             "items": [
21               {
22                 "label": "Max Projects",
23                 "value": "50"
24               },
25               {
26                 "label": "Storage",
27                 "value": "100 GB"
28               },
29               {
30                 "label": "Support",
31                 "value": "Priority email support"
32               }
33             ]
34           }
35         ]
36       }
37     },
38     "status": "active",
39     "current_period_start": "2024-04-01T00:00:00Z",
40     "current_period_end": "2024-04-30T23:59:59Z",
41     "cancel_at_period_end": true,
42     "canceled_at": "2024-04-15T12:00:00Z",
43     "scheduled_plan": {
44       "id": "d2f7e9a1-8b4c-4d3f-9a7e-5b6c7d8e9f01",
45       "name": "Basic Plan",
46       "tier": "paid",
47       "limits": {
48         "projects": 10,
49         "storage_gb": 20
50       },
51       "billing_interval": "monthly",
52       "amount": 999,
53       "currency": "USD",
54       "display_order": 1,
55       "plan_details": {
56         "sections": [
57           {
58             "title": "Features",
59             "items": [
60               {
61                 "label": "Max Projects",
62                 "value": "10"
63               },
64               {
65                 "label": "Storage",
66                 "value": "20 GB"
67               },
68               {
69                 "label": "Support",
70                 "value": "Standard email support"
71               }
72             ]
73           }
74         ]
75       }
76     },
77     "scheduled_at": "2024-04-20T08:00:00Z"
78   },
79   "meta": {
80     "request_id": "7f9c2ba4-3d1e-4f6a-9b8c-123456789abc",
81     "timestamp": "2024-04-15T12:00:00Z"
82   }
83 }

Cancel a scheduled plan downgrade.

Authentication

AuthorizationBearer

Clerk JWT token

Response

Successful Response

dataobject

metaobject

Errors

422

Unprocessable Entity Error