FAQ

chevron-rightWhat is Tebex?hashtag

Tebex is a payments and monetization platform designed for game developers. Our Unity SDK lets you embed a fully functional in-game store without requiring your own payment infrastructure.

Tebex handles payment processing, currencies, VAT, gift cards, coupons, and subscriptions. You focus on what to sell and what happens when a player buys it.

chevron-rightDoes Tebex support subscriptions?hashtag

Yes! In addition to one-time purchases (such as for consumables, DLC, and cosmetics), we support both recurring subscriptions as well as tiered memberships.

chevron-rightDo you include a pre-built UI?hashtag

Yes, we include both a Store Browser and In-Game Cart to render your store and a player's cart dynamically in-game. This uses no external dependencies and can be drawn on the Canvas you specify.

chevron-rightCan I use the API without the pre-built UI components?hashtag

Yes. HeadlessApi is a standalone class. You can call it directly to build your own UI:

var api = HeadlessApi.GetInstance(new UnityHeadlessAdapter(), "your-public-token");

await api.GetAllCategoriesIncludingPackagesAsync(
    onSuccess: categories => { /* populate your own UI */ },
    onApiError: err => Debug.LogError(err.detail),
    onServerError: err => Debug.LogError(err.Body)
);
chevron-rightDo I need a backend/API to use Tebex?hashtag

No backend is required for the purchase or fulfillment flow.

The Headless API and all TebexUnity components included with our SDK work entirely from the Unity client using your store's public token. See Implementation Guidefor more details.

If your game implements private servers and can run commands, we provide a Plugin API and example plugin that fulfils these commands. See Plugin API for more information.

Tebex can also send webhooks for various events to endpoints you control. See Webhooks for further detail.

chevron-rightWhat are the two API types and when do I use them?hashtag

Headless API is for browsing the store's available packages, creating baskets, and checking out the user. For most Unity games, Headless API will suffice.

Plugin API is intended for dedicated servers that need to deliver player rewards.

chevron-rightIs there a demo scene I can reference?hashtag

Yes, open the scene at Assets/Tebex/Veilborn/Veilborn.unity.

This is a complete example store built around a fantasy game theme ("Veilborn") that demonstrates the StoreBrowser, InGameCart, and Deliverables components of the Unity SDK working together, along with QR code checkout.

chevron-rightAre there any dependencies?hashtag

There are no external dependencies for our Unity SDK. JSON encoding uses Unity's internal tooling.

chevron-rightHow do I get my public token?hashtag

Login to your store at https://creator.tebex.io/arrow-up-right, select Integrations > API Keys. Your Public Token is displayed on this page.

Quick link: https://creator.tebex.io/developers/api-keysarrow-up-right

chevron-rightCan I add Tebex to an existing scene?hashtag

Yes! Adding Tebex can be done in just a few steps:

  1. Create a Canvas in your scene (or use an existing one).

  2. Add the StoreBrowser component to a GameObject on that canvas.

  3. Assign your Store Public Key in the Inspector.

  4. Assign a TMP_FontAsset and any branding textures you want to use.

  5. Optionally attach an InGameCart component and link it to StoreBrowser.

  6. Press Play - the SDK fetches your store data automatically.

chevron-rightDoes payment happen inside the game?hashtag

Payment does not happen inside the game.

When the player is ready to check out, the SDK opens the basket.links.checkout URL in the player's browser (or displays it as a QR code for mobile checkout).

Tebex's hosted page handles all payment collection. After payment, the basket's complete flag is set to true, and the Deliverables component detects this via polling.

This approach means you are never handling card numbers or payment data inside Unity.

chevron-rightHow do I know when a player has paid, so I can give them their reward?hashtag

Use the Deliverables component. Register a callback for each package you sell:

Deliverables polls the basket every few seconds. When basket.complete is true, it fires every registered callback for the purchased packages.

chevron-rightIs it safe to include my store's public token in the game client?hashtag

Yes. The public token is designed to be client-visible. It only allows reading store data and managing baskets - it cannot access financial data, ban players, or modify your store.

circle-exclamation

Last updated