cURL
curl --request POST \
--url https://api.example.com/v1/panel/codes/batches \
--header 'Content-Type: application/json' \
--header 'X-CSRF-Token: <x-csrf-token>' \
--data '
{
"reference": "<string>",
"planVersionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"quantity": 5000,
"unitPriceMinor": 123,
"currency": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"planCode": "<string>",
"planVersion": 123,
"billingPeriod": "<string>",
"note": "<string>",
"issued": 123,
"redeemed": 123,
"revoked": 123,
"expiresAt": "2023-11-07T05:31:56Z",
"revokedAt": "2023-11-07T05:31:56Z",
"revokeReason": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"createdBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'import requests
url = "https://api.example.com/v1/panel/codes/batches"
payload = {
"reference": "<string>",
"planVersionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"quantity": 5000,
"unitPriceMinor": 123,
"currency": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"planCode": "<string>",
"planVersion": 123,
"billingPeriod": "<string>",
"note": "<string>",
"issued": 123,
"redeemed": 123,
"revoked": 123,
"expiresAt": "2023-11-07T05:31:56Z",
"revokedAt": "2023-11-07T05:31:56Z",
"revokeReason": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"createdBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
headers = {
"X-CSRF-Token": "<x-csrf-token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-CSRF-Token': '<x-csrf-token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
reference: '<string>',
planVersionId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
quantity: 5000,
unitPriceMinor: 123,
currency: '<string>',
id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
planCode: '<string>',
planVersion: 123,
billingPeriod: '<string>',
note: '<string>',
issued: 123,
redeemed: 123,
revoked: 123,
expiresAt: '2023-11-07T05:31:56Z',
revokedAt: '2023-11-07T05:31:56Z',
revokeReason: '<string>',
createdAt: '2023-11-07T05:31:56Z',
createdBy: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
})
};
fetch('https://api.example.com/v1/panel/codes/batches', 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.example.com/v1/panel/codes/batches",
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([
'reference' => '<string>',
'planVersionId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'quantity' => 5000,
'unitPriceMinor' => 123,
'currency' => '<string>',
'id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'planCode' => '<string>',
'planVersion' => 123,
'billingPeriod' => '<string>',
'note' => '<string>',
'issued' => 123,
'redeemed' => 123,
'revoked' => 123,
'expiresAt' => '2023-11-07T05:31:56Z',
'revokedAt' => '2023-11-07T05:31:56Z',
'revokeReason' => '<string>',
'createdAt' => '2023-11-07T05:31:56Z',
'createdBy' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-CSRF-Token: <x-csrf-token>"
],
]);
$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.example.com/v1/panel/codes/batches"
payload := strings.NewReader("{\n \"reference\": \"<string>\",\n \"planVersionId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"quantity\": 5000,\n \"unitPriceMinor\": 123,\n \"currency\": \"<string>\",\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"planCode\": \"<string>\",\n \"planVersion\": 123,\n \"billingPeriod\": \"<string>\",\n \"note\": \"<string>\",\n \"issued\": 123,\n \"redeemed\": 123,\n \"revoked\": 123,\n \"expiresAt\": \"2023-11-07T05:31:56Z\",\n \"revokedAt\": \"2023-11-07T05:31:56Z\",\n \"revokeReason\": \"<string>\",\n \"createdAt\": \"2023-11-07T05:31:56Z\",\n \"createdBy\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-CSRF-Token", "<x-csrf-token>")
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.example.com/v1/panel/codes/batches")
.header("X-CSRF-Token", "<x-csrf-token>")
.header("Content-Type", "application/json")
.body("{\n \"reference\": \"<string>\",\n \"planVersionId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"quantity\": 5000,\n \"unitPriceMinor\": 123,\n \"currency\": \"<string>\",\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"planCode\": \"<string>\",\n \"planVersion\": 123,\n \"billingPeriod\": \"<string>\",\n \"note\": \"<string>\",\n \"issued\": 123,\n \"redeemed\": 123,\n \"revoked\": 123,\n \"expiresAt\": \"2023-11-07T05:31:56Z\",\n \"revokedAt\": \"2023-11-07T05:31:56Z\",\n \"revokeReason\": \"<string>\",\n \"createdAt\": \"2023-11-07T05:31:56Z\",\n \"createdBy\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/panel/codes/batches")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-CSRF-Token"] = '<x-csrf-token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"reference\": \"<string>\",\n \"planVersionId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"quantity\": 5000,\n \"unitPriceMinor\": 123,\n \"currency\": \"<string>\",\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"planCode\": \"<string>\",\n \"planVersion\": 123,\n \"billingPeriod\": \"<string>\",\n \"note\": \"<string>\",\n \"issued\": 123,\n \"redeemed\": 123,\n \"revoked\": 123,\n \"expiresAt\": \"2023-11-07T05:31:56Z\",\n \"revokedAt\": \"2023-11-07T05:31:56Z\",\n \"revokeReason\": \"<string>\",\n \"createdAt\": \"2023-11-07T05:31:56Z\",\n \"createdBy\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}"
response = http.request(request)
puts response.read_body{
"batch": {
"reference": "<string>",
"planVersionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"quantity": 5000,
"unitPriceMinor": 123,
"currency": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"planCode": "<string>",
"planVersion": 123,
"billingPeriod": "<string>",
"note": "<string>",
"issued": 123,
"redeemed": 123,
"revoked": 123,
"expiresAt": "2023-11-07T05:31:56Z",
"revokedAt": "2023-11-07T05:31:56Z",
"revokeReason": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"createdBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"codes": [
"<string>"
]
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"request_id": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"request_id": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"request_id": "<string>"
}panel
Post v1panelcodesbatches
Requires catalog.write. Generates a batch and returns its codes. This is the only response in the API that carries redeemable codes, and it carries every code in the batch. It cannot be replayed: asking again generates a different batch rather than returning this one, because nothing is stored that could return it. An operator who loses the list has to issue a new batch, which the screen says before they generate one. The batch row and every code commit together. A partial batch would leave somebody holding a list whose halves behave differently with no way to tell which is which.
POST
/
v1
/
panel
/
codes
/
batches
cURL
curl --request POST \
--url https://api.example.com/v1/panel/codes/batches \
--header 'Content-Type: application/json' \
--header 'X-CSRF-Token: <x-csrf-token>' \
--data '
{
"reference": "<string>",
"planVersionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"quantity": 5000,
"unitPriceMinor": 123,
"currency": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"planCode": "<string>",
"planVersion": 123,
"billingPeriod": "<string>",
"note": "<string>",
"issued": 123,
"redeemed": 123,
"revoked": 123,
"expiresAt": "2023-11-07T05:31:56Z",
"revokedAt": "2023-11-07T05:31:56Z",
"revokeReason": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"createdBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'import requests
url = "https://api.example.com/v1/panel/codes/batches"
payload = {
"reference": "<string>",
"planVersionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"quantity": 5000,
"unitPriceMinor": 123,
"currency": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"planCode": "<string>",
"planVersion": 123,
"billingPeriod": "<string>",
"note": "<string>",
"issued": 123,
"redeemed": 123,
"revoked": 123,
"expiresAt": "2023-11-07T05:31:56Z",
"revokedAt": "2023-11-07T05:31:56Z",
"revokeReason": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"createdBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
headers = {
"X-CSRF-Token": "<x-csrf-token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-CSRF-Token': '<x-csrf-token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
reference: '<string>',
planVersionId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
quantity: 5000,
unitPriceMinor: 123,
currency: '<string>',
id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
planCode: '<string>',
planVersion: 123,
billingPeriod: '<string>',
note: '<string>',
issued: 123,
redeemed: 123,
revoked: 123,
expiresAt: '2023-11-07T05:31:56Z',
revokedAt: '2023-11-07T05:31:56Z',
revokeReason: '<string>',
createdAt: '2023-11-07T05:31:56Z',
createdBy: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
})
};
fetch('https://api.example.com/v1/panel/codes/batches', 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.example.com/v1/panel/codes/batches",
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([
'reference' => '<string>',
'planVersionId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'quantity' => 5000,
'unitPriceMinor' => 123,
'currency' => '<string>',
'id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'planCode' => '<string>',
'planVersion' => 123,
'billingPeriod' => '<string>',
'note' => '<string>',
'issued' => 123,
'redeemed' => 123,
'revoked' => 123,
'expiresAt' => '2023-11-07T05:31:56Z',
'revokedAt' => '2023-11-07T05:31:56Z',
'revokeReason' => '<string>',
'createdAt' => '2023-11-07T05:31:56Z',
'createdBy' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-CSRF-Token: <x-csrf-token>"
],
]);
$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.example.com/v1/panel/codes/batches"
payload := strings.NewReader("{\n \"reference\": \"<string>\",\n \"planVersionId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"quantity\": 5000,\n \"unitPriceMinor\": 123,\n \"currency\": \"<string>\",\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"planCode\": \"<string>\",\n \"planVersion\": 123,\n \"billingPeriod\": \"<string>\",\n \"note\": \"<string>\",\n \"issued\": 123,\n \"redeemed\": 123,\n \"revoked\": 123,\n \"expiresAt\": \"2023-11-07T05:31:56Z\",\n \"revokedAt\": \"2023-11-07T05:31:56Z\",\n \"revokeReason\": \"<string>\",\n \"createdAt\": \"2023-11-07T05:31:56Z\",\n \"createdBy\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-CSRF-Token", "<x-csrf-token>")
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.example.com/v1/panel/codes/batches")
.header("X-CSRF-Token", "<x-csrf-token>")
.header("Content-Type", "application/json")
.body("{\n \"reference\": \"<string>\",\n \"planVersionId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"quantity\": 5000,\n \"unitPriceMinor\": 123,\n \"currency\": \"<string>\",\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"planCode\": \"<string>\",\n \"planVersion\": 123,\n \"billingPeriod\": \"<string>\",\n \"note\": \"<string>\",\n \"issued\": 123,\n \"redeemed\": 123,\n \"revoked\": 123,\n \"expiresAt\": \"2023-11-07T05:31:56Z\",\n \"revokedAt\": \"2023-11-07T05:31:56Z\",\n \"revokeReason\": \"<string>\",\n \"createdAt\": \"2023-11-07T05:31:56Z\",\n \"createdBy\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/panel/codes/batches")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-CSRF-Token"] = '<x-csrf-token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"reference\": \"<string>\",\n \"planVersionId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"quantity\": 5000,\n \"unitPriceMinor\": 123,\n \"currency\": \"<string>\",\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"planCode\": \"<string>\",\n \"planVersion\": 123,\n \"billingPeriod\": \"<string>\",\n \"note\": \"<string>\",\n \"issued\": 123,\n \"redeemed\": 123,\n \"revoked\": 123,\n \"expiresAt\": \"2023-11-07T05:31:56Z\",\n \"revokedAt\": \"2023-11-07T05:31:56Z\",\n \"revokeReason\": \"<string>\",\n \"createdAt\": \"2023-11-07T05:31:56Z\",\n \"createdBy\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}"
response = http.request(request)
puts response.read_body{
"batch": {
"reference": "<string>",
"planVersionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"quantity": 5000,
"unitPriceMinor": 123,
"currency": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"planCode": "<string>",
"planVersion": 123,
"billingPeriod": "<string>",
"note": "<string>",
"issued": 123,
"redeemed": 123,
"revoked": 123,
"expiresAt": "2023-11-07T05:31:56Z",
"revokedAt": "2023-11-07T05:31:56Z",
"revokeReason": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"createdBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"codes": [
"<string>"
]
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"request_id": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"request_id": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"request_id": "<string>"
}Headers
Echoes the token from the current session. Required on every unsafe method.
Body
application/json
What the operator calls the batch. Unique, and what they search for.
A version rather than a plan: publishing a new version must not change what people already hold a code for.
Required range:
1 <= x <= 10000The agreed wholesale price, recorded and never charged. The money changed hands outside Omniflow.
Codes nobody has redeemed, and therefore what revoking would kill.
Absent means the codes never expire.