Pular para o conteúdo principal

Cupons

Descontos com regra de validade e limite de uso. redemptions mostra onde cada cupom foi efetivamente aplicado.

ComandoHTTPDescrição
coupons listGET /v1/couponsListar cupons
coupons createPOST /v1/couponsCriar cupom
coupons getGET /v1/coupons/{id}Obter cupom
coupons updatePATCH /v1/coupons/{id}Atualizar cupom
coupons deleteDELETE /v1/coupons/{id}Excluir cupom
coupons deactivatePOST /v1/coupons/{id}/deactivateDesativar cupom
coupons redemptionsGET /v1/coupons/{id}/redemptionsListar resgates do cupom

Exemplos​

--params carrega parâmetros de query e de caminho (id, página, filtros); --json carrega o corpo da requisição; --fields limita os campos que voltam — vale a pena em todo list/get, para economizar contexto. Veja Flags globais para a referência completa.

# Listar cupons
kobana billing coupons list --fields "id,public_id,external_id,code,name"

# Obter cupom
kobana billing coupons get --params '{"id": "COUPON_ID"}'

# Criar cupom
kobana billing coupons create \
--json '{"code": "CODE", "name": "NAME", "discount_type": "percentage", "discount_value": 0}'

# Atualizar cupom
kobana billing coupons update \
--params '{"id": "COUPON_ID"}' \
--json '{"name": "NAME", "external_id": "EXTERNAL_ID", "description": "DESCRIPTION"}'

# Desativar cupom
kobana billing coupons deactivate --params '{"id": "COUPON_ID"}'

# Excluir cupom
kobana billing coupons delete --params '{"id": "COUPON_ID"}' --dry-run

Próximos passos​