1 of 1

Endpoints

Webstores

Baskets

Package

Creator Codes

Gift Cards

Coupons

Adding / Removing Packages

Updating Quantities

Endpoints

Webstores

Fetch a webstore by its identifier

Gets the webstore associated with the provided identifier.

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

Path parameters

token*string

The webstore identifier.

Example: "some-uuid"

Response

Successful response returns the webstore's information.

Body

dataobject

schemaWebstore (object)

idinteger

Example: 1

descriptionstring

Store description in HTML format

Example:

"<p>Lorem ipsum dolor sit amet, consectetur adipiscing elit. Mauris fermentum eget tellus et cursus. Pellentesque vel vehicula velit, sit amet tincidunt diam. Aliquam sit amet fermentum lorem.</p>"

namestring

Name of the store

Example: "Minecraft Store"

webstore_urlstring (uri)

URL of the webstore

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

currencystring

Currency used in the store

Example: "USD"

langstring

Language of the store

Example: "en"

logonullable string (uri)

URL of the store's logo

platform_typestring

Platform type for the store

Example: "Minecraft: Java Edition"

platform_type_idstring

Example: "minecraft"

created_atstring (date-time)

The date and time when the store was created

Example: "2023-05-25T09:49:37+00:00"

Request

Response

Fetch the custom pages associated with the store.

Gets a list of custom pages associated with the webstore. These contain a content variable with the HTML content of the page.

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

Path parameters

token*string

The webstore identifier.

Example: "some-uuid"

Response

Successful response returns the webstore's pages.

Body

dataarray of CMSPage (object)

idnumber

Example: 127

created_atstring (date-time)

Example: "2023-11-13T20:59:54.000000Z"

updated_atstring (date-time)

Example: "2023-11-13T20:59:54.000000Z"

account_idnumber

Example: 244

titlestring

Example: "About"

slugstring

Example: "about"

privateboolean

Example: false

hiddenboolean

Example: false

disabledboolean

Example: false

sequenceboolean

Example: false

contentstring

Example:

"<p>This is a custom page which you can add your own content to if you wish.</p>\n\n<p>You can modify your pages by going to <strong>Webstore</strong> &gt; <strong>Pages</strong> from within the\nTebex Store control panel.</p>\n\n<p>Make sure to take a look at our <a href=\"https://help.tebex.io\" rel=\"noreferrer\" target=\"_blank\">knowledgebase</a>\nfor helpful guides on getting started.</p>"

Request

Response

Baskets

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

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

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

Package

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

Fetch a package from a webstore by its identifier

Gets all packages from a webstore.

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

Path parameters

token*string

The webstore identifier.

Example: "t66x-7cd928b1e9312709e6810edac6dc1fd1eefc57cb"

ipAddress*string

An IP address can be provided with authenticated requests.

Example: "127.0.0.1"

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

Fetch a package from a webstore by its identifier

Gets all packages from a webstore.

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

Path parameters

token*string

The webstore identifier.

Example: "t66x-7cd928b1e9312709e6810edac6dc1fd1eefc57cb"

basketIdent*string

The basket identifier.

Example: "c00244-d2ac2e77418a55b25292a6bc7a719ad9c529ba2c"

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

Fetch a package from a webstore by its identifier

Gets all packages from a webstore.

GEThttps://headless.tebex.io/api/accounts/{token}/packages?ipAddress={ipAddress}&basketIdent={basketIdent}

Path parameters

token*string

The webstore identifier.

Example: "t66x-7cd928b1e9312709e6810edac6dc1fd1eefc57cb"

basketIdent*string

The basket identifier.

Example: "c00244-d2ac2e77418a55b25292a6bc7a719ad9c529ba2c"

ipAddress*string

An IP address can be provided with authenticated requests.

Example: "127.0.0.1"

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

Creator Codes

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

Gift Cards

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

Coupons

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

Adding / Removing Packages

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

Updating Quantities

Updates the quantity of the given package in the basket. The user must be logged in before the quantity can be changed.

Sets the quantity of the given item in the basket.

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

Path parameters

basketIdent*string

The basket identifier.

Example: "c00244-d2ac2e77418a55b25292a6bc7a719ad9c529ba2c"

packageId*number

The package identifier.

Example: 6276316

Body

quantitynumber

Example: 1

Response

Successful response.

Request

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

Updates the quantity of the given package in the basket. The user must be logged in before the quantity can be changed.

Sets the quantity of the given item in the basket.

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

Path parameters

basketIdent*string

The basket identifier.

Example: "c00244-d2ac2e77418a55b25292a6bc7a719ad9c529ba2c"

packageId*number

The package identifier.

Example: 6276316

Body

quantitynumber

Example: 1

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

Fetch a package from a webstore by its identifier

Gets all packages from a webstore.

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

Path parameters

token*string

The webstore identifier.

Example: "t66x-7cd928b1e9312709e6810edac6dc1fd1eefc57cb"

