Adila
Referência da APICodigos promocionais

Criar: códigos promocionais

POST
/v2/organizations/{organizationId}/stripe/promotion-codes

Permissão: coupons:write. A conta Stripe é resolvida no servidor a partir da organização autorizada. Exige Idempotency-Key com 8 a 255 caracteres.

Authorization

headerx-api-key<token>

API key Adila Pay vinculada à organização; use somente no servidor.

Path Parameters

organizationId*string

UUID da organização vinculada à API key ou à sessão autorizada.

Formatuuid

Header Parameters

idempotency-key*string

Chave estável da operação lógica. Reutilize apenas com os mesmos parâmetros em retries.

Length8 <= length <= 255

Request Body

application/json
  1. body
code*string
Match^[A-Za-z0-9]+$
Length3 <= length <= 40
discount*|
duration*string
Value in"once""forever""repeating"
duration_in_months?integer
Range1 <= value <= 36
max_redemptions?integer
Range1 <= value <= 1000000
expires_at?integer
Range0 <= value <= 4102444800
products?array<>
Items1 <= items <= 100

Response Body

Objeto Stripe retornado pelo backend. Campos de resposta ainda não possuem schema detalhado neste contrato.

application/json
  1. response

Objeto Stripe sem schema de resposta detalhado no backend atual.

[key: string]?any
curl -X POST "https://example.com/v2/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/stripe/promotion-codes" \  -H "idempotency-key: stringst" \  -H "Content-Type: application/json" \  -d '{    "code": "string",    "discount": {      "percent_off": 1    },    "duration": "once"  }'
{}

Listar: códigos promocionais GET

Página anterior

Atualizar: códigos promocionais PATCH

Próxima página