Skip to content
/Products

Admin API Reference (2026-01-08)

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
Languages
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

Meter

Actions on resource Meter.

Operations

Products

Actions on resource Product.

Operations

List products

Request

Retrieves all configured products.

Security
ZephrHmacHttp
curl -i -X GET \
  https://developer.zuora.com/_mock/zephr-api-reference/zephr-admin-api/v3/products \
  -H 'Authorization: ZEPHR-HMAC-* <YOUR_TOKEN_HERE>'

Responses

OK

Bodyapplication/json
resultsArray of objects(products)
Response
application/json
{
  "results": [
    { … }
  ]
}

Save a product

Request

This endpoint saves a product with the given details specified in the body of the request. The product ID is randomyly generated and provided as part of the URI path parameter response returned on success.

Security
ZephrHmacHttp
Bodyapplication/json
labelstringrequired

The product label. This is the human-readable name of the product.

Example: "Gold Subscription"
descriptionstring

The product description. This is a human-readable description of the product.

Example: "The most premium subscription."
entitlementobject(product.entitlement)required
entitlement.​idstring

Entitlement ID/slug.

Example: "gold-bundle"
entitlement.​typestring

Entitlement type (always "bundle").

Example: "bundle"
entitlement.​entitlementTenantstring

Entitlement tenant ID.

Example: "company"
mappingobject(product.mapping)required
Example: {"braintree_one_off":{"price_points":[{"id":"ten","label":"Ten Dollars","price":10}]}}
mapping.​braintree_recurringobject
mapping.​braintree_one_offobject
Example: {"price_points":[{"id":"ten","label":"Ten Dollars","price":10}]}
mapping.​stripe_recurringobject
mapping.​stripe_one_offobject
mapping.​rate_plansArray of objects(product.mapping.rate_plan)
mapping.​jwtobject(product.mapping.jwt)
sharingLimitnumber

The number of other users that the purchaser of this product can share the product with.

Example: 5
curl -i -X POST \
  https://developer.zuora.com/_mock/zephr-api-reference/zephr-admin-api/v3/products \
  -H 'Authorization: ZEPHR-HMAC-* <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "label": "Gold Subscription",
    "description": "The most premium subscription.",
    "entitlement": {
      "id": "gold-bundle",
      "type": "bundle",
      "entitlementTenant": "company"
    },
    "mapping": {
      "braintree_one_off": {
        "price_points": [
          {
            "id": "ten",
            "label": "Ten Dollars",
            "price": 10
          }
        ]
      }
    },
    "sharingLimit": 5
  }'

Responses

Created. The product was created.

Bodyapplication/json
messagestring
Example: "Product created successfully"
uristring
Example: "https://company.api.zephr.com/v3/products/63b68935-c996-4e90-b88a-dd6a133a7a3"
Response
application/json
{
  "message": "Product created successfully",
  "uri": "https://company.api.zephr.com/v3/products/63b68935-c996-4e90-b88a-dd6a133a7a3"
}

Retrieve a product

Request

Retrieves a single product. The product is identified by the id path parameter.

Security
ZephrHmacHttp
Path
idstringrequired

Unique Product identifier.

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

Responses

OK. Returns the product details.

Bodyapplication/json
tenantIdstring
Example: "company"
subTenantIdstring
Example: "company|demo"
idstring

The product ID/slug. This is the unique identifier for the product within the tenant.

Example: "gold"
labelstring

The product label. This is the human-readable name of the product.

Example: "Gold Subscription"
descriptionstring

The product description. This is a human-readable description of the product.

Example: "The most premium subscription."
entitlementobject(product.entitlement)
mappingobject(product.mapping)
Example: {"braintree_one_off":{"price_points":[{"id":"ten","label":"Ten Dollars","price":10}]}}
sharingLimitnumber

The number of other users that the purchaser of this product can share the product with.

Example: 5
Response
application/json
{
  "tenantId": "company",
  "subTenantId": "company|demo",
  "id": "gold",
  "label": "Gold Subscription",
  "description": "The most premium subscription.",
  "entitlement": {
    "id": "gold-bundle",
    "type": "bundle",
    "entitlementTenant": "company"
  },
  "mapping": {
    "braintree_one_off": { … }
  },
  "sharingLimit": 5
}

Delete a product

Request

Deletes a product. The product is identified by the id path parameter.

Security
ZephrHmacHttp
Path
idstringrequired

Unique Product identifier.

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

Responses

OK. The product was deleted.

Save a product with the given ID

Request

This endpoint both saves and updates a product. The product is identified by the id path parameter. If the product ID does not exist, then a new product with the corresponding ID will be created. Otherwise, the existing product will be modified.

Security
ZephrHmacHttp
Path
idstringrequired

Unique Product identifier.

Bodyapplication/json
labelstringrequired

The product label. This is the human-readable name of the product.

Example: "Gold Subscription"
descriptionstring

The product description. This is a human-readable description of the product.

Example: "The most premium subscription."
entitlementobject(product.entitlement)required
entitlement.​idstring

Entitlement ID/slug.

Example: "gold-bundle"
entitlement.​typestring

Entitlement type (always "bundle").

Example: "bundle"
entitlement.​entitlementTenantstring

Entitlement tenant ID.

Example: "company"
mappingobject(product.mapping)required
Example: {"braintree_one_off":{"price_points":[{"id":"ten","label":"Ten Dollars","price":10}]}}
mapping.​braintree_recurringobject
mapping.​braintree_one_offobject
Example: {"price_points":[{"id":"ten","label":"Ten Dollars","price":10}]}
mapping.​stripe_recurringobject
mapping.​stripe_one_offobject
mapping.​rate_plansArray of objects(product.mapping.rate_plan)
mapping.​jwtobject(product.mapping.jwt)
sharingLimitnumber

The number of other users that the purchaser of this product can share the product with.

Example: 5
curl -i -X PUT \
  'https://developer.zuora.com/_mock/zephr-api-reference/zephr-admin-api/v3/products/{id}' \
  -H 'Authorization: ZEPHR-HMAC-* <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "label": "Gold Subscription",
    "description": "The most premium subscription.",
    "entitlement": {
      "id": "gold-bundle",
      "type": "bundle",
      "entitlementTenant": "company"
    },
    "mapping": {
      "braintree_one_off": {
        "price_points": [
          {
            "id": "ten",
            "label": "Ten Dollars",
            "price": 10
          }
        ]
      }
    },
    "sharingLimit": 5
  }'

Responses

OK. The product was updated.

Bodyapplication/json
messagestring
Example: "Product updated successfully"
uristring
Example: "https://company.api.zephr.com/v3/products/gold"
Response
application/json
{
  "message": "Product updated successfully",
  "uri": "https://company.api.zephr.com/v3/products/gold"
}

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

OK

Bodyapplication/json
string
Response
application/json
[
  "The template the-value::!"
]

Pages

Operations

Dynamic Offer Promo code redemption

Operations

Subscription

Operations