Skip to content
/Braintree Payments

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

Retrieve the Braintree token

Request

Issues a Braintree client token for the current blaize session. This holds the user's userId if the user has an authenticated session. This token can be used to request a payment once.

Security
CookieBlaizeSession or JwtQuery or JwtHeaderXBlaizeJwt or JwtHeaderXZephrJwt or JwtBearer or JwtCookie
Query
allowUnauthenticatedboolean

If tokens can be generated for unauthenticated user sessions - defaults to false.

Headers
cookiestring

The session cookie.

Example: `blaize_session=...` (string)
curl -i -X GET \
  'https://developer.zuora.com/_mock/zephr-api-reference/zephr-public-api/blaize/payment/braintree/token?allowUnauthenticated=true' \
  -H 'cookie: `blaize_session=...` (string)' \
  -b '`blaize_session=...` (string)'

Responses

OK

Bodyapplication/json
tokenstring
Example: "eyJ2ZXmsaW5nQW...(lots more random-looking characters)...dyZWmVubW8iOiJvZmYifQ=="
Response
application/json
{
  "token": "eyJ2ZXmsaW5nQW...(lots more random-looking characters)...dyZWmVubW8iOiJvZmYifQ=="
}

Create a subscription charged callback

Request

This endpoint generates a callback for subscription charges when a product purchase is created, regardless of success or failure. It requires a mandatory string payload containing the bt_signature and bt_payload parameters. To use subscriptions, configure the Braintree callback to direct to this endpoint.

Security
CookieBlaizeSession or JwtQuery or JwtHeaderXBlaizeJwt or JwtHeaderXZephrJwt or JwtBearer or JwtCookie
Bodyapplication/json
string
curl -i -X POST \
  https://developer.zuora.com/_mock/zephr-api-reference/zephr-public-api/blaize/payment/braintree/subscriptionChargedCallback \
  -H 'Content-Type: application/json' \
  -b blaize_session=YOUR_API_KEY_HERE

Responses

OK. A product purchase is created successfully.

List the Braintree subscriptions of a user

Request

Lists all Braintree subscriptions for the logged-in user.

Security
CookieBlaizeSession or JwtQuery or JwtHeaderXBlaizeJwt or JwtHeaderXZephrJwt or JwtBearer or JwtCookie
Headers
cookiestring

The session cookie.

Example: `blaize_session=...` (string)
curl -i -X GET \
  https://developer.zuora.com/_mock/zephr-api-reference/zephr-public-api/blaize/payment/braintree/subscriptions \
  -H 'cookie: `blaize_session=...` (string)' \
  -b '`blaize_session=...` (string)'

Responses

OK

Bodyapplication/json
managed-bystringrequired

The name of payment provider capitalised.

Example: "Braintree"
endsstring(date-time)

ISO-8601 formatted time at which the subscription was canceled. This field will be omitted if the subscription is not canceled.

Example: "2021-05-17T04:31:33Z"
external-idstringrequired

The ID for this subscription in Braintree.

Example: "abc123"
next-billing-timestring(date-time)required

ISO-8601 formatted time at which the subscription will next be billed.

Example: "2021-05-17T04:31:33Z"
blaize-productobject(braintree-subscription-product)required
blaize-product.​tenantIdstring

Zephr tenant ID and site slug

Example: "your-tenant|site-slug"
blaize-product.​subTenantIdstring

Zephr subtenant ID and site slug

Example: "your-tenant|site-slug"
blaize-product.​idstring

Zephr product ID

Example: "one-month-one-off"
blaize-product.​labelstring

Zephr product label

Example: "One month access"
blaize-product.​descriptionstring

Description of Zephr product

Example: "One month access"
blaize-product.​entitlementobject
blaize-product.​mappingobject
blaize-product.​sharingLimitnumber

The number of users this product can be shared with. Users can share the product multiple times by canceling previous shares. A value of 0 indicates that the product is not shareable.

Example: 0
transaction-historyArray of objectsrequired
transaction-history[].​timestring(date-time)

ISO-8601 formatted time at which the transaction was made.

