1 of 1

Overview

Tebex Headless API allows integration of your store directly into your own frontend or in-game.

The Headless API works with your existing packages, coupons, sales & creator codes.

If you haven't already done so, we recommend having a read of our quick start guide before beginning integration.

You can query the Headless API to retrieve your packages/categories, build a basket for a user, and direct them to checkout - all from within your own frontend implementation (be that a website or in-game).

The Headless API can be used with Tebex.js for a fully embedded checkout experience without the user ever leaving your own website.

Headless API Flow

Below is the expected flow your application should follow when utilizing the Headless API. For a list of all endpoints, please see the Endpoints page.

Packages & Listings

You can retrieve your store's listings in JSON format and display them however you wish:

Creating Baskets

In order to purchase items, a basket must be created for the customer. Create a basket and allow the customer to login with their username or other OAuth login mechanism (e.g Steam or FiveM).

Adding and Removing Packages

You can add or remove packages programmatically to the created basket via the API as needed when the user interacts with your application.

Coupons, Gift Cards, and Creator Codes

Once all packages and quantities are selected, apply any relevant coupons, gift cards, or creator codes with these endpoints.

Checkout

When the user is ready to checkout, fetch the basket and direct the user to the links.checkout URL.

Starter Template

To get started with your own integration of the Headless API you're able to use our example integration built upon Nuxt.js, Vue & Typescript. Take a look at the tebexio/Headless-Template GitHub repo to begin.

Examples

The following websites are built using the Headless API - hosted via our customers own infrastructure, using frontend frameworks such as Vue or React.

Overview

Tebex Headless API allows integration of your store directly into your own frontend or in-game.

The Headless API works with your existing packages, coupons, sales & creator codes.

If you haven't already done so, we recommend having a read of our quick start guide before beginning integration.

The Headless API can be used with Tebex.js for a fully embedded checkout experience without the user ever leaving your own website.

Headless API Flow

Below is the expected flow your application should follow when utilizing the Headless API. For a list of all endpoints, please see the Endpoints page.

Packages & Listings

You can retrieve your store's listings in JSON format and display them however you wish:

Gets all categories available in the webstore.

Gets all categories from a webstore. This does not include package information. To include package information, add ?includePackages=1 to the URL.

GEThttps://headless.tebex.io/api/accounts/{token}/categories

Path parameters

token*string

The webstore identifier.

Example: "t66x-7cd928b1e9312709e6810edac6dc1fd1eefc57cb"

Response

Successful response returns a list of category information.

Body

dataarray of Category (object)

idinteger

Example: 2678660

namestring

User-friendly name of the category

Example: "Test"

slugnullable string

Short identifier slug for the category

parentnullable object (Category)

Parent category, if applicable

descriptionstring

HTML description of the category

packagesnullable array of Package (object)

idinteger

Example: 6276316

namestring

Example: "test package 101"

descriptionstring

Example: "this is just a test. only a test. nothing more."

imagenullable string

typestring

Example: "single"

categoryobject

idinteger

Example: 2678660

namestring

Example: "Packages"

base_pricenumber (float)

Example: 5

sales_taxnumber (float)

Example: 0

total_pricenumber (float)

Example: 5

currencystring

Example: "USD"

discountnumber (float)

Example: 0

disable_quantityboolean

Example: false

disable_giftingboolean

Example: false

expiration_datenullable string (date-time)

created_atstring (date-time)

Example: "2024-05-21T18:09:17+00:00"

updated_atstring (date-time)

Example: "2024-05-21T18:09:17+00:00"

orderinteger

The numeric order in which to display the category.

Example: 1

display_typeenum

How the category should be displayed

listgrid

Request

Response

Gets a store's categories including all package information with them.

Gets all categories from a webstore including packages.

GEThttps://headless.tebex.io/api/accounts/{token}/categories?includePackages=1

Path parameters

token*string

The webstore identifier.

Example: "t66x-7cd928b1e9312709e6810edac6dc1fd1eefc57cb"

Response

Successful response returns a list of category information.

Body

dataarray of Category (object)

idinteger

Example: 2678660

namestring

User-friendly name of the category

Example: "Test"

slugnullable string

Short identifier slug for the category

parentnullable object (Category)

Parent category, if applicable

descriptionstring

HTML description of the category

packagesnullable array of Package (object)

idinteger

Example: 6276316

namestring

Example: "test package 101"

descriptionstring

Example: "this is just a test. only a test. nothing more."

imagenullable string

typestring

Example: "single"

categoryobject

idinteger

Example: 2678660

namestring

Example: "Packages"

base_pricenumber (float)

Example: 5

sales_taxnumber (float)

Example: 0

total_pricenumber (float)

Example: 5

currencystring

Example: "USD"

discountnumber (float)

Example: 0

disable_quantityboolean

Example: false

disable_giftingboolean

Example: false

expiration_datenullable string (date-time)

created_atstring (date-time)

Example: "2024-05-21T18:09:17+00:00"

updated_atstring (date-time)

Example: "2024-05-21T18:09:17+00:00"

orderinteger

The numeric order in which to display the category.

Example: 1

display_typeenum

How the category should be displayed

listgrid

Request

Response

Gets information about a specific category

Gets information about a category and returns the packages in that category.

GEThttps://headless.tebex.io/api/accounts/{token}/categories/{categoryId}

Path parameters

token*string

The webstore identifier.

Example: "t66x-7cd928b1e9312709e6810edac6dc1fd1eefc57cb"

categoryId*string

The ID of the category to fetch.

Example: 127244343

Response

Successful response returns the category without package information.

Body

dataarray of Category (object)

idinteger

Example: 2678660

namestring

User-friendly name of the category

Example: "Test"

slugnullable string

Short identifier slug for the category

parentnullable object (Category)

Parent category, if applicable

descriptionstring

HTML description of the category

packagesnullable array of Package (object)

idinteger

Example: 6276316

namestring

Example: "test package 101"

descriptionstring

Example: "this is just a test. only a test. nothing more."

imagenullable string

typestring

Example: "single"

categoryobject

idinteger

Example: 2678660

namestring

Example: "Packages"

base_pricenumber (float)

Example: 5

sales_taxnumber (float)

Example: 0

total_pricenumber (float)

Example: 5

currencystring

Example: "USD"

discountnumber (float)

Example: 0

disable_quantityboolean

Example: false

disable_giftingboolean

Example: false

expiration_datenullable string (date-time)

created_atstring (date-time)

Example: "2024-05-21T18:09:17+00:00"

updated_atstring (date-time)

Example: "2024-05-21T18:09:17+00:00"

orderinteger

The numeric order in which to display the category.

Example: 1

display_typeenum

How the category should be displayed

listgrid

Request

Response

Gets information about a specific category, including all the packages in the category

Gets information about a category and returns the packages in that category.

GEThttps://headless.tebex.io/api/accounts/{token}/categories/{categoryId}?includePackages=1

Path parameters

token*string

The webstore identifier.

Example: "t66x-7cd928b1e9312709e6810edac6dc1fd1eefc57cb"

categoryId*string

The ID of the category to fetch.

Example: 127244343

Response

Successful response returns the category with package information.

Body

dataarray of Category (object)

idinteger

Example: 2678660

namestring

User-friendly name of the category

Example: "Test"

slugnullable string

Short identifier slug for the category

parentnullable object (Category)

Parent category, if applicable

descriptionstring

HTML description of the category

packagesnullable array of Package (object)

idinteger

Example: 6276316

namestring

Example: "test package 101"

descriptionstring

Example: "this is just a test. only a test. nothing more."

imagenullable string

typestring

Example: "single"

categoryobject

idinteger

Example: 2678660

namestring

Example: "Packages"

base_pricenumber (float)

Example: 5

sales_taxnumber (float)

Example: 0

total_pricenumber (float)

Example: 5

currencystring

Example: "USD"

discountnumber (float)

Example: 0

disable_quantityboolean

Example: false

disable_giftingboolean

Example: false

expiration_datenullable string (date-time)

created_atstring (date-time)

Example: "2024-05-21T18:09:17+00:00"

updated_atstring (date-time)

Example: "2024-05-21T18:09:17+00:00"

orderinteger

The numeric order in which to display the category.

Example: 1

display_typeenum

How the category should be displayed

listgrid

Request

Response

Fetch a package from a webstore by its identifier

Gets a package from a webstore by ID.

GEThttps://headless.tebex.io/api/accounts/{token}/packages/{packageId}

Path parameters

token*string

The webstore identifier.

Example: "t66x-7cd928b1e9312709e6810edac6dc1fd1eefc57cb"

packageId*number

The package's ID.

Example: 1272441812

Response

Successful response returns the package information.

Body

dataarray of Package (object)

idinteger

Example: 6276316

namestring

Example: "test package 101"

descriptionstring

Example: "this is just a test. only a test. nothing more."

imagenullable string

typestring

Example: "single"

categoryobject

idinteger

Example: 2678660

namestring

Example: "Packages"

base_pricenumber (float)

Example: 5

sales_taxnumber (float)

Example: 0

total_pricenumber (float)

Example: 5

currencystring

Example: "USD"

discountnumber (float)

Example: 0

disable_quantityboolean

Example: false

disable_giftingboolean

Example: false

expiration_datenullable string (date-time)

created_atstring (date-time)

Example: "2024-05-21T18:09:17+00:00"

updated_atstring (date-time)

Example: "2024-05-21T18:09:17+00:00"

Request

Response

Fetch all packages from a webstore

Gets all packages from a webstore.

GEThttps://headless.tebex.io/api/accounts/{token}/packages

Path parameters

token*string

The webstore identifier.

