Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2,406 changes: 2,405 additions & 1 deletion customer-api/openapi-2025-04-01.json

Large diffs are not rendered by default.

11 changes: 2 additions & 9 deletions supertab-experiences/experiences.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,6 @@ The Paywall is simple, yet adaptable:

- The layout will react to the number of Offerings you select
- A second screen can be added for more customization
- Upsells give you an option to encourage customers to choose other (e.g. longer) offerings. If we detect savings for the user, we will show a calculated discount.
- To align with your brand, colors can be customized and the logo will be displayed at the top of the Paywall (if you added it to the Website)
- Parts of the Paywall text can be edited in all languages we support.

Expand Down Expand Up @@ -45,20 +44,14 @@ We automatically create the first Paywall for each new Website using default tim

You cannot use the same Offering on a screen twice.

For each Offering, you can choose an upsell. We will calculate the difference between prices and if we detect a discount, it will be displayed on the Paywall. Upsells are only displayed when customer clicks on the associated Offering.

If we detect no discount, the Paywall will adapt to not show the savings badge.

There are no restrictions for upsells other than the Offering and the associated upsell cannot be the same (e.g. all your time passes can upsell to the same subscription)

If you choose two or three Offerings on one screen, you will have an option to select which one of them should be highlighted by default to grab the attention of customers.
</Step>
<Step title="Customize colors and text">
Use **Button text color** to edit the **Put it on my Tab** and **More access options** button text.

**Button color** controls the background of the **Put it on my Tab** button, highlighted Offering box, and the upsell box when active.
**Button color** controls the background of the **Put it on my Tab** button, highlighted Offering box.

**Highlighted text color** controls the color of text on highlighted Offerings and the savings badge on upsells to ensure proper contrast.
**Highlighted text color** controls the color of text on highlighted Offerings to ensure proper contrast.

Parts of Paywall text (such as title) can be edited in all languages we support. They will not be translated automatically. If you choose not to provide a translation, we will use default values.
</Step>
Expand Down
45 changes: 23 additions & 22 deletions supertab-js/reference/api.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,11 @@ This interface is particularly useful for custom integrations that require direc

## Methods

<Info>Each method returns a promise which resolves with the response from the Customer API endpoint with object keys transformed from snake_case to camelCase.</Info>
<Info>
Each method returns a promise which resolves with the response from the
Customer API endpoint with object keys transformed from snake_case to
camelCase.
</Info>

See <a href="./errors">Errors</a> for a list of common exceptions.

Expand All @@ -26,14 +30,14 @@ Retrieves the current customer.
Call this method again <a href="/supertab-js/reference/auth">after auth</a> to get limits in the user's tab currency.

You must re-fetch this information after a new auth session is started.

</Info>

#### Returns

Customer object. See <a href="/customer-api/endpoints/retrieve-customer">Retrieve current customer</a>.
Supertab.js returns the response object keys in camelCase.


#### Type

```typescript retrieveCustomer return type [expandable]
Expand Down Expand Up @@ -104,7 +108,6 @@ Supertab.js returns the response object keys in camelCase.
}
```


#### Example

```typescript
Expand All @@ -124,6 +127,7 @@ Retrieves the site object associated with the client ID used to [initialize Supe
Call this method again <a href="/supertab-js/reference/auth">after auth</a> to get prices in the user's tab currency.

You must re-fetch this information after a new auth session is started in order to show correct pricing.

</Info>

#### Returns
Expand Down Expand Up @@ -170,11 +174,6 @@ Supertab.js returns the response object keys in camelCase.
offerings: string[];
configuration: {
onClose: string | (string | null)[] | null;
upsells: {
mainOffering: string;
upsellOffering: string;
discount: number;
}[];
uiConfig?: unknown;
};
}[];
Expand All @@ -198,7 +197,7 @@ This method checks the entitlement details for a given content key.
#### Parameters

<ParamField path="contentKey" type="string" required>
The content key of the entitlement to check.
The content key of the entitlement to check.
</ParamField>

#### Returns
Expand All @@ -221,7 +220,7 @@ Supertab.js returns the response object keys in camelCase.

```typescript Check entitlement for a specific content key
await supertabClient.api.checkEntitlement({
contentKey: "content-key"
contentKey: "content-key",
});
```

Expand All @@ -231,9 +230,9 @@ const { contentKeys } = await supertabClient.api.retrieveSite();

// Check entitlement
const entitlement = await Promise.all(
contentKeys.map(async (contentKey) => {
return await supertabClient.api.checkEntitlement({ contentKey });
})
contentKeys.map(async (contentKey) => {
return await supertabClient.api.checkEntitlement({ contentKey });
}),
);
```