Example: "2024-02-15T11:30:58Z"
transaction-history[].​currencystring
Example: "EUR"
transaction-history[].​centsnumber
Example: 900
transaction-history[].​cyclestring
Example: "month"
transaction-history[].​cycleCountnumber
Example: 1
transaction-history[].​currencyCodestring

ISO 4217 currency code for this currency.

Example: "EUR"
transaction-history[].​human-readable-amountstring
Example: "€9.0"
subscription-statestringrequired

The subscription state, as acquired from Braintree.

Enum"Active""Canceled""Expired""Past Due""Pending""Unrecognized"
paid_through_datestring(date-time)

ISO-8601 formatted time up to which the subscription has been paid for. This will be null if the subscription has not yet been paid for.

Example: "2021-05-17T04:31:33Z"
plan_idstringrequired

The Braintree plan ID

Example: "plan-123"
plan_namestringrequired

The Braintree plan name

Example: "monthly-plan"
billing_frequency_unitstringrequired

The time unit of the billing frequency. Braintree only supports MONTH.

Value"MONTH"
billing_frequencynumberrequired

The frequency at which the subscription is billed, in the units specified by billing_frequency_unit.

Example: 1
currency_codestringrequired

The currency of the subscription price.

Example: "GBP"
pre_discount_pricenumberrequired

The subscription price before any discounts are applied.

Example: 50
multiphase_planbooleanrequired

Always false, as Braintree does not support multi-phased plans.

Example: false
discounts_appliedbooleanrequired

If the subscription has any applied discounts.

Example: true
Response
application/json
{
  "managed-by": "Braintree",
  "external-id": "abc123",
  "next-billing-time": "2021-05-17T04:31:33Z",
  "blaize-product": {
    "id": "one-month-one-off",
    "label": "One month access",
    "description": "One month access",
    "entitlement": { … },
    "mapping": { … },
    "sharingLimit": 0
  },
  "transaction-history": {
    "time": "2021-05-17T04:31:33Z",
    "currency": "GBP",
    "cents": 234,
    "cycle": "month",
    "cycleCount": 1,
    "currencyCode": "GBP",
    "human-readable-amount": "£2.34"
  },
  "subscription-state": "Active",
  "paid_through_date": "2021-05-17T04:31:33Z",
  "plan_id": "plan-123",
  "plan_name": "monthly-plan",
  "billing_frequency_unit": "MONTH",
  "billing_frequency": 1,
  "currency_code": "GBP",
  "pre_discount_price": 2,
  "multiphase_plan": false,
  "discounts_applied": true
}

Update the Braintree subscription

Request

Updates a Braintree subscription by ID. This operation currently only supports updating the payment method for a subscription, sending the payment method token or nonce.

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

Subscription ID

Headers
cookiestring

The session cookie.

Example: `blaize_session=...` (string)
Bodyapplication/json
payment_method_tokenstring

Payment method token referencing a payment method in Braintree.

Example: "alpha123token"
payment_method_noncestring

Payment method nonce referencing a payment method in Braintree.

Example: "alpha123token"
curl -i -X PATCH \
  'https://developer.zuora.com/_mock/zephr-api-reference/zephr-public-api/blaize/payment/braintree/subscriptions/{subscriptionId}' \
  -H 'Content-Type: application/json' \
  -H 'cookie: `blaize_session=...` (string)' \
  -b '`blaize_session=...` (string)' \
  -d '{
    "payment_method_token": "alpha123token",
    "payment_method_nonce": "alpha123token"
  }'

Responses

No Content

Cancel the Braintree subscription

Request

Cancels a Braintree subscription by ID.

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

Subscription ID

curl -i -X DELETE \
  'https://developer.zuora.com/_mock/zephr-api-reference/zephr-public-api/blaize/payment/braintree/subscriptions/{subscriptionId}' \
  -b blaize_session=YOUR_API_KEY_HERE

Responses

OK

Create a Braintree buy (one-off)

Request

Uses the payment info captured by the braintree drop-in UI and encoded in the payment nonce to create a braintree customer and issue a one-off payment. When braintree responds successfully, the logged-in user will be granted all entitlements in the product's associated bundle.