ipAddress*string

An IP address can be provided with authenticated requests.

Example: "127.0.0.1"

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

Fetch a package from a webstore by its identifier

Gets all packages from a webstore.

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

Path parameters

token*string

The webstore identifier.

Example: "t66x-7cd928b1e9312709e6810edac6dc1fd1eefc57cb"

basketIdent*string

The basket identifier.

Example: "c00244-d2ac2e77418a55b25292a6bc7a719ad9c529ba2c"

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

Fetch a package from a webstore by its identifier

Gets all packages from a webstore.

GEThttps://headless.tebex.io/api/accounts/{token}/packages?ipAddress={ipAddress}&basketIdent={basketIdent}

Path parameters

token*string

The webstore identifier.

Example: "t66x-7cd928b1e9312709e6810edac6dc1fd1eefc57cb"

basketIdent*string

The basket identifier.

Example: "c00244-d2ac2e77418a55b25292a6bc7a719ad9c529ba2c"

ipAddress*string

An IP address can be provided with authenticated requests.

Example: "127.0.0.1"

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

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 the custom pages associated with the store.

Gets a list of custom pages associated with the webstore. These contain a content variable with the HTML content of the page.

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

Path parameters

token*string

The webstore identifier.

Example: "some-uuid"

Response

Successful response returns the webstore's pages.

Body

dataarray of CMSPage (object)

idnumber

Example: 127

created_atstring (date-time)

Example: "2023-11-13T20:59:54.000000Z"

updated_atstring (date-time)

Example: "2023-11-13T20:59:54.000000Z"

account_idnumber

Example: 244

titlestring

Example: "About"

slugstring

Example: "about"

privateboolean

Example: false

hiddenboolean

Example: false

disabledboolean

Example: false

sequenceboolean

Example: false

contentstring

Example:

"<p>This is a custom page which you can add your own content to if you wish.</p>\n\n<p>You can modify your pages by going to <strong>Webstore</strong> &gt; <strong>Pages</strong> from within the\nTebex Store control panel.</p>\n\n<p>Make sure to take a look at our <a href=\"https://help.tebex.io\" rel=\"noreferrer\" target=\"_blank\">knowledgebase</a>\nfor helpful guides on getting started.</p>"

Request

Response

Fetch a webstore by its identifier

Gets the webstore associated with the provided identifier.

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

Path parameters

token*string

The webstore identifier.

Example: "some-uuid"

Response

Successful response returns the webstore's information.

Body

dataobject

schemaWebstore (object)

idinteger

Example: 1

descriptionstring

Store description in HTML format

Example:

"<p>Lorem ipsum dolor sit amet, consectetur adipiscing elit. Mauris fermentum eget tellus et cursus. Pellentesque vel vehicula velit, sit amet tincidunt diam. Aliquam sit amet fermentum lorem.</p>"

namestring

Name of the store

Example: "Minecraft Store"

webstore_urlstring (uri)

URL of the webstore

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

currencystring

Currency used in the store

Example: "USD"

langstring

Language of the store

Example: "en"

logonullable string (uri)

URL of the store's logo

platform_typestring

Platform type for the store

Example: "Minecraft: Java Edition"

platform_type_idstring

Example: "minecraft"

created_atstring (date-time)

The date and time when the store was created

Example: "2023-05-25T09:49:37+00:00"

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

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

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

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

const response = await fetch('https://headless.tebex.io/api/accounts/{token}/baskets/{basketIdent}/creator-codes/remove', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

const response = await fetch('https://headless.tebex.io/api/accounts/{token}/baskets/{basketIdent}/coupons/remove', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

const response = await fetch('https://headless.tebex.io/api/baskets/{basketIdent}/packages/{packageId}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

const response = await fetch('https://headless.tebex.io/api/accounts/{token}/categories?includePackages=1', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

{
  "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"
    }
  ]
}

const response = await fetch('https://headless.tebex.io/api/accounts/{token}/categories/{categoryId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

{
  "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"
    }
  ]
}

const response = await fetch('https://headless.tebex.io/api/accounts/{token}/categories/{categoryId}?includePackages=1', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

{
  "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"
    }
  ]
}

const response = await fetch('https://headless.tebex.io/api/accounts/{token}/packages', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

{
  "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"
    }
  ]
}

const response = await fetch('https://headless.tebex.io/api/accounts/{token}/baskets/{basketIdent}/giftcards/remove', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

const response = await fetch('https://headless.tebex.io/api/accounts/{token}/packages?ipAddress={ipAddress}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

{
  "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"
    }
  ]
}

const response = await fetch('https://headless.tebex.io/api/accounts/{token}/packages?basketIdent={basketIdent}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

{
  "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"
    }
  ]
}

const response = await fetch('https://headless.tebex.io/api/accounts/{token}/packages?ipAddress={ipAddress}&basketIdent={basketIdent}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

{
  "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"
    }
  ]
}

