Skip to main content
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();
{
  "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,
  "redeem_by": "2023-11-07T05:31:56Z",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "percent_off": 123,
  "currency": "<string>"
}

Authorizations

Authorization
string
header
required

API key in the format: Bearer {api_token}

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
redeem_by
string<date-time> | null
max_redemptions
integer | null
price_variants
string[]

Response

Discount created

id
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
redeem_by
string<date-time> | null
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
percent_off
number<double> | null
required
currency
string | null
required