Admin API Reference (2026-01-08)
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude
Connect to Cursor
Install MCP server on Cursor
Connect to VS Code
Install MCP server on VS Code

The Zephr Admin API provides RESTful access to all Zephr functionality. It is designed for server-side integrations. All requests must be signed as described in HMAC Request Signing and Key Pairs.

The Admin API uses a base URL with the following format: https://{tenantId}.api.zephr.com

Note: If you have multiple tenants, the current tenant ID is shown in a blue box in the top right of the Admin Console. If you have a single site, you can find the tenant ID by navigating to your site domains. To do this, select Sites from the Delivery menu, select your site, and then click the Site Domains button. The tenant ID is the first part of the domain. For example, if the domain is news-paper.cdn.zephr.com, the tenant ID is news.

Download OpenAPI description

index.json

index.yaml

Servers

Mock server

https://developer.zuora.com/_mock/zephr-api-reference/zephr-admin-api

https://{tenantId}.api.zephr.com

Account User

Contains operations on the Account User resource.

Operations

Admin User

Contains operations on the Admin User resource.

Operations

Bundle

Contains operations on the Bundle resource.

Operations

Cache Configurations

Contains operations on the Cache Configurations resource.

Operations

Cache Management

Cache Mangement.

Operations

Company

Actions on resource Company.

Operations

Component Library

Actions on resource Library Component.

Operations

Configuration

Blaize tenant configuration.

Operations

Credit

Actions on resource Credit.

Operations

Decision Engine

Operations

Email Templates

Actions on email templates.

Operations

Entitlement

Actions on resource Entitlement.

Operations

Feature Rules

Actions on resource Feature Rules.

Note: - Note: The APIs mentioned in this section support legacy Feature Rules only. Feature Rules created through the Admin Console (V4 Features) are stored in a different system and are not accessible through these APIs.

Operations

Form

Actions on resource Form.

Operations

Gifts

Operations

Grants

Actions on resource Grant.

Operations

List user grants

Request

Retrieves a list of user grants.

Security

ZephrHmacHttp

Path

userIdstringrequired

Unique User identifier

Query

activeboolean

Whether or not to include only active grants

Example: active=true

curl -i -X GET \
  'https://developer.zuora.com/_mock/zephr-api-reference/zephr-admin-api/v3/users/{userId}/grants?active=true' \
  -H 'Authorization: ZEPHR-HMAC-* <YOUR_TOKEN_HERE>'

Responses

Returns a list of grants for the user

Bodyapplication/json

One of:

resultsArray of objects(grant-response)

Response

application/json

{
  "results": [
    { … }
  ]
}

Create a grant

Request

Creates a user grant.

Security

ZephrHmacHttp

Path

userIdstringrequired

Unique User identifier

Bodyapplication/json

entitlement_typestringrequired

An enum describing the type of the entitlement.

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

Example: "bundle"

entitlement_idstringrequired

Example: "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"

startTimestring

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

endTimestring

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

product_idstringrequired

Example: "XXXXXXXXXXXXXX"

curl -i -X POST \
  'https://developer.zuora.com/_mock/zephr-api-reference/zephr-admin-api/v3/users/{userId}/grants' \
  -H 'Authorization: ZEPHR-HMAC-* <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "entitlement_type": "bundle",
    "entitlement_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
    "startTime": "2022-06-01 00:00:00",
    "endTime": "2022-12-31 23:59:59",
    "product_id": "XXXXXXXXXXXXXX"
  }'

Responses

Created

Retrieve a grant

Request

Retrieves a single grant.

Security

ZephrHmacHttp

Path

userIdstringrequired

Unique User identifier

grantIdstringrequired

Unique Grant identifier

curl -i -X GET \
  'https://developer.zuora.com/_mock/zephr-api-reference/zephr-admin-api/v3/users/{userId}/grants/{grantId}' \
  -H 'Authorization: ZEPHR-HMAC-* <YOUR_TOKEN_HERE>'

Responses

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_typestringrequired

An enum describing the type of the entitlement.

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

entitlement_idstringrequired

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

startTimestring

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

endTimestring

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

product_idstringrequired

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

createdAtstring

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

Response

application/json

{
  "grantId": "e196ad75-a6d0-471b-90b3-de3843dd7860",
  "user_id": "e1812285-2f21-441e-8be4-b08835cd4b2c",
  "account_id": "14515649-565f-4b1c-8346-eb98301c1d6b",
  "expiry_state": "pending",
  "entitlement_type": "bundle",
  "entitlement_id": "b74df5c4-fded-492c-ad90-07646bded5db",
  "startTime": "2022-06-01 00:00:00",
  "endTime": "2022-12-31 23:59:59",
  "product_id": "86abb44a-e6f2-4f9b-ac26-46ae0a13ed31",
  "createdAt": "2022-05-31 23:59:59"
}

Delete a grant

Request

Deletes a grant specified by the grantId. This is for a user that is specified by the userId

Security

ZephrHmacHttp

Path

userIdstringrequired

Unique User identifier

Example: 3f589a2d-86ad-4b70-a5df-68dca75a3a21

