POST/api/v2/admin/discount-codes

Creates a new discount code

Authentication

Send your API key in the x-api-key header on every request.

Parameters

Request parameters
FieldTypeRequiredDescription
companyId (query)unknownNo

Request body

application/json

Request body fields
FieldTypeRequiredDescription
CodestringNo
DescriptionstringNo
DiscountTypestringNo
BuyDiscountPercentunknownNo
MonthlyDiscountPercentunknownNo
YearlyDiscountPercentunknownNo
BuyDiscountFixedunknownNo
MonthlyDiscountFixedunknownNo
YearlyDiscountFixedunknownNo
CardDiscountDurationMonthsunknownNo
TierDiscountDurationMonthsunknownNo
TierMonthlyDiscountPercentunknownNo
TierYearlyDiscountPercentunknownNo
TierMonthlyDiscountFixedunknownNo
TierYearlyDiscountFixedunknownNo
MaxUsesTotalunknownNo
MaxUsesPerUserunknownNo
ValidFromstring (date-time)No
ValidTillstring (date-time)No
ApplicableUserIdsarray of unknownNo
IsActivebooleanNo

Responses

200 — OK

Response 200 fields
FieldTypeRequiredDescription
IdunknownNo
CodestringNo
DescriptionstringNo
CompanyIdunknownNo
DiscountTypestringNo
BuyDiscountPercentunknownNo
MonthlyDiscountPercentunknownNo
YearlyDiscountPercentunknownNo
BuyDiscountFixedunknownNo
MonthlyDiscountFixedunknownNo
YearlyDiscountFixedunknownNo
CardDiscountDurationMonthsunknownNo
TierDiscountDurationMonthsunknownNo
TierMonthlyDiscountPercentunknownNo
TierYearlyDiscountPercentunknownNo
TierMonthlyDiscountFixedunknownNo
TierYearlyDiscountFixedunknownNo
MaxUsesTotalunknownNo
MaxUsesPerUserunknownNo
CurrentUsesunknownNo
ValidFromstring (date-time)No
ValidTillstring (date-time)No
ApplicableUserIdsarray of unknownNo
IsActivebooleanNo
CreatedAtstring (date-time)No
UpdatedAtstring (date-time)No
CreatedByunknownNo

Example request

curl -X POST "https://{base_url}/api/v2/admin/discount-codes" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

This page is generated from the live OpenAPI specification and always matches the current API.