Example: "t66x-7cd928b1e9312709e6810edac6dc1fd1eefc57cb"

Response

Successful response returns a list of package information.

Body

dataarray of Package (object)

idinteger

Example: 6276316

namestring

Example: "test package 101"

descriptionstring

Example: "this is just a test. only a test. nothing more."

imagenullable string

typestring

Example: "single"

categoryobject

idinteger

Example: 2678660

namestring

Example: "Packages"

base_pricenumber (float)

Example: 5

sales_taxnumber (float)

Example: 0

total_pricenumber (float)

Example: 5

currencystring

Example: "USD"

discountnumber (float)

Example: 0

disable_quantityboolean

Example: false

disable_giftingboolean

Example: false

expiration_datenullable string (date-time)

created_atstring (date-time)

Example: "2024-05-21T18:09:17+00:00"

updated_atstring (date-time)

Example: "2024-05-21T18:09:17+00:00"

Request

Response

Creating Baskets

In order to purchase items, a basket must be created for the customer. Create a basket and allow the customer to login with their username or other OAuth login mechanism (e.g Steam or FiveM).

Create a new basket

Creates a new basket for use during checkout.

POSThttps://headless.tebex.io/api/accounts/{token}/baskets

Path parameters

token*string

The webstore identifier.

Example: "t66x-7cd928b1e9312709e6810edac6dc1fd1eefc57cb"

Body

complete_urlstring

A URL the user can return to when checkout is completed.

Example: "https://example.tebex.io/thank-you"

cancel_urlstring

A URL the user can return to when cancelling checkout.

Example: "https://tebex.io/"

customobject

Custom data you wish to associate with the basket. This data will be included with webhook responses and GET requests associated with the Basket.

complete_auto_redirectboolean

True if the user should automatically be redirected to the relevant complete/cancel URL

Example: true

Response

Successful response returns the basket information.

Body

dataBasket (object)

idstring

Example: 244127617

identstring

Example: "1a-55fff4107740a1f40d844ff89607557f45bfafb3"

completeboolean

Example: false

emailnullable string

Example: "support@tebex.io"

usernamenullable string

couponsarray of Coupon (object)

coupon_codestring

Example: "Academy10"

giftcardsarray of GiftCard (object)

card_numberstring

Example: "0127 0244 7210 1111"

creator_codestring

The creator code is used to share a percentage of the payment with another party. See more about creator codes at https://docs.tebex.io/creators/tebex-control-panel/engagement/creator-codes

cancel_urlstring

Example: "https://tebex.io"

complete_urlnullable string

complete_auto_redirectboolean

Example: false

countrystring

A two-character country code

Example: "US"

ipstring

Example: "127.0.0.1"

username_idnumber

Example: 127244

base_pricenumber (float)

Example: 1.27

sales_taxnumber (float)

Example: 0.11

total_pricenumber (float)

Example: 1.38

currencystring

A 3 character currency code

Example: "USD"

packagesarray of BasketPackage (object)

qtyinteger

The quantity of package in this basket. This is not the total quantity of overall items in the basket.

Example: 2

typeenum

The type of payment, either single for one-time payments or subscription.

Example: "single"

singlesubscription

revenue_sharearray of RevenueShare (object)

An array of payment destination objects describing how the purchase should be split between multiple wallets. Only available with pre-agreement from Tebex.

wallet_refstring

Example: "some_wallet_reference"

amountnumber

A float (decimal) value representing the amount of this payment in your account currency that is credited to the wallet_ref

Example: 0.5

gateway_fee_percentnumber

A float (decimal) value representing the percentage of the gateway fee that should be dedicated from this wallet’s revenue share. This optional value can be anywhere between 0 - 100.

Example: 50

customnullable object

linksBasketLinks (object)

paymentstring

The links.payment property is only returned if the basket has been paid for and a payment exists with the complete,refund, or chargeback status.

Example: "https://checkout.tebex.io/api/payments/tbx-12345"

checkoutstring

The links.checkout property is only returned if the basket has not been paid, and is the URL to send the customer to make payment

Example: "https://checkout.tebex.io/checkout/1a-55fff4107740a1f40d844ff89607557f45bfafb3"

Request

Response

Get authentication links for a basket.

Fetches a basket's auth URL.

GEThttps://headless.tebex.io/api/accounts/{token}/baskets/{basketIdent}/auth?returnUrl={returnUrl}

Path parameters

token*string

The webstore identifier.

Example: "t66x-7cd928b1e9312709e6810edac6dc1fd1eefc57cb"

basketIdent*string

The basket identifier.

Example: "c00244-d2ac2e77418a55b25292a6bc7a719ad9c529ba2c"

returnUrl*string

The URL you would like to redirect the user to after successful basket authentication.

Example: "https://example.tebex.io/"

Response

Successful response returns the basket auth information.

Body

namestring

Example: "FiveM"

urlstring

Example: "https://ident.tebex.io/"

Request

Response

Adding and Removing Packages

You can add or remove packages programmatically to the created basket via the API as needed when the user interacts with your application.

Add a package to a basket

Add a package with the given ID to the basket.

POSThttps://headless.tebex.io/api/baskets/{basketIdent}/packages

Path parameters

basketIdent*string

The basket identifier.

Example: "c00244-d2ac2e77418a55b25292a6bc7a719ad9c529ba2c"

Body

package_idstring

Example: 6276316

quantitynumber

Example: 1

Response

Successful response.

Body

idstring

Example: 244127617

identstring

Example: "1a-55fff4107740a1f40d844ff89607557f45bfafb3"

completeboolean

Example: false

emailnullable string

Example: "support@tebex.io"

usernamenullable string

couponsarray of Coupon (object)

coupon_codestring

Example: "Academy10"

giftcardsarray of GiftCard (object)

card_numberstring

Example: "0127 0244 7210 1111"

creator_codestring

The creator code is used to share a percentage of the payment with another party. See more about creator codes at https://docs.tebex.io/creators/tebex-control-panel/engagement/creator-codes

cancel_urlstring

Example: "https://tebex.io"

complete_urlnullable string

complete_auto_redirectboolean

Example: false

countrystring

A two-character country code

Example: "US"

ipstring

Example: "127.0.0.1"

username_idnumber

Example: 127244

base_pricenumber (float)

Example: 1.27

sales_taxnumber (float)

Example: 0.11

total_pricenumber (float)

Example: 1.38

currencystring

A 3 character currency code

Example: "USD"

packagesarray of BasketPackage (object)

qtyinteger

The quantity of package in this basket. This is not the total quantity of overall items in the basket.

Example: 2

typeenum

The type of payment, either single for one-time payments or subscription.

Example: "single"

singlesubscription

revenue_sharearray of RevenueShare (object)

An array of payment destination objects describing how the purchase should be split between multiple wallets. Only available with pre-agreement from Tebex.

wallet_refstring

Example: "some_wallet_reference"

amountnumber

A float (decimal) value representing the amount of this payment in your account currency that is credited to the wallet_ref

Example: 0.5

gateway_fee_percentnumber

A float (decimal) value representing the percentage of the gateway fee that should be dedicated from this wallet’s revenue share. This optional value can be anywhere between 0 - 100.

Example: 50

customnullable object

linksBasketLinks (object)

paymentstring

The links.payment property is only returned if the basket has been paid for and a payment exists with the complete,refund, or chargeback status.

Example: "https://checkout.tebex.io/api/payments/tbx-12345"

checkoutstring

The links.checkout property is only returned if the basket has not been paid, and is the URL to send the customer to make payment

Example: "https://checkout.tebex.io/checkout/1a-55fff4107740a1f40d844ff89607557f45bfafb3"

Request

Response

Remove a package from a basket

Remove the given package ID from the basket.

POSThttps://headless.tebex.io/api/baskets/{basketIdent}/packages/remove

Path parameters

basketIdent*string

The basket identifier.

Example: "c00244-d2ac2e77418a55b25292a6bc7a719ad9c529ba2c"

Body

package_idstring

Example: 6276316

Response

Successful response returns the basket.

Body

idstring

Example: 244127617

identstring

Example: "1a-55fff4107740a1f40d844ff89607557f45bfafb3"

completeboolean

Example: false

emailnullable string

Example: "support@tebex.io"

usernamenullable string

couponsarray of Coupon (object)

coupon_codestring

Example: "Academy10"

giftcardsarray of GiftCard (object)

card_numberstring

Example: "0127 0244 7210 1111"

creator_codestring

The creator code is used to share a percentage of the payment with another party. See more about creator codes at https://docs.tebex.io/creators/tebex-control-panel/engagement/creator-codes

cancel_urlstring

Example: "https://tebex.io"

complete_urlnullable string

complete_auto_redirectboolean

Example: false

countrystring

A two-character country code

Example: "US"

ipstring

Example: "127.0.0.1"

username_idnumber

Example: 127244

base_pricenumber (float)

Example: 1.27

sales_taxnumber (float)

Example: 0.11

total_pricenumber (float)

Example: 1.38

currencystring

A 3 character currency code

Example: "USD"

packagesarray of BasketPackage (object)

qtyinteger

The quantity of package in this basket. This is not the total quantity of overall items in the basket.

Example: 2

typeenum

The type of payment, either single for one-time payments or subscription.

Example: "single"

singlesubscription

revenue_sharearray of RevenueShare (object)

An array of payment destination objects describing how the purchase should be split between multiple wallets. Only available with pre-agreement from Tebex.

wallet_refstring

Example: "some_wallet_reference"

amountnumber

A float (decimal) value representing the amount of this payment in your account currency that is credited to the wallet_ref

Example: 0.5

gateway_fee_percentnumber

