Endpoints

All endpoints for Headless API: for specific implementation guides see Guides

Get the webstore's information

get

Gets the webstore associated with the provided token

Responses

200

Successful response returns the webstore's information.

application/json

Wrapped webstore information in a "data" object.

get/

HTTPcURLJavaScriptPython

GET /api/accounts/ HTTP/1.1
Host: headless.tebex.io/
Accept: */*

200

Successful response returns the webstore's information.

{
  "data": {
    "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",
    "disabled": false,
    "created_at": "2023-05-25T09:49:37+00:00"
  }
}

Get custom pages defined for the webstore.

get

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

Responses

200

Successful response returns the webstore's pages.

application/json

get/pages

HTTPcURLJavaScriptPython

GET /api/accounts/pages HTTP/1.1
Host: headless.tebex.io/
Accept: */*

200

Successful response returns the webstore's pages.

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

Get a basket

get

Gets a basket associated with the provided identifier.

Path parameters

basketIdentstringRequired

The basket identifier.

Example: c00244-d2ac2e77418a55b25292a6bc7a719ad9c529ba2c

Responses

200

Successful response returns the basket information.

application/json

get/baskets/{basketIdent}

HTTPcURLJavaScriptPython

GET /api/accounts/baskets/{basketIdent} HTTP/1.1
Host: headless.tebex.io/
Accept: */*

200

Successful response returns the basket information.

{
  "data": {
    "id": 244127617,
    "ident": "1a-55fff4107740a1f40d844ff89607557f45bfafb3",
    "complete": false,
    "email": "[e-mail]",
    "username": null,
    "coupons": [
      {
        "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": [
      {
        "id": 1,
        "description": "100 coins added to your character",
        "image": "https://tebex.io/path/to/image.png",
        "name": "100 Coins",
        "slug": "100-coins",
        "in_basket": {
          "quantity": 2,
          "price": 1,
          "gift_username_id": "text",
          "gift_username": "text"
        },
        "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"
    }
  }
}

Create a new basket

post

Creates a new basket for use during checkout.

Body

application/json

complete_urlstringOptional

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

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

cancel_urlstringOptional

A URL the user can return to when cancelling checkout.

Example: https://tebex.io/

customobjectOptional

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

Example: {"foo":"bar"}

complete_auto_redirectbooleanOptional

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

Example: true

Responses

200

Successful response returns the basket information.

application/json

422

The provided webstore ID is invalid.

post/baskets

HTTPcURLJavaScriptPython

POST /api/accounts/baskets HTTP/1.1
Host: headless.tebex.io/
Content-Type: application/json
Accept: */*
Content-Length: 139

{
  "complete_url": "https://example.tebex.io/thank-you",
  "cancel_url": "https://tebex.io/",
  "custom": {
    "foo": "bar"
  },
  "complete_auto_redirect": true
}