grantIdstringrequired

Unique Grant identifier

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

curl -i -X DELETE \
  https://developer.zuora.com/_mock/zephr-api-reference/zephr-admin-api/v3/users/3f589a2d-86ad-4b70-a5df-68dca75a3a21/grants/5fag4a2d-86cd-4bb0-a5df-68dca75a3a21 \
  -H 'Authorization: ZEPHR-HMAC-* <YOUR_TOKEN_HERE>'

Responses

OK - The grant was found and successfully deleted

Create an account grant

Request

Creates an account grant.

Security

ZephrHmacHttp

Path

userIdstringrequired

Unique User identifier

grantIdstringrequired

Unique Grant identifier

Bodyapplication/json

entitlement_typestringrequired

An enum describing the type of the entitlement.

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

Example: "bundle"

entitlement_idstringrequired

Example: "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"

startTimestring

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

endTimestring

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

product_idstringrequired

Example: "XXXXXXXXXXXXXX"

curl -i -X POST \
  'https://developer.zuora.com/_mock/zephr-api-reference/zephr-admin-api/v3/users/{userId}/grants/{grantId}' \
  -H 'Authorization: ZEPHR-HMAC-* <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "entitlement_type": "bundle",
    "entitlement_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
    "startTime": "2022-06-01 00:00:00",
    "endTime": "2022-12-31 23:59:59",
    "product_id": "XXXXXXXXXXXXXX"
  }'

Responses

Created

Retrieve a user access model

Request

Retrieves a user access model.

Security

ZephrHmacHttp

Path

userIdstringrequired

Unique User identifier

curl -i -X GET \
  'https://developer.zuora.com/_mock/zephr-api-reference/zephr-admin-api/v3/users/{userId}/accessModel' \
  -H 'Authorization: ZEPHR-HMAC-* <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/json

metersobject

creditsobject

delivered_entitlementsArray of objects(delivered_entitlement)

granted_bundlesArray of strings

Example: ["e10a5ff3-fc63-47fb-af04-75c2ec3fdf1c"]

jwt_bundlesArray of strings

Example: []

user_statestring

Example: "registered"

Response

application/json

{
  "meters": {},
  "credits": {},
  "delivered_entitlements": [
    { … }
  ]
}

List account grants

Request

Retrieves a list of account grants.

Security

ZephrHmacHttp

Path

accountIdstringrequired

Unique Account identifier

curl -i -X GET \
  'https://developer.zuora.com/_mock/zephr-api-reference/zephr-admin-api/v3/accounts/{accountId}/grants' \
  -H 'Authorization: ZEPHR-HMAC-* <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/jsonArray [

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_typestringrequired

An enum describing the type of the entitlement.

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

entitlement_idstringrequired

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

startTimestring

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

endTimestring

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

product_idstringrequired

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

createdAtstring

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

]

Response

application/json

[
  {
    "grantId": "e196ad75-a6d0-471b-90b3-de3843dd7860",
    "user_id": "e1812285-2f21-441e-8be4-b08835cd4b2c",
    "account_id": "14515649-565f-4b1c-8346-eb98301c1d6b",
    "expiry_state": "pending",
    "entitlement_type": "bundle",
    "entitlement_id": "b74df5c4-fded-492c-ad90-07646bded5db",
    "startTime": "2022-06-01 00:00:00",
    "endTime": "2022-12-31 23:59:59",
    "product_id": "86abb44a-e6f2-4f9b-ac26-46ae0a13ed31",
    "createdAt": "2022-05-31 23:59:59"
  }
]

Create an account grant

Request

Creates an account grant.

Security

ZephrHmacHttp

Path

accountIdstringrequired

Unique Account identifier

Bodyapplication/json

entitlement_typestringrequired

An enum describing the type of the entitlement.

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

Example: "bundle"

entitlement_idstringrequired

Example: "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"

startTimestring

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

endTimestring

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

product_idstringrequired

Example: "XXXXXXXXXXXXXX"

curl -i -X POST \
  'https://developer.zuora.com/_mock/zephr-api-reference/zephr-admin-api/v3/accounts/{accountId}/grants' \
  -H 'Authorization: ZEPHR-HMAC-* <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "entitlement_type": "bundle",
    "entitlement_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
    "startTime": "2022-06-01 00:00:00",
    "endTime": "2022-12-31 23:59:59",
    "product_id": "XXXXXXXXXXXXXX"
  }'

Responses

Created

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 -i -X GET \
  https://developer.zuora.com/_mock/zephr-api-reference/zephr-admin-api/v3/accounts/5fag4a2d-86cd-4bb0-a5df-68dca75a3a21/grants/0123456789ABCD \
  -H 'Authorization: ZEPHR-HMAC-* <YOUR_TOKEN_HERE>'

Responses

OK - Retrieved an account grant

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

application/json

{
  "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"
}

Delete an account grant

Request

Deletes an account grant specified by the grantId. This is for a user that is specified by the accountId.

Security

ZephrHmacHttp

Path

accountIdstringrequired

Unique Account identifier

