Overview

Develop advanced custom checkout experiences.

The Checkout API is designed to allow creators to use Tebex's Merchant of Record platform without the need to use a Tebex-powered webstore.

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

This means creators can create baskets with custom products (as opposed to pre-created products on our webstore platform), and send customers directly to the checkout flow to proceed with payment.

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

Using the Checkout API requires prior approval from our compliance teams. Please note that the Checkout API is not available to some UGC creators, such as those on FiveM or RedM.

Terminology

Term	Description
Basket	To start a transaction, a basket must be created. The basket, similar to a standard eCommerce basket will contain the items that the customer is purchasing
Ident	A string identifier representing the basket

Checkout API Flow

Below is the expected flow your application should follow when implementing the Checkout API. This should be considered a general guideline. For a full list of endpoints available, see the Endpoints page.

You have two options for implementing Checkout API. We include a Checkout request where all data about the customer and their desired packages can be provided in one request.

Option 1. Using the Checkout Request

If your app has existing basket functionality, we recommend using a Checkout request. You can send the details of your customer, basket, and sale information all in one request:

Create a checkout request

This API call allows the complete checkout flow (create basket, add items, add sale) to be made in a single API call, for when the Seller is managing the basket locally. This endpoint requires prior approval - please contact your account manager.

post

/checkout

Authorizations

Body

saleobject

itemsobject[]required

An array of Packages in the basket.

basketobjectrequired

An object containing the customer's information, relevant links, and any custom tracking data.

Example: {"first_name":"Neil","last_name":"McNeil","email":"[e-mail]","return_url":"https://tebex.io","complete_url":"https://tebex.io","custom":{"foo":"bar","trackingId":127,"list":["1","2","3"]}}

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://checkout.tebex.io/api/checkout' \
  --header 'Authorization: Basic username:password' \
  --header 'Content-Type: application/json'

200

400

200

{
  "ident": "1a-55fff4107740a1f40d844ff89607557f45bfafb3",
  "expire": "2022-10-25 15:15:40",
  "price": 1.27,
  "priceDetails": {
    "fullPrice": 1.4,
    "subTotal": 1.27,
    "total": 1.4,
    "tax": 0.13,
    "balance": 0,
    "roundUp": null,
    "discounts": [],
    "surcharges": [],
    "sales": [],
    "giftcards": []
  },
  "isPaymentMethodUpdate": false,
  "returnUrl": null,
  "complete": false,
  "tax": 1,
  "username": null,
  "address": {
    "name": "Ted Tebex",
    "first_name": "Ted",
    "last_name": "Tebex",
    "address": "37 Broadhurst Gardens, London, United Kingdom, NW6 3QT",
    "email": "[e-mail]",
    "state_id": null,
    "country": "UK",
    "postal_code": "NW6 3QT"
  },
  "fingerprint": "",
  "creator_code": "text",
  "roundup": false,
  "cancel_url": "https://tebex.io",
  "complete_url": null,
  "complete_auto_redirect": false,
  "links": {
    "payment": "https://checkout.tebex.io/api/payments/tbx-12345",
    "checkout": "https://checkout.tebex.io/checkout/1a-55fff4107740a1f40d844ff89607557f45bfafb3"
  },
  "discounts": [
    {}
  ],
  "coupons": [
    {}
  ],
  "giftcards": [
    {}
  ],
  "rows": [
    {
      "id": 173125385,
      "basket": 725572301,
      "package": null,
      "override": 0,
      "quantity": 2,
      "server": null,
      "price": 1.27,
      "gift_username_id": null,
      "options": null,
      "recurring": false,
      "recurring_period": null,
      "recurring_next_payment_date": null,
      "custom": null,
      "image_url": null,
      "recurring_price": null,
      "meta": {
        "name": "1000 Gold",
        "rowprice": 2.54,
        "initialprice": 1.27,
        "isCumulative": false,
        "requiresAny": false,
        "category": false,
        "producesGiftCard": false,
        "allowsGiftCards": true,
        "hasDeliverables": false,
        "downloadLink": "",
        "hasSellerProtection": true,
        "itemType": null,
        "image": null,
        "realprice": 1.27,
        "requiredPackages": [],
        "servers": [],
        "deliverableTypes": [],
        "revenue_share": [],
        "limits": {
          "packageExpiryTime": 0,
          "user": {
            "enabled": false,
            "timestamp": 0,
            "limit": false
          },
          "global": {
            "enabled": false,
            "timestamp": 0,
            "limit": false
          }
        }
      }
    }
  ],
  "custom": {
    "foo": "bar",
    "ref": 1234
  }
}

