curl --request POST \
--url http://localhost:7701/api/v1/subscriptions/coupons \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--header 'x-client-id: <x-client-id>' \
--data '
{
"code": "SUMMER20",
"name": "20% off Summer Sale",
"discount_type": "percentage",
"discount_value": 20,
"valid_from": "2026-07-01",
"description": "Applies to all monthly plans.",
"valid_until": "2026-08-31",
"max_redemptions": 100,
"max_cycles": 3
}
'import requests
url = "http://localhost:7701/api/v1/subscriptions/coupons"
payload = {
"code": "SUMMER20",
"name": "20% off Summer Sale",
"discount_type": "percentage",
"discount_value": 20,
"valid_from": "2026-07-01",
"description": "Applies to all monthly plans.",
"valid_until": "2026-08-31",
"max_redemptions": 100,
"max_cycles": 3
}
headers = {
"x-client-id": "<x-client-id>",
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-client-id': '<x-client-id>',
'X-API-Key': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
code: 'SUMMER20',
name: '20% off Summer Sale',
discount_type: 'percentage',
discount_value: 20,
valid_from: '2026-07-01',
description: 'Applies to all monthly plans.',
valid_until: '2026-08-31',
max_redemptions: 100,
max_cycles: 3
})
};
fetch('http://localhost:7701/api/v1/subscriptions/coupons', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "7701",
CURLOPT_URL => "http://localhost:7701/api/v1/subscriptions/coupons",
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' => 'SUMMER20',
'name' => '20% off Summer Sale',
'discount_type' => 'percentage',
'discount_value' => 20,
'valid_from' => '2026-07-01',
'description' => 'Applies to all monthly plans.',
'valid_until' => '2026-08-31',
'max_redemptions' => 100,
'max_cycles' => 3
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>",
"x-client-id: <x-client-id>"
],
]);
$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 := "http://localhost:7701/api/v1/subscriptions/coupons"
payload := strings.NewReader("{\n \"code\": \"SUMMER20\",\n \"name\": \"20% off Summer Sale\",\n \"discount_type\": \"percentage\",\n \"discount_value\": 20,\n \"valid_from\": \"2026-07-01\",\n \"description\": \"Applies to all monthly plans.\",\n \"valid_until\": \"2026-08-31\",\n \"max_redemptions\": 100,\n \"max_cycles\": 3\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-client-id", "<x-client-id>")
req.Header.Add("X-API-Key", "<api-key>")
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("http://localhost:7701/api/v1/subscriptions/coupons")
.header("x-client-id", "<x-client-id>")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"code\": \"SUMMER20\",\n \"name\": \"20% off Summer Sale\",\n \"discount_type\": \"percentage\",\n \"discount_value\": 20,\n \"valid_from\": \"2026-07-01\",\n \"description\": \"Applies to all monthly plans.\",\n \"valid_until\": \"2026-08-31\",\n \"max_redemptions\": 100,\n \"max_cycles\": 3\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:7701/api/v1/subscriptions/coupons")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["x-client-id"] = '<x-client-id>'
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"code\": \"SUMMER20\",\n \"name\": \"20% off Summer Sale\",\n \"discount_type\": \"percentage\",\n \"discount_value\": 20,\n \"valid_from\": \"2026-07-01\",\n \"description\": \"Applies to all monthly plans.\",\n \"valid_until\": \"2026-08-31\",\n \"max_redemptions\": 100,\n \"max_cycles\": 3\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"code": "SUMMER20",
"name": "20% off Summer Sale",
"description": "<string>",
"discount_type": "percentage",
"discount_value": 20,
"max_redemptions": 100,
"redemptions_count": 5,
"max_cycles": 3,
"valid_from": "2023-11-07T05:31:56Z",
"valid_until": "2023-11-07T05:31:56Z",
"is_active": true,
"created_at": "2023-11-07T05:31:56Z"
}
}Create a coupon
Creates a discount coupon that can be applied to subscriptions. The code must be unique within the company.
curl --request POST \
--url http://localhost:7701/api/v1/subscriptions/coupons \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--header 'x-client-id: <x-client-id>' \
--data '
{
"code": "SUMMER20",
"name": "20% off Summer Sale",
"discount_type": "percentage",
"discount_value": 20,
"valid_from": "2026-07-01",
"description": "Applies to all monthly plans.",
"valid_until": "2026-08-31",
"max_redemptions": 100,
"max_cycles": 3
}
'import requests
url = "http://localhost:7701/api/v1/subscriptions/coupons"
payload = {
"code": "SUMMER20",
"name": "20% off Summer Sale",
"discount_type": "percentage",
"discount_value": 20,
"valid_from": "2026-07-01",
"description": "Applies to all monthly plans.",
"valid_until": "2026-08-31",
"max_redemptions": 100,
"max_cycles": 3
}
headers = {
"x-client-id": "<x-client-id>",
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-client-id': '<x-client-id>',
'X-API-Key': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
code: 'SUMMER20',
name: '20% off Summer Sale',
discount_type: 'percentage',
discount_value: 20,
valid_from: '2026-07-01',
description: 'Applies to all monthly plans.',
valid_until: '2026-08-31',
max_redemptions: 100,
max_cycles: 3
})
};
fetch('http://localhost:7701/api/v1/subscriptions/coupons', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "7701",
CURLOPT_URL => "http://localhost:7701/api/v1/subscriptions/coupons",
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' => 'SUMMER20',
'name' => '20% off Summer Sale',
'discount_type' => 'percentage',
'discount_value' => 20,
'valid_from' => '2026-07-01',
'description' => 'Applies to all monthly plans.',
'valid_until' => '2026-08-31',
'max_redemptions' => 100,
'max_cycles' => 3
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>",
"x-client-id: <x-client-id>"
],
]);
$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 := "http://localhost:7701/api/v1/subscriptions/coupons"
payload := strings.NewReader("{\n \"code\": \"SUMMER20\",\n \"name\": \"20% off Summer Sale\",\n \"discount_type\": \"percentage\",\n \"discount_value\": 20,\n \"valid_from\": \"2026-07-01\",\n \"description\": \"Applies to all monthly plans.\",\n \"valid_until\": \"2026-08-31\",\n \"max_redemptions\": 100,\n \"max_cycles\": 3\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-client-id", "<x-client-id>")
req.Header.Add("X-API-Key", "<api-key>")
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("http://localhost:7701/api/v1/subscriptions/coupons")
.header("x-client-id", "<x-client-id>")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"code\": \"SUMMER20\",\n \"name\": \"20% off Summer Sale\",\n \"discount_type\": \"percentage\",\n \"discount_value\": 20,\n \"valid_from\": \"2026-07-01\",\n \"description\": \"Applies to all monthly plans.\",\n \"valid_until\": \"2026-08-31\",\n \"max_redemptions\": 100,\n \"max_cycles\": 3\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:7701/api/v1/subscriptions/coupons")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["x-client-id"] = '<x-client-id>'
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"code\": \"SUMMER20\",\n \"name\": \"20% off Summer Sale\",\n \"discount_type\": \"percentage\",\n \"discount_value\": 20,\n \"valid_from\": \"2026-07-01\",\n \"description\": \"Applies to all monthly plans.\",\n \"valid_until\": \"2026-08-31\",\n \"max_redemptions\": 100,\n \"max_cycles\": 3\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"code": "SUMMER20",
"name": "20% off Summer Sale",
"description": "<string>",
"discount_type": "percentage",
"discount_value": 20,
"max_redemptions": 100,
"redemptions_count": 5,
"max_cycles": 3,
"valid_from": "2023-11-07T05:31:56Z",
"valid_until": "2023-11-07T05:31:56Z",
"is_active": true,
"created_at": "2023-11-07T05:31:56Z"
}
}Authorizations
Company API key. Send in the X-API-Key header.
Headers
Client identifier for the company in the request.
"client_abc123"
Body
Unique alphanumeric code (max 50 chars). Case-sensitive.
"SUMMER20"
Display name for the coupon (max 255 chars).
"20% off Summer Sale"
How the discount is calculated.
percentage, fixed "percentage"
Discount amount: percentage (1–100) when type is percentage; cents when type is fixed.
20
Date from which the coupon can be applied.
"2026-07-01"
Optional description (max 1000 chars).
"Applies to all monthly plans."
Expiry date (must be after valid_from). Null = no expiry.
"2026-08-31"
Maximum total uses across all subscriptions. Null = unlimited.
100
Maximum billing cycles the discount applies per subscription. Null = applies forever.
3
Response
Coupon created
Show child attributes
Show child attributes