A float (decimal) value representing the percentage of the gateway fee that should be dedicated from this wallet’s revenue share. This optional value can be anywhere between 0 - 100.

Example: 50

customnullable object

linksBasketLinks (object)

paymentstring

The links.payment property is only returned if the basket has been paid for and a payment exists with the complete,refund, or chargeback status.

Example: "https://checkout.tebex.io/api/payments/tbx-12345"

checkoutstring

The links.checkout property is only returned if the basket has not been paid, and is the URL to send the customer to make payment

Example: "https://checkout.tebex.io/checkout/1a-55fff4107740a1f40d844ff89607557f45bfafb3"

Request

Response

Coupons, Gift Cards, and Creator Codes

Once all packages and quantities are selected, apply any relevant coupons, gift cards, or creator codes with these endpoints.

Apply a creator code to a basket.

Applies a creator code to a basket.

POSThttps://headless.tebex.io/api/accounts/{token}/baskets/{basketIdent}/creator-codes

Path parameters

token*string

The webstore identifier.

Example: "t66x-7cd928b1e9312709e6810edac6dc1fd1eefc57cb"

basketIdent*string

The basket identifier.

Example: "c00244-d2ac2e77418a55b25292a6bc7a719ad9c529ba2c"

Body

Provide a creator_code to apply to the basket.

creator_codestring

Example: "Academy10"

Response

Successful response returns the basket.

Body

dataBasket (object)

idstring

Example: 244127617

identstring

Example: "1a-55fff4107740a1f40d844ff89607557f45bfafb3"

completeboolean

Example: false

emailnullable string

Example: "support@tebex.io"

usernamenullable string

couponsarray of Coupon (object)

coupon_codestring

Example: "Academy10"

giftcardsarray of GiftCard (object)

card_numberstring

Example: "0127 0244 7210 1111"

creator_codestring

The creator code is used to share a percentage of the payment with another party. See more about creator codes at https://docs.tebex.io/creators/tebex-control-panel/engagement/creator-codes

cancel_urlstring

Example: "https://tebex.io"

complete_urlnullable string

complete_auto_redirectboolean

Example: false

countrystring

A two-character country code

Example: "US"

ipstring

Example: "127.0.0.1"

username_idnumber

Example: 127244

base_pricenumber (float)

Example: 1.27

sales_taxnumber (float)

Example: 0.11

total_pricenumber (float)

Example: 1.38

currencystring

A 3 character currency code

Example: "USD"

packagesarray of BasketPackage (object)

qtyinteger

The quantity of package in this basket. This is not the total quantity of overall items in the basket.

Example: 2

typeenum

The type of payment, either single for one-time payments or subscription.

Example: "single"

singlesubscription

revenue_sharearray of RevenueShare (object)

An array of payment destination objects describing how the purchase should be split between multiple wallets. Only available with pre-agreement from Tebex.

wallet_refstring

Example: "some_wallet_reference"

amountnumber

A float (decimal) value representing the amount of this payment in your account currency that is credited to the wallet_ref

Example: 0.5

gateway_fee_percentnumber

A float (decimal) value representing the percentage of the gateway fee that should be dedicated from this wallet’s revenue share. This optional value can be anywhere between 0 - 100.

Example: 50

customnullable object

linksBasketLinks (object)

paymentstring

The links.payment property is only returned if the basket has been paid for and a payment exists with the complete,refund, or chargeback status.

Example: "https://checkout.tebex.io/api/payments/tbx-12345"

checkoutstring

The links.checkout property is only returned if the basket has not been paid, and is the URL to send the customer to make payment

Example: "https://checkout.tebex.io/checkout/1a-55fff4107740a1f40d844ff89607557f45bfafb3"

Request

Response

Remove a creator code from the basket.

Applies a creator code to a basket.

POSThttps://headless.tebex.io/api/accounts/{token}/baskets/{basketIdent}/creator-codes/remove

Path parameters

token*string

The webstore identifier.

Example: "t66x-7cd928b1e9312709e6810edac6dc1fd1eefc57cb"

basketIdent*string

The basket identifier.

Example: "c00244-d2ac2e77418a55b25292a6bc7a719ad9c529ba2c"

Response

Creator code removed successfully.

Request

Apply a gift card to a basket.

Applies a creator code to a basket.

POSThttps://headless.tebex.io/api/accounts/{token}/baskets/{basketIdent}/giftcards

Path parameters

token*string

The webstore identifier.

Example: "t66x-7cd928b1e9312709e6810edac6dc1fd1eefc57cb"

basketIdent*string

The basket identifier.

Example: "c00244-d2ac2e77418a55b25292a6bc7a719ad9c529ba2c"

Body

Provide a card_number to apply to the basket.

card_numberstring

Example: "0127 0244 7210 1111"

Response

Successful response returns the basket.

Body

dataBasket (object)

idstring

Example: 244127617

identstring

Example: "1a-55fff4107740a1f40d844ff89607557f45bfafb3"

completeboolean

Example: false

emailnullable string

Example: "support@tebex.io"

usernamenullable string

couponsarray of Coupon (object)

coupon_codestring

Example: "Academy10"

giftcardsarray of GiftCard (object)

card_numberstring

Example: "0127 0244 7210 1111"

creator_codestring

The creator code is used to share a percentage of the payment with another party. See more about creator codes at https://docs.tebex.io/creators/tebex-control-panel/engagement/creator-codes

cancel_urlstring

Example: "https://tebex.io"

complete_urlnullable string

complete_auto_redirectboolean

Example: false

countrystring

A two-character country code

Example: "US"

ipstring

Example: "127.0.0.1"

username_idnumber

Example: 127244

base_pricenumber (float)

Example: 1.27

sales_taxnumber (float)

Example: 0.11

total_pricenumber (float)

Example: 1.38

currencystring

A 3 character currency code

Example: "USD"

packagesarray of BasketPackage (object)

qtyinteger

The quantity of package in this basket. This is not the total quantity of overall items in the basket.

Example: 2

typeenum

The type of payment, either single for one-time payments or subscription.

Example: "single"

singlesubscription

revenue_sharearray of RevenueShare (object)

An array of payment destination objects describing how the purchase should be split between multiple wallets. Only available with pre-agreement from Tebex.

wallet_refstring

Example: "some_wallet_reference"

amountnumber

A float (decimal) value representing the amount of this payment in your account currency that is credited to the wallet_ref

Example: 0.5

gateway_fee_percentnumber

A float (decimal) value representing the percentage of the gateway fee that should be dedicated from this wallet’s revenue share. This optional value can be anywhere between 0 - 100.

Example: 50

customnullable object

linksBasketLinks (object)

paymentstring

The links.payment property is only returned if the basket has been paid for and a payment exists with the complete,refund, or chargeback status.

Example: "https://checkout.tebex.io/api/payments/tbx-12345"

checkoutstring

The links.checkout property is only returned if the basket has not been paid, and is the URL to send the customer to make payment

Example: "https://checkout.tebex.io/checkout/1a-55fff4107740a1f40d844ff89607557f45bfafb3"

Request

Response

Remove a gift card from the basket.

Removes a gift card from the basket.

POSThttps://headless.tebex.io/api/accounts/{token}/baskets/{basketIdent}/giftcards/remove

Path parameters

token*string

The webstore identifier.

Example: "t66x-7cd928b1e9312709e6810edac6dc1fd1eefc57cb"

basketIdent*string

The basket identifier.

Example: "c00244-d2ac2e77418a55b25292a6bc7a719ad9c529ba2c"

Body

Provide the card_number to remove from the basket.

card_numberstring

Example: "0127 0244 7210 1111"

Response

Gift card removed successfully.

Request

Apply a coupon to a basket.

Applies a creator code to a basket.

POSThttps://headless.tebex.io/api/accounts/{token}/baskets/{basketIdent}/coupons

Path parameters

token*string

The webstore identifier.

Example: "t66x-7cd928b1e9312709e6810edac6dc1fd1eefc57cb"

basketIdent*string

The basket identifier.

Example: "c00244-d2ac2e77418a55b25292a6bc7a719ad9c529ba2c"

Body

Provide a coupon_code to apply to the basket.

coupon_codestring

Example: "Academy10"

Response

Successful response returns the basket.

Body

dataBasket (object)

idstring

Example: 244127617

identstring

Example: "1a-55fff4107740a1f40d844ff89607557f45bfafb3"

completeboolean

Example: false

emailnullable string

Example: "support@tebex.io"

usernamenullable string

couponsarray of Coupon (object)

coupon_codestring

Example: "Academy10"

giftcardsarray of GiftCard (object)

card_numberstring

Example: "0127 0244 7210 1111"

creator_codestring

The creator code is used to share a percentage of the payment with another party. See more about creator codes at https://docs.tebex.io/creators/tebex-control-panel/engagement/creator-codes

cancel_urlstring

Example: "https://tebex.io"

complete_urlnullable string

complete_auto_redirectboolean

Example: false

countrystring

A two-character country code

Example: "US"

ipstring

Example: "127.0.0.1"

username_idnumber

Example: 127244

base_pricenumber (float)

Example: 1.27

sales_taxnumber (float)

Example: 0.11

total_pricenumber (float)

Example: 1.38

currencystring

A 3 character currency code

Example: "USD"

packagesarray of BasketPackage (object)

qtyinteger

The quantity of package in this basket. This is not the total quantity of overall items in the basket.

Example: 2

typeenum

The type of payment, either single for one-time payments or subscription.

Example: "single"

singlesubscription

revenue_sharearray of RevenueShare (object)

An array of payment destination objects describing how the purchase should be split between multiple wallets. Only available with pre-agreement from Tebex.