Successfully created basket. The basket will be returned with links containing the URLs you should direct the customer to in order to complete payment.

Option 2. Using the Tebex Basket

If you do not have existing basket functionality in your app, you can use the Checkout API to fully manage the customer's basket on Tebex:

1. Create a basket for the customer.

   • Your app should save the ident value for reference later, as this is the identifier for this customer's basket.

Create a basket that can be used to pay for items

This will create and return a Basket that can be paid for by redirecting the user to links.checkout

post

/baskets

Authorizations

Body

return_urlstring

The URL a customer can return to without completing checkout

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

complete_urlstring

URL the customer can return to after completing payment

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

first_namestring

The first name of the customer

Example: Neil

last_namestring

The last name of the customer

Example: McNeil

emailstring

The email address of the customer

Example: [e-mail]

expires_atstring

An ISO8601 formatted date. After this date the basket cannot be used to checkout.

Example: 2025-01-27T18:09:51Z

complete_auto_redirectboolean

Automatically redirect to the complete_url provided

Example: true

countrystring

An ISO 3166-1 alpha-2 character code representing the customer's country.

Example: US

creator_codestring

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

ipstring

The IP address of the customer using this basket. Provide the IP if creating a basket on your server backend.

Example: 1.2.3.4

customobject

Any custom data to be passed through the request. This will be returned in a post-completion webhook.

Example: {"foo":"bar"}

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://checkout.tebex.io/api/baskets' \
  --header 'Authorization: Basic username:password' \
  --header 'Content-Type: application/json' \
  --data '{"return_url":"https://example.tebex.io/","complete_url":"https://example.tebex.io/complete","first_name":"Neil","last_name":"McNeil","email":"[e-mail]","expires_at":"2025-01-27T18:09:51Z","complete_auto_redirect":true,"country":"US","creator_code":null,"ip":"1.2.3.4","custom":{"foo":"bar"}}'

200

200

{
  "ident": "1a-55fff4107740a1f40d844ff89607557f45bfafb3",
  "expire": "2022-10-25 15:15:40",
  "price": 1.27,
  "priceDetails": {
    "fullPrice": 1.4,
    "subTotal": 1.27,
    "total": 1.4,
    "tax": 0.13,
    "balance": 0,
    "roundUp": null,
    "discounts": [],
    "surcharges": [],
    "sales": [],
    "giftcards": []
  },
  "isPaymentMethodUpdate": false,
  "returnUrl": null,
  "complete": false,
  "tax": 1,
  "username": null,
  "address": {
    "name": "Ted Tebex",
    "first_name": "Ted",
    "last_name": "Tebex",
    "address": "37 Broadhurst Gardens, London, United Kingdom, NW6 3QT",
    "email": "[e-mail]",
    "state_id": null,
    "country": "UK",
    "postal_code": "NW6 3QT"
  },
  "fingerprint": "",
  "creator_code": "text",
  "roundup": false,
  "cancel_url": "https://tebex.io",
  "complete_url": null,
  "complete_auto_redirect": false,
  "links": {
    "payment": "https://checkout.tebex.io/api/payments/tbx-12345",
    "checkout": "https://checkout.tebex.io/checkout/1a-55fff4107740a1f40d844ff89607557f45bfafb3"
  },
  "discounts": [
    {}
  ],
  "coupons": [
    {}
  ],
  "giftcards": [
    {}
  ],
  "rows": [
    {
      "id": 173125385,
      "basket": 725572301,
      "package": null,
      "override": 0,
      "quantity": 2,
      "server": null,
      "price": 1.27,
      "gift_username_id": null,
      "options": null,
      "recurring": false,
      "recurring_period": null,
      "recurring_next_payment_date": null,
      "custom": null,
      "image_url": null,
      "recurring_price": null,
      "meta": {
        "name": "1000 Gold",
        "rowprice": 2.54,
        "initialprice": 1.27,
        "isCumulative": false,
        "requiresAny": false,
        "category": false,
        "producesGiftCard": false,
        "allowsGiftCards": true,
        "hasDeliverables": false,
        "downloadLink": "",
        "hasSellerProtection": true,
        "itemType": null,
        "image": null,
        "realprice": 1.27,
        "requiredPackages": [],
        "servers": [],
        "deliverableTypes": [],
        "revenue_share": [],
        "limits": {
          "packageExpiryTime": 0,
          "user": {
            "enabled": false,
            "timestamp": 0,
            "limit": false
          },
          "global": {
            "enabled": false,
            "timestamp": 0,
            "limit": false
          }
        }
      }
    }
  ],
  "custom": {
    "foo": "bar",
    "ref": 1234
  }
}

