Skip to content
Public API reference
/
/
Complete updating the cur...

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

Start updating the current email address

Request

Updates the user's email address. The user will receive an email with a one-time password (OTP) to verify the new email address. In order to finish the process, the user must provide the OTP to the /zephr/users/update-email/{otp} endpoint. The difference between this endpoint and the /blaize/users/update-email endpoint is that this endpoint requires the extra layer of authentication through the required validator.

Security
CookieBlaizeSession or JwtQuery or JwtHeaderXBlaizeJwt or JwtHeaderXZephrJwt or JwtBearer or JwtCookie
Bodyapplication/json
current_identifiersobject(identifiers)required
current_identifiers.​email_addressstring
Example: "joe.blow@company.com"
new_identifiersobject(identifiers)required
new_identifiers.​email_addressstring
Example: "joe.blow@company.com"
validatorsobject(validators)required
validators.​passwordstring
Example: "mysecurepassword123"
validators.​use_ssoboolean

When this is present there should be no identifiers in the body. The user is identified through a blaize_session cookie.

curl -i -X POST \
  https://developer.zuora.com/_mock/zephr-api-reference/zephr-public-api/zephr/users/update-email \
  -H 'Content-Type: application/json' \
  -b blaize_session=YOUR_API_KEY_HERE \
  -d '{
    "current_identifiers": {
      "email_address": "john.doe@company.com"
    },
    "new_identifiers": {
      "email_address": "doe.john@company.com"
    },
    "validators": {
      "password": "mysecurepassword123"
    }
  }'

Responses

OK. The confirmation email was sent successfully.

Bodyapplication/json
messagestring
Example: "Email with OTP sent to verify new email address"
Response
application/json
{
  "message": "Email with OTP sent to verify new email address"
}

Complete updating the current email address

Request

Completes updating the user's email address. The user must provide the OTP received in the email to verify the new email address. The difference between this endpoint and the /blaize/users/update-email/ endpoint is that this endpoint requires the extra layer of authentication through the required validator.

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

The one-time password (OTP) received in the email.

Bodyapplication/json
current_identifiersobject(identifiers)required
current_identifiers.​email_addressstring
Example: "joe.blow@company.com"
validatorsobject(validators)required
validators.​passwordstring
Example: "mysecurepassword123"
validators.​use_ssoboolean

When this is present there should be no identifiers in the body. The user is identified through a blaize_session cookie.

curl -i -X POST \
  'https://developer.zuora.com/_mock/zephr-api-reference/zephr-public-api/zephr/users/update-email/{otp}' \
  -H 'Content-Type: application/json' \
  -b blaize_session=YOUR_API_KEY_HERE \
  -d '{
    "current_identifiers": {
      "email_address": "john.doe@company.com"
    },
    "validators": {
      "password": "mysecurepassword123"
    }
  }'

Responses

OK. The email address was updated successfully.

Bodyapplication/json
messagestring
Example: "User Email updated"
Response
application/json
{
  "message": "User Email updated"
}

Return the update email request form

Request

Returns the update email request Form.

Security
CookieBlaizeSession or JwtQuery or JwtHeaderXBlaizeJwt or JwtHeaderXZephrJwt or JwtBearer or JwtCookie
curl -i -X GET \
  https://developer.zuora.com/_mock/zephr-api-reference/zephr-public-api/blaize/update-email.html \
  -b blaize_session=YOUR_API_KEY_HERE

Responses

OK

Bodytext/html
Response
text/html

Braintree Payments

Operations

Browser Feature Transformations

Operations

Decision Engine

Operations

Dynamic Offer Decision Engine

Operations

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