Security
CookieBlaizeSession or JwtQuery or JwtHeaderXBlaizeJwt or JwtHeaderXZephrJwt or JwtBearer or JwtCookie
Headers
cookiestring

The session cookie.

Example: `blaize_session=...` (string)
Bodyapplication/json
product_idstringrequired

Product Id/slug

Example: "lifetime-membership"
price_point_idstringrequired

Price Point Id/slug

Example: "gold-package"
payment_noncestringrequired

Payment method nonce from Braintree drop-in UI.

Example: "eyJ2ZXmsaW5nQW...(lots more random-looking characters)...dyZWmVubW8iOiJvZmYifQ=="
curl -i -X POST \
  https://developer.zuora.com/_mock/zephr-api-reference/zephr-public-api/blaize/payment/braintree/buy \
  -H 'Content-Type: application/json' \
  -H 'cookie: `blaize_session=...` (string)' \
  -b '`blaize_session=...` (string)' \
  -d '{
    "product_id": "lifetime-membership",
    "price_point_id": "gold-package",
    "payment_nonce": "eyJ2ZXmsaW5nQW...(lots more random-looking characters)...dyZWmVubW8iOiJvZmYifQ=="
  }'

Responses

OK

Bodyapplication/json
grant_idstring

New grant of product bundle to user.

Example: "aa583cb8-51d1-4bd9-9ec7-3a43796ef8e5"
Response
application/json
{
  "grant_id": "aa583cb8-51d1-4bd9-9ec7-3a43796ef8e5"
}

List Braintree payment methods

Request

Lists the Braintree payment method details associated with the logged-in user.

Security
CookieBlaizeSession or JwtQuery or JwtHeaderXBlaizeJwt or JwtHeaderXZephrJwt or JwtBearer or JwtCookie
Headers
cookiestring

The session cookie.

Example: `blaize_session=...` (string)
curl -i -X GET \
  https://developer.zuora.com/_mock/zephr-api-reference/zephr-public-api/zephr/payment/braintree/payment-methods \
  -H 'cookie: `blaize_session=...` (string)' \
  -b '`blaize_session=...` (string)'

Responses

OK

Bodyapplication/jsonArray [
tokenstringrequired

The token identifier for this payment method.

Example: "8m2kc5g"
defaultbooleanrequired

If this the default payment method for this user.

card_typestring

In the case of a card payment method, the type of the card.

Example: "Visa"
card_holder_namestring

In the case of a credit card payment method, the name of the card holder.

Example: "John Rambo"
card_number_maskedstring

In the case of a card payment method, the masked card number, compliant with PCI security standards.

Example: "654321******0987"
expiration_datestring

In the case of a card payment method, the expiration date, in the format of MM/YY or MM/YYYY.

Example: "07/22"
expiredboolean

In the case of a card payment method, if the card has expired.

expiring_soonboolean

In the case of a card payment method, if the card will expire within the configured number of days.

in_useboolean

Indicates if this payment method is used by any subscriptions that have not been finalised and would be cancelled if this payment method is deleted.

last_4string

In the case of a card payment method, the last four digits of the card number.

Example: "1111"
noncestringrequired

A nonce that can be used for other payment method operations.

Example: "086128f3-04c2-069e-78d2-3f4de98508e5"
typestringrequired

The payment method type.

Example: "CreditCard"
zipcodestring

In the case of a card payment method, the zip code associated with the card.

Example: "123456"
]
Response
application/json
[
  {
    "token": "8m2kc5g",
    "default": false,
    "card_type": "Visa",
    "card_holder_name": "John Rambo",
    "card_number_masked": "654321******0987",
    "expiration_date": "07/22",
    "expired": false,
    "expiring_soon": false,
    "in_use": false,
    "last_4": "1111",
    "nonce": "086128f3-04c2-069e-78d2-3f4de98508e5",
    "type": "CreditCard",
    "zipcode": "123456"
  }
]

Create a new Braintree payment method.

Request

Creates the Braintree payment method with the associated vaulted nonce, for the authenticated user.

