latestOpenAPI 3.1.12026-08-108026304.2 KB

7b222e8ec91c

Vouchers

Update a voucher

Update an exiting voucher's name. If any voucher codes are given, create new voucher codes and associate them with the voucher

post/v1/vouchers/{voucher_id}

Path parameters

voucher_idstring required

The unique identifier for the existing voucher

Response

Successfully updated the voucher

objectstring

idstring

A unique identifier for the voucher

available_codesinteger

The number of unused voucher codes belonging to the voucher

event_series_idsstring[]

List of event series IDs

namestring

A descriptive name given to the voucher

partial_redemption'true' | 'false'

Indicates whether voucher can be partially redeemed

total_codesinteger

Total number of voucher codes belonging to the voucher

usable_on_any_event'true' | 'false' nullable

Indicates whether voucher can be used on any event

type'PROMO' | 'GIFT_CARD'

Type of voucher

valueinteger

The integer value in cents given to the voucher

Example response

{
  "object": "voucher",
  "id": "vo_123",
  "available_codes": 7,
  "event_series_ids": [
    "es_123",
    "es_234",
    "es_345"
  ],
  "interval": null,
  "expiry": {
    "date": "2020-05-01",
    "formatted": "Fri 1 May 2020 10:30 PM",
    "iso": "2020-05-01T22:30:00+01:00",
    "time": "22:30",
    "timezone": "+01:00",
    "unix": 1588368600
  },
  "name": "Test Voucher",
  "partial_redemption": "true",
  "total_codes": 25,
  "type": "PROMO",
  "usable_on_any_event": "true",
  "value": 540
}