wallet_refstring

Example: "some_wallet_reference"

amountnumber

A float (decimal) value representing the amount of this payment in your account currency that is credited to the wallet_ref

Example: 0.5

gateway_fee_percentnumber

A float (decimal) value representing the percentage of the gateway fee that should be dedicated from this wallet’s revenue share. This optional value can be anywhere between 0 - 100.

Example: 50

customnullable object

linksBasketLinks (object)

paymentstring

The links.payment property is only returned if the basket has been paid for and a payment exists with the complete,refund, or chargeback status.

Example: "https://checkout.tebex.io/api/payments/tbx-12345"

checkoutstring

The links.checkout property is only returned if the basket has not been paid, and is the URL to send the customer to make payment

Example: "https://checkout.tebex.io/checkout/1a-55fff4107740a1f40d844ff89607557f45bfafb3"

Request

Response

Remove a coupon from the basket.

Removes a coupon code from a basket

POSThttps://headless.tebex.io/api/accounts/{token}/baskets/{basketIdent}/coupons/remove

Path parameters

token*string

The webstore identifier.

Example: "t66x-7cd928b1e9312709e6810edac6dc1fd1eefc57cb"

basketIdent*string

The basket identifier.

Example: "c00244-d2ac2e77418a55b25292a6bc7a719ad9c529ba2c"

Response

Successful response.

Request

Checkout

When the user is ready to checkout, fetch the basket and direct the user to the links.checkout URL.

Fetch a basket from a webstore by its identifier

Gets a basket associated with the provided identifier.

GEThttps://headless.tebex.io/api/accounts/{token}/baskets/{basketIdent}

Path parameters

token*string

The webstore identifier.

Example: "t66x-7cd928b1e9312709e6810edac6dc1fd1eefc57cb"

basketIdent*string

The basket identifier.

Example: "c00244-d2ac2e77418a55b25292a6bc7a719ad9c529ba2c"

Response

Successful response returns the basket information.

Body

dataBasket (object)

idstring

Example: 244127617

identstring

Example: "1a-55fff4107740a1f40d844ff89607557f45bfafb3"

completeboolean

Example: false

emailnullable string

Example: "support@tebex.io"

usernamenullable string

couponsarray of Coupon (object)

coupon_codestring

Example: "Academy10"

giftcardsarray of GiftCard (object)

card_numberstring

Example: "0127 0244 7210 1111"

creator_codestring

The creator code is used to share a percentage of the payment with another party. See more about creator codes at https://docs.tebex.io/creators/tebex-control-panel/engagement/creator-codes

cancel_urlstring

Example: "https://tebex.io"

complete_urlnullable string

complete_auto_redirectboolean

Example: false

countrystring

A two-character country code

Example: "US"

ipstring

Example: "127.0.0.1"

username_idnumber

Example: 127244

base_pricenumber (float)

Example: 1.27

sales_taxnumber (float)

Example: 0.11

total_pricenumber (float)

Example: 1.38

currencystring

A 3 character currency code

Example: "USD"

packagesarray of BasketPackage (object)

qtyinteger

The quantity of package in this basket. This is not the total quantity of overall items in the basket.

Example: 2

typeenum

The type of payment, either single for one-time payments or subscription.

Example: "single"

singlesubscription

revenue_sharearray of RevenueShare (object)

An array of payment destination objects describing how the purchase should be split between multiple wallets. Only available with pre-agreement from Tebex.

wallet_refstring

Example: "some_wallet_reference"

amountnumber

A float (decimal) value representing the amount of this payment in your account currency that is credited to the wallet_ref

Example: 0.5

gateway_fee_percentnumber

A float (decimal) value representing the percentage of the gateway fee that should be dedicated from this wallet’s revenue share. This optional value can be anywhere between 0 - 100.

Example: 50

customnullable object

linksBasketLinks (object)

paymentstring

The links.payment property is only returned if the basket has been paid for and a payment exists with the complete,refund, or chargeback status.

Example: "https://checkout.tebex.io/api/payments/tbx-12345"

checkoutstring

The links.checkout property is only returned if the basket has not been paid, and is the URL to send the customer to make payment

Example: "https://checkout.tebex.io/checkout/1a-55fff4107740a1f40d844ff89607557f45bfafb3"

Request

Response

Starter Template

Examples

The following websites are built using the Headless API - hosted via our customers own infrastructure, using frontend frameworks such as Vue or React.

Remove a creator code from the basket.

Applies a creator code to a basket.

POSThttps://headless.tebex.io/api/accounts/{token}/baskets/{basketIdent}/creator-codes/remove

Path parameters

token*string

The webstore identifier.

Example: "t66x-7cd928b1e9312709e6810edac6dc1fd1eefc57cb"

basketIdent*string

The basket identifier.

Example: "c00244-d2ac2e77418a55b25292a6bc7a719ad9c529ba2c"

Response

Creator code removed successfully.

Request

Remove a coupon from the basket.

Removes a coupon code from a basket

POSThttps://headless.tebex.io/api/accounts/{token}/baskets/{basketIdent}/coupons/remove

Path parameters

token*string

The webstore identifier.

Example: "t66x-7cd928b1e9312709e6810edac6dc1fd1eefc57cb"

basketIdent*string

The basket identifier.

Example: "c00244-d2ac2e77418a55b25292a6bc7a719ad9c529ba2c"

Response

Successful response.

Request

Gets a store's categories including all package information with them.

Gets all categories from a webstore including packages.

GEThttps://headless.tebex.io/api/accounts/{token}/categories?includePackages=1

Path parameters

token*string

The webstore identifier.

Example: "t66x-7cd928b1e9312709e6810edac6dc1fd1eefc57cb"

Response

Successful response returns a list of category information.

Body

dataarray of Category (object)

idinteger

Example: 2678660

namestring

User-friendly name of the category

Example: "Test"

slugnullable string

Short identifier slug for the category

parentnullable object (Category)

Parent category, if applicable

descriptionstring

HTML description of the category

packagesnullable array of Package (object)

idinteger

Example: 6276316

namestring

Example: "test package 101"

descriptionstring

Example: "this is just a test. only a test. nothing more."

imagenullable string

typestring

Example: "single"

categoryobject

idinteger

Example: 2678660

namestring

Example: "Packages"

base_pricenumber (float)

Example: 5

sales_taxnumber (float)

Example: 0

total_pricenumber (float)

Example: 5

currencystring

Example: "USD"

discountnumber (float)

Example: 0

disable_quantityboolean

Example: false

disable_giftingboolean

Example: false

expiration_datenullable string (date-time)

created_atstring (date-time)

Example: "2024-05-21T18:09:17+00:00"

updated_atstring (date-time)

Example: "2024-05-21T18:09:17+00:00"

orderinteger

The numeric order in which to display the category.

Example: 1

display_typeenum

How the category should be displayed

listgrid

Request

Response

Gets information about a specific category

Gets information about a category and returns the packages in that category.

GEThttps://headless.tebex.io/api/accounts/{token}/categories/{categoryId}

Path parameters

token*string

The webstore identifier.

Example: "t66x-7cd928b1e9312709e6810edac6dc1fd1eefc57cb"

categoryId*string

The ID of the category to fetch.

Example: 127244343

Response

Successful response returns the category without package information.

Body

dataarray of Category (object)

idinteger

Example: 2678660

namestring

User-friendly name of the category

Example: "Test"

slugnullable string

Short identifier slug for the category

parentnullable object (Category)

Parent category, if applicable

descriptionstring

HTML description of the category

packagesnullable array of Package (object)

idinteger

Example: 6276316

namestring

Example: "test package 101"

descriptionstring

Example: "this is just a test. only a test. nothing more."

imagenullable string

typestring

Example: "single"

categoryobject

idinteger

Example: 2678660

namestring

Example: "Packages"

base_pricenumber (float)

Example: 5

sales_taxnumber (float)

Example: 0

total_pricenumber (float)

Example: 5

currencystring

Example: "USD"

discountnumber (float)

Example: 0

disable_quantityboolean

Example: false

disable_giftingboolean

Example: false

expiration_datenullable string (date-time)

created_atstring (date-time)

Example: "2024-05-21T18:09:17+00:00"

updated_atstring (date-time)

Example: "2024-05-21T18:09:17+00:00"

orderinteger

The numeric order in which to display the category.

Example: 1

display_typeenum

How the category should be displayed

listgrid

Request

Response

Gets information about a specific category, including all the packages in the category

Gets information about a category and returns the packages in that category.

GEThttps://headless.tebex.io/api/accounts/{token}/categories/{categoryId}?includePackages=1

Path parameters

token*string

The webstore identifier.

Example: "t66x-7cd928b1e9312709e6810edac6dc1fd1eefc57cb"

categoryId*string

The ID of the category to fetch.

Example: 127244343

Response

Successful response returns the category with package information.

Body

dataarray of Category (object)

idinteger

Example: 2678660

namestring

User-friendly name of the category

Example: "Test"

slugnullable string

Short identifier slug for the category

parentnullable object (Category)

Parent category, if applicable

descriptionstring

HTML description of the category

packagesnullable array of Package (object)

idinteger

Example: 6276316

namestring

Example: "test package 101"

descriptionstring

Example: "this is just a test. only a test. nothing more."

imagenullable string

typestring

Example: "single"

categoryobject

idinteger

Example: 2678660

namestring

Example: "Packages"

base_pricenumber (float)

Example: 5

sales_taxnumber (float)

Example: 0

total_pricenumber (float)

Example: 5

currencystring

Example: "USD"

discountnumber (float)

Example: 0

disable_quantityboolean

Example: false

disable_giftingboolean

Example: false