Basket created successfully

1. Add or remove packages from the customer's basket as desired.

Add a package to the basket

This adds a package (an object describing the product) to the basket {ident}. For subscriptions, only one subscription item may be in a basket at a time, and it cannot be included with one-time payment items. This endpoint requires prior approval. Please contact your account manager.

post

/baskets/{ident}/packages

Authorizations

Path parameters

identstringrequired

The basket identifier.

Example: 1a-55fff4107740a1f40d844ff89607557f45bfafb3

Body

packageobject

qtyinteger

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

Example: 2

typestring · enum

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

Example: single

Options: single, subscription

revenue_shareobject | nullable[]

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

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://checkout.tebex.io/api/baskets/{ident}/packages' \
  --header 'Authorization: Basic username:password' \
  --header 'Content-Type: application/json'

200

400

404

200

{
  "ident": "1a-55fff4107740a1f40d844ff89607557f45bfafb3",
  "expire": "2022-10-25 15:15:40",
  "price": 1.27,
  "priceDetails": {
    "fullPrice": 1.4,
    "subTotal": 1.27,
    "total": 1.4,
    "tax": 0.13,
    "balance": 0,
    "roundUp": null,
    "discounts": [],
    "surcharges": [],
    "sales": [],
    "giftcards": []
  },
  "isPaymentMethodUpdate": false,
  "returnUrl": null,
  "complete": false,
  "tax": 1,
  "username": null,
  "address": {
    "name": "Ted Tebex",
    "first_name": "Ted",
    "last_name": "Tebex",
    "address": "37 Broadhurst Gardens, London, United Kingdom, NW6 3QT",
    "email": "[e-mail]",
    "state_id": null,
    "country": "UK",
    "postal_code": "NW6 3QT"
  },
  "fingerprint": "",
  "creator_code": "text",
  "roundup": false,
  "cancel_url": "https://tebex.io",
  "complete_url": null,
  "complete_auto_redirect": false,
  "links": {
    "payment": "https://checkout.tebex.io/api/payments/tbx-12345",
    "checkout": "https://checkout.tebex.io/checkout/1a-55fff4107740a1f40d844ff89607557f45bfafb3"
  },
  "discounts": [
    {}
  ],
  "coupons": [
    {}
  ],
  "giftcards": [
    {}
  ],
  "rows": [
    {
      "id": 173125385,
      "basket": 725572301,
      "package": null,
      "override": 0,
      "quantity": 2,
      "server": null,
      "price": 1.27,
      "gift_username_id": null,
      "options": null,
      "recurring": false,
      "recurring_period": null,
      "recurring_next_payment_date": null,
      "custom": null,
      "image_url": null,
      "recurring_price": null,
      "meta": {
        "name": "1000 Gold",
        "rowprice": 2.54,
        "initialprice": 1.27,
        "isCumulative": false,
        "requiresAny": false,
        "category": false,
        "producesGiftCard": false,
        "allowsGiftCards": true,
        "hasDeliverables": false,
        "downloadLink": "",
        "hasSellerProtection": true,
        "itemType": null,
        "image": null,
        "realprice": 1.27,
        "requiredPackages": [],
        "servers": [],
        "deliverableTypes": [],
        "revenue_share": [],
        "limits": {
          "packageExpiryTime": 0,
          "user": {
            "enabled": false,
            "timestamp": 0,
            "limit": false
          },
          "global": {
            "enabled": false,
            "timestamp": 0,
            "limit": false
          }
        }
      }
    }
  ],
  "custom": {
    "foo": "bar",
    "ref": 1234
  }
}

