Overview

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

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

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

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

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

Headless API Flow

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

Packages & Listings

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

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.

get

/accounts/{token}/categories

Path parameters

tokenstringrequired

The webstore identifier.

Example: t66x-7cd928b1e9312709e6810edac6dc1fd1eefc57cb

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://headless.tebex.io/api/accounts/{token}/categories'

200

200

{
  "data": [
    {
      "id": 2678660,
      "name": "Test",
      "slug": "text",
      "parent": {},
      "description": "text",
      "order": 1,
      "display_type": "list",
      "packages": [
        {
          "id": 6276316,
          "name": "test package 101",
          "description": "<p>this is just a test. only a test. nothing more.</p>",
          "image": null,
          "type": "single",
          "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",
          "category": {
            "id": 2678660,
            "name": "Packages"
          }
        }
      ]
    }
  ]
}

Successful response returns a list of category information.

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

Gets all categories from a webstore including packages.

get

/accounts/{token}/categories?includePackages=1

Path parameters

tokenstringrequired

The webstore identifier.

Example: t66x-7cd928b1e9312709e6810edac6dc1fd1eefc57cb

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://headless.tebex.io/api/accounts/{token}/categories?includePackages=1'

200

200

{
  "data": [
    {
      "id": 2678660,
      "name": "Test",
      "slug": "text",
      "parent": {},
      "description": "text",
      "order": 1,
      "display_type": "list",
      "packages": [
        {
          "id": 6276316,
          "name": "test package 101",
          "description": "<p>this is just a test. only a test. nothing more.</p>",
          "image": null,
          "type": "single",
          "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",
          "category": {
            "id": 2678660,
            "name": "Packages"
          }
        }
      ]
    }
  ]
}

Successful response returns a list of category information.

Gets information about a specific category

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

get

/accounts/{token}/categories/{categoryId}

Path parameters

tokenstringrequired

The webstore identifier.

Example: t66x-7cd928b1e9312709e6810edac6dc1fd1eefc57cb

categoryIdstringrequired

The ID of the category to fetch.

Example: 127244343

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://headless.tebex.io/api/accounts/{token}/categories/{categoryId}'

200

200

{
  "data": [
    {
      "id": 2678660,
      "name": "Test",
      "slug": "text",
      "parent": {},
      "description": "text",
      "order": 1,
      "display_type": "list",
      "packages": [
        {
          "id": 6276316,
          "name": "test package 101",
          "description": "<p>this is just a test. only a test. nothing more.</p>",
          "image": null,
          "type": "single",
          "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",
          "category": {
            "id": 2678660,
            "name": "Packages"
          }
        }
      ]
    }
  ]
}

Successful response returns the category without package information.

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.

get

/accounts/{token}/categories/{categoryId}?includePackages=1

Path parameters

tokenstringrequired

The webstore identifier.

Example: t66x-7cd928b1e9312709e6810edac6dc1fd1eefc57cb

categoryIdstringrequired

The ID of the category to fetch.

Example: 127244343

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://headless.tebex.io/api/accounts/{token}/categories/{categoryId}?includePackages=1'

200

200

{
  "data": [
    {
      "id": 2678660,
      "name": "Test",
      "slug": "text",
      "parent": {},
      "description": "text",
      "order": 1,
      "display_type": "list",
      "packages": [
        {
          "id": 6276316,
          "name": "test package 101",
          "description": "<p>this is just a test. only a test. nothing more.</p>",
          "image": null,
          "type": "single",
          "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",
          "category": {
            "id": 2678660,
            "name": "Packages"
          }
        }
      ]
    }
  ]
}

Successful response returns the category with package information.

Fetch a package from a webstore by its identifier

Gets a package from a webstore by ID.

get

/accounts/{token}/packages/{packageId}

Path parameters

tokenstringrequired

The webstore identifier.

Example: t66x-7cd928b1e9312709e6810edac6dc1fd1eefc57cb

packageIdnumberrequired

The package's ID.

Example: 1272441812

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://headless.tebex.io/api/accounts/{token}/packages/{packageId}'

200

200

{
  "data": [
    {
      "id": 6276316,
      "name": "test package 101",
      "description": "<p>this is just a test. only a test. nothing more.</p>",
      "image": null,
      "type": "single",
      "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",
      "category": {
        "id": 2678660,
        "name": "Packages"
      }
    }
  ]
}

Successful response returns the package information.

Fetch all packages from a webstore

Gets all packages from a webstore.

get

/accounts/{token}/packages

Path parameters

tokenstringrequired

The webstore identifier.

Example: t66x-7cd928b1e9312709e6810edac6dc1fd1eefc57cb

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://headless.tebex.io/api/accounts/{token}/packages'