{
  "data": {
    "id": 244127617,
    "ident": "1a-55fff4107740a1f40d844ff89607557f45bfafb3",
    "complete": false,
    "email": "[e-mail]",
    "username": null,
    "coupons": [
      {
        "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": [
      {
        "id": 1,
        "description": "100 coins added to your character",
        "image": "https://tebex.io/path/to/image.png",
        "name": "100 Coins",
        "slug": "100-coins",
        "in_basket": {
          "quantity": 2,
          "price": 1,
          "gift_username_id": "text",
          "gift_username": "text"
        },
        "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"
    }
  }
}

Get auth links for basket

get

Fetches a basket's auth URL. The player should be directed here in order for them to authorize their account. When complete, they will be returned to the provided returnUrl and the basket will be authorized from that moment onwards.

Path parameters

basketIdentstringRequired

The basket identifier.

Example: c00244-d2ac2e77418a55b25292a6bc7a719ad9c529ba2c

returnUrlstringRequired

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

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

Responses

200

Successful response returns the auth provider options and URLs of the sign-in link.

application/json

namestringOptionalExample: FiveM

urlstringOptionalExample: https://ident.tebex.io/

422

The provided webstore ID or basket ID is invalid.

get/baskets/{basketIdent}/auth?returnUrl={returnUrl}

HTTPcURLJavaScriptPython

GET /api/accounts/baskets/{basketIdent}/auth?returnUrl={returnUrl} HTTP/1.1
Host: headless.tebex.io/
Accept: */*

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

Add packages to a dynamic category for a basket.

put

Populates a dynamic category with custom packages for the given basket. Dynamic categories are created in the creator panel with the type dynamic, and are typically populated in response to a basket.authenticated webhook.

Once created, the packages can be fetched using the category endpoints with both includePackages=1 and basketIdent provided.

Path parameters

basketIdentstringRequired

The basket identifier.

Example: c00244-d2ac2e77418a55b25292a6bc7a719ad9c529ba2c

Body

application/json

usernamestringRequired

The username of the authenticated customer the packages are being created for.

Example: TestUser

category_idintegerRequired

The ID of the dynamic category to populate.

Example: 1234

Responses

200

Successful response confirms the dynamic packages were created.

application/json

messagestringOptionalExample: Dynamic packages created successfully.

422

The provided request is invalid. The error response will include detail as to which parameter failed validation.

put/baskets/{basketIdent}/dynamic-packages

HTTPcURLJavaScriptPython

PUT /api/accounts/baskets/{basketIdent}/dynamic-packages HTTP/1.1
Host: headless.tebex.io/
Content-Type: application/json
Accept: */*
Content-Length: 302

{
  "username": "TestUser",
  "category_id": 1234,
  "packages": [
    {
      "name": "Package Name 1",
      "price": 10,
      "slug": "package-name-1",
      "description": "This is the description",
      "image_url": "image.url/imageurl",
      "custom": {
        "custom-field-1": "custom-value-1",
        "custom-field-2": "custom-value-2",
        "custom-field-3": "custom-value-3"
      }
    }
  ]
}

{
  "message": "Dynamic packages created successfully."
}

Get all categories

get

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

Responses

200

Successful response returns a list of category information.

application/json

get/categories

HTTPcURLJavaScriptPython

GET /api/accounts/categories HTTP/1.1
Host: headless.tebex.io/
Accept: */*

200

Successful response returns a list of category information.

{
  "data": [
    {
      "id": 2678660,
      "name": "Test",
      "slug": "text",
      "parent": {},
      "tiered": false,
      "active_tier": {
        "id": 40796,
        "created_at": "2025-05-14T13:48:56.000000Z",
        "username_id": "text",
        "package": {
          "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",
          "prorate_price": 1,
          "discount": 0,
          "disable_quantity": false,
          "disable_gifting": false,
          "expiration_date": null,
          "media": [],
          "order": 1,
          "slug": "text",
          "user_limit": 1,
          "creator_meta_data": {},
          "options": [],
          "variables": [],
          "created_at": "2024-05-21T18:09:17+00:00",
          "updated_at": "2024-05-21T18:09:17+00:00"
        },
        "active": true,
        "recurring_payment_reference": "tbx-r-757925142",
        "next_payment_date": "2025-06-14T13:48:56+00:00",
        "status": {
          "id": 2,
          "description": "Active"
        },
        "pending_downgrade_package": {
          "id": 6834820,
          "name": "Bronze"
        }
      },
      "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",
          "prorate_price": 1,
          "discount": 0,
          "disable_quantity": false,
          "disable_gifting": false,
          "expiration_date": null,
          "media": [],
          "order": 1,
          "slug": "text",
          "user_limit": 1,
          "creator_meta_data": {},
          "options": [],
          "variables": [],
          "created_at": "2024-05-21T18:09:17+00:00",
          "updated_at": "2024-05-21T18:09:17+00:00"
        }
      ],
      "order": 1,
      "display_type": "list",
      "image_url": null,
      "dynamic": false
    }
  ]
}

Gets all categories and packages

get

Gets all categories from a webstore including packages.

Responses

200

Successful response returns a list of category information.

application/json

get/categories?includePackages=1

HTTPcURLJavaScriptPython

GET /api/accounts/categories?includePackages=1 HTTP/1.1
Host: headless.tebex.io/
Accept: */*

200

Successful response returns a list of category information.

{
  "data": [
    {
      "id": 2678660,
      "name": "Test",
      "slug": "text",
      "parent": {},
      "tiered": false,
      "active_tier": {
        "id": 40796,
        "created_at": "2025-05-14T13:48:56.000000Z",
        "username_id": "text",
        "package": {
          "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",
          "prorate_price": 1,
          "discount": 0,
          "disable_quantity": false,
          "disable_gifting": false,
          "expiration_date": null,
          "media": [],
          "order": 1,
          "slug": "text",
          "user_limit": 1,
          "creator_meta_data": {},
          "options": [],
          "variables": [],
          "created_at": "2024-05-21T18:09:17+00:00",
          "updated_at": "2024-05-21T18:09:17+00:00"
        },
        "active": true,
        "recurring_payment_reference": "tbx-r-757925142",
        "next_payment_date": "2025-06-14T13:48:56+00:00",
        "status": {
          "id": 2,
          "description": "Active"
        },
        "pending_downgrade_package": {
          "id": 6834820,
          "name": "Bronze"
        }
      },
      "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",
          "prorate_price": 1,
          "discount": 0,
          "disable_quantity": false,
          "disable_gifting": false,
          "expiration_date": null,
          "media": [],
          "order": 1,
          "slug": "text",
          "user_limit": 1,
          "creator_meta_data": {},
          "options": [],
          "variables": [],
          "created_at": "2024-05-21T18:09:17+00:00",
          "updated_at": "2024-05-21T18:09:17+00:00"
        }
      ],
      "order": 1,
      "display_type": "list",
      "image_url": null,
      "dynamic": false
    }
  ]
}

Get user's tiered categories

get

Gets all categories from the webstore, returning active tier information for the given player.

Authorizations

basicAuth

AuthorizationstringRequired

Path parameters

usernameIdintegerRequiredExample: 76561198042467020

Responses

200

Successful response returns a list of category information.

application/json

get/categories?usernameId={usernameId}&includePackages=1

HTTPcURLJavaScriptPython

GET /api/accounts/categories?usernameId={usernameId}&includePackages=1 HTTP/1.1
Host: headless.tebex.io/
Authorization: Basic username:password
Accept: */*

200

Successful response returns a list of category information.

{
  "data": [
    {
      "id": 2678660,
      "name": "Test",
      "slug": "text",
      "parent": {},
      "tiered": false,
      "active_tier": {
        "id": 40796,
        "created_at": "2025-05-14T13:48:56.000000Z",
        "username_id": "text",
        "package": {
          "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",
          "prorate_price": 1,
          "discount": 0,
          "disable_quantity": false,
          "disable_gifting": false,
          "expiration_date": null,
          "media": [],
          "order": 1,
          "slug": "text",
          "user_limit": 1,
          "creator_meta_data": {},
          "options": [],
          "variables": [],
          "created_at": "2024-05-21T18:09:17+00:00",
          "updated_at": "2024-05-21T18:09:17+00:00"
        },
        "active": true,
        "recurring_payment_reference": "tbx-r-757925142",
        "next_payment_date": "2025-06-14T13:48:56+00:00",
        "status": {
          "id": 2,
          "description": "Active"
        },
        "pending_downgrade_package": {
          "id": 6834820,
          "name": "Bronze"
        }
      },
      "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",
          "prorate_price": 1,
          "discount": 0,
          "disable_quantity": false,
          "disable_gifting": false,
          "expiration_date": null,
          "media": [],
          "order": 1,
          "slug": "text",
          "user_limit": 1,
          "creator_meta_data": {},
          "options": [],
          "variables": [],
          "created_at": "2024-05-21T18:09:17+00:00",
          "updated_at": "2024-05-21T18:09:17+00:00"
        }
      ],
      "order": 1,
      "display_type": "list",
      "image_url": null,
      "dynamic": false
    }
  ]
}

Get Dynamic Categories

get

Gets all categories from a webstore including packages. When basketIdent is provided, dynamic categories are populated with the packages associated with that basket.

If a basket identifier is not provided, dynamic categories will be empty as the basket is required to relate packages to the category.

Path parameters

basketIdentstringRequired

The basket identifier.

Example: c00244-d2ac2e77418a55b25292a6bc7a719ad9c529ba2c

Responses

200

Successful response returns a list of category information.

application/json

get/categories?includePackages=1&basketIdent={basketIdent}

HTTPcURLJavaScriptPython

GET /api/accounts/categories?includePackages=1&basketIdent={basketIdent} HTTP/1.1
Host: headless.tebex.io/
Accept: */*

200

Successful response returns a list of category information.

{
  "data": [
    {
      "id": 2678660,
      "name": "Test",
      "slug": "text",
      "parent": {},
      "tiered": false,
      "active_tier": {
        "id": 40796,
        "created_at": "2025-05-14T13:48:56.000000Z",
        "username_id": "text",
        "package": {
          "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",
          "prorate_price": 1,
          "discount": 0,
          "disable_quantity": false,
          "disable_gifting": false,
          "expiration_date": null,
          "media": [],
          "order": 1,
          "slug": "text",
          "user_limit": 1,
          "creator_meta_data": {},
          "options": [],
          "variables": [],
          "created_at": "2024-05-21T18:09:17+00:00",
          "updated_at": "2024-05-21T18:09:17+00:00"
        },
        "active": true,
        "recurring_payment_reference": "tbx-r-757925142",
        "next_payment_date": "2025-06-14T13:48:56+00:00",
        "status": {
          "id": 2,
          "description": "Active"
        },
        "pending_downgrade_package": {
          "id": 6834820,
          "name": "Bronze"
        }
      },
      "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",
          "prorate_price": 1,
          "discount": 0,
          "disable_quantity": false,
          "disable_gifting": false,
          "expiration_date": null,
          "media": [],
          "order": 1,
          "slug": "text",
          "user_limit": 1,
          "creator_meta_data": {},
          "options": [],
          "variables": [],
          "created_at": "2024-05-21T18:09:17+00:00",
          "updated_at": "2024-05-21T18:09:17+00:00"
        }
      ],
      "order": 1,
      "display_type": "list",
      "image_url": null,
      "dynamic": false
    }
  ]
}

