Create a discount

Create a discount.

curl --request POST \
  --url https://api.creem.io/v1/discounts \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "Holiday Sale",
  "duration": "repeating",
  "applies_to_products": [
    "prod_123",
    "prod_456"
  ],
  "code": "HOLIDAY2024",
  "amount": 20,
  "currency": "USD",
  "percentage": 15,
  "expiry_date": "2024-12-31T23:59:59Z",
  "max_redemptions": 100,
  "duration_in_months": 6
}
'

import requests

url = "https://api.creem.io/v1/discounts"

payload = {
    "name": "Holiday Sale",
    "duration": "repeating",
    "applies_to_products": ["prod_123", "prod_456"],
    "code": "HOLIDAY2024",
    "amount": 20,
    "currency": "USD",
    "percentage": 15,
    "expiry_date": "2024-12-31T23:59:59Z",
    "max_redemptions": 100,
    "duration_in_months": 6
}
headers = {
    "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-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'Holiday Sale',
    duration: 'repeating',
    applies_to_products: ['prod_123', 'prod_456'],
    code: 'HOLIDAY2024',
    amount: 20,
    currency: 'USD',
    percentage: 15,
    expiry_date: '2024-12-31T23:59:59Z',
    max_redemptions: 100,
    duration_in_months: 6
  })
};

fetch('https://api.creem.io/v1/discounts', 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.creem.io/v1/discounts",
  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' => 'Holiday Sale',
    'duration' => 'repeating',
    'applies_to_products' => [
        'prod_123',
        'prod_456'
    ],
    'code' => 'HOLIDAY2024',
    'amount' => 20,
    'currency' => 'USD',
    'percentage' => 15,
    'expiry_date' => '2024-12-31T23:59:59Z',
    'max_redemptions' => 100,
    'duration_in_months' => 6
  ]),
  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.creem.io/v1/discounts"

	payload := strings.NewReader("{\n  \"name\": \"Holiday Sale\",\n  \"duration\": \"repeating\",\n  \"applies_to_products\": [\n    \"prod_123\",\n    \"prod_456\"\n  ],\n  \"code\": \"HOLIDAY2024\",\n  \"amount\": 20,\n  \"currency\": \"USD\",\n  \"percentage\": 15,\n  \"expiry_date\": \"2024-12-31T23:59:59Z\",\n  \"max_redemptions\": 100,\n  \"duration_in_months\": 6\n}")

	req, _ := http.NewRequest("POST", 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.post("https://api.creem.io/v1/discounts")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Holiday Sale\",\n  \"duration\": \"repeating\",\n  \"applies_to_products\": [\n    \"prod_123\",\n    \"prod_456\"\n  ],\n  \"code\": \"HOLIDAY2024\",\n  \"amount\": 20,\n  \"currency\": \"USD\",\n  \"percentage\": 15,\n  \"expiry_date\": \"2024-12-31T23:59:59Z\",\n  \"max_redemptions\": 100,\n  \"duration_in_months\": 6\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.creem.io/v1/discounts")

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

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"Holiday Sale\",\n  \"duration\": \"repeating\",\n  \"applies_to_products\": [\n    \"prod_123\",\n    \"prod_456\"\n  ],\n  \"code\": \"HOLIDAY2024\",\n  \"amount\": 20,\n  \"currency\": \"USD\",\n  \"percentage\": 15,\n  \"expiry_date\": \"2024-12-31T23:59:59Z\",\n  \"max_redemptions\": 100,\n  \"duration_in_months\": 6\n}"

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

{
  "id": "<string>",
  "object": "discount",
  "status": "active",
  "name": "Holiday Sale",
  "code": "HOLIDAY2024",
  "type": "percentage",
  "amount": 20,
  "currency": "USD",
  "percentage": 15,
  "expiry_date": "2024-12-31T23:59:59Z",
  "max_redemptions": 100,
  "duration": "repeating",
  "duration_in_months": 6,
  "applies_to_products": [
    "prod_123",
    "prod_456"
  ],
  "redeem_count": 15
}

POST

discounts

Create a discount.

curl --request POST \
  --url https://api.creem.io/v1/discounts \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "Holiday Sale",
  "duration": "repeating",
  "applies_to_products": [
    "prod_123",
    "prod_456"
  ],
  "code": "HOLIDAY2024",
  "amount": 20,
  "currency": "USD",
  "percentage": 15,
  "expiry_date": "2024-12-31T23:59:59Z",
  "max_redemptions": 100,
  "duration_in_months": 6
}
'

import requests

url = "https://api.creem.io/v1/discounts"

payload = {
    "name": "Holiday Sale",
    "duration": "repeating",
    "applies_to_products": ["prod_123", "prod_456"],
    "code": "HOLIDAY2024",
    "amount": 20,
    "currency": "USD",
    "percentage": 15,
    "expiry_date": "2024-12-31T23:59:59Z",
    "max_redemptions": 100,
    "duration_in_months": 6
}
headers = {
    "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-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'Holiday Sale',
    duration: 'repeating',
    applies_to_products: ['prod_123', 'prod_456'],
    code: 'HOLIDAY2024',
    amount: 20,
    currency: 'USD',
    percentage: 15,
    expiry_date: '2024-12-31T23:59:59Z',
    max_redemptions: 100,
    duration_in_months: 6
  })
};

