Skip to content
/Sessions

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

Dynamic Offer Promo Code Decision

Operations

OAuth Flow

Operations

Payments

Operations

Product Sharing

Operations

SDK Feature Decision Engine

Operations

Sessions

Operations

List all the user sessions

Request

Lists of all sessions for the current user and site.

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/zephr/public/sessions/v1/sessions \
  -b blaize_session=YOUR_API_KEY_HERE

Responses

OK

Bodyapplication/jsonArray [
idstring

The ID of the session

Example: "aba22-a5mfh-"
startDatestring(date-time)

The creation date-time of the session

Example: "2011-11-11T11:11:11.000"
deviceTypestring

The type of device this session was created on

Example: "pc"
deviceNamestring

The name of the device this session was created on

Example: "Google Nexus 5"
ipstring

The IP address this session was created from

Example: "10.10.10.1"
browserstring

The name of the browser that this session was created from

Example: "Chrome"
osstring

The operating system of the device that this session was created from

Example: "Android"
citystring

The name of the city that this session was created from

Example: "Huston"
geoStatestring

The name of the state that this session was created from

Example: "Texas"
countrystring

The name of the country that this session was created from

Example: "USA"
isRequestingSessionboolean

True if this session is the session that made the request to this endpoint, otherwise false

Example: true
]
Response
application/json
[
  {
    "id": "aba22-a5mfh-",
    "startDate": "2011-11-11T11:11:11.000",
    "deviceType": "pc",
    "deviceName": "Google Nexus 5",
    "browser": "Chrome",
    "os": "Android",
    "city": "Huston",
    "geoState": "Texas",
    "country": "USA",
    "isRequestingSession": true
  }
]

Delete all other sessions

Request

Deletes all sessions for the current user and site apart from the session used to make the request.

Security
CookieBlaizeSession or JwtQuery or JwtHeaderXBlaizeJwt or JwtHeaderXZephrJwt or JwtBearer or JwtCookie
Query
except-currentbooleanrequired
curl -i -X DELETE \
  'https://developer.zuora.com/_mock/zephr-api-reference/zephr-public-api/zephr/public/sessions/v1/sessions?except-current=true' \
  -b blaize_session=YOUR_API_KEY_HERE

Responses

OK

Delete the session by ID

Request

Deletes a session by ID. Returns a 404 if the specified session does not exist or does not belong to the current user.

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

The ID of the session to delete.

Example: 0nasdj-aso25-6454
curl -i -X DELETE \
  https://developer.zuora.com/_mock/zephr-api-reference/zephr-public-api/zephr/public/sessions/v1/sessions/0nasdj-aso25-6454 \
  -b blaize_session=YOUR_API_KEY_HERE

Responses

OK

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