Skip to main content
POST
/
discounts
Create discount
curl --request POST \
  --url https://api.example.com/discounts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-environment: <x-environment>' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "productHandle": "<string>",
  "invoiceText": "<string>",
  "percentage": 123,
  "expiresAt": "2023-11-07T05:31:56Z",
  "amounts": {}
}
'
import requests

url = "https://api.example.com/discounts"

payload = {
"name": "<string>",
"description": "<string>",
"productHandle": "<string>",
"invoiceText": "<string>",
"percentage": 123,
"expiresAt": "2023-11-07T05:31:56Z",
"amounts": {}
}
headers = {
"x-environment": "<x-environment>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

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

print(response.text)
const options = {
method: 'POST',
headers: {
'x-environment': '<x-environment>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
name: '<string>',
description: '<string>',
productHandle: '<string>',
invoiceText: '<string>',
percentage: 123,
expiresAt: '2023-11-07T05:31:56Z',
amounts: {}
})
};

fetch('https://api.example.com/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.example.com/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' => '<string>',
'description' => '<string>',
'productHandle' => '<string>',
'invoiceText' => '<string>',
'percentage' => 123,
'expiresAt' => '2023-11-07T05:31:56Z',
'amounts' => [

]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"x-environment: <x-environment>"
],
]);

$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/discounts"

payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"productHandle\": \"<string>\",\n \"invoiceText\": \"<string>\",\n \"percentage\": 123,\n \"expiresAt\": \"2023-11-07T05:31:56Z\",\n \"amounts\": {}\n}")

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

req.Header.Add("x-environment", "<x-environment>")
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://api.example.com/discounts")
.header("x-environment", "<x-environment>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"productHandle\": \"<string>\",\n \"invoiceText\": \"<string>\",\n \"percentage\": 123,\n \"expiresAt\": \"2023-11-07T05:31:56Z\",\n \"amounts\": {}\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/discounts")

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

request = Net::HTTP::Post.new(url)
request["x-environment"] = '<x-environment>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"productHandle\": \"<string>\",\n \"invoiceText\": \"<string>\",\n \"percentage\": 123,\n \"expiresAt\": \"2023-11-07T05:31:56Z\",\n \"amounts\": {}\n}"

response = http.request(request)
puts response.read_body
{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>"
}
{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}
{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}
{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}

Headers

x-environment
string<uuid>
required

Configure which environment the request will handle. If the provided credentials do not allow access to this specified environment, a 403 Forbidden response is returned.

Body

application/json
name
string
required
Required string length: 1 - 50
description
string | null

An internal short description for this discount.

productHandle
string | null

Stock keeping unit of line. See https://go.plude.io/h21010.

Maximum string length: 50
invoiceText
string | null

A description that will be shown on the invoice item.

Maximum string length: 500
percentage
number<double> | null

The discount amount in percentage. between 0.0001 and 1.0000. Detaults to 0.

expiresAt
string<date-time> | null

Datetime of when this discount expires. Discount can no longer be applied after this date has elapsed.

amounts
object | null

Dictionary with discount amounts. Key is a three-letter ISO currency code, in lowercase. Must be a supported currency.

Response

OK