HomeGuidesAPI ReferenceChangelog
Terms of Use
API Reference

Voucher / Create

Create new Voucher

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
integer | null

The operator ID for this resource.
Required for global admin tokens.
Optional for operator-scoped tokens (defaults to token's operator).

float
required
date | null

RFC 3339 formatted date. Defines the date on which the voucher expires. The field can be calculated based on the redeemedAt timestamp and the validityPeriod field if the validityPeriod is set and the expireDate is not.

string | null
enum

Defines the validity period for the voucher. When a user redeems the voucher, this period is added to the redeemedAt timestamp to calculate the voucher's expireDate. This field is only used when expireDate is not already set - if expireDate has a value, this period is ignored and the defined expireDate is used instead.

date | null

The date before which the voucher should be assigned to user in order to be valid. RFC 3339 formatted date

string
string
length between 3 and 3

The prefix of the voucher's code.

title
array of objects

The title of the voucher.

title
Responses

Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json