200

200

{
  "data": [
    {
      "id": 6276316,
      "name": "test package 101",
      "description": "<p>this is just a test. only a test. nothing more.</p>",
      "image": null,
      "type": "single",
      "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",
      "category": {
        "id": 2678660,
        "name": "Packages"
      }
    }
  ]
}

Successful response returns a list of package information.

Creating Baskets

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

Create a new basket

Creates a new basket for use during checkout.

post

/accounts/{token}/baskets

Path parameters

tokenstringrequired

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/

complete_auto_redirectboolean

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

Example: true

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.

Example: {"foo":"bar"}

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://headless.tebex.io/api/accounts/{token}/baskets' \
  --header 'Content-Type: application/json' \
  --data '{"complete_url":"https://example.tebex.io/thank-you","cancel_url":"https://tebex.io/","complete_auto_redirect":true,"custom":{"foo":"bar"}}'

200

422

200

{
  "data": {
    "id": 244127617,
    "ident": "1a-55fff4107740a1f40d844ff89607557f45bfafb3",
    "complete": false,
    "email": "[e-mail]",
    "username": null,
    "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",
    "links": {
      "payment": "https://checkout.tebex.io/api/payments/tbx-12345",
      "checkout": "https://checkout.tebex.io/checkout/1a-55fff4107740a1f40d844ff89607557f45bfafb3"
    },
    "coupons": [
      {
        "coupon_code": "Academy10"
      }
    ],
    "giftcards": [
      {
        "card_number": "0127 0244 7210 1111"
      }
    ],
    "packages": [
      {
        "qty": 2,
        "type": "single",
        "revenue_share": [
          {
            "wallet_ref": "some_wallet_reference",
            "amount": 0.5,
            "gateway_fee_percent": 50
          }
        ]
      }
    ],
    "custom": {
      "foo": "bar",
      "ref": 1234
    }
  }
}

Successful response returns the basket information.

Get authentication links for a basket.

Fetches a basket's auth URL.

get

/accounts/{token}/baskets/{basketIdent}/auth?returnUrl={returnUrl}

Path parameters

tokenstringrequired

The webstore identifier.

Example: t66x-7cd928b1e9312709e6810edac6dc1fd1eefc57cb

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

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://headless.tebex.io/api/accounts/{token}/baskets/{basketIdent}/auth?returnUrl={returnUrl}'

200

422

200

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

Successful response returns the basket auth information.

Adding and Removing Packages

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

Add a package to a basket

Add a package with the given ID to the basket.

post

/baskets/{basketIdent}/packages

Path parameters

basketIdentstringrequired

The basket identifier.

Example: c00244-d2ac2e77418a55b25292a6bc7a719ad9c529ba2c

Body

package_idstring

Example: 6276316

quantitynumber

Example: 1

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://headless.tebex.io/api/baskets/{basketIdent}/packages' \
  --header 'Content-Type: application/json' \
  --data '{"package_id":6276316,"quantity":1}'

200

422

200

{
  "id": 244127617,
  "ident": "1a-55fff4107740a1f40d844ff89607557f45bfafb3",
  "complete": false,
  "email": "[e-mail]",
  "username": null,
  "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",
  "links": {
    "payment": "https://checkout.tebex.io/api/payments/tbx-12345",
    "checkout": "https://checkout.tebex.io/checkout/1a-55fff4107740a1f40d844ff89607557f45bfafb3"
  },
  "coupons": [
    {
      "coupon_code": "Academy10"
    }
  ],
  "giftcards": [
    {
      "card_number": "0127 0244 7210 1111"
    }
  ],
  "packages": [
    {
      "qty": 2,
      "type": "single",
      "revenue_share": [
        {
          "wallet_ref": "some_wallet_reference",
          "amount": 0.5,
          "gateway_fee_percent": 50
        }
      ]
    }
  ],
  "custom": {
    "foo": "bar",
    "ref": 1234
  }
}

Successful response.

Remove a package from a basket

Remove the given package ID from the basket.

post

/baskets/{basketIdent}/packages/remove

Path parameters

basketIdentstringrequired

The basket identifier.

Example: c00244-d2ac2e77418a55b25292a6bc7a719ad9c529ba2c

Body

package_idstring

Example: 6276316

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://headless.tebex.io/api/baskets/{basketIdent}/packages/remove' \
  --header 'Content-Type: application/json' \
  --data '{"package_id":6276316}'

200

422

200

