Retrieve a voucher

Returns the details of a specific voucher, including its redemption count and expiry.

GET

Headers

string

The Bearer token for authentication.

string

The user agent of the request. Must contain at least two identifiers separated by a space.

string

The content type of the request.

Parameters

string

The ID of the voucher to retrieve.

Response Body

application/json
boolean

Indicates that the request was successful.

object

The voucher data.

string

The ID of the voucher.

string

The description of the voucher.

string

The code of the voucher.

float

The amount of the voucher.

object

The redeems of the voucher.

number

The count of redeems.

number

The maximum count of redeems.

boolean

Whether the voucher is archived.

date-time

The date and time the voucher was created.

date-time

The date and time the voucher expires.