Create a new voucher

curl --request POST \
  --url https://api.spirii.com/v2/vouchers \
  --header 'Content-Type: application/json' \
  --data '
{
  "code": "TT-67890",
  "voucherGroupId": 67890,
  "maxUsers": 100,
  "expiresAt": "2025-06-03T12:00:00.000Z"
}
'

import requests

url = "https://api.spirii.com/v2/vouchers"

payload = {
    "code": "TT-67890",
    "voucherGroupId": 67890,
    "maxUsers": 100,
    "expiresAt": "2025-06-03T12:00:00.000Z"
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    code: 'TT-67890',
    voucherGroupId: 67890,
    maxUsers: 100,
    expiresAt: '2025-06-03T12:00:00.000Z'
  })
};

fetch('https://api.spirii.com/v2/vouchers', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.spirii.com/v2/vouchers",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'code' => 'TT-67890',
    'voucherGroupId' => 67890,
    'maxUsers' => 100,
    'expiresAt' => '2025-06-03T12:00:00.000Z'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.spirii.com/v2/vouchers"

	payload := strings.NewReader("{\n  \"code\": \"TT-67890\",\n  \"voucherGroupId\": 67890,\n  \"maxUsers\": 100,\n  \"expiresAt\": \"2025-06-03T12:00:00.000Z\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.spirii.com/v2/vouchers")
  .header("Content-Type", "application/json")
  .body("{\n  \"code\": \"TT-67890\",\n  \"voucherGroupId\": 67890,\n  \"maxUsers\": 100,\n  \"expiresAt\": \"2025-06-03T12:00:00.000Z\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.spirii.com/v2/vouchers")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"code\": \"TT-67890\",\n  \"voucherGroupId\": 67890,\n  \"maxUsers\": 100,\n  \"expiresAt\": \"2025-06-03T12:00:00.000Z\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": 67890,
  "code": "TT-67890",
  "voucherGroupId": 67890,
  "maxUsers": 100,
  "expiresAt": "2025-06-03T12:00:00.000Z",
  "createdAt": "2025-06-03T12:00:00.000Z",
  "updatedAt": "2025-06-03T12:00:00.000Z",
  "deletedAt": "2025-06-03T12:00:00.000Z"
}

Create a new voucher

This endpoint allows you to create a voucher(s).

A Voucher belongs to a Voucher Group and is uniquely identified by a code. It can be linked to multiple tokens (idtags) and appUsers.

When a driver starts a session at a location, the system checks:

If the driver’s token is linked to a voucher, or

If the driver’s appUser (linked to that token) is linked to a voucher.

If either is true and the voucher’s group is associated with the location, the voucher is applied — potentially affecting pricing or granting access.

POST

vouchers

Create a new voucher

curl --request POST \
  --url https://api.spirii.com/v2/vouchers \
  --header 'Content-Type: application/json' \
  --data '
{
  "code": "TT-67890",
  "voucherGroupId": 67890,
  "maxUsers": 100,
  "expiresAt": "2025-06-03T12:00:00.000Z"
}
'

import requests

url = "https://api.spirii.com/v2/vouchers"

payload = {
    "code": "TT-67890",
    "voucherGroupId": 67890,
    "maxUsers": 100,
    "expiresAt": "2025-06-03T12:00:00.000Z"
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    code: 'TT-67890',
    voucherGroupId: 67890,
    maxUsers: 100,
    expiresAt: '2025-06-03T12:00:00.000Z'
  })
};

fetch('https://api.spirii.com/v2/vouchers', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.spirii.com/v2/vouchers",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'code' => 'TT-67890',
    'voucherGroupId' => 67890,
    'maxUsers' => 100,
    'expiresAt' => '2025-06-03T12:00:00.000Z'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.spirii.com/v2/vouchers"

	payload := strings.NewReader("{\n  \"code\": \"TT-67890\",\n  \"voucherGroupId\": 67890,\n  \"maxUsers\": 100,\n  \"expiresAt\": \"2025-06-03T12:00:00.000Z\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.spirii.com/v2/vouchers")
  .header("Content-Type", "application/json")
  .body("{\n  \"code\": \"TT-67890\",\n  \"voucherGroupId\": 67890,\n  \"maxUsers\": 100,\n  \"expiresAt\": \"2025-06-03T12:00:00.000Z\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.spirii.com/v2/vouchers")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"code\": \"TT-67890\",\n  \"voucherGroupId\": 67890,\n  \"maxUsers\": 100,\n  \"expiresAt\": \"2025-06-03T12:00:00.000Z\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": 67890,
  "code": "TT-67890",
  "voucherGroupId": 67890,
  "maxUsers": 100,
  "expiresAt": "2025-06-03T12:00:00.000Z",
  "createdAt": "2025-06-03T12:00:00.000Z",
  "updatedAt": "2025-06-03T12:00:00.000Z",
  "deletedAt": "2025-06-03T12:00:00.000Z"
}

Body

application/json

The voucher to be created.

code

string<string>

required

Unique code used to redeem the voucher.

Example:

"TT-67890"

voucherGroupId

number<integer>

required

Id belonging to a voucher group this voucher is associated with.

Example:

67890

maxUsers

number<integer> | null

Maximum number of users allowed to redeem this voucher.

Required range: x <= 65535

Example:

100

expiresAt

string<date-time> | null

Date after which the voucher is unusable.

Example:

"2025-06-03T12:00:00.000Z"

Response

The voucher has been successfully created.

number<integer>

required

Used to identify the voucher throughout the Spirii system.

Example:

67890

code

string<string>

required

Unique code used to redeem the voucher.

Example:

"TT-67890"

voucherGroupId

number<integer>

required

Id belonging to a voucher group this voucher is associated with.

Example:

67890

maxUsers

number<integer> | null

required

Maximum number of users allowed to redeem this voucher.

Required range: x <= 65535

Example:

100

expiresAt

string<date-time> | null

required

Date after which the voucher is unusable.

Example:

"2025-06-03T12:00:00.000Z"

createdAt

string<date-time>

required

The date and time when the voucher was created.

Example:

"2025-06-03T12:00:00.000Z"

updatedAt

string<date-time>

required

The date and time when the voucher was last updated.

Example:

"2025-06-03T12:00:00.000Z"

deletedAt

string<date-time> | null

required

The date and time when the voucher was deleted.

Example:

"2025-06-03T12:00:00.000Z"

Get started

Spirii API

EMSP API

Billing API

Energy Management API

Legacy API

Create a new voucher

Body

Response