Skip to main content
POST
/
coupons
/
create
curl -X POST 'https://api.goatpay.com.br/v1/coupons/create' \
  -H 'X-API-Key: gp_live_SUA_CHAVE' \
  -H 'Content-Type: application/json' \
  -d '{
    "code": "VERAO10",
    "discountType": "PERCENT",
    "discountValue": 10,
    "maxUses": 100,
    "expiresAt": "2026-12-31T23:59:59.000Z",
    "paymentLinkIds": ["clx_link"]
  }'

{
  "success": true,
  "message": "Cupom criado",
  "data": {
    "id": "clx_coupon",
    "code": "VERAO10",
    "discountType": "PERCENT",
    "discountValue": 10,
    "maxUses": 100,
    "uses": 0,
    "status": "ACTIVE",
    "productIds": [],
    "paymentLinkIds": ["clx_link"]
  },
  "requestId": "req_abc"
}
URL: POST https://api.goatpay.com.br/v1/coupons/create · Permissão: coupons/create
curl -X POST 'https://api.goatpay.com.br/v1/coupons/create' \
  -H 'X-API-Key: gp_live_SUA_CHAVE' \
  -H 'Content-Type: application/json' \
  -d '{
    "code": "VERAO10",
    "discountType": "PERCENT",
    "discountValue": 10,
    "maxUses": 100,
    "expiresAt": "2026-12-31T23:59:59.000Z",
    "paymentLinkIds": ["clx_link"]
  }'

{
  "success": true,
  "message": "Cupom criado",
  "data": {
    "id": "clx_coupon",
    "code": "VERAO10",
    "discountType": "PERCENT",
    "discountValue": 10,
    "maxUses": 100,
    "uses": 0,
    "status": "ACTIVE",
    "productIds": [],
    "paymentLinkIds": ["clx_link"]
  },
  "requestId": "req_abc"
}

​
Corpo

​
code
string
required
Código (até 32 caracteres, único na conta).
​
discountType
string
required
PERCENT ou FIXED.
​
discountValue
number
required
Percentual ou valor fixo em BRL.
​
maxUses
number
Limite de usos.
​
expiresAt
string
ISO 8601.
​
productIds
array
Restringe a produtos.
​
paymentLinkIds
array
Restringe a links.
Guia: Cupons.

Authorizations

​
X-API-Key
string
header
required

Chave gp_live_... criada em Integrações → Chaves de API no dashboard.

Body

application/json
​
code
string
required
Maximum string length: 32
​
discountType
enum<string>
required
Available options:
PERCENT,
FIXED
​
discountValue
number
required
Required range: x >= 0.01
​
maxUses
integer
Required range: x >= 1
​
expiresAt
string<date-time>
​
productIds
string[]
​
paymentLinkIds
string[]

Response

200 - application/json

Cupom criado, consultado ou atualizado.

​
success
boolean
required
​
message
string
required
​
data
object
required
​
requestId
string