Get specific category

get

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

Path parameters

basketIdentstringRequired

The basket identifier.

Example: c00244-d2ac2e77418a55b25292a6bc7a719ad9c529ba2c

Responses

200

Successful response returns the category without package information.

application/json

get/categories/{categoryId}

HTTPcURLJavaScriptPython

GET /api/accounts/categories/{categoryId} HTTP/1.1
Host: headless.tebex.io/
Accept: */*

200

Successful response returns the category without package information.

{
  "data": [
    {
      "id": 2678660,
      "name": "Test",
      "slug": "text",
      "parent": {},
      "tiered": false,
      "active_tier": {
        "id": 40796,
        "created_at": "2025-05-14T13:48:56.000000Z",
        "username_id": "text",
        "package": {
          "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",
          "prorate_price": 1,
          "discount": 0,
          "disable_quantity": false,
          "disable_gifting": false,
          "expiration_date": null,
          "media": [],
          "order": 1,
          "slug": "text",
          "user_limit": 1,
          "creator_meta_data": {},
          "options": [],
          "variables": [],
          "created_at": "2024-05-21T18:09:17+00:00",
          "updated_at": "2024-05-21T18:09:17+00:00"
        },
        "active": true,
        "recurring_payment_reference": "tbx-r-757925142",
        "next_payment_date": "2025-06-14T13:48:56+00:00",
        "status": {
          "id": 2,
          "description": "Active"
        },
        "pending_downgrade_package": {
          "id": 6834820,
          "name": "Bronze"
        }
      },
      "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",
          "prorate_price": 1,
          "discount": 0,
          "disable_quantity": false,
          "disable_gifting": false,
          "expiration_date": null,
          "media": [],
          "order": 1,
          "slug": "text",
          "user_limit": 1,
          "creator_meta_data": {},
          "options": [],
          "variables": [],
          "created_at": "2024-05-21T18:09:17+00:00",
          "updated_at": "2024-05-21T18:09:17+00:00"
        }
      ],
      "order": 1,
      "display_type": "list",
      "image_url": null,
      "dynamic": false
    }
  ]
}

Get a category with all packages

get

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

Path parameters

categoryIdstringRequired

The ID or slug of the category to fetch.

Example: 127244343

Responses

200

Successful response returns the category with package information.

application/json

get/categories/{categoryId}?includePackages=1

HTTPcURLJavaScriptPython

GET /api/accounts/categories/{categoryId}?includePackages=1 HTTP/1.1
Host: headless.tebex.io/
Accept: */*