expiration_datenullable string (date-time)

created_atstring (date-time)

Example: "2024-05-21T18:09:17+00:00"

updated_atstring (date-time)

Example: "2024-05-21T18:09:17+00:00"

orderinteger

The numeric order in which to display the category.

Example: 1

display_typeenum

How the category should be displayed

listgrid

Request

Response

Fetch all packages from a webstore

Gets all packages from a webstore.

GEThttps://headless.tebex.io/api/accounts/{token}/packages

Path parameters

token*string

The webstore identifier.

Example: "t66x-7cd928b1e9312709e6810edac6dc1fd1eefc57cb"

Response

Successful response returns a list of package information.

Body

dataarray of Package (object)

idinteger

Example: 6276316

namestring

Example: "test package 101"

descriptionstring

Example: "this is just a test. only a test. nothing more."

imagenullable string

typestring

Example: "single"

categoryobject

idinteger

Example: 2678660

namestring

Example: "Packages"

base_pricenumber (float)

Example: 5

sales_taxnumber (float)

Example: 0

total_pricenumber (float)

Example: 5

currencystring

Example: "USD"

discountnumber (float)

Example: 0

disable_quantityboolean

Example: false

disable_giftingboolean

Example: false

expiration_datenullable string (date-time)

created_atstring (date-time)

Example: "2024-05-21T18:09:17+00:00"

updated_atstring (date-time)

Example: "2024-05-21T18:09:17+00:00"

Request

Response

Remove a gift card from the basket.

Removes a gift card from the basket.

POSThttps://headless.tebex.io/api/accounts/{token}/baskets/{basketIdent}/giftcards/remove

Path parameters

token*string

The webstore identifier.

Example: "t66x-7cd928b1e9312709e6810edac6dc1fd1eefc57cb"

basketIdent*string

The basket identifier.

Example: "c00244-d2ac2e77418a55b25292a6bc7a719ad9c529ba2c"

Body

Provide the card_number to remove from the basket.

card_numberstring

Example: "0127 0244 7210 1111"

Response

Gift card removed successfully.

Request

Get authentication links for a basket.

Fetches a basket's auth URL.

GEThttps://headless.tebex.io/api/accounts/{token}/baskets/{basketIdent}/auth?returnUrl={returnUrl}

Path parameters

token*string

The webstore identifier.

Example: "t66x-7cd928b1e9312709e6810edac6dc1fd1eefc57cb"

basketIdent*string

The basket identifier.

Example: "c00244-d2ac2e77418a55b25292a6bc7a719ad9c529ba2c"

returnUrl*string

The URL you would like to redirect the user to after successful basket authentication.

Example: "https://example.tebex.io/"

Response

Successful response returns the basket auth information.

Body

namestring

Example: "FiveM"

urlstring

Example: "https://ident.tebex.io/"

Request

Response

Apply a creator code to a basket.

Applies a creator code to a basket.

POSThttps://headless.tebex.io/api/accounts/{token}/baskets/{basketIdent}/creator-codes

Path parameters

token*string

The webstore identifier.

Example: "t66x-7cd928b1e9312709e6810edac6dc1fd1eefc57cb"

basketIdent*string

The basket identifier.

Example: "c00244-d2ac2e77418a55b25292a6bc7a719ad9c529ba2c"

Body

Provide a creator_code to apply to the basket.

creator_codestring

Example: "Academy10"

Response

Successful response returns the basket.

Body

dataBasket (object)

idstring

Example: 244127617

identstring

Example: "1a-55fff4107740a1f40d844ff89607557f45bfafb3"

completeboolean

Example: false

emailnullable string

Example: "support@tebex.io"

usernamenullable string

couponsarray of Coupon (object)

coupon_codestring

Example: "Academy10"

giftcardsarray of GiftCard (object)

card_numberstring

Example: "0127 0244 7210 1111"

creator_codestring

The creator code is used to share a percentage of the payment with another party. See more about creator codes at https://docs.tebex.io/creators/tebex-control-panel/engagement/creator-codes

cancel_urlstring

Example: "https://tebex.io"

complete_urlnullable string

complete_auto_redirectboolean

Example: false

countrystring

A two-character country code

Example: "US"

ipstring

Example: "127.0.0.1"

username_idnumber

Example: 127244

base_pricenumber (float)

Example: 1.27

sales_taxnumber (float)

Example: 0.11

total_pricenumber (float)

Example: 1.38

currencystring

A 3 character currency code

Example: "USD"

packagesarray of BasketPackage (object)

qtyinteger

The quantity of package in this basket. This is not the total quantity of overall items in the basket.

Example: 2

typeenum

The type of payment, either single for one-time payments or subscription.

Example: "single"

singlesubscription

revenue_sharearray of RevenueShare (object)

An array of payment destination objects describing how the purchase should be split between multiple wallets. Only available with pre-agreement from Tebex.

wallet_refstring

Example: "some_wallet_reference"

amountnumber

A float (decimal) value representing the amount of this payment in your account currency that is credited to the wallet_ref

Example: 0.5

gateway_fee_percentnumber

A float (decimal) value representing the percentage of the gateway fee that should be dedicated from this wallet’s revenue share. This optional value can be anywhere between 0 - 100.

Example: 50

customnullable object

linksBasketLinks (object)

paymentstring

The links.payment property is only returned if the basket has been paid for and a payment exists with the complete,refund, or chargeback status.

Example: "https://checkout.tebex.io/api/payments/tbx-12345"

checkoutstring

The links.checkout property is only returned if the basket has not been paid, and is the URL to send the customer to make payment

Example: "https://checkout.tebex.io/checkout/1a-55fff4107740a1f40d844ff89607557f45bfafb3"

Request

Response

Apply a gift card to a basket.

Applies a creator code to a basket.

POSThttps://headless.tebex.io/api/accounts/{token}/baskets/{basketIdent}/giftcards

Path parameters

token*string

The webstore identifier.

Example: "t66x-7cd928b1e9312709e6810edac6dc1fd1eefc57cb"

basketIdent*string

The basket identifier.

Example: "c00244-d2ac2e77418a55b25292a6bc7a719ad9c529ba2c"

Body

Provide a card_number to apply to the basket.

card_numberstring

Example: "0127 0244 7210 1111"

Response

Successful response returns the basket.

Body

dataBasket (object)

idstring

Example: 244127617

identstring

Example: "1a-55fff4107740a1f40d844ff89607557f45bfafb3"

completeboolean

Example: false

emailnullable string

Example: "support@tebex.io"

usernamenullable string

couponsarray of Coupon (object)

coupon_codestring

Example: "Academy10"

giftcardsarray of GiftCard (object)

card_numberstring

Example: "0127 0244 7210 1111"

creator_codestring

The creator code is used to share a percentage of the payment with another party. See more about creator codes at https://docs.tebex.io/creators/tebex-control-panel/engagement/creator-codes

cancel_urlstring

Example: "https://tebex.io"

complete_urlnullable string

complete_auto_redirectboolean

Example: false

countrystring

A two-character country code

Example: "US"

ipstring

Example: "127.0.0.1"

username_idnumber

Example: 127244

base_pricenumber (float)

Example: 1.27

sales_taxnumber (float)

Example: 0.11

total_pricenumber (float)

Example: 1.38

currencystring

A 3 character currency code

Example: "USD"

packagesarray of BasketPackage (object)

qtyinteger

The quantity of package in this basket. This is not the total quantity of overall items in the basket.

Example: 2

typeenum

The type of payment, either single for one-time payments or subscription.

Example: "single"

singlesubscription

revenue_sharearray of RevenueShare (object)

An array of payment destination objects describing how the purchase should be split between multiple wallets. Only available with pre-agreement from Tebex.

wallet_refstring

Example: "some_wallet_reference"

amountnumber

A float (decimal) value representing the amount of this payment in your account currency that is credited to the wallet_ref

Example: 0.5

gateway_fee_percentnumber

A float (decimal) value representing the percentage of the gateway fee that should be dedicated from this wallet’s revenue share. This optional value can be anywhere between 0 - 100.

Example: 50

customnullable object

linksBasketLinks (object)

paymentstring

The links.payment property is only returned if the basket has been paid for and a payment exists with the complete,refund, or chargeback status.

Example: "https://checkout.tebex.io/api/payments/tbx-12345"

checkoutstring

The links.checkout property is only returned if the basket has not been paid, and is the URL to send the customer to make payment

Example: "https://checkout.tebex.io/checkout/1a-55fff4107740a1f40d844ff89607557f45bfafb3"

Request

Response

Apply a coupon to a basket.

Applies a creator code to a basket.

POSThttps://headless.tebex.io/api/accounts/{token}/baskets/{basketIdent}/coupons

Path parameters

token*string

The webstore identifier.

Example: "t66x-7cd928b1e9312709e6810edac6dc1fd1eefc57cb"

basketIdent*string

The basket identifier.

Example: "c00244-d2ac2e77418a55b25292a6bc7a719ad9c529ba2c"

Body

Provide a coupon_code to apply to the basket.

coupon_codestring

Example: "Academy10"

Response

Successful response returns the basket.

Body

dataBasket (object)

idstring

Example: 244127617

identstring

Example: "1a-55fff4107740a1f40d844ff89607557f45bfafb3"

completeboolean

Example: false

emailnullable string

Example: "support@tebex.io"

usernamenullable string

couponsarray of Coupon (object)

coupon_codestring

Example: "Academy10"

giftcardsarray of GiftCard (object)

card_numberstring

Example: "0127 0244 7210 1111"

creator_codestring

The creator code is used to share a percentage of the payment with another party. See more about creator codes at https://docs.tebex.io/creators/tebex-control-panel/engagement/creator-codes