Package is successfully added to the basket, and basket is returned.

Remove a row from the basket

This will remove the given {rows.id} from the basket {ident}. The basket must be re-fetched after running to receive updated totals.

delete

/baskets/{ident}/packages/{rows.id}

Authorizations

Path parameters

identstringrequired

The basket identifier.

Example: 1a-55fff4107740a1f40d844ff89607557f45bfafb3

rows.idintegerrequired

The id of the basket.rows row to remove.

Example: 1

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://checkout.tebex.io/api/baskets/{ident}/packages/{rows.id}' \
  --header 'Authorization: Basic username:password'

204

404

204

No body

Successfully deleted a row from the basket.

1. Add any desired sales / discounts to the basket

Add a sale to the basket

Adds a Sale to the basket with {ident}. Sales cannot be applied to baskets with revenue_share set.

post

/baskets/{ident}/sales

Authorizations

Path parameters

identstringrequired

The basket identifier.

Example: 1a-55fff4107740a1f40d844ff89607557f45bfafb3

Body

namestring

The name of the sale (displayed to the customer)

Example: Test Sale

amountnumber

The amount or percentage to deduct

Example: 4.99

discount_typestring · enum

The type of discount, either percentage for deducting a percentage of each item, or amount to deduct a fixed amount from each item.

Example: amount

Options: percentage, amount

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://checkout.tebex.io/api/baskets/{ident}/sales' \
  --header 'Authorization: Basic username:password' \
  --header 'Content-Type: application/json' \
  --data '{"name":"Test Sale","amount":4.99,"discount_type":"amount"}'

200

400

404

200

{
  "ident": "1a-55fff4107740a1f40d844ff89607557f45bfafb3",
  "expire": "2022-10-25 15:15:40",
  "price": 1.27,
  "priceDetails": {
    "fullPrice": 1.4,
    "subTotal": 1.27,
    "total": 1.4,
    "tax": 0.13,
    "balance": 0,
    "roundUp": null,
    "discounts": [],
    "surcharges": [],
    "sales": [],
    "giftcards": []
  },
  "isPaymentMethodUpdate": false,
  "returnUrl": null,
  "complete": false,
  "tax": 1,
  "username": null,
  "address": {
    "name": "Ted Tebex",
    "first_name": "Ted",
    "last_name": "Tebex",
    "address": "37 Broadhurst Gardens, London, United Kingdom, NW6 3QT",
    "email": "[e-mail]",
    "state_id": null,
    "country": "UK",
    "postal_code": "NW6 3QT"
  },
  "fingerprint": "",
  "creator_code": "text",
  "roundup": false,
  "cancel_url": "https://tebex.io",
  "complete_url": null,
  "complete_auto_redirect": false,
  "links": {
    "payment": "https://checkout.tebex.io/api/payments/tbx-12345",
    "checkout": "https://checkout.tebex.io/checkout/1a-55fff4107740a1f40d844ff89607557f45bfafb3"
  },
  "discounts": [
    {}
  ],
  "coupons": [
    {}
  ],
  "giftcards": [
    {}
  ],
  "rows": [
    {
      "id": 173125385,
      "basket": 725572301,
      "package": null,
      "override": 0,
      "quantity": 2,
      "server": null,
      "price": 1.27,
      "gift_username_id": null,
      "options": null,
      "recurring": false,
      "recurring_period": null,
      "recurring_next_payment_date": null,
      "custom": null,
      "image_url": null,
      "recurring_price": null,
      "meta": {
        "name": "1000 Gold",
        "rowprice": 2.54,
        "initialprice": 1.27,
        "isCumulative": false,
        "requiresAny": false,
        "category": false,
        "producesGiftCard": false,
        "allowsGiftCards": true,
        "hasDeliverables": false,
        "downloadLink": "",
        "hasSellerProtection": true,
        "itemType": null,
        "image": null,
        "realprice": 1.27,
        "requiredPackages": [],
        "servers": [],
        "deliverableTypes": [],
        "revenue_share": [],
        "limits": {
          "packageExpiryTime": 0,
          "user": {
            "enabled": false,
            "timestamp": 0,
            "limit": false
          },
          "global": {
            "enabled": false,
            "timestamp": 0,
            "limit": false
          }
        }
      }
    }
  ],
  "custom": {
    "foo": "bar",
    "ref": 1234
  }
}

