post
https://restapi.ordergroove.com/entitlements/void/
This Endpoint Allows for the voiding of multiple entitlements.
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
Side-effects:
- Entitlement live updated to false
- Entitlement expiration updated to time of execution
- Entitlement grace_period updated to 0
- EntitlementTransaction created
- New “entitlement.entitlements_voided” event is triggered upon successful modification
Response Body Definitions
Entitlement Object
| Name | Type | Description | Example |
|---|---|---|---|
| merchant | string | Merchant ID | "ac4f7938383a11e89ecbbc764e1107f2" |
| public_id | string | Entitlement ID | "c4cd7f86ccc411e8ada3bc764e101db1" |
| merchant_user_id | string | Customer ID | "11100-C01" |
| initial_activation_date | string | Initial activation date (UTC) | "2017-02-29T12:00:00.00Z" |
| latest_activation_date | string | Latest activation date (UTC) | "2017-02-29T12:00:00.00Z" |
| grace_period | string | Grace period in seconds | 86400 |
| live | bool | Whether the resource associated with this entitlement is accessible (considers grace_period) | false |
| access_type | string | Entitlement access type (enum) | "time_based" |
| expiration | string | Entitlement access expiration date (UTC) | "2017-02-29T12:00:00.00Z" |
| created | string | Date of resource creation (UTC) | "2017-02-29T12:00:00.00Z" |
| last_updated | string | Date of last resource update (UTC) | "2017-02-29T12:00:00.00Z" |
| resource | object | Resource information (see Resource Object below) | {"name": "sample resource", ... } |
| grantees | array | List of grantees associated to the entitlement. null if there are none. | [ { "external_id": "grantee-001", "name": "Grantee Name", "created": "2017-02-29T12:00:00.00Z", "updated": "2017-02-29T12:00:00.00Z" }, ... ] |
Resource Object
| Name | Type | Description | Example |
|---|---|---|---|
| merchant | string | Merchant ID | "ac4f7938383a11e89ecbbc764e1107f2" |
| public_id | string | Resource ID | "c4cd7f86ccc411e8ada3bc764e101db1" |
| name | string | Resource name | "4k Resolution Movies" |
| external_resource_id | string | Merchant resource ID | "id1234" |
| description | string | Resource description | "Unlocks streaming of movies in 4K resolution" |
| image_url | string | Resource image URL | "ordergroove.com/resource/resource_id.png" |
| created | string | Date of resource creation (UTC) | "2017-02-29T12:00:00.00Z" |
| last_updated | string | Date of last resource update (UTC) | "2017-02-29T12:00:00.00Z" |
Grantee Object
| Name | Type | Description | Example |
|---|---|---|---|
| external_id | string | Merchant ID | "grantee-001" |
| name | string | Resource ID | "Grantee Name" |
| created | datetime string | Datetime of creation | "2020-12-31 23:28:48" |
| updated | datetime string | Datetime of last update | "2020-12-31 23:28:48" |
Entitlement Transaction Object
| Name | Type | Description | Example |
|---|---|---|---|
| transaction_type | string | The type of transaction this is | "entitlement_voided" |
| public_id | string | ID of transaction | "71a591cb40be4985ab9ce2746329c865" |
| entitlement_public_id | string | ID of entitlement transaction was on | "6bba77e50a244f818f32f17e2da5aed8" |
| merchant_user_id | datetime string | Datetime of last update | "23773486874988" |
| resource_public_id | string | ID of resource | "450a64bf72024d99998f6c7541fefa42" |
| merchant_public_id | string | ID of merchant | "80c9a167fb434fa0abe215c7f19a86cc" |
| transaction_initiation_time | datetime string | time when transaction was set up | "2026-03-11T18:51:45.520224856Z" |
| transaction_execution_time | datetime string | time when transaction was executed | "2026-03-11T18:51:45.520224856Z" |
| source_action | string | action that triggered the transaction | "api-call" |
| source_object | string | source object that triggered transaction | "user" |
| source_object_id | string | id of source object | "dd0756ea-f502-4292-931e-b48f26677ef9_2026-03-11T18:51:45.520224856Z" |
| access_type | string | entitlement access type | time-based |
| grace_period | integer | time in seconds of entitlement grace period | 0 |
| expiration | datetime string | datetime of expiration | "2028-03-01T23:59:59Z" |
| grace_period_expiration | datetime string | datetime of expiration with grace period in account | "2028-03-01T23:59:59Z" |