Copy of

POST

https://restapi.ordergroove.com/entitlements/void/

POST

/entitlements/void/

$ curl -X POST https://restapi.ordergroove.com/entitlements/void/ \
>      -H "Content-Type: application/json" \
>      -d '{
>   "entitlement_public_ids": [
>     "4e9d934275734a859a7f8d98dc52c8af",
>     "5289bf2ad76e4fde881ad1a89a55b5dc"
>   ]
> }'

200New Example

1 {
2   "results": {
3     "4e9d934275734a859a7f8d98dc52c8af": {
4       "entitlement_transaction": {
5         "transaction_type": "entitlement_voided",
6         "public_id": "b95671a531974f6a98d7156e72284c34",
7         "entitlement_public_id": "4e9d934275734a859a7f8d98dc52c8af",
8         "merchant_user_id": "23799452926316",
9         "resource_public_id": "3fa56741671444bdbcdf7b1554f67bee",
10         "merchant_public_id": "80c9a167fb434fa0abe215c7f19a86cc",
11         "transaction_initiation_time": "2026-04-07T18:36:24.908319269Z",
12         "transaction_execution_time": "2026-04-07T18:36:24.908319269Z",
13         "source_action": "api-call",
14         "source_object": "user",
15         "source_object_id": "dd0756ea-f502-4292-931e-b48f26677ef9_2026-04-07T18:36:24.908319269Z",
16         "access_type": "time_based",
17         "grace_period": 0,
18         "expiration": "2026-04-07T18:36:24.908319269Z",
19         "grace_period_expiration": "2026-04-07T18:36:24.908319269Z"
20       },
21       "entitlement": {
22         "merchant": "80c9a167fb434fa0abe215c7f19a86cc",
23         "public_id": "4e9d934275734a859a7f8d98dc52c8af",
24         "merchant_user_id": "23799452926316",
25         "initial_activation_date": null,
26         "latest_activation_date": null,
27         "grace_period": 0,
28         "live": false,
29         "access_type": "time_based",
30         "expiration": "2026-04-07T18:36:24.908319269Z",
31         "created": "2026-03-16T17:00:13.059Z",
32         "last_updated": "2026-04-07T18:36:24.912728516Z",
33         "resource": {
34           "public_id": "3fa56741671444bdbcdf7b1554f67bee",
35           "merchant": "80c9a167fb434fa0abe215c7f19a86cc",
36           "name": "Advanced Phonics for Professionals - With Tutoring",
37           "external_resource_id": "53204456309100",
38           "description": null,
39           "image_url": null,
40           "created": "2026-02-26T15:54:29.306Z",
41           "last_updated": "2026-02-26T15:54:29.306Z"
42         },
43         "grantees": [
44           {
45             "external_id": "qveq35",
46             "name": "vwW4w4fv",
47             "created": "2026-03-16T17:00:12.907Z",
48             "updated": "2026-03-16T17:00:12.907Z"
49           },
50           {
51             "external_id": "F2VS",
52             "name": "F4Q34",
53             "created": "2026-03-16T17:00:12.907Z",
54             "updated": "2026-03-16T17:00:12.907Z"
55           },
56           {
57             "external_id": "BES576FYE4DS5ET",
58             "name": "AE5 YBEYA5V",
59             "created": "2026-03-16T17:00:12.907Z",
60             "updated": "2026-03-16T17:00:12.907Z"
61           },
62           {
63             "external_id": "W4T6C",
64             "name": "A W AGW4",
65             "created": "2026-03-16T17:00:12.907Z",
66             "updated": "2026-03-16T17:00:12.907Z"
67           },
68           {
69             "external_id": "EM. DTSCRTRGXTD",
70             "name": "awww eh5q",
71             "created": "2026-03-16T17:00:12.907Z",
72             "updated": "2026-03-16T17:00:12.907Z"
73           },
74           {
75             "external_id": "we5yyvw5",
76             "name": "arg. ag",
77             "created": "2026-03-16T17:00:12.907Z",
78             "updated": "2026-03-16T17:00:12.907Z"
79           },
80           {
81             "external_id": "yvac3y",
82             "name": "we. WT4GW4",
83             "created": "2026-03-16T17:00:12.907Z",
84             "updated": "2026-03-16T17:00:12.907Z"
85           },
86           {
87             "external_id": "QT4VQ3CRAE",
88             "name": "SEH SRJMDSRZRGE",
89             "created": "2026-03-16T17:00:12.907Z",
90             "updated": "2026-03-16T17:00:12.907Z"
91           },
92           {
93             "external_id": "Wr gcax4wEab",
94             "name": "ag wGaawg",
95             "created": "2026-03-16T17:00:12.907Z",
96             "updated": "2026-03-16T17:00:12.907Z"
97           }
98         ]
99       }
100     },
101     "5289bf2ad76e4fde881ad1a89a55b5dc": {
102       "entitlement_transaction": {
103         "transaction_type": "entitlement_voided",
104         "public_id": "452c6a1b3f3d4c178257ae2449709157",
105         "entitlement_public_id": "5289bf2ad76e4fde881ad1a89a55b5dc",
106         "merchant_user_id": "23799452926316",
107         "resource_public_id": "04f5d0ab2dca4111ba785abc714e9010",
108         "merchant_public_id": "80c9a167fb434fa0abe215c7f19a86cc",
109         "transaction_initiation_time": "2026-04-07T18:36:24.908266844Z",
110         "transaction_execution_time": "2026-04-07T18:36:24.908266844Z",
111         "source_action": "api-call",
112         "source_object": "user",
113         "source_object_id": "dd0756ea-f502-4292-931e-b48f26677ef9_2026-04-07T18:36:24.908266844Z",
114         "access_type": "time_based",
115         "grace_period": 0,
116         "expiration": "2026-04-07T18:36:24.908266844Z",
117         "grace_period_expiration": "2026-04-07T18:36:24.908266844Z"
118       },
119       "entitlement": {
120         "merchant": "80c9a167fb434fa0abe215c7f19a86cc",
121         "public_id": "5289bf2ad76e4fde881ad1a89a55b5dc",
122         "merchant_user_id": "23799452926316",
123         "initial_activation_date": null,
124         "latest_activation_date": null,
125         "grace_period": 0,
126         "live": false,
127         "access_type": "time_based",
128         "expiration": "2026-04-07T18:36:24.908266844Z",
129         "created": "2026-04-07T16:45:43.119Z",
130         "last_updated": "2026-04-07T18:36:24.917619184Z",
131         "resource": {
132           "public_id": "04f5d0ab2dca4111ba785abc714e9010",
133           "merchant": "80c9a167fb434fa0abe215c7f19a86cc",
134           "name": "taco",
135           "external_resource_id": "taco",
136           "description": null,
137           "image_url": null,
138           "created": "2026-02-25T17:17:27.623Z",
139           "last_updated": "2026-02-25T17:17:27.623Z"
140         },
141         "grantees": null
142       }
143     }
144   }
145 }