200

Successful response returns the category with package information.

{
  "data": [
    {
      "id": 2678660,
      "name": "Test",
      "slug": "text",
      "parent": {},
      "tiered": false,
      "active_tier": {
        "id": 40796,
        "created_at": "2025-05-14T13:48:56.000000Z",
        "username_id": "text",
        "package": {
          "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",
          "prorate_price": 1,
          "discount": 0,
          "disable_quantity": false,
          "disable_gifting": false,
          "expiration_date": null,
          "media": [],
          "order": 1,
          "slug": "text",
          "user_limit": 1,
          "creator_meta_data": {},
          "options": [],
          "variables": [],
          "created_at": "2024-05-21T18:09:17+00:00",
          "updated_at": "2024-05-21T18:09:17+00:00"
        },
        "active": true,
        "recurring_payment_reference": "tbx-r-757925142",
        "next_payment_date": "2025-06-14T13:48:56+00:00",
        "status": {
          "id": 2,
          "description": "Active"
        },
        "pending_downgrade_package": {
          "id": 6834820,
          "name": "Bronze"
        }
      },
      "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",
          "prorate_price": 1,
          "discount": 0,
          "disable_quantity": false,
          "disable_gifting": false,
          "expiration_date": null,
          "media": [],
          "order": 1,
          "slug": "text",
          "user_limit": 1,
          "creator_meta_data": {},
          "options": [],
          "variables": [],
          "created_at": "2024-05-21T18:09:17+00:00",
          "updated_at": "2024-05-21T18:09:17+00:00"
        }
      ],
      "order": 1,
      "display_type": "list",
      "image_url": null,
      "dynamic": false
    }
  ]
}

Gets a specific category including packages, populating a dynamic category for the given basket.

get

Gets information about a category and returns the packages in that category. When the category is dynamic and basketIdent is provided, the category is populated with the packages associated with that basket.

If a basket identifier is not provided, a dynamic category will be empty as the basket is required to relate packages to the category.

Path parameters