cancel_urlstring

Example: "https://tebex.io"

complete_urlnullable string

complete_auto_redirectboolean

Example: false

countrystring

A two-character country code

Example: "US"

ipstring

Example: "127.0.0.1"

username_idnumber

Example: 127244

base_pricenumber (float)

Example: 1.27

sales_taxnumber (float)

Example: 0.11

total_pricenumber (float)

Example: 1.38

currencystring

A 3 character currency code

Example: "USD"

packagesarray of BasketPackage (object)

qtyinteger

The quantity of package in this basket. This is not the total quantity of overall items in the basket.

Example: 2

typeenum

The type of payment, either single for one-time payments or subscription.

Example: "single"

singlesubscription

revenue_sharearray of RevenueShare (object)

An array of payment destination objects describing how the purchase should be split between multiple wallets. Only available with pre-agreement from Tebex.

wallet_refstring

Example: "some_wallet_reference"

amountnumber

A float (decimal) value representing the amount of this payment in your account currency that is credited to the wallet_ref

Example: 0.5

gateway_fee_percentnumber

A float (decimal) value representing the percentage of the gateway fee that should be dedicated from this wallet’s revenue share. This optional value can be anywhere between 0 - 100.

Example: 50

customnullable object

linksBasketLinks (object)

paymentstring

The links.payment property is only returned if the basket has been paid for and a payment exists with the complete,refund, or chargeback status.

Example: "https://checkout.tebex.io/api/payments/tbx-12345"

checkoutstring

The links.checkout property is only returned if the basket has not been paid, and is the URL to send the customer to make payment

Example: "https://checkout.tebex.io/checkout/1a-55fff4107740a1f40d844ff89607557f45bfafb3"

Request

Response

Create a new basket

Creates a new basket for use during checkout.

POSThttps://headless.tebex.io/api/accounts/{token}/baskets

Path parameters

token*string

The webstore identifier.

Example: "t66x-7cd928b1e9312709e6810edac6dc1fd1eefc57cb"

Body

complete_urlstring

A URL the user can return to when checkout is completed.

Example: "https://example.tebex.io/thank-you"

cancel_urlstring

A URL the user can return to when cancelling checkout.

Example: "https://tebex.io/"

customobject

Custom data you wish to associate with the basket. This data will be included with webhook responses and GET requests associated with the Basket.

complete_auto_redirectboolean

True if the user should automatically be redirected to the relevant complete/cancel URL

Example: true

Response

Successful response returns the basket information.

Body

dataBasket (object)

idstring

Example: 244127617

identstring

Example: "1a-55fff4107740a1f40d844ff89607557f45bfafb3"

completeboolean

Example: false

emailnullable string

Example: "support@tebex.io"

usernamenullable string

couponsarray of Coupon (object)

coupon_codestring

Example: "Academy10"

giftcardsarray of GiftCard (object)

card_numberstring

Example: "0127 0244 7210 1111"

creator_codestring

The creator code is used to share a percentage of the payment with another party. See more about creator codes at https://docs.tebex.io/creators/tebex-control-panel/engagement/creator-codes

cancel_urlstring

Example: "https://tebex.io"

complete_urlnullable string

complete_auto_redirectboolean

Example: false

countrystring

A two-character country code

Example: "US"

ipstring

Example: "127.0.0.1"

username_idnumber

Example: 127244

base_pricenumber (float)

Example: 1.27

sales_taxnumber (float)

Example: 0.11

total_pricenumber (float)

Example: 1.38

currencystring

A 3 character currency code

Example: "USD"

packagesarray of BasketPackage (object)

qtyinteger

The quantity of package in this basket. This is not the total quantity of overall items in the basket.

Example: 2

typeenum

The type of payment, either single for one-time payments or subscription.

Example: "single"

singlesubscription

revenue_sharearray of RevenueShare (object)

An array of payment destination objects describing how the purchase should be split between multiple wallets. Only available with pre-agreement from Tebex.

wallet_refstring

Example: "some_wallet_reference"

amountnumber

A float (decimal) value representing the amount of this payment in your account currency that is credited to the wallet_ref

Example: 0.5

gateway_fee_percentnumber

A float (decimal) value representing the percentage of the gateway fee that should be dedicated from this wallet’s revenue share. This optional value can be anywhere between 0 - 100.

Example: 50

customnullable object

linksBasketLinks (object)

paymentstring

The links.payment property is only returned if the basket has been paid for and a payment exists with the complete,refund, or chargeback status.

Example: "https://checkout.tebex.io/api/payments/tbx-12345"

checkoutstring

The links.checkout property is only returned if the basket has not been paid, and is the URL to send the customer to make payment

Example: "https://checkout.tebex.io/checkout/1a-55fff4107740a1f40d844ff89607557f45bfafb3"

Request

Response

Fetch a package from a webstore by its identifier

Gets a package from a webstore by ID.

GEThttps://headless.tebex.io/api/accounts/{token}/packages/{packageId}

Path parameters

token*string

The webstore identifier.

Example: "t66x-7cd928b1e9312709e6810edac6dc1fd1eefc57cb"

packageId*number

The package's ID.

Example: 1272441812

Response

Successful response returns the package information.

Body

dataarray of Package (object)

idinteger

Example: 6276316

namestring

Example: "test package 101"

descriptionstring

Example: "this is just a test. only a test. nothing more."

imagenullable string

typestring

Example: "single"

categoryobject

idinteger

Example: 2678660

namestring

Example: "Packages"

base_pricenumber (float)

Example: 5

sales_taxnumber (float)

Example: 0

total_pricenumber (float)

Example: 5

currencystring

Example: "USD"

discountnumber (float)

Example: 0

disable_quantityboolean

Example: false

disable_giftingboolean

Example: false

expiration_datenullable string (date-time)

created_atstring (date-time)

Example: "2024-05-21T18:09:17+00:00"

updated_atstring (date-time)

Example: "2024-05-21T18:09:17+00:00"

Request

Response

Remove a package from a basket

Remove the given package ID from the basket.

POSThttps://headless.tebex.io/api/baskets/{basketIdent}/packages/remove

Path parameters

basketIdent*string

The basket identifier.

Example: "c00244-d2ac2e77418a55b25292a6bc7a719ad9c529ba2c"

Body

package_idstring

Example: 6276316

Response

Successful response returns the basket.

Body

idstring

Example: 244127617

identstring

Example: "1a-55fff4107740a1f40d844ff89607557f45bfafb3"

completeboolean

Example: false

emailnullable string

Example: "support@tebex.io"

usernamenullable string

couponsarray of Coupon (object)

coupon_codestring

Example: "Academy10"

giftcardsarray of GiftCard (object)

card_numberstring

Example: "0127 0244 7210 1111"

creator_codestring

The creator code is used to share a percentage of the payment with another party. See more about creator codes at https://docs.tebex.io/creators/tebex-control-panel/engagement/creator-codes

cancel_urlstring

Example: "https://tebex.io"

complete_urlnullable string

complete_auto_redirectboolean

Example: false

countrystring

A two-character country code

Example: "US"

ipstring

Example: "127.0.0.1"

username_idnumber

Example: 127244

base_pricenumber (float)

Example: 1.27

sales_taxnumber (float)

Example: 0.11

total_pricenumber (float)

Example: 1.38

currencystring

A 3 character currency code

Example: "USD"

packagesarray of BasketPackage (object)

qtyinteger

The quantity of package in this basket. This is not the total quantity of overall items in the basket.

Example: 2

typeenum

The type of payment, either single for one-time payments or subscription.

Example: "single"

singlesubscription

revenue_sharearray of RevenueShare (object)

An array of payment destination objects describing how the purchase should be split between multiple wallets. Only available with pre-agreement from Tebex.

wallet_refstring

Example: "some_wallet_reference"

amountnumber

A float (decimal) value representing the amount of this payment in your account currency that is credited to the wallet_ref

Example: 0.5

gateway_fee_percentnumber

A float (decimal) value representing the percentage of the gateway fee that should be dedicated from this wallet’s revenue share. This optional value can be anywhere between 0 - 100.

Example: 50

customnullable object

linksBasketLinks (object)

paymentstring

The links.payment property is only returned if the basket has been paid for and a payment exists with the complete,refund, or chargeback status.

Example: "https://checkout.tebex.io/api/payments/tbx-12345"

checkoutstring

The links.checkout property is only returned if the basket has not been paid, and is the URL to send the customer to make payment

Example: "https://checkout.tebex.io/checkout/1a-55fff4107740a1f40d844ff89607557f45bfafb3"

Request

Response

Fetch a basket from a webstore by its identifier

Gets a basket associated with the provided identifier.

GEThttps://headless.tebex.io/api/accounts/{token}/baskets/{basketIdent}

Path parameters

token*string

The webstore identifier.

Example: "t66x-7cd928b1e9312709e6810edac6dc1fd1eefc57cb"

basketIdent*string

The basket identifier.

Example: "c00244-d2ac2e77418a55b25292a6bc7a719ad9c529ba2c"

Response

Successful response returns the basket information.

Body

dataBasket (object)

idstring

Example: 244127617

identstring

Example: "1a-55fff4107740a1f40d844ff89607557f45bfafb3"

completeboolean

Example: false

emailnullable string

Example: "support@tebex.io"

usernamenullable string

couponsarray of Coupon (object)

coupon_codestring

Example: "Academy10"

giftcardsarray of GiftCard (object)

card_numberstring

Example: "0127 0244 7210 1111"

creator_codestring

The creator code is used to share a percentage of the payment with another party. See more about creator codes at https://docs.tebex.io/creators/tebex-control-panel/engagement/creator-codes

