Create a discount

curl --request POST \
  --url https://sandboxapi.kelviq.com/api/v1/discount/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "code": "<string>",
  "amountOff": "<string>",
  "percentageOff": 123,
  "currency": "<string>",
  "duration": "ONCE",
  "durationInMonths": 123,
  "redeemBy": "2023-11-07T05:31:56Z",
  "maxRedemptions": 123,
  "appliesTo": [
    {
      "product": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "plans": [
        "<string>"
      ]
    }
  ]
}
'

import requests

url = "https://sandboxapi.kelviq.com/api/v1/discount/"

payload = {
    "name": "<string>",
    "code": "<string>",
    "amountOff": "<string>",
    "percentageOff": 123,
    "currency": "<string>",
    "duration": "ONCE",
    "durationInMonths": 123,
    "redeemBy": "2023-11-07T05:31:56Z",
    "maxRedemptions": 123,
    "appliesTo": [
        {
            "product": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "plans": ["<string>"]
        }
    ]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    code: '<string>',
    amountOff: '<string>',
    percentageOff: 123,
    currency: '<string>',
    duration: 'ONCE',
    durationInMonths: 123,
    redeemBy: '2023-11-07T05:31:56Z',
    maxRedemptions: 123,
    appliesTo: [{product: '3c90c3cc-0d44-4b50-8888-8dd25736052a', plans: ['<string>']}]
  })
};

fetch('https://sandboxapi.kelviq.com/api/v1/discount/', 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://sandboxapi.kelviq.com/api/v1/discount/",
  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([
    'name' => '<string>',
    'code' => '<string>',
    'amountOff' => '<string>',
    'percentageOff' => 123,
    'currency' => '<string>',
    'duration' => 'ONCE',
    'durationInMonths' => 123,
    'redeemBy' => '2023-11-07T05:31:56Z',
    'maxRedemptions' => 123,
    'appliesTo' => [
        [
                'product' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
                'plans' => [
                                '<string>'
                ]
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "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://sandboxapi.kelviq.com/api/v1/discount/"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"code\": \"<string>\",\n  \"amountOff\": \"<string>\",\n  \"percentageOff\": 123,\n  \"currency\": \"<string>\",\n  \"duration\": \"ONCE\",\n  \"durationInMonths\": 123,\n  \"redeemBy\": \"2023-11-07T05:31:56Z\",\n  \"maxRedemptions\": 123,\n  \"appliesTo\": [\n    {\n      \"product\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"plans\": [\n        \"<string>\"\n      ]\n    }\n  ]\n}")

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

	req.Header.Add("Authorization", "Bearer <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://sandboxapi.kelviq.com/api/v1/discount/")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"code\": \"<string>\",\n  \"amountOff\": \"<string>\",\n  \"percentageOff\": 123,\n  \"currency\": \"<string>\",\n  \"duration\": \"ONCE\",\n  \"durationInMonths\": 123,\n  \"redeemBy\": \"2023-11-07T05:31:56Z\",\n  \"maxRedemptions\": 123,\n  \"appliesTo\": [\n    {\n      \"product\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"plans\": [\n        \"<string>\"\n      ]\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://sandboxapi.kelviq.com/api/v1/discount/")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"code\": \"<string>\",\n  \"amountOff\": \"<string>\",\n  \"percentageOff\": 123,\n  \"currency\": \"<string>\",\n  \"duration\": \"ONCE\",\n  \"durationInMonths\": 123,\n  \"redeemBy\": \"2023-11-07T05:31:56Z\",\n  \"maxRedemptions\": 123,\n  \"appliesTo\": [\n    {\n      \"product\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"plans\": [\n        \"<string>\"\n      ]\n    }\n  ]\n}"

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

{
  "id": "b3f1a2c4-5d6e-4f7a-8b9c-0d1e2f3a4b5c",
  "discountType": "PERCENTAGE",
  "amountOff": "10.00",
  "percentageOff": 20,
  "currency": "usd",
  "currencySymbol": "$",
  "name": "Summer Sale",
  "code": "SUMMER20",
  "duration": "ONCE",
  "durationInMonths": 123,
  "redeemBy": "2023-11-07T05:31:56Z",
  "maxRedemptions": 123,
  "timesRedeemed": 123,
  "appliesTo": [
    {
      "product": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>"
      },
      "plans": [
        {
          "identifier": "<string>",
          "name": "<string>"
        }
      ]
    }
  ],
  "isActive": true
}

POST

discount

Create a discount

curl --request POST \
  --url https://sandboxapi.kelviq.com/api/v1/discount/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "code": "<string>",
  "amountOff": "<string>",
  "percentageOff": 123,
  "currency": "<string>",
  "duration": "ONCE",
  "durationInMonths": 123,
  "redeemBy": "2023-11-07T05:31:56Z",
  "maxRedemptions": 123,
  "appliesTo": [
    {
      "product": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "plans": [
        "<string>"
      ]
    }
  ]
}
'

import requests

url = "https://sandboxapi.kelviq.com/api/v1/discount/"

payload = {
    "name": "<string>",
    "code": "<string>",
    "amountOff": "<string>",
    "percentageOff": 123,
    "currency": "<string>",
    "duration": "ONCE",
    "durationInMonths": 123,
    "redeemBy": "2023-11-07T05:31:56Z",
    "maxRedemptions": 123,
    "appliesTo": [
        {
            "product": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "plans": ["<string>"]
        }
    ]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    code: '<string>',
    amountOff: '<string>',
    percentageOff: 123,
    currency: '<string>',
    duration: 'ONCE',
    durationInMonths: 123,
    redeemBy: '2023-11-07T05:31:56Z',
    maxRedemptions: 123,
    appliesTo: [{product: '3c90c3cc-0d44-4b50-8888-8dd25736052a', plans: ['<string>']}]
  })
};