Expand All @@ -250,20 +249,22 @@ Purchases an offering or a one-time offering.
<Info>Either `offeringId` or `onetimeOfferingId` must be provided.</Info>

<ParamField path="offeringId" type="string">
The offering ID to purchase.
The offering ID to purchase.
</ParamField>

<ParamField path="onetimeOfferingId" type="string">
The onetime offering ID to purchase.
The onetime offering ID to purchase.
</ParamField>

<ParamField path="currencyCode" type="string" required>
ISO4217 currency code.
<Warning>Must match the currency of user's tab, otherwise the purchase will fail.</Warning>
ISO4217 currency code.
<Warning>
Must match the currency of user's tab, otherwise the purchase will fail.
</Warning>
</ParamField>

<ParamField path="metadata" type="object">
Free-form metadata to associate with the purchase.
Free-form metadata to associate with the purchase.
</ParamField>

#### Returns
Expand Down Expand Up @@ -318,8 +319,8 @@ Supertab.js returns the response object keys in camelCase.

```typescript
await supertabClient.api.purchase({
offeringId: "offering-id",
currencyCode: "USD"
offeringId: "offering-id",
currencyCode: "USD",
});
```

Expand All @@ -334,7 +335,7 @@ This method retrieves a purchase object for a given purchase ID.
#### Parameters

<ParamField path="purchaseId" type="string" required>
The purchase ID to retrieve.
The purchase ID to retrieve.
</ParamField>

#### Returns
Expand Down Expand Up @@ -380,6 +381,6 @@ Supertab.js returns the response object keys in camelCase.

```typescript
await supertabClient.api.retrievePurchase({
purchaseId: "purchase-id"
purchaseId: "purchase-id",
});
```
1 change: 0 additions & 1 deletion updates/experiences-2025-02-06.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,6 @@ We’re thrilled to announce major updates to the Supertab Experiences, includin
subscriptions can now stand alone or be combined with other offerings.
- **Flexible Basic Paygate**:
- A new two-screen layout for a cleaner, more engaging experience.
- Upsells to highlight savings and encourage users to stay engaged longer.
- Design customization, including logo support, for better brand alignment.
- **More Flexibility**: Create **multiple paygate** for different part of your site and
control where each one appears using specific installation codes.
Expand Down
47 changes: 24 additions & 23 deletions updates/product.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,74 +8,75 @@ mode: "wide"
<Update label="October 2025">
## [Trigger Purchases Anywhere with Supertab.js](/updates/trigger-purchase-flow-2025-10-02)

The new createPurchase method in Supertab.js, makes it easier for developers to bring Supertab’s purchase flow directly into their applications programatically. This speeds up custom integrations via a simple function call and allows customization to tailor the purchase flow to your brand's design. [Read more...](/updates/trigger-purchase-flow-2025-10-02)
The new createPurchase method in Supertab.js, makes it easier for developers to bring Supertab’s purchase flow directly into their applications programatically. This speeds up custom integrations via a simple function call and allows customization to tailor the purchase flow to your brand's design. [Read more...](/updates/trigger-purchase-flow-2025-10-02)

</Update>

<Update label="August 2025">
## [New Purchase Flow and Tab auto-closing: better UX for users, improved fund collection and branding options for Merchants](/updates/context-aware-purchase-flow-2025-08-22)

![Group3625316 Pn](/Group3625316.png)

Our new purchase flow delivers a smoother, more consistent experience—fully styled to match your brand.
You can now enable card capture on a per-site basis and activate Tab auto-closing: after 30 days of inactivity, open Tabs are automatically charged, helping you secure revenue more reliably. [Read more...](/updates/context-aware-purchase-flow-2025-08-22)
</Update>

<Update label="July 2025">
## [Set Upsell Offerings as the Default on Your Paywall](/updates/upsell-offerings-2025-07-29)
![Group3625316 Pn](/Group3625316.png)

![Upsell as default offering in paywall](/images/upsell-default-paywall.png)
Our new purchase flow delivers a smoother, more consistent experience—fully styled to match your brand.
You can now enable card capture on a per-site basis and activate Tab auto-closing: after 30 days of inactivity, open Tabs are automatically charged, helping you secure revenue more reliably. [Read more...](/updates/context-aware-purchase-flow-2025-08-22)

You can now set an upsell offering as the default selection on your paywall. [Read more...](/updates/upsell-offerings-2025-07-29)
</Update>

<Update label="June 2025">
## [Off-App Purchase Flow](/updates/off-app-purchase-flow-2025-06-09)

