Retrieve a Bundle

Request

Retrieves a single bundle. Each bundle contains a list of entitlements, meters, credits, and other bundles.

Security

ZephrHmacHttp

Path

idstringrequired

Unique Bundle Identifier.

cURL

curl -i -X GET \
  'https://demo.api.zephr.com/v3/bundles/{id}' \
  -H 'Authorization: ZEPHR-HMAC-* <YOUR_TOKEN_HERE>'

Responses

OK

Headers

any

Bodyapplication/json

tenantIdstring

Example:"company"

subTenantIdstring

Example:"company|demo"

typestring

Example:"bundle"

idstring

Example:"1163991e-d671-4695-9ac0-b3d63fecfc20"

labelstring

Example:"Test bundle"

descriptionstring

Returned if not null

Example:"This is a bundle"

includesobject(includes)

auto_assignany

Enum:"none""all""anonymous""authenticated"

Example:"none"

Response

{
  "tenantId": "company",
  "subTenantId": "company|demo",
  "type": "bundle",
  "id": "1163991e-d671-4695-9ac0-b3d63fecfc20",
  "label": "Test bundle",
  "description": "This is a bundle",
  "includes": {
    "entitlements": [],
    "meters": [],
    "credits": [],
    "bundles": []
  },
  "auto_assign": "none"
}