categoryIdstringRequired

The ID or slug of the category to fetch.

Example: 1234

basketIdentstringRequired

The basket identifier.

Example: c00244-d2ac2e77418a55b25292a6bc7a719ad9c529ba2c

Responses

200

Successful response returns the category with package information.

application/json

get/categories/{categoryId}?includePackages=1&basketIdent={basketIdent}

HTTPcURLJavaScriptPython

GET /api/accounts/categories/{categoryId}?includePackages=1&basketIdent={basketIdent} HTTP/1.1
Host: headless.tebex.io/
Accept: */*

200

Successful response returns the category with package information.

{
  "data": [
    {
      "id": 2678660,
      "name": "Test",
      "slug": "text",
      "parent": {},
      "tiered": false,
      "active_tier": {
        "id": 40796,
        "created_at": "2025-05-14T13:48:56.000000Z",
        "username_id": "text",
        "package": {
          "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",
          "prorate_price": 1,
          "discount": 0,
          "disable_quantity": false,
          "disable_gifting": false,
          "expiration_date": null,
          "media": [],
          "order": 1,
          "slug": "text",
          "user_limit": 1,
          "creator_meta_data": {},
          "options": [],
          "variables": [],
          "created_at": "2024-05-21T18:09:17+00:00",
          "updated_at": "2024-05-21T18:09:17+00:00"
        },
        "active": true,
        "recurring_payment_reference": "tbx-r-757925142",
        "next_payment_date": "2025-06-14T13:48:56+00:00",
        "status": {
          "id": 2,
          "description": "Active"
        },
        "pending_downgrade_package": {
          "id": 6834820,
          "name": "Bronze"
        }
      },
      "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",
          "prorate_price": 1,
          "discount": 0,
          "disable_quantity": false,
          "disable_gifting": false,
          "expiration_date": null,
          "media": [],
          "order": 1,
          "slug": "text",
          "user_limit": 1,
          "creator_meta_data": {},
          "options": [],
          "variables": [],
          "created_at": "2024-05-21T18:09:17+00:00",
          "updated_at": "2024-05-21T18:09:17+00:00"
        }
      ],
      "order": 1,
      "display_type": "list",
      "image_url": null,
      "dynamic": false
    }
  ]
}

Get package

get

Gets a package from a webstore by its ID or slug.

Note: this endpoint does not support packages belonging to dynamic categories. Use the category endpoints with includePackages=1 and basketIdent to fetch dynamic packages.

Path parameters

packageIdstringRequired

The package's ID or slug.

Example: 1272441812

Responses

200

Successful response returns the package information.

application/json

get/packages/{packageId}

HTTPcURLJavaScriptPython

GET /api/accounts/packages/{packageId} HTTP/1.1
Host: headless.tebex.io/
Accept: */*

200

Successful response returns the package information.

{
  "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",
      "prorate_price": 1,
      "discount": 0,
      "disable_quantity": false,
      "disable_gifting": false,
      "expiration_date": null,
      "media": [],
      "order": 1,
      "slug": "text",
      "user_limit": 1,
      "creator_meta_data": {},
      "options": [],
      "variables": [],
      "created_at": "2024-05-21T18:09:17+00:00",
      "updated_at": "2024-05-21T18:09:17+00:00"
    }
  ]
}

Get all packages

get

Gets all packages from a webstore.

Note: this endpoint does not support packages belonging to dynamic categories. Use the category endpoints with includePackages=1 and basketIdent to fetch dynamic packages.

Responses

200

Successful response returns a list of package information.

application/json

get/packages

HTTPcURLJavaScriptPython

GET /api/accounts/packages HTTP/1.1
Host: headless.tebex.io/
Accept: */*

200

Successful response returns a list of package information.

{
  "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",
      "prorate_price": 1,
      "discount": 0,
      "disable_quantity": false,
      "disable_gifting": false,
      "expiration_date": null,
      "media": [],
      "order": 1,
      "slug": "text",
      "user_limit": 1,
      "creator_meta_data": {},
      "options": [],
      "variables": [],
      "created_at": "2024-05-21T18:09:17+00:00",
      "updated_at": "2024-05-21T18:09:17+00:00"
    }
  ]
}

Get packages

get

Gets all packages from a webstore.

Path parameters

ipAddressstringRequired

An IP address can be provided with authenticated requests

Example: 127.0.0.1

Responses

200

Successful response returns a list of package information.

application/json

422

The provided request is invalid.

get/packages?ipAddress={ipAddress}

HTTPcURLJavaScriptPython

GET /api/accounts/packages?ipAddress={ipAddress} HTTP/1.1
Host: headless.tebex.io/
Accept: */*