Enable direct transactions outside of app stores with Supertab’s new Off-App Purchase flow, keeping more revenue in your hands while offering a seamless user experience. [Read more...](/updates/off-app-purchase-flow-2025-06-09)
Enable direct transactions outside of app stores with Supertab’s new Off-App Purchase flow, keeping more revenue in your hands while offering a seamless user experience. [Read more...](/updates/off-app-purchase-flow-2025-06-09)

</Update>

<Update label="May 2025">
## [Improved Navigation with Site-Driven Architecture](/updates/site-driven-architecture-2025-05-10)

![Frame64 Pn](/images/Frame64.png)
![Frame64 Pn](/images/Frame64.png)

We’ve restructured how you navigate Offerings, Experiences, and settings—so it’s easier to manage multiple Sites and stay focused. [Read more...](/updates/site-driven-architecture-2025-05-10)

We’ve restructured how you navigate Offerings, Experiences, and settings—so it’s easier to manage multiple Sites and stay focused. [Read more...](/updates/site-driven-architecture-2025-05-10)
</Update>

<Update label="May 2025">
## [Dynamic Tab Limits to Close Payments Faster](/updates/dynamic-tab-limits-2025-05-10)

First-time users now get a smaller Tab limit to start, making it easier to complete a payment early and unlock the full \$5 Tab. Faster conversions for Merchants, shorter time-to-value value for users. [Read more...](/updates/dynamic-tab-limits-2025-05-10)
First-time users now get a smaller Tab limit to start, making it easier to complete a payment early and unlock the full \$5 Tab. Faster conversions for Merchants, shorter time-to-value value for users. [Read more...](/updates/dynamic-tab-limits-2025-05-10)

</Update>

<Update label="May 2025">
## [Get Started Faster — KYC Now Only Required at Payout](/updates/kyc-at-payout-2025-05-10)

Whether you’re using Supertab directly or through our integration with Google Ad Manager, you can now start earning without completing KYC upfront. [Read more...](/updates/kyc-at-payout-2025-05-10)
Whether you’re using Supertab directly or through our integration with Google Ad Manager, you can now start earning without completing KYC upfront. [Read more...](/updates/kyc-at-payout-2025-05-10)

</Update>

<Update label="April 2025">
## [Customize Your Paygate Messaging in Multiple Languages](/updates/editable-paygate-copy-2025-04-16)

![Editablecopyandlangsupport Pn](/images/editablecopyandlangsupport.png)
![Editablecopyandlangsupport Pn](/images/editablecopyandlangsupport.png)

Tailor your Paygate messaging to fit your use case, test what converts best, and speak to users in one of eight supported languages. [Read more...](/updates/editable-paygate-copy-2025-04-16)

Tailor your Paygate messaging to fit your use case, test what converts best, and speak to users in one of eight supported languages. [Read more...](/updates/editable-paygate-copy-2025-04-16)
</Update>

<Update label="February 2025">
## [Validate Purchases with Server-Side Webhooks](/updates/webhooks-2025-02)

![Webhooks Pn](/images/Webhooks.png)
![Webhooks Pn](/images/Webhooks.png)

You can now securely confirm purchases and trigger real-time workflows—grant access, send emails, update analytics, and more. Plus, `onPurchaseComplete` now gives you detailed purchase data. [Read more...](/updates/webhooks-2025-02)

You can now securely confirm purchases and trigger real-time workflows—grant access, send emails, update analytics, and more. Plus, `onPurchaseComplete` now gives you detailed purchase data. [Read more...](/updates/webhooks-2025-02)
</Update>

<Update label="February 2025">
## [New Basic Paygate, Changes to the Purchase Button and Unlimited Offerings](/updates/experiences-2025-02-06)

![Paygatepreview2 Pn](/Paygatepreview2.png)
![Paygatepreview2 Pn](/Paygatepreview2.png)

You can now use the all new Supertab Paygate to secure and monetize your content or access to your SaaS product. The new Basic Paygate replaces existing Paygate installations and offers enhanced options for controlling how you price and sell your content.

You can now use the all new Supertab Paygate to secure and monetize your content or access to your SaaS product. The new Basic Paygate replaces existing Paygate installations and offers enhanced options for controlling how you price and sell your content.
Setup and installation takes minutes, existing customers are encouraged to migrate to the new Paygate Experience. [Read more...](/updates/experiences-2025-02-06)

Setup and installation takes minutes, existing customers are encouraged to migrate to the new Paygate Experience. [Read more...](/updates/experiences-2025-02-06)
</Update>
29 changes: 0 additions & 29 deletions updates/upsell-offerings-2025-07-29.mdx

This file was deleted.