com.gigs.voucher.created

Name
object
Type
string
required
Description
Type of object is always event.
Name
id
Type
string
required
Description
Unique identifier for the event.
Example: evt_0SNlurA049MEWV5gNTcQ5A07h3Ol
Name
data
Type
object
required
Description
Name
object
Type
string
required
Description
Type of object is always voucher.
Name
id
Type
string
required
Description
Unique identifier for the voucher.
Example: vou_0SNlurA049MEWV0h2jfjkdiOdplN
Name
name
Type
string
required
Description
The voucher's name.
Example: Monthly Basic 15%
Name
priceDiscount
Type
nullable object
required
Description
The price amount of the discount applied via the voucher. A voucher object has always either a priceDiscount or a priceDiscountPercentage.
Name
priceDiscountPercentage
Type
nullable number
required
Description
The percentage amount of the discount applied via the voucher. A voucher object has always either a priceDiscount or a priceDiscountPercentage.
Example: 30.12
>= 1
<= 100
Name
recurrence
Type
object
required
Description
Details on whether and for how long the discounts applied via the voucher recur.
Name
redemptions
Type
integer
required
Description
Number of times the voucher has been redeemed.
Example: 2
Name
restrictions
Type
object
required
Description
Conditions under which the voucher can be used.
Name
retiredReason
Type
nullable string
required
Description
Label indicating the reason why the voucher is retired.
Allowed values: , manualAction, expired, maxRedemptionsReached, unknown
Name
status
Type
string
required
Description
Allowed values: available, retired
Name
createdAt
Type
string
required
Description
Time when the voucher was created.
Example: 2021-02-14T19:38:34Z
Name
datacontenttype
Type
string
required
Description
The RFC 2046 content-type.
Example: application/json
Default: application/json
Name
project
Type
string
required
Description
Unique identifier for the project where the event occurred.
Example: gigs
Name
source
Type
string
required
Description
URI identifying the event source.
Example: https://api.gigs.com
Default: https://api.gigs.com
Name
specversion
Type
string
required
Description
The CloudEvents spec version.
Example: 1.0
Default: 1.0
Name
time
Type
string
required
Description
Time when the event occurred.
Example: 2022-03-16T14:12:42Z
Name
type
Type
string
required
Description
Type is always com.gigs.voucher.created.
Name
version
Type
string
required
Description
API version used to serialize the data and the event itself.
Default: 2024-08-29

Example

{
  "object": "event",
  "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
  "data": {
    "object": "voucher",
    "id": "vou_0SNlurA049MEWV0h2jfjkdiOdplN",
    "name": "Monthly Basic 15%",
    "priceDiscount": {
      "amount": 999,
      "currency": "USD"
    },
    "priceDiscountPercentage": 30.12,
    "recurrence": {
      "type": "once"
    },
    "redemptions": 2,
    "restrictions": {
      "expiresAt": "2021-04-14T19:38:34Z"
    },
    "status": "available",
    "createdAt": "2021-02-14T19:38:34Z"
  },
  "datacontenttype": "application/json",
  "project": "gigs",
  "source": "https://api.gigs.com",
  "specversion": "1.0",
  "time": "2022-03-16T14:12:42Z",
  "type": "com.gigs.voucher.created",
  "version": "2024-08-29"
}