StreamAMG Fusion

Introduction

Features

Client Guides

Exporting Reports

Creating a PPV Package

Creating a Recurring Subscription Package

FeatureIDs & Adding an Entitlement to Video Content

Putting a Package on-sale/off-sale

Customer Profiles, Refunds, Cancellations

Complementary Subscriptions

Integration Guides

Creating a Simple Checkout

Customer Portal Flow

Building a Pricing Table

Migration from CloudPay to Fusion + Stripe Checkout

FAQ's

Creating Products in Stripe

<p class="slate-p " >API for managing monetization operations and proxying Stripe calls.</p><p class="slate-p " ><strong class="slate-bold">IMPORTANT NOTE ON ERROR HANDLING:</strong>
This API uses a non-standard error handling pattern in its /v1 endpoints, where most errors return HTTP 500 status code
regardless of the error type. The actual error type is indicated by the <code class="slate-code">errors</code> field in the response. Check the ApiError schema for the list of error strings.
Exceptions to this pattern are explicitly noted in individual endpoint descriptions.</p><h2 class="slate-h2 " >Authentication</h2><p class="slate-p " >This API uses two primary authentication methods:</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">API Key - </strong>All calls must be made with your Fusion API Key in the X-API-KEY header</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">JWT Token - </strong>All calls specific to a user e.g. checkout sessions and subscriptions must also contain a valid JWT token in the Authorization header in the format ‘Bearer TOKEN’. This token must contain the ‘sub’ claim which serves as the unique ID for the customer across the Fusion system. </div></li></ul><p class="slate-p " ></p><p class="slate-p " ></p>

Fusion API Reference

<p class="slate-p " >These endpoints allow you to return Stripe products and prices to display to your users so that they can purchase them. They are all accessible using your Fusion API key and do not require a JWT token from the user. </p><p class="slate-p " ></p>

Product

<p class="slate-p " >These endpoints allow you to perform monetization operations, and proxy through the Stripe, a world leading payment platform that is the technology underpinning of Fusion monetization. Here you will find endpoints for creating checkout sessions, retrieving checkout information and giving access to the customer portal.</p><p class="slate-p " ></p>

Billing

<p class="slate-p " >These endpoints are for the checking of customer entitlements, establishing what a customer has access to and what products they should be able to purchase.</p><p class="slate-p " ></p>

Subscriptions

Preferences

Default

Fusion

Production server

Staging server

Local development server

Check User Subscription

Create Checkout Session

Create Customer Portal Link

Get Active Subscriptions for a User

Get current user's preferences

Get preference schema

Get Price by ID

Get Product by ID

List Products

Retrieve Stripe Checkout Session by ID

Update current user's preferences

<p class="slate-p " >API for managing monetization operations and proxying Stripe calls.</p><h2 class="slate-h2 " >Authentication</h2><p class="slate-p " >This API uses two primary authentication methods:</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">API Key - </strong>All calls must be made with your Fusion API Key in the X-API-KEY header</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">JWT Token - </strong>All calls specific to a user e.g. checkout sessions and subscriptions must also contain a valid JWT token in the Authorization header in the format ‘Bearer TOKEN’. This token must contain the ‘sub’ claim which serves as the unique ID for the customer across the Fusion system. </div></li></ul><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p>

API for managing monetization operations and proxying Stripe calls.

This API uses two primary authentication methods:

<p class="slate-p " >Returns all active products from Stripe that are available in the geo location of the customer. If desired, a set of IDs can be passed as a query parameter to return only those specific products. </p><p class="slate-p " ><strong class="slate-bold">Key Fields:</strong></p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">n<strong class="slate-bold">ame - </strong>The product name, for display to customers</div></li><li class="slate-li " ><div style="position:relative">d<strong class="slate-bold">escription - </strong>Extra information about the product e.g. ‘Season pass for all games’</div></li><li class="slate-li " ><div style="position:relative">m<strong class="slate-bold">arketingFeatures - </strong>This is an array of extra information strings that you can display to the customer, letting them know what features this product grants e.g. ‘Presale ticket access’, ‘Eclusive interviews’ etc.</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">prices/defaultPrice - </strong>These are the available prices for your product, and will also be automatically filtered by geo location. To create a checkout session, you make a call to <a href="https://app.theneo.io/streamamg/fusion/billing/create-a-checkout-session-for-payment" target="">create-checkout-session</a> using the ID of the price you wish to charge the user. Prices will either be of type ‘one_time’ or ‘recurring’ and will contain information about their billing and how long they give access. Currencies will also be served according to the customer&apos;s geo location if this has been set up with us by your account manager.</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">features - </strong>Not to be confused with <strong class="slate-bold">marketingFeatures</strong>! These <strong class="slate-bold">features </strong>specify what entitlements are granted to the customer when they purchase this product. e.g., if the Paid Access feature is attached to this product, a customer will get Paid Access for the duration they are paying for this product. Similarly, if instead, the feature is for a PPV event, e.g. Liverpool V Man Utd Match Pass, they will gain access to just that entitlement instead. The featureId of these features, can be compared against the <a href="https://app.theneo.io/streamamg/fusion/subscriptions-1/get-all-active-subscriptions-for-a-user-returns-empty-array-if-none-found" target="">user subscription response</a> to check if a customer already has access to a feature granted by the product, so you can prevent them accidentally buying the same thing twice, for example.</div></li></ul><p class="slate-p " ></p>

<p class="slate-p " >Please see the <a href="https://app.theneo.io/streamamg/fusion/product-1/get-all-active-products-with-their-prices-or-by-specific-ids" target="">get all products section</a> for more details on returned fields.</p><p class="slate-p " ></p>

Sections