com.gigs.voucherCode.updated

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 voucherCode.
Name
id
Type
string
required
Description
Unique identifier for the voucher code.
Example: voc_0SNlurA049MEWV0Q5vaTJnKoXc1v
Name
code
Type
string
required
Description
The associated code.
Example: BlackFriday22
Name
redemptions
Type
integer
required
Description
Number of times the voucher code has been redeemed.
Example: 2
Name
restrictions
Type
object
required
Description
Conditions under which the voucher code can be redeemed.
Name
retiredReason
Type
nullable string
required
Description
Label indicating the reason why the voucher code is retired.
Allowed values: , expired, voucherExpired, maxRedemptionsReached, voucherMaxRedemptionsReached, voucherManuallyRetired
Name
status
Type
string
required
Description
Allowed values: active, inactive, retired
Name
voucher
Type
string
required
Description
Unique identifier of the voucher associated to the voucher code.
Example: vou_0SNlurA049MEWV0h2jfjkdiOdplN
Name
createdAt
Type
string
required
Description
Time when the voucher code 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
previousData
Type
object
Description
Present only for events of type `*.updated`. Contains the values fields in the schema had prior to the update. This field is the result of a shallow diff of the previous schema (i.e., if a nested field has changed, then the entire object will be included).
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.voucherCode.updated.
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": "voucherCode",
    "id": "voc_0SNlurA049MEWV0Q5vaTJnKoXc1v",
    "code": "BlackFriday22",
    "redemptions": 2,
    "restrictions": {
      "firstTimeTransaction": true,
      "minimumPrice": {
        "amount": 999,
        "currency": "USD"
      },
      "expiresAt": "2021-04-14T19:38:34Z"
    },
    "status": "active",
    "voucher": "vou_0SNlurA049MEWV0h2jfjkdiOdplN",
    "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.voucherCode.updated",
  "version": "2024-08-29"
}