Security
CookieBlaizeSession or JwtQuery or JwtHeaderXBlaizeJwt or JwtHeaderXZephrJwt or JwtBearer or JwtCookie
Headers
cookiestringrequired

The session cookie.

Example: `blaize_session=...` (string)
Bodyapplication/json
payment_method_noncestring

The vaulted nonce associated with the new payment method.

Example: "aa583cb8...and other characters...3a43796ef8e5"
curl -i -X POST \
  https://developer.zuora.com/_mock/zephr-api-reference/zephr-public-api/zephr/payment/braintree/payment-methods \
  -H 'Content-Type: application/json' \
  -H 'cookie: `blaize_session=...` (string)' \
  -b '`blaize_session=...` (string)' \
  -d '{
    "payment_method_nonce": "aa583cb8...and other characters...3a43796ef8e5"
  }'

Responses

OK. A new Braintree payment method has been created for the authenticated user.

Bodyapplication/json
tokenstringrequired

The token identifier for this payment method.

Example: "8m2kc5g"
defaultbooleanrequired

If this the default payment method for this user.

card_typestring

In the case of a card payment method, the type of the card.

Example: "Visa"
card_holder_namestring

In the case of a credit card payment method, the name of the card holder.

Example: "John Rambo"
card_number_maskedstring

In the case of a card payment method, the masked card number, compliant with PCI security standards.

Example: "654321******0987"
expiration_datestring

In the case of a card payment method, the expiration date, in the format of MM/YY or MM/YYYY.

Example: "07/22"
expiredboolean

In the case of a card payment method, if the card has expired.

expiring_soonboolean

In the case of a card payment method, if the card will expire within the configured number of days.

in_useboolean

Indicates if this payment method is used by any subscriptions that have not been finalised and would be cancelled if this payment method is deleted.

last_4string

In the case of a card payment method, the last four digits of the card number.

Example: "1111"
noncestringrequired

A nonce that can be used for other payment method operations.

Example: "086128f3-04c2-069e-78d2-3f4de98508e5"
typestringrequired

The payment method type.

Example: "CreditCard"
zipcodestring

In the case of a card payment method, the zip code associated with the card.

Example: "123456"
Response
application/json
{
  "token": "8m2kc5g",
  "default": false,
  "card_type": "Visa",
  "card_holder_name": "John Rambo",
  "card_number_masked": "654321******0987",
  "expiration_date": "07/22",
  "expired": false,
  "expiring_soon": false,
  "in_use": false,
  "last_4": "1111",
  "nonce": "086128f3-04c2-069e-78d2-3f4de98508e5",
  "type": "CreditCard",
  "zipcode": "123456"
}

Update a Braintree payment method

Request

Updates the Braintree payment method details associated with the logged-in user. The details to update must first be captured from Braintree in a nonce and vaulted.

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

The unique ID of the payment method.

Headers
cookiestring

The session cookie.

Example: `blaize_session=...` (string)
Bodyapplication/json
payment_method_noncestring

The vaulted nonce associated with the update payment method.

Example: "aa583cb8...and other characters...3a43796ef8e5"
curl -i -X PATCH \
  'https://developer.zuora.com/_mock/zephr-api-reference/zephr-public-api/zephr/payment/braintree/payment-methods/{paymentMethodToken}' \
  -H 'Content-Type: application/json' \
  -H 'cookie: `blaize_session=...` (string)' \
  -b '`blaize_session=...` (string)' \
  -d '{
    "payment_method_nonce": "aa583cb8...and other characters...3a43796ef8e5"
  }'

Responses

OK

Bodyapplication/json
tokenstringrequired

The token identifier for this payment method.

Example: "8m2kc5g"
defaultbooleanrequired

If this the default payment method for this user.

card_typestring

In the case of a card payment method, the type of the card.

Example: "Visa"
card_holder_namestring

In the case of a credit card payment method, the name of the card holder.

Example: "John Rambo"
card_number_maskedstring

In the case of a card payment method, the masked card number, compliant with PCI security standards.

Example: "654321******0987"
expiration_datestring