const response = await fetch('https://headless.tebex.io/api/accounts/{token}/baskets/{basketIdent}/auth?returnUrl={returnUrl}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

[
  {
    "name": "FiveM",
    "url": "https://ident.tebex.io/"
  }
]

const response = await fetch('https://headless.tebex.io/api/accounts/{token}/baskets/{basketIdent}/creator-codes', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

{
  "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"
    }
  }
}

const response = await fetch('https://headless.tebex.io/api/accounts/{token}/baskets/{basketIdent}/giftcards', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

{
  "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"
    }
  }
}

const response = await fetch('https://headless.tebex.io/api/accounts/{token}/baskets/{basketIdent}/coupons', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

{
  "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"
    }
  }
}

const response = await fetch('https://headless.tebex.io/api/accounts/{token}/baskets', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

{
  "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"
    }
  }
}

const response = await fetch('https://headless.tebex.io/api/accounts/{token}/pages', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

{
  "data": [
    {
      "id": 127,
      "created_at": "2023-11-13T20:59:54.000000Z",
      "updated_at": "2023-11-13T20:59:54.000000Z",
      "account_id": 244,
      "title": "About",
      "slug": "about",
      "private": false,
      "hidden": false,
      "disabled": false,
      "sequence": false,
      "content": "<p>This is a custom page which you can add your own content to if you wish.</p>\n\n<p>You can modify your pages by going to <strong>Webstore</strong> &gt; <strong>Pages</strong> from within the\nTebex Store control panel.</p>\n\n<p>Make sure to take a look at our <a href=\"https://help.tebex.io\" rel=\"noreferrer\" target=\"_blank\">knowledgebase</a>\nfor helpful guides on getting started.</p>"
    }
  ]
}

const response = await fetch('https://headless.tebex.io/api/accounts/{token}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

{
  "data": {
    "schema": {
      "id": 1,
      "description": "<p>Lorem ipsum dolor sit amet, consectetur adipiscing elit. Mauris fermentum eget tellus et cursus. Pellentesque vel vehicula velit, sit amet tincidunt diam. Aliquam sit amet fermentum lorem.</p>",
      "name": "Minecraft Store",
      "webstore_url": "https://example.tebex.io",
      "currency": "USD",
      "lang": "en",
      "logo": "https://example.com",
      "platform_type": "Minecraft: Java Edition",
      "platform_type_id": "minecraft",
      "created_at": "2023-05-25T09:49:37+00:00"
    }
  }
}

const response = await fetch('https://headless.tebex.io/api/accounts/{token}/packages/{packageId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

{
  "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"
    }
  ]
}

const response = await fetch('https://headless.tebex.io/api/baskets/{basketIdent}/packages/remove', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

{
  "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"
  }
}

const response = await fetch('https://headless.tebex.io/api/baskets/{basketIdent}/packages', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

{
  "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"
  }
}

const response = await fetch('https://headless.tebex.io/api/accounts/{token}/categories', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

{
  "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"
    }
  ]
}

const response = await fetch('https://headless.tebex.io/api/accounts/{token}/baskets/{basketIdent}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

{
  "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"
    }
  }
}

Endpoints

Webstores

Baskets

Categories

Package

Creator Codes

Gift Cards

Coupons

Adding / Removing Packages

Updating Quantities

Endpoints

Webstores

Fetch a webstore by its identifier

Fetch the custom pages associated with the store.

Baskets

Fetch a basket from a webstore by its identifier

Create a new basket

Get authentication links for a basket.

Categories

Gets all categories available in the webstore.

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

Gets information about a specific category

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

Package

Fetch a package from a webstore by its identifier

Fetch all packages from a webstore

Fetch a package from a webstore by its identifier

Fetch a package from a webstore by its identifier

Fetch a package from a webstore by its identifier

Creator Codes

Apply a creator code to a basket.

Remove a creator code from the basket.

Gift Cards

Apply a gift card to a basket.

Remove a gift card from the basket.

Coupons

Apply a coupon to a basket.

Remove a coupon from the basket.

Adding / Removing Packages

Add a package to a basket

Remove a package from a basket

Updating Quantities

Updates the quantity of the given package in the basket. The user must be logged in before the quantity can be changed.

Remove a creator code from the basket.

Remove a coupon from the basket.

Updates the quantity of the given package in the basket. The user must be logged in before the quantity can be changed.

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

Gets information about a specific category

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

Fetch all packages from a webstore

Remove a gift card from the basket.

Fetch a package from a webstore by its identifier

Fetch a package from a webstore by its identifier

Fetch a package from a webstore by its identifier

Get authentication links for a basket.

Apply a creator code to a basket.

Apply a gift card to a basket.

Apply a coupon to a basket.

Create a new basket

Fetch the custom pages associated with the store.

Fetch a webstore by its identifier

Fetch a package from a webstore by its identifier

Remove a package from a basket

Add a package to a basket

Gets all categories available in the webstore.

Fetch a basket from a webstore by its identifier