List

List entitlements associated to merchant's customers

🔐

Authentication

✔️ Application API Scope

✔️ Storefront API Scope

Response Body Definitions

NameTypeDescriptionExample
merchantstringMerchant ID"ac4f7938383a11e89ecbbc764e1107f2"
public_idstringEntitlement ID"c4cd7f86ccc411e8ada3bc764e101db1"
merchant_user_idstringCustomer ID"11100-C01"
initial_activation_datestringInitial activation date (UTC)"2017-02-29T12:00:00.00Z"
latest_activation_datestringLatest activation date (UTC)"2017-02-29T12:00:00.00Z"
grace_periodstringGrace period in seconds86400
access_typestringEntitlement access type (enum)"time_based"
expirationstringEntitlement access expiration date (UTC)"2017-02-29T12:00:00.00Z"
createdstringDate of resource creation (UTC)"2017-02-29T12:00:00.00Z"
last_updatedstringDate of last resource update (UTC)"2017-02-29T12:00:00.00Z"
resourceobjectResource information (see Resource Object below){"name": "sample resource", ... }

Resource Object

NameTypeDescriptionExample
merchantstringMerchant ID"ac4f7938383a11e89ecbbc764e1107f2"
public_idstringResource ID"c4cd7f86ccc411e8ada3bc764e101db1"
namestringResource name"4k Resolution Movies"
external_resource_idstringMerchant resource ID"id1234"
descriptionstringResource description"Unlocks streaming of movies in 4K resolution"
image_urlstringResource image URL"ordergroove.com/resource/resource_id.png"
createdstringDate of resource creation (UTC)"2017-02-29T12:00:00.00Z"
last_updatedstringDate of last resource update (UTC)"2017-02-29T12:00:00.00Z"
Language