In the case of a card payment method, the expiration date, in the format of MM/YY or MM/YYYY.

Example: "07/22"
expiredboolean

In the case of a card payment method, if the card has expired.

expiring_soonboolean

In the case of a card payment method, if the card will expire within the configured number of days.

in_useboolean

Indicates if this payment method is used by any subscriptions that have not been finalised and would be cancelled if this payment method is deleted.

last_4string

In the case of a card payment method, the last four digits of the card number.

Example: "1111"
noncestringrequired

A nonce that can be used for other payment method operations.

Example: "086128f3-04c2-069e-78d2-3f4de98508e5"
typestringrequired

The payment method type.

Example: "CreditCard"
zipcodestring

In the case of a card payment method, the zip code associated with the card.

Example: "123456"
Response
application/json
{
  "token": "8m2kc5g",
  "default": false,
  "card_type": "Visa",
  "card_holder_name": "John Rambo",
  "card_number_masked": "654321******0987",
  "expiration_date": "07/22",
  "expired": false,
  "expiring_soon": false,
  "in_use": false,
  "last_4": "1111",
  "nonce": "086128f3-04c2-069e-78d2-3f4de98508e5",
  "type": "CreditCard",
  "zipcode": "123456"
}

Delete the Braintree payment method

Request

Deletes the Braintree payment method associated with the provided token.

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

The unique ID of the payment method.

Headers
cookiestring

The session cookie.

Example: `blaize_session=...` (string)
curl -i -X DELETE \
  'https://developer.zuora.com/_mock/zephr-api-reference/zephr-public-api/zephr/payment/braintree/payment-methods/{paymentMethodToken}' \
  -H 'cookie: `blaize_session=...` (string)' \
  -b '`blaize_session=...` (string)'

Responses

No Content

Set the default Braintree payment method

Request

Sets the Braintree default payment method for the logged-in user. This must be a valid payment method already associated with the user.

Security
CookieBlaizeSession or JwtQuery or JwtHeaderXBlaizeJwt or JwtHeaderXZephrJwt or JwtBearer or JwtCookie
Headers
cookiestring

The session cookie.

Example: `blaize_session=...` (string)
Bodyapplication/json
payment_method_tokenstring

The unique ID of the payment method to be set as default for the user.

Example: "payment-method-123"
curl -i -X PUT \
  https://developer.zuora.com/_mock/zephr-api-reference/zephr-public-api/zephr/payment/braintree/default-payment-method \
  -H 'Content-Type: application/json' \
  -H 'cookie: `blaize_session=...` (string)' \
  -b '`blaize_session=...` (string)' \
  -d '{
    "payment_method_token": "payment-method-123"
  }'

Responses

No Content

List all Braintree plans

Request

Lists the plans associated with the identified product. The product ID is required.

Security
CookieBlaizeSession or JwtQuery or JwtHeaderXBlaizeJwt or JwtHeaderXZephrJwt or JwtBearer or JwtCookie
Query
product_idstringrequired

Product ID

Headers
cookiestring

The session cookie.

Example: `blaize_session=...` (string)
curl -i -X GET \
  'https://developer.zuora.com/_mock/zephr-api-reference/zephr-public-api/zephr/payment/braintree/plans?product_id=string' \
  -H 'cookie: `blaize_session=...` (string)' \
  -b '`blaize_session=...` (string)'

Responses

OK

Bodyapplication/json
plan-idobject(payment_plan)
Response
application/json
{
  "plan-id": {
    "id": "annual-plan",
    "name": "Sports+ Membership Annual",
    "currency_code": "USD",
    "base_price": 10.2,
    "billing_interval_unit": "MONTH",
    "billing_interval": 3,
    "billing_cycles": 12,
    "trial_duration_unit": "DAY",
    "trial_duration": 30,
    "discounts": [ … ],
    "zephr_product_id": "product-123"
  }
}

Get a Braintree Promo Code

Request

Gets a Braintree promo code.

Security
CookieBlaizeSession or JwtQuery or JwtHeaderXBlaizeJwt or JwtHeaderXZephrJwt or JwtBearer or JwtCookie
Query
codestringrequired

