Verificar Disponibilidade do Cupom

curl --request GET \
  --url https://api.example.com/coupons/{code}/availability \
  --header 'Authorization: <authorization>'

{
  "coupon": {
    "couponId": "019525fd-d3a4-7baf-a7c3-9d1e3f5b7c9f",
    "externalRef": null,
    "code": "WELCOME10",
    "name": "Welcome Discount",
    "type": "PERCENTAGE",
    "amount": 10,
    "currency": "BRL",
    "duration": "ONCE",
    "durationInMonths": null,
    "maxRedemptions": 100,
    "redeemBy": null,
    "timesRedeemed": 25,
    "amountRedeemed": 12500,
    "status": "ACTIVE",
    "createdBy": "019525fd-56a8-7db4-8c3e-2a1b4d6f8e0c",
    "createdAt": "2026-01-01T00:00:00.000Z",
    "updatedBy": "019525fd-56a8-7db4-8c3e-2a1b4d6f8e0c",
    "updatedAt": "2026-01-01T00:00:00.000Z",
    "deletedBy": null,
    "deletedAt": null
  },
  "meta": { "available": true }
}

GET

coupons

{code}

availability

Verificar Disponibilidade do Cupom

curl --request GET \
  --url https://api.example.com/coupons/{code}/availability \
  --header 'Authorization: <authorization>'

{
  "coupon": {
    "couponId": "019525fd-d3a4-7baf-a7c3-9d1e3f5b7c9f",
    "externalRef": null,
    "code": "WELCOME10",
    "name": "Welcome Discount",
    "type": "PERCENTAGE",
    "amount": 10,
    "currency": "BRL",
    "duration": "ONCE",
    "durationInMonths": null,
    "maxRedemptions": 100,
    "redeemBy": null,
    "timesRedeemed": 25,
    "amountRedeemed": 12500,
    "status": "ACTIVE",
    "createdBy": "019525fd-56a8-7db4-8c3e-2a1b4d6f8e0c",
    "createdAt": "2026-01-01T00:00:00.000Z",
    "updatedBy": "019525fd-56a8-7db4-8c3e-2a1b4d6f8e0c",
    "updatedAt": "2026-01-01T00:00:00.000Z",
    "deletedBy": null,
    "deletedAt": null
  },
  "meta": { "available": true }
}

Requer permissao coupon:read.

Headers

Authorization

string

required

Bearer token.

Parametros de Path

code

string

required

Codigo do cupom.

Resposta

coupon

object

Coupon details.

Show propriedades do cupom

couponId

string

UUID do cupom.

externalRef

string

Referencia externa.

code

string

Codigo do cupom.

name

string

Nome do cupom.

type

string

Tipo de desconto.

amount

integer

Discount amount.

currency

string

Codigo da moeda.

duration

string

Duration type.

durationInMonths

integer

Duration in months.

maxRedemptions

integer

Maximum redemptions.

redeemBy

string

Data de expiracao.

timesRedeemed

integer

Times redeemed.

amountRedeemed

integer

Total amount redeemed.

status

string

Status do cupom.

createdBy

string

Identificador do criador.

createdAt

string

Timestamp de criacao.

updatedBy

string

Identificador do ultimo atualizador.

updatedAt

string

Timestamp da ultima atualizacao.

deletedBy

string

Deleter identifier.

deletedAt

string

Deletion timestamp.

Exemplos de Codigo

curl https://api.awsales.io/admin/coupons/WELCOME20/availability \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

Use this endpoint to verify a coupon code is valid and has remaining redemptions before attempting to attach it to a subscription.

Codigos de Erro

Status	Codigo	Descricao
`400`	`validation_error`	Entrada invalida ou campos obrigatorios ausentes
`401`	`unauthorized`	Autenticacao ausente ou invalida
`403`	`forbidden`	Permissoes insuficientes
`404`	`coupon.not_found`	Cupom nao encontrado
`500`	`internal_server_error`	Ocorreu um erro inesperado

Excluir Cupom

O Objeto Voucher

⌘I

Primeiros Passos

Auth & Identidade

Gestão de Acesso

Faturamento

Verificar Disponibilidade do Cupom

Headers

Parametros de Path

Resposta

Exemplos de Codigo

Codigos de Erro

Primeiros Passos

Auth & Identidade

Gestão de Acesso

Faturamento

​Headers

​Parametros de Path

​Resposta

​Exemplos de Codigo

​Codigos de Erro

Headers

Parametros de Path

Resposta

Exemplos de Codigo

Codigos de Erro