cancel_urlstring

Example: "https://tebex.io"

complete_urlnullable string

complete_auto_redirectboolean

Example: false

countrystring

A two-character country code

Example: "US"

ipstring

Example: "127.0.0.1"

username_idnumber

Example: 127244

base_pricenumber (float)

Example: 1.27

sales_taxnumber (float)

Example: 0.11

total_pricenumber (float)

Example: 1.38

currencystring

A 3 character currency code

Example: "USD"

packagesarray of BasketPackage (object)

qtyinteger

The quantity of package in this basket. This is not the total quantity of overall items in the basket.

Example: 2

typeenum

The type of payment, either single for one-time payments or subscription.

Example: "single"

singlesubscription

revenue_sharearray of RevenueShare (object)

An array of payment destination objects describing how the purchase should be split between multiple wallets. Only available with pre-agreement from Tebex.

wallet_refstring

Example: "some_wallet_reference"

amountnumber

A float (decimal) value representing the amount of this payment in your account currency that is credited to the wallet_ref

Example: 0.5

gateway_fee_percentnumber

A float (decimal) value representing the percentage of the gateway fee that should be dedicated from this wallet’s revenue share. This optional value can be anywhere between 0 - 100.

Example: 50

customnullable object

linksBasketLinks (object)

paymentstring

The links.payment property is only returned if the basket has been paid for and a payment exists with the complete,refund, or chargeback status.

Example: "https://checkout.tebex.io/api/payments/tbx-12345"

checkoutstring

The links.checkout property is only returned if the basket has not been paid, and is the URL to send the customer to make payment

Example: "https://checkout.tebex.io/checkout/1a-55fff4107740a1f40d844ff89607557f45bfafb3"

Request

Response

Gets all categories available in the webstore.

Gets all categories from a webstore. This does not include package information. To include package information, add ?includePackages=1 to the URL.

GEThttps://headless.tebex.io/api/accounts/{token}/categories

Path parameters

token*string

The webstore identifier.

Example: "t66x-7cd928b1e9312709e6810edac6dc1fd1eefc57cb"

Response

Successful response returns a list of category information.

Body

dataarray of Category (object)

idinteger

Example: 2678660

namestring

User-friendly name of the category

Example: "Test"

slugnullable string

Short identifier slug for the category

parentnullable object (Category)

Parent category, if applicable

descriptionstring

HTML description of the category

packagesnullable array of Package (object)

idinteger

Example: 6276316

namestring

Example: "test package 101"

descriptionstring

Example: "this is just a test. only a test. nothing more."

imagenullable string

typestring

Example: "single"

categoryobject

idinteger

Example: 2678660

namestring

Example: "Packages"

base_pricenumber (float)

Example: 5

sales_taxnumber (float)

Example: 0

total_pricenumber (float)

Example: 5

currencystring

Example: "USD"

discountnumber (float)

Example: 0

disable_quantityboolean

Example: false

disable_giftingboolean

Example: false

expiration_datenullable string (date-time)

created_atstring (date-time)

Example: "2024-05-21T18:09:17+00:00"

updated_atstring (date-time)

Example: "2024-05-21T18:09:17+00:00"

orderinteger

The numeric order in which to display the category.

Example: 1

display_typeenum

How the category should be displayed

listgrid

Request

Response

Add a package to a basket

Add a package with the given ID to the basket.

POSThttps://headless.tebex.io/api/baskets/{basketIdent}/packages

Path parameters

basketIdent*string

The basket identifier.

Example: "c00244-d2ac2e77418a55b25292a6bc7a719ad9c529ba2c"

Body

package_idstring

Example: 6276316

quantitynumber

Example: 1

Response

Successful response.

Body

idstring

Example: 244127617

identstring

Example: "1a-55fff4107740a1f40d844ff89607557f45bfafb3"

completeboolean

Example: false

emailnullable string

Example: "support@tebex.io"

usernamenullable string

couponsarray of Coupon (object)

coupon_codestring

Example: "Academy10"

giftcardsarray of GiftCard (object)

card_numberstring

Example: "0127 0244 7210 1111"

creator_codestring

The creator code is used to share a percentage of the payment with another party. See more about creator codes at https://docs.tebex.io/creators/tebex-control-panel/engagement/creator-codes

cancel_urlstring

Example: "https://tebex.io"

complete_urlnullable string

complete_auto_redirectboolean

Example: false

countrystring

A two-character country code

Example: "US"

ipstring

Example: "127.0.0.1"

username_idnumber

Example: 127244

base_pricenumber (float)

Example: 1.27

sales_taxnumber (float)

Example: 0.11

total_pricenumber (float)

Example: 1.38

currencystring

A 3 character currency code

Example: "USD"

packagesarray of BasketPackage (object)

qtyinteger

The quantity of package in this basket. This is not the total quantity of overall items in the basket.

Example: 2

typeenum

The type of payment, either single for one-time payments or subscription.

Example: "single"

singlesubscription

revenue_sharearray of RevenueShare (object)

An array of payment destination objects describing how the purchase should be split between multiple wallets. Only available with pre-agreement from Tebex.

wallet_refstring

Example: "some_wallet_reference"

amountnumber

A float (decimal) value representing the amount of this payment in your account currency that is credited to the wallet_ref

Example: 0.5

gateway_fee_percentnumber

A float (decimal) value representing the percentage of the gateway fee that should be dedicated from this wallet’s revenue share. This optional value can be anywhere between 0 - 100.

Example: 50

customnullable object

linksBasketLinks (object)

paymentstring

The links.payment property is only returned if the basket has been paid for and a payment exists with the complete,refund, or chargeback status.

Example: "https://checkout.tebex.io/api/payments/tbx-12345"

checkoutstring

The links.checkout property is only returned if the basket has not been paid, and is the URL to send the customer to make payment

Example: "https://checkout.tebex.io/checkout/1a-55fff4107740a1f40d844ff89607557f45bfafb3"

Request

Response

{
  "data": [
    {
      "id": 2678660,
      "name": "Test",
      "slug": "text",
      "description": "text",
      "packages": [
        {
          "id": 6276316,
          "name": "test package 101",
          "description": "<p>this is just a test. only a test. nothing more.</p>",
          "image": null,
          "type": "single",
          "category": {
            "id": 2678660,
            "name": "Packages"
          },
          "base_price": 5,
          "sales_tax": 0,
          "total_price": 5,
          "currency": "USD",
          "discount": 0,
          "disable_quantity": false,
          "disable_gifting": false,
          "expiration_date": null,
          "created_at": "2024-05-21T18:09:17+00:00",
          "updated_at": "2024-05-21T18:09:17+00:00"
        }
      ],
      "order": 1,
      "display_type": "list"
    }
  ]
}

{
  "data": [
    {
      "id": 2678660,
      "name": "Test",
      "slug": "text",
      "description": "text",
      "packages": [
        {
          "id": 6276316,
          "name": "test package 101",
          "description": "<p>this is just a test. only a test. nothing more.</p>",
          "image": null,
          "type": "single",
          "category": {
            "id": 2678660,
            "name": "Packages"
          },
          "base_price": 5,
          "sales_tax": 0,
          "total_price": 5,
          "currency": "USD",
          "discount": 0,
          "disable_quantity": false,
          "disable_gifting": false,
          "expiration_date": null,
          "created_at": "2024-05-21T18:09:17+00:00",
          "updated_at": "2024-05-21T18:09:17+00:00"
        }
      ],
      "order": 1,
      "display_type": "list"
    }
  ]
}

{
  "data": [
    {
      "id": 2678660,
      "name": "Test",
      "slug": "text",
      "description": "text",
      "packages": [
        {
          "id": 6276316,
          "name": "test package 101",
          "description": "<p>this is just a test. only a test. nothing more.</p>",
          "image": null,
          "type": "single",
          "category": {
            "id": 2678660,
            "name": "Packages"
          },
          "base_price": 5,
          "sales_tax": 0,
          "total_price": 5,
          "currency": "USD",
          "discount": 0,
          "disable_quantity": false,
          "disable_gifting": false,
          "expiration_date": null,
          "created_at": "2024-05-21T18:09:17+00:00",
          "updated_at": "2024-05-21T18:09:17+00:00"
        }
      ],
      "order": 1,
      "display_type": "list"
    }
  ]
}

{
  "data": [
    {
      "id": 6276316,
      "name": "test package 101",
      "description": "<p>this is just a test. only a test. nothing more.</p>",
      "image": null,
      "type": "single",
      "category": {
        "id": 2678660,
        "name": "Packages"
      },
      "base_price": 5,
      "sales_tax": 0,
      "total_price": 5,
      "currency": "USD",
      "discount": 0,
      "disable_quantity": false,
      "disable_gifting": false,
      "expiration_date": null,
      "created_at": "2024-05-21T18:09:17+00:00",
      "updated_at": "2024-05-21T18:09:17+00:00"
    }
  ]
}

{
  "data": {
    "id": 244127617,
    "ident": "1a-55fff4107740a1f40d844ff89607557f45bfafb3",
    "complete": false,
    "email": "support@tebex.io",
    "username": null,
    "coupons": [
      {
        "coupon_code": "Academy10"
      }
    ],
    "giftcards": [
      {
        "card_number": "0127 0244 7210 1111"
      }
    ],
    "creator_code": "text",
    "cancel_url": "https://tebex.io",
    "complete_url": null,
    "complete_auto_redirect": false,
    "country": "US",
    "ip": "127.0.0.1",
    "username_id": 127244,
    "base_price": 1.27,
    "sales_tax": 0.11,
    "total_price": 1.38,
    "currency": "USD",
    "packages": [
      {
        "qty": 2,
        "type": "single",
        "revenue_share": [
          {
            "wallet_ref": "some_wallet_reference",
            "amount": 0.5,
            "gateway_fee_percent": 50
          }
        ]
      }
    ],
    "custom": {
      "foo": "bar",
      "ref": 1234
    },
    "links": {
      "payment": "https://checkout.tebex.io/api/payments/tbx-12345",
      "checkout": "https://checkout.tebex.io/checkout/1a-55fff4107740a1f40d844ff89607557f45bfafb3"
    }
  }
}

