Skip to main content
POST
Alternar status de um cupom
Ativa ou desativa um cupom. Cupons inativos não podem ser aplicados em checkouts.

Requer a permissão COUPON:UPDATE.
Chame este endpoint sempre que quiser pausar uma promoção temporariamente ou reativá-la sem precisar recriar o cupom.

Authorizations

Authorization
string
header
required

Todas as requisições devem incluir sua chave de API no header Authorization usando o formato Bearer <abacatepay-api-key>. Sem esse header a requisição será rejeitada.

Saiba mais sobre como criar e usar chaves de API na documentação de autenticação.

Query Parameters

id
string
required

Identificador único do cupom

Example:

"MY_COUPON"

Response

Status do cupom alternado com sucesso.

data
object

Os dados do seu cupom.

error
string | null
Example:

null

success
boolean

Se a requisição obteve sucesso ou não.

Example:

true