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": {}
}
'
{
  "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

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

Response

OK