Skip to content
/
Dynamic Offer Decision En...

Public API Reference (2025-07-30)

The Zephr Public API provides common client-side actions tied to a session cookie. Unlike the Admin API, neither users nor other resources can be dereferenced; the only data that can be accessed is owned by the user who is currently signed-in. This design is used to protect other users from malicious attacks.

You can find the base URL for the Public API 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 base URL is the Live domain.

Zephr forms use the Public API by default, with relative URLs based on the base URL.

Download OpenAPI description
index.json
index.yaml
Languages
Servers
Mock server
https://developer.zuora.com/_mock/zephr-api-reference/zephr-public-api
https://{your-domain}

Authentication

Operations

Braintree Payments

Operations

Browser Feature Transformations

Operations

Decision Engine

Operations

Dynamic Offer Decision Engine

Operations

Process dynamic offer decisions

Request

The Dynamic Offer Decision Engine can be invoked via the Public API to calculate a decision output response based upon each property rule under the Dynamic Offer created in the Zephr Console.

Security
CookieBlaizeSession or JwtQuery or JwtHeaderXBlaizeJwt or JwtHeaderXZephrJwt or JwtBearer or JwtCookie
Bodyapplication/json
dynamic_offerobjectrequired

The dynamic offer to evaluate, must specify the slug of the dynamic offer, and any custom input to be used in the rules.

Example: {"slug":"offerX","inputs":{}}
dynamic_offer.​slugstringrequired

Dynamic Offer slug

Example: "offerX"
dynamic_offer.​inputsobject

Custom inputs configured in Dynamic Offer. This can be any single layer map of key-value pairs.

Example: {}
sessionstring

Zephr Session ID, required for trials

Example: "xxx-xxx-xxx"
foreign_keysobject

Foreign system and ID used to identify the user.

Example: {}
ipstring

Client IP address, defaults to request IP.

Example: "x.x.x.x"
user_agentstring

Client user agent

Example: "Mozilla/5.0 (Macintosh; Intel Mac OS X 11)..."
jwtstring

A JSON Web Token, may include identity or product holding claims.

Example: "xxx-xxx-xxx"
pathstring

Request path, required for trials if used.

Example: "/x.html"
content_idstring

Content ID, used to perform requests to a 3rd party API for additional content information used in making a decision.

Example: "xxx-xxx-xxx"
curl -i -X POST \
  https://developer.zuora.com/_mock/zephr-api-reference/zephr-public-api/zephr/public/decisions/v2/dynamic-offers \
  -H 'Content-Type: application/json' \
  -b blaize_session=YOUR_API_KEY_HERE \
  -d '{
    "dynamic_offer": {
      "slug": "offerX",
      "inputs": {}
    },
    "session": "xxx-xxx-xxx",
    "foreign_keys": {},
    "ip": "x.x.x.x",
    "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 11)...",
    "jwt": "xxx-xxx-xxx",
    "path": "/x.html",
    "content_id": "xxx-xxx-xxx"
  }'

Responses

OK

Bodyapplication/json
productsArray of objects(do-product-response)

The processed output for mainly the Product rule. Price and Discount, if present, the output of those would be nested under each product element according to the rule specification.

taglinestring

The tagline rule output

customobject

key value pair of any custom property rule output. The key would be the property id, the value would be its rule output

outcomesArray of objects

The rule outcome for each property rule within the offer. If you wish to record user conversion data, you would need to send these outcome data back to Zephr upon when the conversion is happening.

errorsArray of objects
Response
application/json
{
  "products": [
    { … }
  ],
  "tagline": "string",
  "custom": {},
  "outcomes": [
    { … }
  ],
  "errors": [
    { … }
  ]
}

Validate dynamic offer decisions

Request

The Dynamic Offer Decision Engine can be tested via this endpoint to calculate a decision output response based on the criteria of the provided validation ID. Validation criteria is configured on the Zephr Console and determines the version of the dynamic offer being used.

Security
CookieBlaizeSession or JwtQuery or JwtHeaderXBlaizeJwt or JwtHeaderXZephrJwt or JwtBearer or JwtCookie
Path
offerIdstringrequired

The dynamic offer ID.

validationIdstringrequired

The dynamic offer validation ID.

curl -i -X GET \
  'https://developer.zuora.com/_mock/zephr-api-reference/zephr-public-api/zephr/public/decisions/v2/dynamic-offers/{offerId}/validations/{validationId}' \
  -b blaize_session=YOUR_API_KEY_HERE

Responses

OK

Bodyapplication/json
productsArray of objects(do-product-response)

The processed output for mainly the Product rule. Price and Discount, if present, the output of those would be nested under each product element according to the rule specification.

taglinestring

The tagline rule output

customobject

key value pair of any custom property rule output. The key would be the property id, the value would be its rule output

outcomesArray of objects

The rule outcome for each property rule within the offer. If you wish to record user conversion data, you would need to send these outcome data back to Zephr upon when the conversion is happening.

errorsArray of objects
Response
application/json
{
  "products": [
    { … }
  ],
  "tagline": "string",
  "custom": {},
  "outcomes": [
    { … }
  ],
  "errors": [
    { … }
  ]
}

Dynamic Offer Promo Code Decision

Operations

OAuth Flow

Operations

Payments

Operations

Product Sharing

Operations

SDK Feature Decision Engine

Operations

Sessions

Operations

Stripe Payments

Operations

Third-Party Authentication

This section contains the API operations for the OAuth 2.0 Authorization Code Flow.

Operations

User

Operations

V4 Gifts

Create a Gift resource for V4. Gifts can be used to provide access to a particular URL for one session only by appending a gift token ID to the URL as the gift path parameter.

Operations

Web Analytics

Operations

Zephr Features

Operations

Component Library

Operations

Change the Stripe subscription price

Request

Generates a new preview of the price that Stripe will charge the customer if they create a new subscription for the specified plan. Note: This method does not create any entities in Stripe and does not result in any payments being made.

Security
CookieBlaizeSession or JwtQuery or JwtHeaderXBlaizeJwt or JwtHeaderXZephrJwt or JwtBearer or JwtCookie
Path
externalIdstringrequired
Bodyapplication/json
plan_idstring
curl -i -X POST \
  'https://developer.zuora.com/_mock/zephr-api-reference/zephr-public-api/zephr/payment/stripe/subscriptions/{externalId}/change-previews' \
  -H 'Content-Type: application/json' \
  -b blaize_session=YOUR_API_KEY_HERE \
  -d '{
    "plan_id": "string"
  }'

Responses

OK

Bodyapplication/json
totalnumber

The total amount the user will be initially charged for the subscription in the relevant currency's lowest denomination (e.g. pence), i.e. for a monthly subscription, the first month's cost.

Example: 5000
sub_totalnumber

The total amount minus tax for the initial charge in the relevant currency's lowest denomination (e.g. pence).

Example: 4500
Response
application/json
{
  "total": 5000,
  "sub_total": 4500
}

Oauth2 Access Token

Operations

Subscription

Operations