Skip to main content
PATCH
/
coupons
/
update
/
{id}
curl -X PATCH 'https://api.goatpay.com.br/v1/coupons/update/clx_coupon' \
  -H 'X-API-Key: gp_live_SUA_CHAVE' \
  -H 'Content-Type: application/json' \
  -d '{ "maxUses": 200 }'

{
  "success": true,
  "message": "<string>",
  "data": {
    "id": "<string>",
    "code": "<string>",
    "discountType": "<string>",
    "discountValue": 123,
    "maxUses": 123,
    "uses": 123,
    "expiresAt": "2023-11-07T05:31:56Z",
    "status": "<string>",
    "productIds": [
      "<string>"
    ],
    "paymentLinkIds": [
      "<string>"
    ]
  },
  "requestId": "<string>"
}
URL: PATCH https://api.goatpay.com.br/v1/coupons/update/{id} · Permissão: coupons/update
curl -X PATCH 'https://api.goatpay.com.br/v1/coupons/update/clx_coupon' \
  -H 'X-API-Key: gp_live_SUA_CHAVE' \
  -H 'Content-Type: application/json' \
  -d '{ "maxUses": 200 }'
Corpo: mesmos campos de criar cupom (envie só o que mudar). Guia: Cupons.

Authorizations

​
X-API-Key
string
header
required

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

Path Parameters

​
id
string
required

ID do recurso (transação, cobrança, webhook, etc.)

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