Request

This endpoint expects an object.

entitlement_public_idslist of stringsRequired

List of entitlement public_ids to void

Response

resultsobject

{ “4e9d934275734a859a7f8d98dc52c8af”: { “entitlement_transaction”: { “transaction_type”: “entitlement_voided”, “public_id”: “b95671a531974f6a98d7156e72284c34”, “entitlement_public_id”: “4e9d934275734a859a7f8d98dc52c8af”, “merchant_user_id”: “23799452926316”, “resource_public_id”: “3fa56741671444bdbcdf7b1554f67bee”, “merchant_public_id”: “80c9a167fb434fa0abe215c7f19a86cc”, “transaction_initiation_time”: “2026-04-07T18:36:24.908319269Z”, “transaction_execution_time”: “2026-04-07T18:36:24.908319269Z”, “source_action”: “api-call”, “source_object”: “user”, “source_object_id”: “dd0756ea-f502-4292-931e-b48f26677ef9_2026-04-07T18:36:24.908319269Z”, “access_type”: “time_based”, “grace_period”: 0, “expiration”: “2026-04-07T18:36:24.908319269Z”, “grace_period_expiration”: “2026-04-07T18:36:24.908319269Z” }, “entitlement”: { “merchant”: “80c9a167fb434fa0abe215c7f19a86cc”, “public_id”: “4e9d934275734a859a7f8d98dc52c8af”, “merchant_user_id”: “23799452926316”, “initial_activation_date”: null, “latest_activation_date”: null, “grace_period”: 0, “live”: false, “access_type”: “time_based”, “expiration”: “2026-04-07T18:36:24.908319269Z”, “created”: “2026-03-16T17:00:13.059Z”, “last_updated”: “2026-04-07T18:36:24.912728516Z”, “resource”: { “public_id”: “3fa56741671444bdbcdf7b1554f67bee”, “merchant”: “80c9a167fb434fa0abe215c7f19a86cc”, “name”: “Advanced Phonics for Professionals - With Tutoring”, “external_resource_id”: “53204456309100”, “description”: null, “image_url”: null, “created”: “2026-02-26T15:54:29.306Z”, “last_updated”: “2026-02-26T15:54:29.306Z” }, “grantees”: [ { “external_id”: “qveq35”, “name”: “vwW4w4fv”, “created”: “2026-03-16T17:00:12.907Z”, “updated”: “2026-03-16T17:00:12.907Z” }, { “external_id”: “F2VS”, “name”: “F4Q34”, “created”: “2026-03-16T17:00:12.907Z”, “updated”: “2026-03-16T17:00:12.907Z” }, { “external_id”: “BES576FYE4DS5ET”, “name”: “AE5 YBEYA5V”, “created”: “2026-03-16T17:00:12.907Z”, “updated”: “2026-03-16T17:00:12.907Z” }, { “external_id”: “W4T6C”, “name”: “A W AGW4”, “created”: “2026-03-16T17:00:12.907Z”, “updated”: “2026-03-16T17:00:12.907Z” }, { “external_id”: “EM. DTSCRTRGXTD”, “name”: “awww eh5q”, “created”: “2026-03-16T17:00:12.907Z”, “updated”: “2026-03-16T17:00:12.907Z” }, { “external_id”: “we5yyvw5”, “name”: “arg. ag”, “created”: “2026-03-16T17:00:12.907Z”, “updated”: “2026-03-16T17:00:12.907Z” }, { “external_id”: “yvac3y”, “name”: “we. WT4GW4”, “created”: “2026-03-16T17:00:12.907Z”, “updated”: “2026-03-16T17:00:12.907Z” }, { “external_id”: “QT4VQ3CRAE”, “name”: “SEH SRJMDSRZRGE”, “created”: “2026-03-16T17:00:12.907Z”, “updated”: “2026-03-16T17:00:12.907Z” }, { “external_id”: “Wr gcax4wEab”, “name”: “ag wGaawg”, “created”: “2026-03-16T17:00:12.907Z”, “updated”: “2026-03-16T17:00:12.907Z” } ] } }, “5289bf2ad76e4fde881ad1a89a55b5dc”: { “entitlement_transaction”: { “transaction_type”: “entitlement_voided”, “public_id”: “452c6a1b3f3d4c178257ae2449709157”, “entitlement_public_id”: “5289bf2ad76e4fde881ad1a89a55b5dc”, “merchant_user_id”: “23799452926316”, “resource_public_id”: “04f5d0ab2dca4111ba785abc714e9010”, “merchant_public_id”: “80c9a167fb434fa0abe215c7f19a86cc”, “transaction_initiation_time”: “2026-04-07T18:36:24.908266844Z”, “transaction_execution_time”: “2026-04-07T18:36:24.908266844Z”, “source_action”: “api-call”, “source_object”: “user”, “source_object_id”: “dd0756ea-f502-4292-931e-b48f26677ef9_2026-04-07T18:36:24.908266844Z”, “access_type”: “time_based”, “grace_period”: 0, “expiration”: “2026-04-07T18:36:24.908266844Z”, “grace_period_expiration”: “2026-04-07T18:36:24.908266844Z” }, “entitlement”: { “merchant”: “80c9a167fb434fa0abe215c7f19a86cc”, “public_id”: “5289bf2ad76e4fde881ad1a89a55b5dc”, “merchant_user_id”: “23799452926316”, “initial_activation_date”: null, “latest_activation_date”: null, “grace_period”: 0, “live”: false, “access_type”: “time_based”, “expiration”: “2026-04-07T18:36:24.908266844Z”, “created”: “2026-04-07T16:45:43.119Z”, “last_updated”: “2026-04-07T18:36:24.917619184Z”, “resource”: { “public_id”: “04f5d0ab2dca4111ba785abc714e9010”, “merchant”: “80c9a167fb434fa0abe215c7f19a86cc”, “name”: “taco”, “external_resource_id”: “taco”, “description”: null, “image_url”: null, “created”: “2026-02-25T17:17:27.623Z”, “last_updated”: “2026-02-25T17:17:27.623Z” }, “grantees”: null } } }