Plugin API
Plugin API
Home
GitHub
Welcome
Authentication
Error Handling
Official Plugins
Endpoints
Information
Command Queue
Listing
Packages
Community Goals
Payments
Checkout
Gift Cards
Coupons
Bans
Sales
Player Lookup
Customer Purchases
Powered by GitBook

Gift Cards

get
Get all gift cards

https://plugin.tebex.io/gift-cards
Return an array of all gift cards on your account.
Request
Response
Request
Headers
X-Tebex-Secret
required
string
The secret key of a server.
Response
200: OK
{
  "data": [
    {
      "id": 38,
      "code": "165261930219",
      "balance": {
        "starting": "25.00",
        "remaining": "12.60",
        "currency": "GBP"
      },
      "note": "Created for player ABC",
      "void": false
    }
  ]
}

get
Retrieve a gift card

https://plugin.tebex.io/gift-cards/{id}
Retrieve a gift card by ID.
Request
Response
Request
Path Parameters
id
required
string
The ID of a gift card.
Headers
X-Tebex-Secret
required
string
The secret key of a server.
Response
200: OK
{
  "data": {
    "id": 23,
    "code": "094104746161",
    "balance": {
      "starting": "20.00",
      "remaining": "12.00",
      "currency": "GBP"
    },
    "note": "",
    "void": false
  }
}

post
Create a gift card

https://plugin.tebex.io/gift-cards
Create a gift card of a specified amount.
Request
Response
Request
Headers
X-Tebex-Secret
required
string
The secret key of a server.
Body Parameters
expires_at
optional
string
The gift card's expiry date in the format yyyy-mm-dd hh:mm:ss.
note
optional
string
The note that will be stored against the gift card.
amount
required
number
The currency value of the gift card should have upon creation.
Response
200: OK
{
  "data": {
    "id": 40,
    "code": "094006746161",
    "balance": {
      "starting": "60.00",
      "remaining": "60.00",
      "currency": "GBP"
    },
    "note": "My note",
    "void": false
  }
}

delete
Void a gift card

https://plugin.tebex.io/gift-cards/{id}
Void a gift card to prevent it from being used.
Request
Response
Request
Path Parameters
id
required
string
The ID of the gift card.
Headers
X-Tebex-Secret
required
string
The secret key of a server.
Response
200: OK
{
  "data": {
    "id": 23,
    "code": "094104746161",
    "balance": {
      "starting": "20.00",
      "remaining": "12.00",
      "currency": "GBP"
    },
    "note": "",
    "void": true
  }
}

put
Top-up a gift card

https://plugin.tebex.io/gift-cards/{id}
Top-up (Add more credit) to an existing gift card.
Request
Response
Request
Path Parameters
id
required
string
The ID of the gift card.
Headers
X-Tebex-Secret
required
string
The secret key of a server.
Body Parameters
amount
required
string
The currency value the gift card should have added to it.
Response
200: OK
{
  "data": {
    "id": 40,
    "code": "094006746161",
    "balance": {
      "starting": "10.00",
      "remaining": "40.00",
      "currency": "GBP"
    },
    "note": "",
    "void": false
  }
}
Endpoints - Previous
Checkout
Next - Endpoints
Coupons
Last updated 5 months ago
Contents
get
Get all gift cards
get
Retrieve a gift card
post
Create a gift card
delete
Void a gift card
put
Top-up a gift card