Promo code to lookup by ID.

paymentFormstringrequired

Payment form to lookup by slug.

curl -i -X GET \
  'https://developer.zuora.com/_mock/zephr-api-reference/zephr-public-api/blaize/payment/braintree/promo-code?code=string&paymentForm=string' \
  -b blaize_session=YOUR_API_KEY_HERE

Responses

OK

Bodyapplication/json
codestringrequired

The promo code identifier.

Example: "promo-123"
discountnumberrequired

The discount amount.

Example: 20
paymentOptionsArray of objects(promo-code-payment-options)required

The list of payment options.

paymentOptions[].​slugstring

The plan slug with which this promo code is associated.

Example: "plan-123"
paymentOptions[].​currencystring

The currency symbol.

Example: "$"
paymentOptions[].​pricePointIdstring
Example: "cost-123"
paymentOptions[].​originalPricenumber
Example: 3.45
paymentOptions[].​discountPricenumber
Example: 2
Response
application/json
{
  "code": "promo-123",
  "discount": 20,
  "paymentOptions": [
    { … }
  ]
}

List Braintree add-ons

Request

Lists the Braintree add-ons.

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

Promo code to lookup by ID.

Query
paymentFormstringrequired

Payment form to lookup by slug.

curl -i -X GET \
  'https://developer.zuora.com/_mock/zephr-api-reference/zephr-public-api/blaize/payment/braintree/addons&promoCode={promoCode}?paymentForm=string' \
  -b blaize_session=YOUR_API_KEY_HERE

Responses

OK

Bodyapplication/jsonArray [
idstring
labelstring
valuenumber
paymentOptionsArray of objects(add-on-payment-options)
]
Response
application/json
[
  {
    "id": "add-123",
    "label": "Easy Add-on",
    "value": 12,
    "type": "PERCENT",
    "paymentOptions": [ … ]
  }
]

Start the Braintree subscription (Deprecated)

Request

** (Deprecated - use the "/zephr/subscribe" operation intead)** Uses the payment info captured by the braintree drop-in UI and encoded in the payment nonce to create a braintree customer in with a recurring payment. When braintree responds successfully, the logged-in user will be temporarily granted all entitlements in the product's associated bundle.

Security
CookieBlaizeSession or JwtQuery or JwtHeaderXBlaizeJwt or JwtHeaderXZephrJwt or JwtBearer or JwtCookie
Headers
cookiestring

The session cookie.

Example: `blaize_session=...` (string)
Bodyapplication/json
product_idstringrequired

Product ID/slug

Example: "premium-access-monthly-recurring"
plan_idstring
discount_codestring
payment_noncestringrequired

Payment method nonce from Braintree drop-in UI.

Example: "eyJ2ZXmsaW5nQW...(lots more random-looking characters)...dyZWmVubW8iOiJvZmYifQ=="
skip_trial_periodboolean

Whether or not to skip any trial period that may be associated with this subscription. This should be null or not set to use the configured trial period.

Example: true
start_datestring

ISO 8601 date format which determines when the subscription will start. When the attribute is passed, the value must be in the future. Otherwise, the subscription is expected to start immediately.

Example: "2021-01-01T00:00:00Z"
curl -i -X POST \
  https://developer.zuora.com/_mock/zephr-api-reference/zephr-public-api/blaize/payment/braintree/subscribe \
  -H 'Content-Type: application/json' \
  -H 'cookie: `blaize_session=...` (string)' \
  -b '`blaize_session=...` (string)' \
  -d '{
    "product_id": "premium-access-monthly-recurring",
    "payment_nonce": "eyJ2ZXmsaW5nQW...(lots more random-looking characters)...dyZWmVubW8iOiJvZmYifQ==",
    "skip_trial_period": true,
    "start_date": "2021-01-01T00:00:00Z"
  }'

Responses

OK

Bodyapplication/json
grant_idstring

New grant of product bundle to user.

Example: "33d576c7-d036-40e7-8141-8a91998a5c79"
Response
application/json
{
  "grant_id": "33d576c7-d036-40e7-8141-8a91998a5c79"
}

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