{
  "id": 244127617,
  "ident": "1a-55fff4107740a1f40d844ff89607557f45bfafb3",
  "complete": false,
  "email": "[e-mail]",
  "username": null,
  "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",
  "links": {
    "payment": "https://checkout.tebex.io/api/payments/tbx-12345",
    "checkout": "https://checkout.tebex.io/checkout/1a-55fff4107740a1f40d844ff89607557f45bfafb3"
  },
  "coupons": [
    {
      "coupon_code": "Academy10"
    }
  ],
  "giftcards": [
    {
      "card_number": "0127 0244 7210 1111"
    }
  ],
  "packages": [
    {
      "qty": 2,
      "type": "single",
      "revenue_share": [
        {
          "wallet_ref": "some_wallet_reference",
          "amount": 0.5,
          "gateway_fee_percent": 50
        }
      ]
    }
  ],
  "custom": {
    "foo": "bar",
    "ref": 1234
  }
}

Successful response returns the basket.

Coupons, Gift Cards, and Creator Codes

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

Apply a creator code to a basket.

Applies a creator code to a basket.

post

/accounts/{token}/baskets/{basketIdent}/creator-codes

Path parameters

tokenstringrequired

The webstore identifier.

Example: t66x-7cd928b1e9312709e6810edac6dc1fd1eefc57cb

basketIdentstringrequired

The basket identifier.

Example: c00244-d2ac2e77418a55b25292a6bc7a719ad9c529ba2c

Body

creator_codestring

Example: Academy10

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://headless.tebex.io/api/accounts/{token}/baskets/{basketIdent}/creator-codes' \
  --header 'Content-Type: application/json' \
  --data '{"creator_code":"Academy10"}'

200

422

200

{
  "data": {
    "id": 244127617,
    "ident": "1a-55fff4107740a1f40d844ff89607557f45bfafb3",
    "complete": false,
    "email": "[e-mail]",
    "username": null,
    "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",
    "links": {
      "payment": "https://checkout.tebex.io/api/payments/tbx-12345",
      "checkout": "https://checkout.tebex.io/checkout/1a-55fff4107740a1f40d844ff89607557f45bfafb3"
    },
    "coupons": [
      {
        "coupon_code": "Academy10"
      }
    ],
    "giftcards": [
      {
        "card_number": "0127 0244 7210 1111"
      }
    ],
    "packages": [
      {
        "qty": 2,
        "type": "single",
        "revenue_share": [
          {
            "wallet_ref": "some_wallet_reference",
            "amount": 0.5,
            "gateway_fee_percent": 50
          }
        ]
      }
    ],
    "custom": {
      "foo": "bar",
      "ref": 1234
    }
  }
}

Successful response returns the basket.

Remove a creator code from the basket.

Applies a creator code to a basket.

post

/accounts/{token}/baskets/{basketIdent}/creator-codes/remove

Path parameters

tokenstringrequired

The webstore identifier.

Example: t66x-7cd928b1e9312709e6810edac6dc1fd1eefc57cb

basketIdentstringrequired

The basket identifier.

Example: c00244-d2ac2e77418a55b25292a6bc7a719ad9c529ba2c

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://headless.tebex.io/api/accounts/{token}/baskets/{basketIdent}/creator-codes/remove'

200

422

200

No body

Creator code removed successfully.

Apply a gift card to a basket.

Applies a creator code to a basket.

post

/accounts/{token}/baskets/{basketIdent}/giftcards

Path parameters

tokenstringrequired

The webstore identifier.

Example: t66x-7cd928b1e9312709e6810edac6dc1fd1eefc57cb

basketIdentstringrequired

The basket identifier.

Example: c00244-d2ac2e77418a55b25292a6bc7a719ad9c529ba2c

Body

card_numberstring

Example: 0127 0244 7210 1111

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://headless.tebex.io/api/accounts/{token}/baskets/{basketIdent}/giftcards' \
  --header 'Content-Type: application/json' \
  --data '{"card_number":"0127 0244 7210 1111"}'

200

200

{
  "data": {
    "id": 244127617,
    "ident": "1a-55fff4107740a1f40d844ff89607557f45bfafb3",
    "complete": false,
    "email": "[e-mail]",
    "username": null,
    "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",
    "links": {
      "payment": "https://checkout.tebex.io/api/payments/tbx-12345",
      "checkout": "https://checkout.tebex.io/checkout/1a-55fff4107740a1f40d844ff89607557f45bfafb3"
    },
    "coupons": [
      {
        "coupon_code": "Academy10"
      }
    ],
    "giftcards": [
      {
        "card_number": "0127 0244 7210 1111"
      }
    ],
    "packages": [
      {
        "qty": 2,
        "type": "single",
        "revenue_share": [
          {
            "wallet_ref": "some_wallet_reference",
            "amount": 0.5,
            "gateway_fee_percent": 50
          }
        ]
      }
    ],
    "custom": {
      "foo": "bar",
      "ref": 1234
    }
  }
}