Example: 3f589a2d-86ad-4b70-a5df-68dca75a3a21

grantIdstringrequired

Unique Grant identifier

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

curl -i -X DELETE \
  https://developer.zuora.com/_mock/zephr-api-reference/zephr-admin-api/v3/accounts/3f589a2d-86ad-4b70-a5df-68dca75a3a21/grants/5fag4a2d-86cd-4bb0-a5df-68dca75a3a21 \
  -H 'Authorization: ZEPHR-HMAC-* <YOUR_TOKEN_HERE>'

Responses

OK - The grant was found and successfully deleted

Create an account grant

Request

Creates an account grant. This is for an account that is specified by the accountId

Security

ZephrHmacHttp

Path

accountIdstringrequired

Unique Account identifier

Bodyapplication/json

entitlement_typestringrequired

An enum describing the type of the entitlement.

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

Example: "bundle"

entitlement_idstringrequired

Example: "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"

startTimestring

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

endTimestring

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

product_idstringrequired

Example: "XXXXXXXXXXXXXX"

curl -i -X POST \
  'https://developer.zuora.com/_mock/zephr-api-reference/zephr-admin-api/v4/accounts/{accountId}/grants' \
  -H 'Authorization: ZEPHR-HMAC-* <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "entitlement_type": "bundle",
    "entitlement_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
    "startTime": "2022-06-01 00:00:00",
    "endTime": "2022-12-31 23:59:59",
    "product_id": "XXXXXXXXXXXXXX"
  }'

Responses

Created

Delete an account grant

Request

Deletes an account grant specified by the grantId. This is for a user that is specified by the accountId.

Security

ZephrHmacHttp

Path

accountIdstringrequired

Unique Account identifier

Example: 3f589a2d-86ad-4b70-a5df-68dca75a3a21

grantIdstringrequired

Unique Grant identifier

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

curl -i -X DELETE \
  https://developer.zuora.com/_mock/zephr-api-reference/zephr-admin-api/v4/accounts/3f589a2d-86ad-4b70-a5df-68dca75a3a21/grants/5fag4a2d-86cd-4bb0-a5df-68dca75a3a21 \
  -H 'Authorization: ZEPHR-HMAC-* <YOUR_TOKEN_HERE>'

Responses

OK - The grant was found and successfully deleted

Bodyapplication/json

Response

application/json

"Account grant revoked"

Meter

Actions on resource Meter.

Operations

Products

Actions on resource Product.

Operations

Request Rules

Actions on resource Request Rules.

Operations

Session

Actions on resource Session.

Operations

Static Items

Actions on resource Static Item.

Operations

Third Party Authentication

Contains operations for the OAuth 2.0 Authorization Code Flow Token Exchange.

Operations

User Export

Operations

User Schema

Actions on resource User Schema.

Operations

Users

Contains operations on the User resource. Important: The Attributes object contains the custom-defined attributes for a user.

Operations

V4 Session

Actions on resource Session.

Operations

Webhook

Actions on resource Webhook.

Operations

Account

Actions on resource Account.

Operations

Health Check

Actions on Health checks.

Operations

System Resources

Actions on system resources.

Operations

External Templates

External Templates.

Accounts

Operations

Request Rules Version

Operations

Fetch external template

Request

Fetch External Template

Security

ZephrHmacHttp

Path

templateConfigIdstringrequired

Unique External Template identifier

curl -i -X GET \
  'https://developer.zuora.com/_mock/zephr-api-reference/zephr-admin-api/zephr/public/template-components/v1/template-components/{templateConfigId}' \
  -H 'Authorization: ZEPHR-HMAC-* <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/json

string

Response

application/json

[
  "The template the-value::!"
]

Pages

Operations

Subscription

Operations

Admin API Reference (2026-01-08)CopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from ClaudeConnect to CursorInstall MCP server on CursorConnect to VS CodeInstall MCP server on VS Code

Account User

Admin User

Bundle

Cache Configurations

Cache Management

Company

Component Library

Configuration

Credit

Decision Engine

Email Templates

Entitlement

Feature Rules

Form

Gifts

Grants

List user grants

Request

Responses

Was this helpful?

Create a grant

Request

Responses

Was this helpful?

Retrieve a grant

Request

Responses

Was this helpful?

Delete a grant

Request

Responses

Was this helpful?

Create an account grant

Request

Responses

Was this helpful?

Retrieve a user access model

Request

Responses

Was this helpful?

List account grants

Request

Responses

Was this helpful?

Create an account grant

Request

Responses

Was this helpful?

Retrieve an account grant

Request

Responses

Was this helpful?

Delete an account grant

Request

Responses

Was this helpful?

Create an account grant

Request

Responses

Was this helpful?

Delete an account grant

Request

Responses

Was this helpful?

Meter

Products

Request Rules

Session

Static Items

Third Party Authentication

User Export

User Schema

Users

V4 Session

Webhook

Account

Health Check

System Resources

External Templates

Admin API Reference (2026-01-08)
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude
Connect to Cursor
Install MCP server on Cursor
Connect to VS Code
Install MCP server on VS Code