Skip to content
memberfy
en-us

Cria ou executa coupons

POST/api/coupons

Auth
Requires a token
X-CommunityId
X-CommunityId Send the X-CommunityId of the community the operation happens in.
Endpoint descriptions come straight from the API specification and are in Portuguese for now. The interface around them is translated.

Headers

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

Request body application/json

NameTypeDescription
coderequiredstringCoupon code is required
namerequiredstringName is required
descriptionoptionalstring
typerequiredPERCENTAGE | FIXED | FREE_TRIALInvalid coupon type
discountValuerequirednumberDiscount value must be positive
maxDiscountoptionalnumber
trialExtensionDaysoptionalinteger
durationrequiredONCE | FOREVER | REPEATINGInvalid duration
durationInMonthsoptionalinteger
maxUsesoptionalinteger
maxUsesPerUseroptionalinteger
startDaterequiredstring (date-time)Valid start date required
endDateoptionalstring (date-time)
restrictionoptionalNONE | FIRST_PURCHASE | NEW_CUSTOMER
minPurchaseAmountoptionalnumber
applicableProductsoptional—[]
excludedProductsoptional—[]
applicableToOneTimeoptionalboolean
applicableToSubscriptionoptionalboolean
applicableToInstallmentoptionalboolean
isStackableoptionalboolean

Responses

StatusDescription
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.

curl example

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"}'