{
  "data": {
    "id": 244127617,
    "ident": "1a-55fff4107740a1f40d844ff89607557f45bfafb3",
    "complete": false,
    "email": "support@tebex.io",
    "username": null,
    "coupons": [
      {
        "coupon_code": "Academy10"
      }
    ],
    "giftcards": [
      {
        "card_number": "0127 0244 7210 1111"
      }
    ],
    "creator_code": "text",
    "cancel_url": "https://tebex.io",
    "complete_url": null,
    "complete_auto_redirect": false,
    "country": "US",
    "ip": "127.0.0.1",
    "username_id": 127244,
    "base_price": 1.27,
    "sales_tax": 0.11,
    "total_price": 1.38,
    "currency": "USD",
    "packages": [
      {
        "qty": 2,
        "type": "single",
        "revenue_share": [
          {
            "wallet_ref": "some_wallet_reference",
            "amount": 0.5,
            "gateway_fee_percent": 50
          }
        ]
      }
    ],
    "custom": {
      "foo": "bar",
      "ref": 1234
    },
    "links": {
      "payment": "https://checkout.tebex.io/api/payments/tbx-12345",
      "checkout": "https://checkout.tebex.io/checkout/1a-55fff4107740a1f40d844ff89607557f45bfafb3"
    }
  }
}

{
  "data": {
    "id": 244127617,
    "ident": "1a-55fff4107740a1f40d844ff89607557f45bfafb3",
    "complete": false,
    "email": "support@tebex.io",
    "username": null,
    "coupons": [
      {
        "coupon_code": "Academy10"
      }
    ],
    "giftcards": [
      {
        "card_number": "0127 0244 7210 1111"
      }
    ],
    "creator_code": "text",
    "cancel_url": "https://tebex.io",
    "complete_url": null,
    "complete_auto_redirect": false,
    "country": "US",
    "ip": "127.0.0.1",
    "username_id": 127244,
    "base_price": 1.27,
    "sales_tax": 0.11,
    "total_price": 1.38,
    "currency": "USD",
    "packages": [
      {
        "qty": 2,
        "type": "single",
        "revenue_share": [
          {
            "wallet_ref": "some_wallet_reference",
            "amount": 0.5,
            "gateway_fee_percent": 50
          }
        ]
      }
    ],
    "custom": {
      "foo": "bar",
      "ref": 1234
    },
    "links": {
      "payment": "https://checkout.tebex.io/api/payments/tbx-12345",
      "checkout": "https://checkout.tebex.io/checkout/1a-55fff4107740a1f40d844ff89607557f45bfafb3"
    }
  }
}

{
  "data": {
    "id": 244127617,
    "ident": "1a-55fff4107740a1f40d844ff89607557f45bfafb3",
    "complete": false,
    "email": "support@tebex.io",
    "username": null,
    "coupons": [
      {
        "coupon_code": "Academy10"
      }
    ],
    "giftcards": [
      {
        "card_number": "0127 0244 7210 1111"
      }
    ],
    "creator_code": "text",
    "cancel_url": "https://tebex.io",
    "complete_url": null,
    "complete_auto_redirect": false,
    "country": "US",
    "ip": "127.0.0.1",
    "username_id": 127244,
    "base_price": 1.27,
    "sales_tax": 0.11,
    "total_price": 1.38,
    "currency": "USD",
    "packages": [
      {
        "qty": 2,
        "type": "single",
        "revenue_share": [
          {
            "wallet_ref": "some_wallet_reference",
            "amount": 0.5,
            "gateway_fee_percent": 50
          }
        ]
      }
    ],
    "custom": {
      "foo": "bar",
      "ref": 1234
    },
    "links": {
      "payment": "https://checkout.tebex.io/api/payments/tbx-12345",
      "checkout": "https://checkout.tebex.io/checkout/1a-55fff4107740a1f40d844ff89607557f45bfafb3"
    }
  }
}

{
  "data": [
    {
      "id": 6276316,
      "name": "test package 101",
      "description": "<p>this is just a test. only a test. nothing more.</p>",
      "image": null,
      "type": "single",
      "category": {
        "id": 2678660,
        "name": "Packages"
      },
      "base_price": 5,
      "sales_tax": 0,
      "total_price": 5,
      "currency": "USD",
      "discount": 0,
      "disable_quantity": false,
      "disable_gifting": false,
      "expiration_date": null,
      "created_at": "2024-05-21T18:09:17+00:00",
      "updated_at": "2024-05-21T18:09:17+00:00"
    }
  ]
}

{
  "id": 244127617,
  "ident": "1a-55fff4107740a1f40d844ff89607557f45bfafb3",
  "complete": false,
  "email": "support@tebex.io",
  "username": null,
  "coupons": [
    {
      "coupon_code": "Academy10"
    }
  ],
  "giftcards": [
    {
      "card_number": "0127 0244 7210 1111"
    }
  ],
  "creator_code": "text",
  "cancel_url": "https://tebex.io",
  "complete_url": null,
  "complete_auto_redirect": false,
  "country": "US",
  "ip": "127.0.0.1",
  "username_id": 127244,
  "base_price": 1.27,
  "sales_tax": 0.11,
  "total_price": 1.38,
  "currency": "USD",
  "packages": [
    {
      "qty": 2,
      "type": "single",
      "revenue_share": [
        {
          "wallet_ref": "some_wallet_reference",
          "amount": 0.5,
          "gateway_fee_percent": 50
        }
      ]
    }
  ],
  "custom": {
    "foo": "bar",
    "ref": 1234
  },
  "links": {
    "payment": "https://checkout.tebex.io/api/payments/tbx-12345",
    "checkout": "https://checkout.tebex.io/checkout/1a-55fff4107740a1f40d844ff89607557f45bfafb3"
  }
}

{
  "data": {
    "id": 244127617,
    "ident": "1a-55fff4107740a1f40d844ff89607557f45bfafb3",
    "complete": false,
    "email": "support@tebex.io",
    "username": null,
    "coupons": [
      {
        "coupon_code": "Academy10"
      }
    ],
    "giftcards": [
      {
        "card_number": "0127 0244 7210 1111"
      }
    ],
    "creator_code": "text",
    "cancel_url": "https://tebex.io",
    "complete_url": null,
    "complete_auto_redirect": false,
    "country": "US",
    "ip": "127.0.0.1",
    "username_id": 127244,
    "base_price": 1.27,
    "sales_tax": 0.11,
    "total_price": 1.38,
    "currency": "USD",
    "packages": [
      {
        "qty": 2,
        "type": "single",
        "revenue_share": [
          {
            "wallet_ref": "some_wallet_reference",
            "amount": 0.5,
            "gateway_fee_percent": 50
          }
        ]
      }
    ],
    "custom": {
      "foo": "bar",
      "ref": 1234
    },
    "links": {
      "payment": "https://checkout.tebex.io/api/payments/tbx-12345",
      "checkout": "https://checkout.tebex.io/checkout/1a-55fff4107740a1f40d844ff89607557f45bfafb3"
    }
  }
}

{
  "data": [
    {
      "id": 2678660,
      "name": "Test",
      "slug": "text",
      "description": "text",
      "packages": [
        {
          "id": 6276316,
          "name": "test package 101",
          "description": "<p>this is just a test. only a test. nothing more.</p>",
          "image": null,
          "type": "single",
          "category": {
            "id": 2678660,
            "name": "Packages"
          },
          "base_price": 5,
          "sales_tax": 0,
          "total_price": 5,
          "currency": "USD",
          "discount": 0,
          "disable_quantity": false,
          "disable_gifting": false,
          "expiration_date": null,
          "created_at": "2024-05-21T18:09:17+00:00",
          "updated_at": "2024-05-21T18:09:17+00:00"
        }
      ],
      "order": 1,
      "display_type": "list"
    }
  ]
}

{
  "id": 244127617,
  "ident": "1a-55fff4107740a1f40d844ff89607557f45bfafb3",
  "complete": false,
  "email": "support@tebex.io",
  "username": null,
  "coupons": [
    {
      "coupon_code": "Academy10"
    }
  ],
  "giftcards": [
    {
      "card_number": "0127 0244 7210 1111"
    }
  ],
  "creator_code": "text",
  "cancel_url": "https://tebex.io",
  "complete_url": null,
  "complete_auto_redirect": false,
  "country": "US",
  "ip": "127.0.0.1",
  "username_id": 127244,
  "base_price": 1.27,
  "sales_tax": 0.11,
  "total_price": 1.38,
  "currency": "USD",
  "packages": [
    {
      "qty": 2,
      "type": "single",
      "revenue_share": [
        {
          "wallet_ref": "some_wallet_reference",
          "amount": 0.5,
          "gateway_fee_percent": 50
        }
      ]
    }
  ],
  "custom": {
    "foo": "bar",
    "ref": 1234
  },
  "links": {
    "payment": "https://checkout.tebex.io/api/payments/tbx-12345",
    "checkout": "https://checkout.tebex.io/checkout/1a-55fff4107740a1f40d844ff89607557f45bfafb3"
  }
}