Create discount

Typescript (SDK)

import { Crevio } from "@crevio/sdk";

const crevio = new Crevio({
  apiKey: process.env["CREVIO_API_KEY"] ?? "",
});

async function run() {
  const result = await crevio.discounts.create({});

  console.log(result);
}

run();

curl --request POST \
  --url https://api.crevio.co/v1/discounts \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "code": "<string>",
  "amount_off": 123,
  "percent_off": 123,
  "currency": "<string>",
  "duration_in_months": 123,
  "starts_at": "2023-11-07T05:31:56Z",
  "redeem_by": "2023-11-07T05:31:56Z",
  "max_redemptions": 2,
  "minimum_amount": 2,
  "once_per_customer": true,
  "first_order_only": true,
  "price_variants": [
    "<string>"
  ]
}
'

import requests

url = "https://api.crevio.co/v1/discounts"

payload = {
    "code": "<string>",
    "amount_off": 123,
    "percent_off": 123,
    "currency": "<string>",
    "duration_in_months": 123,
    "starts_at": "2023-11-07T05:31:56Z",
    "redeem_by": "2023-11-07T05:31:56Z",
    "max_redemptions": 2,
    "minimum_amount": 2,
    "once_per_customer": True,
    "first_order_only": True,
    "price_variants": ["<string>"]
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    code: '<string>',
    amount_off: 123,
    percent_off: 123,
    currency: '<string>',
    duration_in_months: 123,
    starts_at: '2023-11-07T05:31:56Z',
    redeem_by: '2023-11-07T05:31:56Z',
    max_redemptions: 2,
    minimum_amount: 2,
    once_per_customer: true,
    first_order_only: true,
    price_variants: ['<string>']
  })
};

fetch('https://api.crevio.co/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.crevio.co/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([
    'code' => '<string>',
    'amount_off' => 123,
    'percent_off' => 123,
    'currency' => '<string>',
    'duration_in_months' => 123,
    'starts_at' => '2023-11-07T05:31:56Z',
    'redeem_by' => '2023-11-07T05:31:56Z',
    'max_redemptions' => 2,
    'minimum_amount' => 2,
    'once_per_customer' => true,
    'first_order_only' => true,
    'price_variants' => [
        '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "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://api.crevio.co/v1/discounts"

	payload := strings.NewReader("{\n  \"code\": \"<string>\",\n  \"amount_off\": 123,\n  \"percent_off\": 123,\n  \"currency\": \"<string>\",\n  \"duration_in_months\": 123,\n  \"starts_at\": \"2023-11-07T05:31:56Z\",\n  \"redeem_by\": \"2023-11-07T05:31:56Z\",\n  \"max_redemptions\": 2,\n  \"minimum_amount\": 2,\n  \"once_per_customer\": true,\n  \"first_order_only\": true,\n  \"price_variants\": [\n    \"<string>\"\n  ]\n}")

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

	req.Header.Add("Authorization", "<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.crevio.co/v1/discounts")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"code\": \"<string>\",\n  \"amount_off\": 123,\n  \"percent_off\": 123,\n  \"currency\": \"<string>\",\n  \"duration_in_months\": 123,\n  \"starts_at\": \"2023-11-07T05:31:56Z\",\n  \"redeem_by\": \"2023-11-07T05:31:56Z\",\n  \"max_redemptions\": 2,\n  \"minimum_amount\": 2,\n  \"once_per_customer\": true,\n  \"first_order_only\": true,\n  \"price_variants\": [\n    \"<string>\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.crevio.co/v1/discounts")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"code\": \"<string>\",\n  \"amount_off\": 123,\n  \"percent_off\": 123,\n  \"currency\": \"<string>\",\n  \"duration_in_months\": 123,\n  \"starts_at\": \"2023-11-07T05:31:56Z\",\n  \"redeem_by\": \"2023-11-07T05:31:56Z\",\n  \"max_redemptions\": 2,\n  \"minimum_amount\": 2,\n  \"once_per_customer\": true,\n  \"first_order_only\": true,\n  \"price_variants\": [\n    \"<string>\"\n  ]\n}"

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

{
  "id": "<string>",
  "object": "<string>",
  "status": "active",
  "discount_type": "percentage",
  "code": "<string>",
  "amount_off": 123,
  "duration": "forever",
  "duration_in_months": 123,
  "max_redemptions": 123,
  "times_redeemed": 123,
  "starts_at": "2023-11-07T05:31:56Z",
  "redeem_by": "2023-11-07T05:31:56Z",
  "minimum_amount": 123,
  "once_per_customer": true,
  "first_order_only": true,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "percent_off": 123,
  "currency": "<string>"
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "bad_request",
    "message": "The request was malformed or contained invalid parameters"
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "authentication_required",
    "message": "You did not provide an API key."
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "forbidden",
    "message": "You do not have permission to perform this action"
  }
}