fetch('https://sandboxapi.kelviq.com/api/v1/discount/', 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://sandboxapi.kelviq.com/api/v1/discount/",
  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([
    'name' => '<string>',
    'code' => '<string>',
    'amountOff' => '<string>',
    'percentageOff' => 123,
    'currency' => '<string>',
    'duration' => 'ONCE',
    'durationInMonths' => 123,
    'redeemBy' => '2023-11-07T05:31:56Z',
    'maxRedemptions' => 123,
    'appliesTo' => [
        [
                'product' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
                'plans' => [
                                '<string>'
                ]
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "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://sandboxapi.kelviq.com/api/v1/discount/"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"code\": \"<string>\",\n  \"amountOff\": \"<string>\",\n  \"percentageOff\": 123,\n  \"currency\": \"<string>\",\n  \"duration\": \"ONCE\",\n  \"durationInMonths\": 123,\n  \"redeemBy\": \"2023-11-07T05:31:56Z\",\n  \"maxRedemptions\": 123,\n  \"appliesTo\": [\n    {\n      \"product\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"plans\": [\n        \"<string>\"\n      ]\n    }\n  ]\n}")

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

	req.Header.Add("Authorization", "Bearer <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://sandboxapi.kelviq.com/api/v1/discount/")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"code\": \"<string>\",\n  \"amountOff\": \"<string>\",\n  \"percentageOff\": 123,\n  \"currency\": \"<string>\",\n  \"duration\": \"ONCE\",\n  \"durationInMonths\": 123,\n  \"redeemBy\": \"2023-11-07T05:31:56Z\",\n  \"maxRedemptions\": 123,\n  \"appliesTo\": [\n    {\n      \"product\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"plans\": [\n        \"<string>\"\n      ]\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://sandboxapi.kelviq.com/api/v1/discount/")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"code\": \"<string>\",\n  \"amountOff\": \"<string>\",\n  \"percentageOff\": 123,\n  \"currency\": \"<string>\",\n  \"duration\": \"ONCE\",\n  \"durationInMonths\": 123,\n  \"redeemBy\": \"2023-11-07T05:31:56Z\",\n  \"maxRedemptions\": 123,\n  \"appliesTo\": [\n    {\n      \"product\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"plans\": [\n        \"<string>\"\n      ]\n    }\n  ]\n}"

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

{
  "id": "b3f1a2c4-5d6e-4f7a-8b9c-0d1e2f3a4b5c",
  "discountType": "PERCENTAGE",
  "amountOff": "10.00",
  "percentageOff": 20,
  "currency": "usd",
  "currencySymbol": "$",
  "name": "Summer Sale",
  "code": "SUMMER20",
  "duration": "ONCE",
  "durationInMonths": 123,
  "redeemBy": "2023-11-07T05:31:56Z",
  "maxRedemptions": 123,
  "timesRedeemed": 123,
  "appliesTo": [
    {
      "product": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>"
      },
      "plans": [
        {
          "identifier": "<string>",
          "name": "<string>"
        }
      ]
    }
  ],
  "isActive": true
}

Click the base URL in the API playground and select the Sandbox host for test data or the Production host for live data. Use credentials from the same environment.

Authorizations

Authorization

string

header

required

The Server API Key obtained from the kelviq application. Pass as a Bearer token in the Authorization header. Example: 'Authorization: Bearer YOUR_API_KEY'

Body

application/json

discountType

enum<string>

required

Available options:

PERCENTAGE,

FIXED_AMOUNT

name

string

required

Displayed on the customer's invoice.

code

string

required

Checkout discount code. Uppercase letters and numbers only, and must be unique among active discounts for the organization.

amountOff

string

Required (and only used) when discountType is FIXED_AMOUNT.

percentageOff

integer

Required (and only used) when discountType is PERCENTAGE.

currency

string

3-letter ISO currency code. Required when discountType is FIXED_AMOUNT.

duration

enum<string>

default:ONCE

Available options:

ONCE,

REPEATING,

FOREVER

durationInMonths

integer

Number of billing periods the discount applies for. Despite the field name, this counts billing cycles, not calendar months — e.g. 3 on a yearly plan means 3 years. Required when duration is REPEATING.

redeemBy

string<date-time>

UTC time after which this discount can no longer be redeemed. Must be in the future.

maxRedemptions

integer

Total number of times this code can be redeemed across all customers.

appliesTo

object[]

Restrict the discount to specific products/plans. Omit to apply to all products.

Show child attributes

Response

Discount created.

string<uuid>

Example:

"b3f1a2c4-5d6e-4f7a-8b9c-0d1e2f3a4b5c"

discountType

enum<string>

PERCENTAGE discounts a percentage off the price. FIXED_AMOUNT discounts a flat amount off the total.

Available options:

PERCENTAGE,

FIXED_AMOUNT

amountOff

string | null

Amount to discount, in currency units (e.g. "10.00"). Set when discountType is FIXED_AMOUNT.

Example:

"10.00"

percentageOff

integer | null

Percentage to discount. Set when discountType is PERCENTAGE.

Example:

20

currency

string | null

3-letter ISO currency code. Required when discountType is FIXED_AMOUNT.

Example:

"usd"

currencySymbol

string

Example:

"$"

name

string

Displayed on the customer's invoice.

Example:

"Summer Sale"

code

string

Checkout discount code. Uppercase letters and numbers only.

Example:

"SUMMER20"

duration

enum<string>

How many billing cycles the discount applies for.

Available options:

ONCE,

REPEATING,

FOREVER

durationInMonths

integer | null

Number of billing periods the discount applies for. Despite the field name, this counts billing cycles, not calendar months — e.g. 3 on a yearly plan means 3 years. Set when duration is REPEATING.

redeemBy

string<date-time> | null

UTC time after which this discount can no longer be redeemed.

maxRedemptions

integer | null

Total number of times this code can be redeemed across all customers.

timesRedeemed

integer

Number of times this code has been redeemed so far.

appliesTo

object[]

Products/plans this discount is restricted to. Empty means the discount applies to all products.

Show child attributes

isActive

boolean

Get Started

API Documentation

Create a discount

Authorizations

Body

Response