Referência da API
Buscar cupom
Retorna o cupom completo, **incluindo a whitelist de Offers** (achatada, sem o intermediário, no campo `allowedOffers`) e um bloco `stats` com totais de uso. `stats.canEditDiscountFields` te diz se ainda dá pra duplicar e editar `discountType`/`discountValue` (só é `true` se ninguém usou o cupom ainda).
GET
/v2/coupons/:idAutenticação
HTTP Basic Auth. Envie sua secret key no header:
Authorization: Basic {base64(secret:SUA_SECRET_KEY)}Parâmetros
idstring (path, UUID)obrigatórioUUID do cupom.
Exemplo: cpn_a8f3d2e1-9b4c-4e5f-8a7d-2e5f6c1d4b9a
Respostas
200
Cupom encontrado. allowedOffers vem como array direto de objetos. stats.totalDiscounted é a soma em centavos de tudo que esse cupom já descontou.
JSON
{
"id": "cpn_a8f3d2e1-9b4c-4e5f-8a7d-2e5f6c1d4b9a",
"code": "VERAO2026",
"description": "Promoção de verão — 15% off",
"discountType": "PERCENTAGE",
"discountValue": 1500,
"status": "ACTIVE",
"maxUses": 500,
"currentUses": 47,
"validFrom": "2026-06-01T00:00:00.000Z",
"validUntil": "2026-12-31T23:59:59.000Z",
"minPurchaseAmount": 5000,
"metadata": { "campaign": "summer-launch" },
"deletedAt": null,
"createdAt": "2026-05-26T14:32:01.923Z",
"updatedAt": "2026-05-26T14:32:01.923Z",
"allowedOffers": [
{
"id": "pl_abc123",
"name": "Plano Premium",
"slug": "plano-premium",
"status": "ACTIVE",
"offer": {
"id": "off_xyz789",
"name": "Anual com desconto",
"product": { "id": "prd_111", "name": "Premium" }
}
}
],
"stats": {
"totalRedemptions": 47,
"totalDiscounted": 705000,
"canEditDiscountFields": false
}
}404
Cupom não encontrado nessa conta.
JSON
{ "status": 404, "error": "Cupom nao encontrado" }Exemplos
cURL
curl -X GET "https://api.pagnovo.com/v2/coupons/cpn_a8f3d2e1-9b4c-4e5f-8a7d-2e5f6c1d4b9a" \
-H "Authorization: Basic $(echo -n 'secret:SUA_SECRET_KEY' | base64)"