Retrieve an account grant

Request

Retrieves a single account grant information, if the supplied accountId and grantId match

Security

ZephrHmacHttp

Path

accountIdstringrequired

Unique Account identifier

Example:5fag4a2d-86cd-4bb0-a5df-68dca75a3a21

grantIdstringrequired

Unique Grant identifier

Example:0123456789ABCD

cURL

curl -i -X GET \
  https://demo.api.zephr.com/v3/accounts/5fag4a2d-86cd-4bb0-a5df-68dca75a3a21/grants/0123456789ABCD \
  -H 'Authorization: ZEPHR-HMAC-* <YOUR_TOKEN_HERE>'

Responses

OK - Retrieved an account grant

Headers

any

Bodyapplication/json

grantIdstring

Example:"e196ad75-a6d0-471b-90b3-de3843dd7860"

user_idstring

Example:"e1812285-2f21-441e-8be4-b08835cd4b2c"

account_idstring

Example:"14515649-565f-4b1c-8346-eb98301c1d6b"

expiry_statestring

Enum:"pending""active""expired"

entitlement_typestring

An enum describing the type of the entitlement.

Enum:"bundle""entitlement""meter""credits"

entitlement_idstring

Example:"b74df5c4-fded-492c-ad90-07646bded5db"

startTimestring

Example:"2022-06-01 00:00:00"

endTimestring

Example:"2022-12-31 23:59:59"

product_idstring

Example:"86abb44a-e6f2-4f9b-ac26-46ae0a13ed31"

createdAtstring

Example:"2022-05-31 23:59:59"

Response

{
  "grantId": "0123456789ABCD",
  "entitlement_type": "bundle",
  "entitlement_id": "8dfb3e7c-7a9e-4f23-b6c1-e2d8c41fb9a8",
  "startTime": "2022-06-01 00:00:00",
  "endTime": "2022-12-31 23:59:59",
  "product_id": "PRD-2024-ABC123"
}