{
  "error": {
    "type": "validation_error",
    "code": "validation_failed",
    "message": "Email is required",
    "errors": {
      "email": [
        "can't be blank"
      ]
    }
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "rate_limit_exceeded",
    "message": "Too many requests. Please retry later."
  }
}

{
  "error": {
    "type": "api_error",
    "code": "internal_error",
    "message": "An unexpected error occurred"
  }
}

POST

discounts

Typescript (SDK)

import { Crevio } from "@crevio/sdk";

const crevio = new Crevio({
  apiKey: process.env["CREVIO_API_KEY"] ?? "",
});

async function run() {
  const result = await crevio.discounts.create({});

  console.log(result);
}

run();

curl --request POST \
  --url https://api.crevio.co/v1/discounts \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "code": "<string>",
  "amount_off": 123,
  "percent_off": 123,
  "currency": "<string>",
  "duration_in_months": 123,
  "starts_at": "2023-11-07T05:31:56Z",
  "redeem_by": "2023-11-07T05:31:56Z",
  "max_redemptions": 2,
  "minimum_amount": 2,
  "once_per_customer": true,
  "first_order_only": true,
  "price_variants": [
    "<string>"
  ]
}
'

import requests

url = "https://api.crevio.co/v1/discounts"

payload = {
    "code": "<string>",
    "amount_off": 123,
    "percent_off": 123,
    "currency": "<string>",
    "duration_in_months": 123,
    "starts_at": "2023-11-07T05:31:56Z",
    "redeem_by": "2023-11-07T05:31:56Z",
    "max_redemptions": 2,
    "minimum_amount": 2,
    "once_per_customer": True,
    "first_order_only": True,
    "price_variants": ["<string>"]
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    code: '<string>',
    amount_off: 123,
    percent_off: 123,
    currency: '<string>',
    duration_in_months: 123,
    starts_at: '2023-11-07T05:31:56Z',
    redeem_by: '2023-11-07T05:31:56Z',
    max_redemptions: 2,
    minimum_amount: 2,
    once_per_customer: true,
    first_order_only: true,
    price_variants: ['<string>']
  })
};

fetch('https://api.crevio.co/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.crevio.co/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([
    'code' => '<string>',
    'amount_off' => 123,
    'percent_off' => 123,
    'currency' => '<string>',
    'duration_in_months' => 123,
    'starts_at' => '2023-11-07T05:31:56Z',
    'redeem_by' => '2023-11-07T05:31:56Z',
    'max_redemptions' => 2,
    'minimum_amount' => 2,
    'once_per_customer' => true,
    'first_order_only' => true,
    'price_variants' => [
        '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "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://api.crevio.co/v1/discounts"

	payload := strings.NewReader("{\n  \"code\": \"<string>\",\n  \"amount_off\": 123,\n  \"percent_off\": 123,\n  \"currency\": \"<string>\",\n  \"duration_in_months\": 123,\n  \"starts_at\": \"2023-11-07T05:31:56Z\",\n  \"redeem_by\": \"2023-11-07T05:31:56Z\",\n  \"max_redemptions\": 2,\n  \"minimum_amount\": 2,\n  \"once_per_customer\": true,\n  \"first_order_only\": true,\n  \"price_variants\": [\n    \"<string>\"\n  ]\n}")

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

	req.Header.Add("Authorization", "<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.crevio.co/v1/discounts")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"code\": \"<string>\",\n  \"amount_off\": 123,\n  \"percent_off\": 123,\n  \"currency\": \"<string>\",\n  \"duration_in_months\": 123,\n  \"starts_at\": \"2023-11-07T05:31:56Z\",\n  \"redeem_by\": \"2023-11-07T05:31:56Z\",\n  \"max_redemptions\": 2,\n  \"minimum_amount\": 2,\n  \"once_per_customer\": true,\n  \"first_order_only\": true,\n  \"price_variants\": [\n    \"<string>\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.crevio.co/v1/discounts")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"code\": \"<string>\",\n  \"amount_off\": 123,\n  \"percent_off\": 123,\n  \"currency\": \"<string>\",\n  \"duration_in_months\": 123,\n  \"starts_at\": \"2023-11-07T05:31:56Z\",\n  \"redeem_by\": \"2023-11-07T05:31:56Z\",\n  \"max_redemptions\": 2,\n  \"minimum_amount\": 2,\n  \"once_per_customer\": true,\n  \"first_order_only\": true,\n  \"price_variants\": [\n    \"<string>\"\n  ]\n}"

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

{
  "id": "<string>",
  "object": "<string>",
  "status": "active",
  "discount_type": "percentage",
  "code": "<string>",
  "amount_off": 123,
  "duration": "forever",
  "duration_in_months": 123,
  "max_redemptions": 123,
  "times_redeemed": 123,
  "starts_at": "2023-11-07T05:31:56Z",
  "redeem_by": "2023-11-07T05:31:56Z",
  "minimum_amount": 123,
  "once_per_customer": true,
  "first_order_only": true,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "percent_off": 123,
  "currency": "<string>"
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "bad_request",
    "message": "The request was malformed or contained invalid parameters"
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "authentication_required",
    "message": "You did not provide an API key."
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "forbidden",
    "message": "You do not have permission to perform this action"
  }
}