Successfully adds sale to basket.

1. Direct the user to the basket's links.checkout URL in order to complete payment.

Fetch a basket by its identifier

Gets the basket associated with the provided identifier.

get

/baskets/{ident}

Authorizations

Path parameters

identstringrequired

The basket identifier.

Example: 1a-55fff4107740a1f40d844ff89607557f45bfafb3

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://checkout.tebex.io/api/baskets/{ident}' \
  --header 'Authorization: Basic username:password'

200

404

200

{
  "ident": "1a-55fff4107740a1f40d844ff89607557f45bfafb3",
  "expire": "2022-10-25 15:15:40",
  "price": 1.27,
  "priceDetails": {
    "fullPrice": 1.4,
    "subTotal": 1.27,
    "total": 1.4,
    "tax": 0.13,
    "balance": 0,
    "roundUp": null,
    "discounts": [],
    "surcharges": [],
    "sales": [],
    "giftcards": []
  },
  "isPaymentMethodUpdate": false,
  "returnUrl": null,
  "complete": false,
  "tax": 1,
  "username": null,
  "address": {
    "name": "Ted Tebex",
    "first_name": "Ted",
    "last_name": "Tebex",
    "address": "37 Broadhurst Gardens, London, United Kingdom, NW6 3QT",
    "email": "[e-mail]",
    "state_id": null,
    "country": "UK",
    "postal_code": "NW6 3QT"
  },
  "fingerprint": "",
  "creator_code": "text",
  "roundup": false,
  "cancel_url": "https://tebex.io",
  "complete_url": null,
  "complete_auto_redirect": false,
  "links": {
    "payment": "https://checkout.tebex.io/api/payments/tbx-12345",
    "checkout": "https://checkout.tebex.io/checkout/1a-55fff4107740a1f40d844ff89607557f45bfafb3"
  },
  "discounts": [
    {}
  ],
  "coupons": [
    {}
  ],
  "giftcards": [
    {}
  ],
  "rows": [
    {
      "id": 173125385,
      "basket": 725572301,
      "package": null,
      "override": 0,
      "quantity": 2,
      "server": null,
      "price": 1.27,
      "gift_username_id": null,
      "options": null,
      "recurring": false,
      "recurring_period": null,
      "recurring_next_payment_date": null,
      "custom": null,
      "image_url": null,
      "recurring_price": null,
      "meta": {
        "name": "1000 Gold",
        "rowprice": 2.54,
        "initialprice": 1.27,
        "isCumulative": false,
        "requiresAny": false,
        "category": false,
        "producesGiftCard": false,
        "allowsGiftCards": true,
        "hasDeliverables": false,
        "downloadLink": "",
        "hasSellerProtection": true,
        "itemType": null,
        "image": null,
        "realprice": 1.27,
        "requiredPackages": [],
        "servers": [],
        "deliverableTypes": [],
        "revenue_share": [],
        "limits": {
          "packageExpiryTime": 0,
          "user": {
            "enabled": false,
            "timestamp": 0,
            "limit": false
          },
          "global": {
            "enabled": false,
            "timestamp": 0,
            "limit": false
          }
        }
      }
    }
  ],
  "custom": {
    "foo": "bar",
    "ref": 1234
  }
}

