Endpoints
Gets the webstore associated with the provided identifier.
The webstore identifier.
some-uuid
GET /api/accounts/{token} HTTP/1.1
Host: headless.tebex.io
Accept: */*
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",
"created_at": "2023-05-25T09:49:37+00:00"
}
}
Gets a list of custom pages associated with the webstore. These contain a content
variable with the HTML content of the page.
The webstore identifier.
some-uuid
GET /api/accounts/{token}/pages HTTP/1.1
Host: headless.tebex.io
Accept: */*
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> > <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>"
}
]
}
Gets a basket associated with the provided identifier.
The webstore identifier.
t66x-7cd928b1e9312709e6810edac6dc1fd1eefc57cb
The basket identifier.
c00244-d2ac2e77418a55b25292a6bc7a719ad9c529ba2c
GET /api/accounts/{token}/baskets/{basketIdent} HTTP/1.1
Host: headless.tebex.io
Accept: */*
Successful response returns the basket information.
{
"data": {
"id": 244127617,
"ident": "1a-55fff4107740a1f40d844ff89607557f45bfafb3",
"complete": false,
"email": "[email protected]",
"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"
}
}
}
Creates a new basket for use during checkout.
The webstore identifier.
t66x-7cd928b1e9312709e6810edac6dc1fd1eefc57cb
A URL the user can return to when checkout is completed.
https://example.tebex.io/thank-you
A URL the user can return to when cancelling checkout.
https://tebex.io/
Custom data you wish to associate with the basket. This data will be included with webhook responses and GET requests associated with the Basket.
{"foo":"bar"}
True if the user should automatically be redirected to the relevant complete/cancel URL
true
POST /api/accounts/{token}/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": "[email protected]",
"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"
}
}
}
Fetches a basket's auth URL.
The webstore identifier.
t66x-7cd928b1e9312709e6810edac6dc1fd1eefc57cb
The basket identifier.
c00244-d2ac2e77418a55b25292a6bc7a719ad9c529ba2c
The URL you would like to redirect the user to after successful basket authentication.
https://example.tebex.io/
GET /api/accounts/{token}/baskets/{basketIdent}/auth HTTP/1.1
Host: headless.tebex.io
Accept: */*
[
{
"name": "FiveM",
"url": "https://ident.tebex.io/"
}
]
Gets all categories from a webstore. This does not include package information. To include package information, add ?includePackages=1
to the URL.
The webstore identifier.
t66x-7cd928b1e9312709e6810edac6dc1fd1eefc57cb
GET /api/accounts/{token}/categories HTTP/1.1
Host: headless.tebex.io
Accept: */*
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,
"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,
"created_at": "2024-05-21T18:09:17+00:00",
"updated_at": "2024-05-21T18:09:17+00:00"
}
],
"order": 1,
"display_type": "list"
}
]
}
Gets all categories from a webstore including packages.
The webstore identifier.
t66x-7cd928b1e9312709e6810edac6dc1fd1eefc57cb
GET /api/accounts/{token}/categories HTTP/1.1
Host: headless.tebex.io
Accept: */*
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,
"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,
"created_at": "2024-05-21T18:09:17+00:00",
"updated_at": "2024-05-21T18:09:17+00:00"
}
],
"order": 1,
"display_type": "list"
}
]
}
Gets information about a category and returns the packages in that category.
The webstore identifier.
t66x-7cd928b1e9312709e6810edac6dc1fd1eefc57cb
The ID of the category to fetch.
127244343
GET /api/accounts/{token}/categories/{categoryId} HTTP/1.1
Host: headless.tebex.io
Accept: */*
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,
"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,
"created_at": "2024-05-21T18:09:17+00:00",
"updated_at": "2024-05-21T18:09:17+00:00"
}
],
"order": 1,
"display_type": "list"
}
]
}
Gets information about a category and returns the packages in that category.
The webstore identifier.
t66x-7cd928b1e9312709e6810edac6dc1fd1eefc57cb
The ID of the category to fetch.
127244343
GET /api/accounts/{token}/categories/{categoryId} HTTP/1.1
Host: headless.tebex.io
Accept: */*
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,
"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,
"created_at": "2024-05-21T18:09:17+00:00",
"updated_at": "2024-05-21T18:09:17+00:00"
}
],
"order": 1,
"display_type": "list"
}
]
}
Gets a package from a webstore by ID.
The webstore identifier.
t66x-7cd928b1e9312709e6810edac6dc1fd1eefc57cb
The package's ID.
1272441812
GET /api/accounts/{token}/packages/{packageId} HTTP/1.1
Host: headless.tebex.io
Accept: */*
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,
"created_at": "2024-05-21T18:09:17+00:00",
"updated_at": "2024-05-21T18:09:17+00:00"
}
]
}
Gets all packages from a webstore.
The webstore identifier.
t66x-7cd928b1e9312709e6810edac6dc1fd1eefc57cb
GET /api/accounts/{token}/packages HTTP/1.1
Host: headless.tebex.io
Accept: */*
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,
"created_at": "2024-05-21T18:09:17+00:00",
"updated_at": "2024-05-21T18:09:17+00:00"
}
]
}
Gets all packages from a webstore.
The webstore identifier.
t66x-7cd928b1e9312709e6810edac6dc1fd1eefc57cb
An IP address can be provided with authenticated requests.
127.0.0.1
GET /api/accounts/{token}/packages 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,
"created_at": "2024-05-21T18:09:17+00:00",
"updated_at": "2024-05-21T18:09:17+00:00"
}
]
}
Gets all packages from a webstore.
The webstore identifier.
t66x-7cd928b1e9312709e6810edac6dc1fd1eefc57cb
The basket identifier.
c00244-d2ac2e77418a55b25292a6bc7a719ad9c529ba2c
GET /api/accounts/{token}/packages 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,
"created_at": "2024-05-21T18:09:17+00:00",
"updated_at": "2024-05-21T18:09:17+00:00"
}
]
}
Gets all packages from a webstore.
The webstore identifier.
t66x-7cd928b1e9312709e6810edac6dc1fd1eefc57cb
The basket identifier.
c00244-d2ac2e77418a55b25292a6bc7a719ad9c529ba2c
An IP address can be provided with authenticated requests.
127.0.0.1
GET /api/accounts/{token}/packages 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,
"created_at": "2024-05-21T18:09:17+00:00",
"updated_at": "2024-05-21T18:09:17+00:00"
}
]
}
Applies a creator code to a basket.
The webstore identifier.
t66x-7cd928b1e9312709e6810edac6dc1fd1eefc57cb
The basket identifier.
c00244-d2ac2e77418a55b25292a6bc7a719ad9c529ba2c
Academy10
POST /api/accounts/{token}/baskets/{basketIdent}/creator-codes HTTP/1.1
Host: headless.tebex.io
Content-Type: application/json
Accept: */*
Content-Length: 28
{
"creator_code": "Academy10"
}
{
"data": {
"id": 244127617,
"ident": "1a-55fff4107740a1f40d844ff89607557f45bfafb3",
"complete": false,
"email": "[email protected]",
"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"
}
}
}
Applies a creator code to a basket.
The webstore identifier.
t66x-7cd928b1e9312709e6810edac6dc1fd1eefc57cb
The basket identifier.
c00244-d2ac2e77418a55b25292a6bc7a719ad9c529ba2c
POST /api/accounts/{token}/baskets/{basketIdent}/creator-codes/remove HTTP/1.1
Host: headless.tebex.io
Accept: */*
No content
Applies a creator code to a basket.
The webstore identifier.
t66x-7cd928b1e9312709e6810edac6dc1fd1eefc57cb
The basket identifier.
c00244-d2ac2e77418a55b25292a6bc7a719ad9c529ba2c
0127 0244 7210 1111
POST /api/accounts/{token}/baskets/{basketIdent}/giftcards HTTP/1.1
Host: headless.tebex.io
Content-Type: application/json
Accept: */*
Content-Length: 37
{
"card_number": "0127 0244 7210 1111"
}
Successful response returns the basket.
{
"data": {
"id": 244127617,
"ident": "1a-55fff4107740a1f40d844ff89607557f45bfafb3",
"complete": false,
"email": "[email protected]",
"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"
}
}
}
Removes a gift card from the basket.
The webstore identifier.
t66x-7cd928b1e9312709e6810edac6dc1fd1eefc57cb
The basket identifier.
c00244-d2ac2e77418a55b25292a6bc7a719ad9c529ba2c
0127 0244 7210 1111
POST /api/accounts/{token}/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
Applies a creator code to a basket.
The webstore identifier.
t66x-7cd928b1e9312709e6810edac6dc1fd1eefc57cb
The basket identifier.
c00244-d2ac2e77418a55b25292a6bc7a719ad9c529ba2c
Academy10
POST /api/accounts/{token}/baskets/{basketIdent}/coupons HTTP/1.1
Host: headless.tebex.io
Content-Type: application/json
Accept: */*
Content-Length: 27
{
"coupon_code": "Academy10"
}
Successful response returns the basket.
{
"data": {
"id": 244127617,
"ident": "1a-55fff4107740a1f40d844ff89607557f45bfafb3",
"complete": false,
"email": "[email protected]",
"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"
}
}
}
Removes a coupon code from a basket
The webstore identifier.
t66x-7cd928b1e9312709e6810edac6dc1fd1eefc57cb
The basket identifier.
c00244-d2ac2e77418a55b25292a6bc7a719ad9c529ba2c
POST /api/accounts/{token}/baskets/{basketIdent}/coupons/remove HTTP/1.1
Host: headless.tebex.io
Accept: */*
No content
Add a package with the given ID to the basket.
The basket identifier.
c00244-d2ac2e77418a55b25292a6bc7a719ad9c529ba2c
6276316
1
POST /api/baskets/{basketIdent}/packages HTTP/1.1
Host: headless.tebex.io
Content-Type: application/json
Accept: */*
Content-Length: 35
{
"package_id": 6276316,
"quantity": 1
}
{
"id": 244127617,
"ident": "1a-55fff4107740a1f40d844ff89607557f45bfafb3",
"complete": false,
"email": "[email protected]",
"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"
}
}
Remove the given package ID from the basket.
The basket identifier.
c00244-d2ac2e77418a55b25292a6bc7a719ad9c529ba2c
6276316
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": "[email protected]",
"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"
}
}
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.
The basket identifier.
c00244-d2ac2e77418a55b25292a6bc7a719ad9c529ba2c
The package identifier.
6276316
1
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
Updates a tier to a new package.
The webstore identifier.
some-uuid
The tier identifier
6276316
6834822
PATCH /api/accounts/{token}/tiers/{tierId} HTTP/1.1
Host: headless.tebex.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 22
{
"package_id": 6834822
}
Successful response.
{
"success": true,
"message": "Tier successfully upgraded, please allow a few moments for your changes to take effect."
}
Last updated
Was this helpful?