Successful response returns the basket.

Remove a gift card from the basket.

Removes a gift card from the basket.

post

/accounts/{token}/baskets/{basketIdent}/giftcards/remove

Path parameters

tokenstringrequired

The webstore identifier.

Example: t66x-7cd928b1e9312709e6810edac6dc1fd1eefc57cb

basketIdentstringrequired

The basket identifier.

Example: c00244-d2ac2e77418a55b25292a6bc7a719ad9c529ba2c

Body

card_numberstring

Example: 0127 0244 7210 1111

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://headless.tebex.io/api/accounts/{token}/baskets/{basketIdent}/giftcards/remove' \
  --header 'Content-Type: application/json' \
  --data '{"card_number":"0127 0244 7210 1111"}'

200

422

200

No body

Gift card removed successfully.

Apply a coupon to a basket.

Applies a creator code to a basket.

post

/accounts/{token}/baskets/{basketIdent}/coupons

Path parameters

tokenstringrequired

The webstore identifier.

Example: t66x-7cd928b1e9312709e6810edac6dc1fd1eefc57cb

basketIdentstringrequired

The basket identifier.

Example: c00244-d2ac2e77418a55b25292a6bc7a719ad9c529ba2c

Body

coupon_codestring

Example: Academy10

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://headless.tebex.io/api/accounts/{token}/baskets/{basketIdent}/coupons' \
  --header 'Content-Type: application/json' \
  --data '{"coupon_code":"Academy10"}'

200

200

{
  "data": {
    "id": 244127617,
    "ident": "1a-55fff4107740a1f40d844ff89607557f45bfafb3",
    "complete": false,
    "email": "[e-mail]",
    "username": null,
    "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",
    "links": {
      "payment": "https://checkout.tebex.io/api/payments/tbx-12345",
      "checkout": "https://checkout.tebex.io/checkout/1a-55fff4107740a1f40d844ff89607557f45bfafb3"
    },
    "coupons": [
      {
        "coupon_code": "Academy10"
      }
    ],
    "giftcards": [
      {
        "card_number": "0127 0244 7210 1111"
      }
    ],
    "packages": [
      {
        "qty": 2,
        "type": "single",
        "revenue_share": [
          {
            "wallet_ref": "some_wallet_reference",
            "amount": 0.5,
            "gateway_fee_percent": 50
          }
        ]
      }
    ],
    "custom": {
      "foo": "bar",
      "ref": 1234
    }
  }
}

Successful response returns the basket.

Remove a coupon from the basket.

Removes a coupon code from a basket

post

/accounts/{token}/baskets/{basketIdent}/coupons/remove

Path parameters

tokenstringrequired

The webstore identifier.

Example: t66x-7cd928b1e9312709e6810edac6dc1fd1eefc57cb

basketIdentstringrequired

The basket identifier.

Example: c00244-d2ac2e77418a55b25292a6bc7a719ad9c529ba2c

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://headless.tebex.io/api/accounts/{token}/baskets/{basketIdent}/coupons/remove'

200

422

200

No body

Successful response.

Checkout

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

Fetch a basket from a webstore by its identifier

Gets a basket associated with the provided identifier.

get

/accounts/{token}/baskets/{basketIdent}

Path parameters

tokenstringrequired

The webstore identifier.

Example: t66x-7cd928b1e9312709e6810edac6dc1fd1eefc57cb

basketIdentstringrequired

The basket identifier.

Example: c00244-d2ac2e77418a55b25292a6bc7a719ad9c529ba2c

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://headless.tebex.io/api/accounts/{token}/baskets/{basketIdent}'

200

200

{
  "data": {
    "id": 244127617,
    "ident": "1a-55fff4107740a1f40d844ff89607557f45bfafb3",
    "complete": false,
    "email": "[e-mail]",
    "username": null,
    "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",
    "links": {
      "payment": "https://checkout.tebex.io/api/payments/tbx-12345",
      "checkout": "https://checkout.tebex.io/checkout/1a-55fff4107740a1f40d844ff89607557f45bfafb3"
    },
    "coupons": [
      {
        "coupon_code": "Academy10"
      }
    ],
    "giftcards": [
      {
        "card_number": "0127 0244 7210 1111"
      }
    ],
    "packages": [
      {
        "qty": 2,
        "type": "single",
        "revenue_share": [
          {
            "wallet_ref": "some_wallet_reference",
            "amount": 0.5,
            "gateway_fee_percent": 50
          }
        ]
      }
    ],
    "custom": {
      "foo": "bar",
      "ref": 1234
    }
  }
}

Successful response returns the basket information.

Starter Template

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

Examples

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

MCC Island

https://store.mccisland.net

Power Scripts

https://power-scripts.com