Successful response returns the basket.

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

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

1. After payment is complete, you may verify payment if you wish by checking the links.payment URL associated with the customer's basket.

Recurring Payments

Tebex Checkout supports recurring payments in addition to single, one-time payments. Below are the endpoints you can use for managing a customer's recurring payments.

Fetch a recurring payment (subscription) by its reference

get

/recurring-payments/{reference}

Authorizations

Path parameters

referencestringrequired

The recurring payment reference to fetch.

Example: tbx-r-55fff4107740a1f40d844ff89607557f45bfafb3

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://checkout.tebex.io/api/recurring-payments/{reference}' \
  --header 'Authorization: Basic username:password'

200

404

200

{
  "id": 5000,
  "created_at": "2022-12-16T16:43:06.000000Z",
  "updated_at": "2022-12-16T16:43:06.000000Z",
  "paused_at": "2025-02-22T06:59:06.167Z",
  "paused_until": "2025-02-22T06:59:06.167Z",
  "next_payment_date": "2022-12-30T16:43:06",
  "reference": "88",
  "account_id": 1,
  "interval": "P2W",
  "cancelled_at": "2025-02-22T06:59:06.167Z",
  "cancellation_requested_at": "2024-07-25 14:01:03",
  "cancel_reason": "text",
  "status": {
    "id": 2,
    "class": "success",
    "description": "Active",
    "active": 1
  },
  "amount": {
    "amount": 7,
    "tax": 1.4,
    "period": "P2W"
  },
  "links": {
    "initial_payment": "https://checkout.tebex.io/api/payments/tbx-123123aabccd123-bf71ad?type=txn_id",
    "payment_history": [
      "https://checkout.tebex.io/api/payments/tbx-123123aabccd123-bf71ad?type=txn_id"
    ]
  }
}

Successfully fetched recurring payment.

Update a subscription with a new product / amount to pay - replacing the existing product

If the new subscription amount is higher than the existing amount, a pro-rata charge will be made to cover the cost of the new price up until the next billing date.

This endpoint requires prior approval - please contact your account manager.

put

/recurring-payments/{reference}

Authorizations

Path parameters

referencestringrequired

The recurring payment reference to fetch.

Example: tbx-r-55fff4107740a1f40d844ff89607557f45bfafb3

Body

itemsobject[]

An array containing the items to be added to the recurring payment. Only 1 item is supported at this time.

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url 'https://checkout.tebex.io/api/recurring-payments/{reference}' \
  --header 'Authorization: Basic username:password' \
  --header 'Content-Type: application/json' \
  --data '{"items":[{"qty":1,"package":{"name":"1000 Gold","price":1.27,"qty":1,"expiry_length":3,"type":"subscription","expiry_period":"month","custom":{"foo":"bar"}},"type":"subscription","revenue_share":[]}]}'

200

400

404

200

{
  "id": 5000,
  "created_at": "2022-12-16T16:43:06.000000Z",
  "updated_at": "2022-12-16T16:43:06.000000Z",
  "paused_at": "2025-02-22T06:59:06.167Z",
  "paused_until": "2025-02-22T06:59:06.167Z",
  "next_payment_date": "2022-12-30T16:43:06",
  "reference": "88",
  "account_id": 1,
  "interval": "P2W",
  "cancelled_at": "2025-02-22T06:59:06.167Z",
  "cancellation_requested_at": "2024-07-25 14:01:03",
  "cancel_reason": "text",
  "status": {
    "id": 2,
    "class": "success",
    "description": "Active",
    "active": 1
  },
  "amount": {
    "amount": 7,
    "tax": 1.4,
    "period": "P2W"
  },
  "links": {
    "initial_payment": "https://checkout.tebex.io/api/payments/tbx-123123aabccd123-bf71ad?type=txn_id",
    "payment_history": [
      "https://checkout.tebex.io/api/payments/tbx-123123aabccd123-bf71ad?type=txn_id"
    ]
  }
}

