Saltar para o conteúdo
memberfy
pt-pt

Cria ou executa coupons

POST/api/coupons

Auth
Exige token
X-CommunityId
X-CommunityId Envie o X-CommunityId da comunidade em que a operação acontece.

Headers

NomeTipoDescrição
X-CommunityIdopcionalstring (uuid)ID da comunidade em que a operação acontece. Obrigatório na maioria dos endpoints com escopo de comunidade.

Corpo da requisição application/json

NomeTipoDescrição
codeobrigatóriostringCoupon code is required
nameobrigatóriostringName is required
descriptionopcionalstring
typeobrigatórioPERCENTAGE | FIXED | FREE_TRIALInvalid coupon type
discountValueobrigatórionumberDiscount value must be positive
maxDiscountopcionalnumber
trialExtensionDaysopcionalinteger
durationobrigatórioONCE | FOREVER | REPEATINGInvalid duration
durationInMonthsopcionalinteger
maxUsesopcionalinteger
maxUsesPerUseropcionalinteger
startDateobrigatóriostring (date-time)Valid start date required
endDateopcionalstring (date-time)
restrictionopcionalNONE | FIRST_PURCHASE | NEW_CUSTOMER
minPurchaseAmountopcionalnumber
applicableProductsopcional—[]
excludedProductsopcional—[]
applicableToOneTimeopcionalboolean
applicableToSubscriptionopcionalboolean
applicableToInstallmentopcionalboolean
isStackableopcionalboolean

Respostas

CódigoDescrição
201Operação realizada com sucesso.
400Requisição inválida — falha de validação.
401Token ausente, inválido ou expirado.
403Autenticado, mas sem permissão para esta operação.
404Recurso não encontrado.
500Erro interno do servidor.

Exemplo com curl

curl -X POST "https://api.memberfy.net/api/coupons" \
  -H "Authorization: Bearer $TOKEN" \
  -H "X-CommunityId: $COMMUNITY_ID" \
  -H "Content-Type: application/json" \
  -d '{"code":"string","name":"string","type":"PERCENTAGE","discountValue":10,"duration":"ONCE","startDate":"2026-01-01T12:00:00.000Z"}'