YUyuvexpay
Coupons

List coupons

Changed on

List the coupons of your account that are not deleted, newest first. Requires the coupons:read scope. Coupons belong to the environment of the key: a ypk_test_ key manages sandbox coupons and a ypk_live_ key production coupons, and a payment uses only coupons of its own environment.

get/v1/coupons

Request

Query parameters

searchstring

Return the coupons whose code contains this text, case-insensitive.

active'true' | 'false'

Filter by active. Only true or false; any other value returns 400.

pageinteger

Page number for pagination.

limitinteger

Number of items per page (1-100).

Response

Coupons listed.

Example response

{
  "coupons": [
    {
      "code": "BLACK10"
    }
  ]
}

Changes