Successfully updated subscription. The updated RecurringPayment is returned.

Cancel a recurring payment

This cancels the recurring payment for the reference provided. Recurring payment references start with tbx-r-

delete

/recurring-payments/{reference}

Authorizations

Path parameters

referencestringrequired

The recurring payment reference to cancel.

Example: tbx-r-55fff4107740a1f40d844ff89607557f45bfafb3

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://checkout.tebex.io/api/recurring-payments/{reference}' \
  --header 'Authorization: Basic username:password'

200

404

200

{
  "id": 5000,
  "created_at": "2022-12-16T16:43:06.000000Z",
  "updated_at": "2022-12-16T16:43:06.000000Z",
  "paused_at": "2025-02-22T06:59:06.167Z",
  "paused_until": "2025-02-22T06:59:06.167Z",
  "next_payment_date": "2022-12-30T16:43:06",
  "reference": "88",
  "account_id": 1,
  "interval": "P2W",
  "cancelled_at": "2025-02-22T06:59:06.167Z",
  "cancellation_requested_at": "2024-07-25 14:01:03",
  "cancel_reason": "text",
  "status": {
    "id": 2,
    "class": "success",
    "description": "Active",
    "active": 1
  },
  "amount": {
    "amount": 7,
    "tax": 1.4,
    "period": "P2W"
  },
  "links": {
    "initial_payment": "https://checkout.tebex.io/api/payments/tbx-123123aabccd123-bf71ad?type=txn_id",
    "payment_history": [
      "https://checkout.tebex.io/api/payments/tbx-123123aabccd123-bf71ad?type=txn_id"
    ]
  }
}

Recurring payment cancelled successfully.

Pause or reactivate a recurring payment

put

/recurring-payments/{reference}/status

Authorizations

Path parameters

referencestringrequired

The recurring payment reference to update.

Example: tbx-r-55fff4107740a1f40d844ff89607557f45bfafb3

Body

paused_untilstring

To pause a payment, provide a ISO8601 formatted date on which the payment should be reactivated.

Example: 2025-01-27T16:43:53.000000Z

statusstring · enumrequired

Your desired state of the recurring payment. Provide Paused with paused_until to pause a recurring payment. Otherwise, provide Active to resume a recurring payment.

Example: Paused

Options: Paused, Active

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url 'https://checkout.tebex.io/api/recurring-payments/{reference}/status' \
  --header 'Authorization: Basic username:password' \
  --header 'Content-Type: application/json'

200

404

422

200

{
  "id": 5000,
  "created_at": "2022-12-16T16:43:06.000000Z",
  "updated_at": "2022-12-16T16:43:06.000000Z",
  "paused_at": "2025-02-22T06:59:06.167Z",
  "paused_until": "2025-02-22T06:59:06.167Z",
  "next_payment_date": "2022-12-30T16:43:06",
  "reference": "88",
  "account_id": 1,
  "interval": "P2W",
  "cancelled_at": "2025-02-22T06:59:06.167Z",
  "cancellation_requested_at": "2024-07-25 14:01:03",
  "cancel_reason": "text",
  "status": {
    "id": 2,
    "class": "success",
    "description": "Active",
    "active": 1
  },
  "amount": {
    "amount": 7,
    "tax": 1.4,
    "period": "P2W"
  },
  "links": {
    "initial_payment": "https://checkout.tebex.io/api/payments/tbx-123123aabccd123-bf71ad?type=txn_id",
    "payment_history": [
      "https://checkout.tebex.io/api/payments/tbx-123123aabccd123-bf71ad?type=txn_id"
    ]
  }
}

Successfully paused or reactivated a payment. The RecurringPayment is returned.

OpenAPI Schema and SDKs

Tebex Checkout is documented with OpenAPI. To view the schema and available SDKs, see our releases on GitHub.

Postman Schema

An importable Postman collection can always be downloaded from Tebex Checkout's repository on GitHub.

Examples

The following websites are integrated using the Checkout API.

Lunarclient

https://store.lunarclient.com/