{
  "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",
      "prorate_price": 1,
      "discount": 0,
      "disable_quantity": false,
      "disable_gifting": false,
      "expiration_date": null,
      "media": [],
      "order": 1,
      "slug": "text",
      "user_limit": 1,
      "creator_meta_data": {},
      "options": [],
      "variables": [],
      "created_at": "2024-05-21T18:09:17+00:00",
      "updated_at": "2024-05-21T18:09:17+00:00"
    }
  ]
}

Get packages available for basket

get

Gets all packages available to the provided basket.

Path parameters

basketIdentstringRequired

The basket identifier.

Example: c00244-d2ac2e77418a55b25292a6bc7a719ad9c529ba2c

Responses

200

Successful response returns a list of package information.

application/json

422

The provided request is invalid.

get/packages?basketIdent={basketIdent}

HTTPcURLJavaScriptPython

GET /api/accounts/packages?basketIdent={basketIdent} HTTP/1.1
Host: headless.tebex.io/
Accept: */*

{
  "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",
      "prorate_price": 1,
      "discount": 0,
      "disable_quantity": false,
      "disable_gifting": false,
      "expiration_date": null,
      "media": [],
      "order": 1,
      "slug": "text",
      "user_limit": 1,
      "creator_meta_data": {},
      "options": [],
      "variables": [],
      "created_at": "2024-05-21T18:09:17+00:00",
      "updated_at": "2024-05-21T18:09:17+00:00"
    }
  ]
}

Get packages available for IP and basket

get

Gets all packages from a webstore.

Path parameters

basketIdentstringRequired

The basket identifier.

Example: c00244-d2ac2e77418a55b25292a6bc7a719ad9c529ba2c

ipAddressstringRequired

An IP address can be provided with authenticated requests.

Example: 127.0.0.1

Responses

200

Successful response returns a list of package information.

application/json

422

The provided request is invalid.

get/packages?ipAddress={ipAddress}&basketIdent={basketIdent}

HTTPcURLJavaScriptPython

GET /api/accounts/packages?ipAddress={ipAddress}&basketIdent={basketIdent} HTTP/1.1
Host: headless.tebex.io/
Accept: */*

{
  "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",
      "prorate_price": 1,
      "discount": 0,
      "disable_quantity": false,
      "disable_gifting": false,
      "expiration_date": null,
      "media": [],
      "order": 1,
      "slug": "text",
      "user_limit": 1,
      "creator_meta_data": {},
      "options": [],
      "variables": [],
      "created_at": "2024-05-21T18:09:17+00:00",
      "updated_at": "2024-05-21T18:09:17+00:00"
    }
  ]
}

Apply a creator code

post

Applies a creator code to a basket.

Path parameters

basketIdentstringRequired

The basket identifier.

Example: c00244-d2ac2e77418a55b25292a6bc7a719ad9c529ba2c

Body

application/json

creator_codestringOptionalExample: Academy10

Responses

200

Successful response returns a success object

application/json

successbooleanOptionalExample: true

messagestringOptionalExample: Creator code applied successfully

422

The provided request is invalid. The error response will include detail as to which parameter failed validation.

post/baskets/{basketIdent}/creator-codes

HTTPcURLJavaScriptPython

POST /api/accounts/baskets/{basketIdent}/creator-codes HTTP/1.1
Host: headless.tebex.io/
Content-Type: application/json
Accept: */*
Content-Length: 28

{
  "creator_code": "Academy10"
}

{
  "success": true,
  "message": "Creator code applied successfully"
}

Remove a creator code from the basket.

post

Applies a creator code to a basket.

Path parameters

basketIdentstringRequired

The basket identifier.

Example: c00244-d2ac2e77418a55b25292a6bc7a719ad9c529ba2c

Responses

200

Creator code removed successfully.

No content

422

The provided request is invalid. The error response will include detail as to which parameter failed validation.

post/baskets/{basketIdent}/creator-codes/remove

HTTPcURLJavaScriptPython

POST /api/accounts/baskets/{basketIdent}/creator-codes/remove HTTP/1.1
Host: headless.tebex.io/
Accept: */*

No content

Apply a gift card

post

Applies a creator code to a basket.

Path parameters

basketIdentstringRequired

The basket identifier.

Example: c00244-d2ac2e77418a55b25292a6bc7a719ad9c529ba2c

Body

application/json

card_numberstringOptionalExample: 0127 0244 7210 1111

Responses

200

Successful response returns a success message.

application/json

successbooleanOptionalExample: true

messagestringOptionalExample: Gift card applied successfully

post/baskets/{basketIdent}/giftcards

HTTPcURLJavaScriptPython

