Vouchers

Events

Action Event name
creating a voucher voucher.created
editing voucher email voucher.updated
void a voucher voucher.updated
redeeming a voucher (paying with a voucher) voucher.updated

Payload example

{
  "id": "string",
  "attemptId": "string",
  "livemode": "boolean",
  "created": "int",
  "event": "string",
  "data": {
    "voucherType": "string",
    "voided": "boolean",
    "value": "int",
    "userId": "string",
    "userComments": [],
    "summary": [],
    "purchased": "int",
    "productTypes": [
      "string"
    ],
    "productType": "string",
    "productRoutes": {
      "to": "string",
      "from": "string"
    },
    "internalId": "string",
    "fareType": "string",
    "expirationDate": {
      "value": "string",
      "offset": "int"
    },
    "emailedTo": "string",
    "createdByUserEmail": "string",
    "createdBy": "string",
    "balance": "int",
    "assignedCustomer": {
      "lastName": "string",
      "firstName": "string"
    },
    "agencyId": "string",
    "accountId": "string",
    "_id": "string",
    "deleted": "boolean",
    "createdAt": {
      "value": "string",
      "offset": "int"
    },
    "updatedAt": {
      "value": "string",
      "offset": "int"
    }
  }
}