Post Entitlements Entitlement Public Id Modify Expiration

POST

https://restapi.ordergroove.com/entitlements/:entitlement.public_id/modify_expiration/

POST

/entitlements/:entitlement.public_id/modify_expiration/

$ curl -X POST https://restapi.ordergroove.com/entitlements/entitlement.public_id/modify_expiration/ \
>      -H "Content-Type: application/json" \
>      -d '{
>   "expiration": "2023-01-15"
> }'

200OK

1 {
2   "results": {
3     "entitlement_transaction": {
4       "transaction_type": "modify_expiration",
5       "public_id": "71a591cb40be4985ab9ce2746329c865",
6       "entitlement_public_id": "6bba77e50a244f818f32f17e2da5aed8",
7       "merchant_user_id": "23773486874988",
8       "resource_public_id": "450a64bf72024d99998f6c7541fefa42",
9       "merchant_public_id": "80c9a167fb434fa0abe215c7f19a86cc",
10       "transaction_initiation_time": "2026-03-11T18:51:45.520224856Z",
11       "transaction_execution_time": "2026-03-11T18:51:45.520224856Z",
12       "source_action": "api-call",
13       "source_object": "user",
14       "source_object_id": "dd0756ea-f502-4292-931e-b48f26677ef9_2026-03-11T18:51:45.520224856Z",
15       "access_type": "time_based",
16       "grace_period": 0,
17       "expiration": "2028-03-01T23:59:59Z",
18       "grace_period_expiration": "2028-03-01T23:59:59Z"
19     },
20     "entitlement": {
21       "merchant": "80c9a167fb434fa0abe215c7f19a86cc",
22       "public_id": "6bba77e50a244f818f32f17e2da5aed8",
23       "merchant_user_id": "23773486874988",
24       "initial_activation_date": null,
25       "latest_activation_date": null,
26       "grace_period": 0,
27       "live": true,
28       "access_type": "time_based",
29       "expiration": "2028-03-01T23:59:59Z",
30       "created": "2026-03-03T17:06:09.424Z",
31       "last_updated": "2026-03-11T18:51:45.521796755Z",
32       "resource": {
33         "public_id": "450a64bf72024d99998f6c7541fefa42",
34         "merchant": "80c9a167fb434fa0abe215c7f19a86cc",
35         "name": "Meta Plan Candidate 01",
36         "external_resource_id": "52810769170796",
37         "description": null,
38         "image_url": null,
39         "created": "2025-10-28T17:48:10.806Z",
40         "last_updated": "2025-10-28T17:48:10.806Z"
41       },
42       "grantees": null
43     },
44     "renewal_correction": {
45       "success": true,
46       "updated_order_ids": [
47         "d8dee1f287c4429b83ff54f438937d98"
48       ]
49     }
50   }
51 }

Path parameters

entitlement.public_idstringRequired

Public_id of entitlement

Request

This endpoint expects an object.

expirationdateRequired

New expiration date (YYYY-MM-DD) of entitlement. Cannot be past date.

Path parameters

Request

Response