POST /api/accounts/baskets/{basketIdent}/giftcards HTTP/1.1
Host: headless.tebex.io/
Content-Type: application/json
Accept: */*
Content-Length: 37

{
  "card_number": "0127 0244 7210 1111"
}

200

Successful response returns a success message.

{
  "success": true,
  "message": "Gift card applied successfully"
}

Remove a gift card from the basket.

post

Removes a gift card from the basket.

Path parameters

basketIdentstringRequired

The basket identifier.

Example: c00244-d2ac2e77418a55b25292a6bc7a719ad9c529ba2c

Body

application/json

card_numberstringOptionalExample: 0127 0244 7210 1111

Responses

200

Gift card removed successfully.

No content

422

The provided request is invalid. The error response will include detail as to which parameter failed validation.

post/baskets/{basketIdent}/giftcards/remove

HTTPcURLJavaScriptPython

POST /api/accounts/baskets/{basketIdent}/giftcards/remove HTTP/1.1
Host: headless.tebex.io/
Content-Type: application/json
Accept: */*
Content-Length: 37

{
  "card_number": "0127 0244 7210 1111"
}

No content

Apply a coupon

post

Applies a coupon to a basket.

Path parameters

basketIdentstringRequired

The basket identifier.

Example: c00244-d2ac2e77418a55b25292a6bc7a719ad9c529ba2c

Body

application/json

coupon_codestringOptionalExample: Academy10

Responses

200

Successful response returns a success message.

application/json

successbooleanOptionalExample: true

messagestringOptionalExample: Coupon applied successfully

post/baskets/{basketIdent}/coupons

HTTPcURLJavaScriptPython

POST /api/accounts/baskets/{basketIdent}/coupons HTTP/1.1
Host: headless.tebex.io/
Content-Type: application/json
Accept: */*
Content-Length: 27

{
  "coupon_code": "Academy10"
}

200

Successful response returns a success message.

{
  "success": true,
  "message": "Coupon applied successfully"
}

Remove a coupon from the basket.

post

Removes a coupon code from a basket

Path parameters

basketIdentstringRequired

The basket identifier.

Example: c00244-d2ac2e77418a55b25292a6bc7a719ad9c529ba2c

Body

application/json

coupon_codestringOptionalExample: Academy10

Responses

200

Successful response.

No content

422

The provided request is invalid. The error response will include detail as to which parameter failed validation.

post/baskets/{basketIdent}/coupons/remove

HTTPcURLJavaScriptPython

POST /api/accounts/baskets/{basketIdent}/coupons/remove HTTP/1.1
Host: headless.tebex.io/
Content-Type: application/json
Accept: */*
Content-Length: 27

{
  "coupon_code": "Academy10"
}

No content

Add package to basket

post

Add a package with the given ID to the basket.

To add a package belonging to a dynamic category, set dynamic to true. Without this property the API will treat the request as a normal package ID.

Path parameters

basketIdentstringRequired

The basket identifier.

Example: c00244-d2ac2e77418a55b25292a6bc7a719ad9c529ba2c

Body

application/json

package_idstringOptionalExample: 6276316

quantityintegerOptionalExample: 1

dynamicbooleanOptional

Set to true when adding a package that belongs to a dynamic category. When omitted, the API acts as if a normal package ID was provided.

Example: true

Responses

200

Successful response.

application/json

idstringOptionalExample: 244127617

identstringOptionalExample: 1a-55fff4107740a1f40d844ff89607557f45bfafb3

completebooleanOptionalExample: false

emailstring · nullableOptionalExample: [e-mail]

usernamestring · nullableOptional

creator_codestringOptional

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_urlstringOptionalExample: https://tebex.io

complete_urlstring · nullableOptional

complete_auto_redirectbooleanOptionalExample: false

countrystringOptional

A two-character country code

Example: US

ipstringOptionalExample: 127.0.0.1

username_idintegerOptionalExample: 127244

base_pricenumber · floatOptionalExample: 1.27

sales_taxnumber · floatOptionalExample: 0.11

total_pricenumber · floatOptionalExample: 1.38

currencystringOptional

A 3 character currency code

Example: USD

customobject · nullableOptionalExample: {"foo":"bar","ref":1234}

422

The provided request is invalid. The error response will include detail as to which parameter failed validation.

post/{basketIdent}/packages

HTTPcURLJavaScriptPython