{
  "error": {
    "type": "validation_error",
    "code": "validation_failed",
    "message": "Email is required",
    "errors": {
      "email": [
        "can't be blank"
      ]
    }
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "rate_limit_exceeded",
    "message": "Too many requests. Please retry later."
  }
}

{
  "error": {
    "type": "api_error",
    "code": "internal_error",
    "message": "An unexpected error occurred"
  }
}

Authorizations

Authorization

string

header

required

API key in the format: Bearer {api_token}

Headers

Idempotency-Key

string

Makes this write safe to retry: a repeat with the same key replays the first response instead of creating a second resource. Scoped to the account, remembered for 24 hours; reusing a key with a different payload is an error.

Maximum string length: 255

Body

application/json

code

string

discount_type

enum<string>

Available options:

percentage,

fixed

amount_off

integer | null

percent_off

number | null

currency

string | null

duration

enum<string>

Available options:

forever,

once,

repeating

duration_in_months

integer | null

starts_at

string<date-time> | null

When the code becomes usable. Checkout rejects it before this time; omit it to make the code usable right away. For a sale that starts later, create the discount now with starts_at set rather than scheduling its creation.

redeem_by

string<date-time> | null

When the code stops being usable. Must be in the future and after starts_at.

max_redemptions

integer | null

How many live orders can use the code, across all customers. Test purchases don't count. The limit set at creation also stays on the Stripe coupon, so raising it later has no effect past that number.

Required range: x >= 1

minimum_amount

integer | null

Smallest order subtotal, in cents before the discount, that can use the code. Requires currency; an order in another currency can't use the code. null removes it.

Required range: x >= 1

once_per_customer

boolean

Each customer can use the code on one live order.

first_order_only

boolean

Only customers with no earlier live paid order from this business can use the code. Free orders and test purchases don't count as earlier orders.

price_variants

string[]

Response

Discount created

string

required

object

string

required

status

enum<string>

required

Available options:

active,

inactive

discount_type

enum<string>

required

Available options:

percentage,

fixed

code

string

required

amount_off

integer | null

required

duration

enum<string>

required

Available options:

forever,

once,

repeating

duration_in_months

integer | null

required

max_redemptions

integer | null

required

times_redeemed

integer

required

starts_at

string<date-time> | null

required

redeem_by

string<date-time> | null

required

minimum_amount

integer | null

required

once_per_customer

boolean

required

first_order_only

boolean

required

created_at

string<date-time>

required

updated_at

string<date-time>

required

percent_off

number<double> | null

required

currency

string | null

required

Overview

Products & catalog

Selling & orders

Customers & leads

Marketing

Website & content

Scheduling & bookings

Calls & phone

AI & automation

Media library

Business & formation

Account & platform

Create discount

Authorizations

Headers

Body

Response