Billing
Update coupon
Limited update: only name, active, maxUses, validUntil can be changed (Stripe limitation). To change the code, discount, duration, scope or plans → delete and re-create. active is synced with the Stripe promotion code.
PATCH
/
public
/
api
/
v1
/
billing
/
coupons
/
{couponPublicId}
Update coupon
curl --request PATCH \
--url https://api.gennia.ai/public/api/v1/billing/coupons/{couponPublicId} \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <api-key>' \
--data '
{
"active": true,
"maxUses": 200,
"name": "Welcome 10% off",
"validUntil": "2026-12-31T23:59:59Z"
}
'import requests
url = "https://api.gennia.ai/public/api/v1/billing/coupons/{couponPublicId}"
payload = {
"active": True,
"maxUses": 200,
"name": "Welcome 10% off",
"validUntil": "2026-12-31T23:59:59Z"
}
headers = {
"X-Api-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'X-Api-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
active: true,
maxUses: 200,
name: 'Welcome 10% off',
validUntil: '2026-12-31T23:59:59Z'
})
};
fetch('https://api.gennia.ai/public/api/v1/billing/coupons/{couponPublicId}', 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.gennia.ai/public/api/v1/billing/coupons/{couponPublicId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'active' => true,
'maxUses' => 200,
'name' => 'Welcome 10% off',
'validUntil' => '2026-12-31T23:59:59Z'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Api-Key: <api-key>"
],
]);
$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.gennia.ai/public/api/v1/billing/coupons/{couponPublicId}"
payload := strings.NewReader("{\n \"active\": true,\n \"maxUses\": 200,\n \"name\": \"Welcome 10% off\",\n \"validUntil\": \"2026-12-31T23:59:59Z\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
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.patch("https://api.gennia.ai/public/api/v1/billing/coupons/{couponPublicId}")
.header("X-Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"active\": true,\n \"maxUses\": 200,\n \"name\": \"Welcome 10% off\",\n \"validUntil\": \"2026-12-31T23:59:59Z\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gennia.ai/public/api/v1/billing/coupons/{couponPublicId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["X-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"active\": true,\n \"maxUses\": 200,\n \"name\": \"Welcome 10% off\",\n \"validUntil\": \"2026-12-31T23:59:59Z\"\n}"
response = http.request(request)
puts response.read_body{
"active": true,
"applicablePlans": [
{
"billingIntervalMonths": 123,
"creditsIncluded": 123,
"currency": "<string>",
"name": "<string>",
"priceCents": 123,
"publicId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
],
"code": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"currency": "<string>",
"discountValue": 123,
"durationMonths": 123,
"isExhausted": true,
"isExpired": true,
"maxUses": 123,
"name": "<string>",
"publicId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"stripeCouponId": "<string>",
"stripePromotionCodeId": "<string>",
"timesUsed": 123,
"updatedAt": "2023-11-07T05:31:56Z",
"validFrom": "2023-11-07T05:31:56Z",
"validUntil": "2023-11-07T05:31:56Z"
}{
"active": true,
"applicablePlans": [
{
"billingIntervalMonths": 123,
"creditsIncluded": 123,
"currency": "<string>",
"name": "<string>",
"priceCents": 123,
"publicId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
],
"code": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"currency": "<string>",
"discountValue": 123,
"durationMonths": 123,
"isExhausted": true,
"isExpired": true,
"maxUses": 123,
"name": "<string>",
"publicId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"stripeCouponId": "<string>",
"stripePromotionCodeId": "<string>",
"timesUsed": 123,
"updatedAt": "2023-11-07T05:31:56Z",
"validFrom": "2023-11-07T05:31:56Z",
"validUntil": "2023-11-07T05:31:56Z"
}{
"active": true,
"applicablePlans": [
{
"billingIntervalMonths": 123,
"creditsIncluded": 123,
"currency": "<string>",
"name": "<string>",
"priceCents": 123,
"publicId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
],
"code": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"currency": "<string>",
"discountValue": 123,
"durationMonths": 123,
"isExhausted": true,
"isExpired": true,
"maxUses": 123,
"name": "<string>",
"publicId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"stripeCouponId": "<string>",
"stripePromotionCodeId": "<string>",
"timesUsed": 123,
"updatedAt": "2023-11-07T05:31:56Z",
"validFrom": "2023-11-07T05:31:56Z",
"validUntil": "2023-11-07T05:31:56Z"
}{
"active": true,
"applicablePlans": [
{
"billingIntervalMonths": 123,
"creditsIncluded": 123,
"currency": "<string>",
"name": "<string>",
"priceCents": 123,
"publicId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
],
"code": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"currency": "<string>",
"discountValue": 123,
"durationMonths": 123,
"isExhausted": true,
"isExpired": true,
"maxUses": 123,
"name": "<string>",
"publicId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"stripeCouponId": "<string>",
"stripePromotionCodeId": "<string>",
"timesUsed": 123,
"updatedAt": "2023-11-07T05:31:56Z",
"validFrom": "2023-11-07T05:31:56Z",
"validUntil": "2023-11-07T05:31:56Z"
}Autorizações
Parâmetros de caminho
Corpo
application/json
Body for updating an existing coupon. Coupons are largely immutable post-creation; only name, active, maxUses and validUntil can change.
Activate or deactivate the coupon. Synced with the Stripe promotion code.
Exemplo:
true
New maximum total redemptions. Must be >= current redemption count.
Intervalo necessário:
x >= 1Exemplo:
200
New internal display name for the coupon.
Maximum string length:
100Exemplo:
"Welcome 10% off"
New end of the validity window.
Exemplo:
"2026-12-31T23:59:59Z"
Resposta
OK
Show child attributes
Show child attributes
Opções disponíveis:
percentage, fixed_amount Opções disponíveis:
once, repeating, forever Opções disponíveis:
hub, plans Esta página foi útil?
⌘I
Update coupon
curl --request PATCH \
--url https://api.gennia.ai/public/api/v1/billing/coupons/{couponPublicId} \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <api-key>' \
--data '
{
"active": true,
"maxUses": 200,
"name": "Welcome 10% off",
"validUntil": "2026-12-31T23:59:59Z"
}
'import requests
url = "https://api.gennia.ai/public/api/v1/billing/coupons/{couponPublicId}"
payload = {
"active": True,
"maxUses": 200,
"name": "Welcome 10% off",
"validUntil": "2026-12-31T23:59:59Z"
}
headers = {
"X-Api-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'X-Api-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
active: true,
maxUses: 200,
name: 'Welcome 10% off',
validUntil: '2026-12-31T23:59:59Z'
})
};
fetch('https://api.gennia.ai/public/api/v1/billing/coupons/{couponPublicId}', 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.gennia.ai/public/api/v1/billing/coupons/{couponPublicId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'active' => true,
'maxUses' => 200,
'name' => 'Welcome 10% off',
'validUntil' => '2026-12-31T23:59:59Z'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Api-Key: <api-key>"
],
]);
$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.gennia.ai/public/api/v1/billing/coupons/{couponPublicId}"
payload := strings.NewReader("{\n \"active\": true,\n \"maxUses\": 200,\n \"name\": \"Welcome 10% off\",\n \"validUntil\": \"2026-12-31T23:59:59Z\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
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.patch("https://api.gennia.ai/public/api/v1/billing/coupons/{couponPublicId}")
.header("X-Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"active\": true,\n \"maxUses\": 200,\n \"name\": \"Welcome 10% off\",\n \"validUntil\": \"2026-12-31T23:59:59Z\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gennia.ai/public/api/v1/billing/coupons/{couponPublicId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["X-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"active\": true,\n \"maxUses\": 200,\n \"name\": \"Welcome 10% off\",\n \"validUntil\": \"2026-12-31T23:59:59Z\"\n}"
response = http.request(request)
puts response.read_body{
"active": true,
"applicablePlans": [
{
"billingIntervalMonths": 123,
"creditsIncluded": 123,
"currency": "<string>",
"name": "<string>",
"priceCents": 123,
"publicId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
],
"code": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"currency": "<string>",
"discountValue": 123,
"durationMonths": 123,
"isExhausted": true,
"isExpired": true,
"maxUses": 123,
"name": "<string>",
"publicId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"stripeCouponId": "<string>",
"stripePromotionCodeId": "<string>",
"timesUsed": 123,
"updatedAt": "2023-11-07T05:31:56Z",
"validFrom": "2023-11-07T05:31:56Z",
"validUntil": "2023-11-07T05:31:56Z"
}{
"active": true,
"applicablePlans": [
{
"billingIntervalMonths": 123,
"creditsIncluded": 123,
"currency": "<string>",
"name": "<string>",
"priceCents": 123,
"publicId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
],
"code": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"currency": "<string>",
"discountValue": 123,
"durationMonths": 123,
"isExhausted": true,
"isExpired": true,
"maxUses": 123,
"name": "<string>",
"publicId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"stripeCouponId": "<string>",
"stripePromotionCodeId": "<string>",
"timesUsed": 123,
"updatedAt": "2023-11-07T05:31:56Z",
"validFrom": "2023-11-07T05:31:56Z",
"validUntil": "2023-11-07T05:31:56Z"
}{
"active": true,
"applicablePlans": [
{
"billingIntervalMonths": 123,
"creditsIncluded": 123,
"currency": "<string>",
"name": "<string>",
"priceCents": 123,
"publicId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
],
"code": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"currency": "<string>",
"discountValue": 123,
"durationMonths": 123,
"isExhausted": true,
"isExpired": true,
"maxUses": 123,
"name": "<string>",
"publicId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"stripeCouponId": "<string>",
"stripePromotionCodeId": "<string>",
"timesUsed": 123,
"updatedAt": "2023-11-07T05:31:56Z",
"validFrom": "2023-11-07T05:31:56Z",
"validUntil": "2023-11-07T05:31:56Z"
}{
"active": true,
"applicablePlans": [
{
"billingIntervalMonths": 123,
"creditsIncluded": 123,
"currency": "<string>",
"name": "<string>",
"priceCents": 123,
"publicId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
],
"code": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"currency": "<string>",
"discountValue": 123,
"durationMonths": 123,
"isExhausted": true,
"isExpired": true,
"maxUses": 123,
"name": "<string>",
"publicId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"stripeCouponId": "<string>",
"stripePromotionCodeId": "<string>",
"timesUsed": 123,
"updatedAt": "2023-11-07T05:31:56Z",
"validFrom": "2023-11-07T05:31:56Z",
"validUntil": "2023-11-07T05:31:56Z"
}