Cupons

Listar Cupons

Lista os cupons cadastrados na conta, com paginação e filtros por status e busca por nome/código.

GET/v1/coupons

Base URL Produção:https://api.validapay.com.br

Base URL Sandbox:https://sandbox.validapay.com.br

Authorizations

bearer

Authorization

string obrigatório

Cabeçalho de autenticação Bearer no formato Bearer {{token}} onde {{token}} é o seu token OAuth2.

Escopos requeridos

products/read

Query Parameters

limitopcional

Quantidade de itens por página (default 50) - optional

lastKeyobrigatório

base64 - optional

statusobrigatório

ACTIVE | PAUSED | INACTIVE - optional

searchobrigatório

busca por nome ou código - optional

← Anterior

Criar Cupom

Buscar Cupom

const url = 'https://sandbox.validapay.com.br/v1/coupons?limit=50&lastKey=&status=&search=?limit=50';

const options = {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer {{token}}'
  },
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

Response Examples

200200▾

JSON

{
  "items": [
    {
      "couponId": "coup_1789157079333_fq358baak",
      "accountId": "4231833",
      "code": "BEMVINDO10",
      "name": "Cupom de boas-vindas",
      "description": "10% na primeira cobrança",
      "discountType": "PERCENTAGE",
      "discountValue": 10,
      "extraPeriodUnit": null,
      "maxCycles": 3,
      "maxRedemptions": 100,
      "currentRedemptions": 12,
      "minAmount": 50.0,
      "maxDiscount": 30.0,
      "validFrom": "2026-09-01T00:00:00.000Z",
      "validUntil": "2026-12-31T23:59:59.000Z",
      "productIds": [
        "price_1788364755079_psuecwgdc"
      ],
      "firstTimeOnly": true,
      "appliesTo": "RECURRING",
      "status": "ACTIVE",
      "createdAt": "2026-09-01T10:00:00.000Z",
      "updatedAt": "2026-09-01T10:00:00.000Z"
    }
  ],
  "pagination": {
    "total": 1,
    "totalPages": 1,
    "limit": 50,
    "hasMore": false,
    "lastKey": null
  }
}

← Anterior

Criar Cupom

Buscar Cupom