POST /api/baskets/{basketIdent}/packages HTTP/1.1
Host: headless.tebex.io
Content-Type: application/json
Accept: */*
Content-Length: 50

{
  "package_id": 6276316,
  "quantity": 1,
  "dynamic": true
}

{
  "id": 244127617,
  "ident": "1a-55fff4107740a1f40d844ff89607557f45bfafb3",
  "complete": false,
  "email": "[e-mail]",
  "username": null,
  "coupons": [
    {
      "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": [
    {
      "id": 1,
      "description": "100 coins added to your character",
      "image": "https://tebex.io/path/to/image.png",
      "name": "100 Coins",
      "slug": "100-coins",
      "in_basket": {
        "quantity": 2,
        "price": 1,
        "gift_username_id": "text",
        "gift_username": "text"
      },
      "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"
  }
}

Remove a package from a basket

post

Remove the given package ID from the basket.

Path parameters

basketIdentstringRequired

The basket identifier.

Example: c00244-d2ac2e77418a55b25292a6bc7a719ad9c529ba2c

Body

application/json

package_idstringOptionalExample: 6276316

Responses

200

Successful response returns the basket.

application/json

idstringOptionalExample: 244127617

identstringOptionalExample: 1a-55fff4107740a1f40d844ff89607557f45bfafb3

completebooleanOptionalExample: false

emailstring · nullableOptionalExample: [e-mail]

usernamestring · nullableOptional

creator_codestringOptional

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_urlstringOptionalExample: https://tebex.io

complete_urlstring · nullableOptional

complete_auto_redirectbooleanOptionalExample: false

countrystringOptional

A two-character country code

Example: US

ipstringOptionalExample: 127.0.0.1

username_idintegerOptionalExample: 127244

base_pricenumber · floatOptionalExample: 1.27

sales_taxnumber · floatOptionalExample: 0.11

total_pricenumber · floatOptionalExample: 1.38

currencystringOptional

A 3 character currency code

Example: USD

customobject · nullableOptionalExample: {"foo":"bar","ref":1234}

422

The provided request is invalid. The error response will include detail as to which parameter failed validation.

post/{basketIdent}/packages/remove

HTTPcURLJavaScriptPython

POST /api/baskets/{basketIdent}/packages/remove HTTP/1.1
Host: headless.tebex.io
Content-Type: application/json
Accept: */*
Content-Length: 22

{
  "package_id": 6276316
}

{
  "id": 244127617,
  "ident": "1a-55fff4107740a1f40d844ff89607557f45bfafb3",
  "complete": false,
  "email": "[e-mail]",
  "username": null,
  "coupons": [
    {
      "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": [
    {
      "id": 1,
      "description": "100 coins added to your character",
      "image": "https://tebex.io/path/to/image.png",
      "name": "100 Coins",
      "slug": "100-coins",
      "in_basket": {
        "quantity": 2,
        "price": 1,
        "gift_username_id": "text",
        "gift_username": "text"
      },
      "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"
  }
}

Update package quantity

put

Sets the quantity of the given item in the basket. The user must be logged in before the quantity can be changed.

Path parameters

basketIdentstringRequired

The basket identifier.

Example: c00244-d2ac2e77418a55b25292a6bc7a719ad9c529ba2c

Body

application/json

quantityintegerOptionalExample: 1

Responses

200

Successful response.

No content

422

The provided request is invalid. The error response will include detail as to which parameter failed validation.

put/{basketIdent}/packages/{packageId}

HTTPcURLJavaScriptPython

PUT /api/baskets/{basketIdent}/packages/{packageId} HTTP/1.1
Host: headless.tebex.io
Content-Type: application/json
Accept: */*
Content-Length: 14

{
  "quantity": 1
}

No content

Update user's tier to a new package

patch

Updates a tier to a new package. A recurring payment updated webhook is sent when an update is successful.

Authorizations

basicAuth

AuthorizationstringRequired

Path parameters

tierIdintegerRequired

The tier identifier

Example: 6276316

Body

application/json

package_idintegerOptionalExample: 6834822

Responses

200

Successful response.

application/json

successbooleanOptionalExample: true

messagestringOptionalExample: Tier successfully upgraded, please allow a few moments for your changes to take effect.

patch/tiers/{tierId}

HTTPcURLJavaScriptPython

PATCH /api/accounts/tiers/{tierId} HTTP/1.1
Host: headless.tebex.io/
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 22

{
  "package_id": 6834822
}

200

Successful response.

{
  "success": true,
  "message": "Tier successfully upgraded, please allow a few moments for your changes to take effect."
}

Retrieves the available sidebar modules.

get

Retrieves the available sidebar modules configured for the store.

Path parameters

tokenstringRequired

The webstore identifier.

Example: some-uuid

Responses

200

Successful response.

application/json

get/sidebar

HTTPcURLJavaScriptPython

GET /api/accounts/sidebar HTTP/1.1
Host: headless.tebex.io/
Accept: */*

200

Successful response.

{
  "data": [
    {
      "id": 1,
      "type": null,
      "start_time": "2026-07-11T01:21:21.752Z",
      "end_time": null,
      "data": {
        "header": "Top Customer",
        "username": "Test",
        "username_id": "d8d5a9237b2043d8883b1150148d6955",
        "total": 1
      }
    }
  ]
}