fetch('https://api.creem.io/v1/discounts', 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.creem.io/v1/discounts",
  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' => 'Holiday Sale',
    'duration' => 'repeating',
    'applies_to_products' => [
        'prod_123',
        'prod_456'
    ],
    'code' => 'HOLIDAY2024',
    'amount' => 20,
    'currency' => 'USD',
    'percentage' => 15,
    'expiry_date' => '2024-12-31T23:59:59Z',
    'max_redemptions' => 100,
    'duration_in_months' => 6
  ]),
  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.creem.io/v1/discounts"

	payload := strings.NewReader("{\n  \"name\": \"Holiday Sale\",\n  \"duration\": \"repeating\",\n  \"applies_to_products\": [\n    \"prod_123\",\n    \"prod_456\"\n  ],\n  \"code\": \"HOLIDAY2024\",\n  \"amount\": 20,\n  \"currency\": \"USD\",\n  \"percentage\": 15,\n  \"expiry_date\": \"2024-12-31T23:59:59Z\",\n  \"max_redemptions\": 100,\n  \"duration_in_months\": 6\n}")

	req, _ := http.NewRequest("POST", 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.post("https://api.creem.io/v1/discounts")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Holiday Sale\",\n  \"duration\": \"repeating\",\n  \"applies_to_products\": [\n    \"prod_123\",\n    \"prod_456\"\n  ],\n  \"code\": \"HOLIDAY2024\",\n  \"amount\": 20,\n  \"currency\": \"USD\",\n  \"percentage\": 15,\n  \"expiry_date\": \"2024-12-31T23:59:59Z\",\n  \"max_redemptions\": 100,\n  \"duration_in_months\": 6\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.creem.io/v1/discounts")

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

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"Holiday Sale\",\n  \"duration\": \"repeating\",\n  \"applies_to_products\": [\n    \"prod_123\",\n    \"prod_456\"\n  ],\n  \"code\": \"HOLIDAY2024\",\n  \"amount\": 20,\n  \"currency\": \"USD\",\n  \"percentage\": 15,\n  \"expiry_date\": \"2024-12-31T23:59:59Z\",\n  \"max_redemptions\": 100,\n  \"duration_in_months\": 6\n}"

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

{
  "id": "<string>",
  "object": "discount",
  "status": "active",
  "name": "Holiday Sale",
  "code": "HOLIDAY2024",
  "type": "percentage",
  "amount": 20,
  "currency": "USD",
  "percentage": 15,
  "expiry_date": "2024-12-31T23:59:59Z",
  "max_redemptions": 100,
  "duration": "repeating",
  "duration_in_months": 6,
  "applies_to_products": [
    "prod_123",
    "prod_456"
  ],
  "redeem_count": 15
}

Authorizations

x-api-key

string

header

required

API key for authentication. You can find your API key in the Creem dashboard under Settings > API Keys.

Body

application/json

Discount creation payload

name

string

required

The name of the discount.

Example:

"Holiday Sale"

type

enum<string>

required

The type of the discount, either "percentage" or "fixed".

Available options:

percentage,

fixed

duration

enum<string>

required

The duration type for the discount.

Available options:

forever,

once,

repeating

Example:

"repeating"

applies_to_products

string[]

required

The list of product IDs to which this discount applies.

Example:

["prod_123", "prod_456"]

code

string

Optional discount code. If left empty, a code will be generated.

Example:

"HOLIDAY2024"

amount

number

The fixed value for the discount. Only applicable if the type is "fixed".

Example:

20

currency

string

The currency of the discount. Only required if type is "fixed".

Example:

"USD"

percentage

number

The percentage value for the discount. Only applicable if the type is "percentage".

Example:

15

expiry_date

string<date-time>

The expiry date of the discount.

Example:

"2024-12-31T23:59:59Z"

max_redemptions

number

The maximum number of redemptions for the discount.

Example:

100

duration_in_months

number

The number of months the discount is valid for. Only applicable if the duration is "repeating" and the product is a subscription.

Example:

6

Response

Successfully created a discount

string

required

Unique identifier for the object.

mode

enum<string>

required

String representing the environment.

Available options:

test,

prod,

sandbox

object

string

required

A string representing the object’s type. Objects of the same type share the same value.

Example:

"discount"

status

enum<string>

required

The status of the discount (e.g., active, inactive).

Available options:

deleted,

active,

draft,

expired,

scheduled

Example:

"active"

name

string

required

The name of the discount.

Example:

"Holiday Sale"

code

string

required

The discount code. A unique identifier for the discount.

Example:

"HOLIDAY2024"

type

enum<string>

required

The type of the discount, either "percentage" or "fixed".

Available options:

percentage,

fixed

Example:

"percentage"

amount

number

The amount of the discount. Can be a percentage or a fixed amount.

Example:

20

currency

string

The currency of the discount. Only required if type is "fixed".

Example:

"USD"

percentage

number

The percentage of the discount. Only applicable if type is "percentage".

Example:

15

expiry_date

string<date-time>

The expiry date of the discount.

Example:

"2024-12-31T23:59:59Z"

max_redemptions

number

The maximum number of redemptions allowed for the discount.

Example:

100

duration

enum<string>

The duration type for the discount.

Available options:

forever,

once,

repeating

Example:

"repeating"

duration_in_months

number

The number of months the discount is valid for. Only applicable if the duration is "repeating" and the product is a subscription.

Example:

6

applies_to_products

string[]

The list of product IDs to which this discount applies.

Example:

["prod_123", "prod_456"]

redeem_count

number

The number of times this discount has been redeemed.

Example:

15

List license instances Delete a discount

API Documentation

Checkout

Product

Customer

Transactions

Affiliate

License

Discount Code

Subscription

Stats

Customer Credits

Moderation

Create a discount

Authorizations

Body

Response