Skip to main content
POST
/
organizations
/
{organizationId}
/
subscriptions
/
attach-coupon
Vincular Cupom
curl --request POST \
  --url https://api.example.com/organizations/{organizationId}/subscriptions/attach-coupon \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "couponCode": "<string>"
}
'
{
  "subscriptionId": "019525fd-b17c-7f8d-e5a1-7b9c1d3f5a7d",
  "organizationId": "019525fd-4c38-7e30-a5c1-b6e3f4d8a9c2",
  "planId": "019525fd-6b2c-7a1e-9d4f-3c5e7a9b1d3f",
  "planIntervalId": "019525fd-7e40-7c5a-b2d8-4e6f8a0c2e4a",
  "externalPlanRef": "sub_stripe_abc",
  "externalFeeRef": null,
  "currency": "BRL",
  "status": "ACTIVE",
  "pastDueReason": null,
  "pastDueAt": null,
  "pausedBy": null,
  "pausedAt": null,
  "cancelledBy": null,
  "cancelledAt": null,
  "coupons": [
    {
      "id": "019525fd-d3a4-7baf-a7c3-9d1e3f5b7c9f",
      "subscriptionId": "019525fd-b17c-7f8d-e5a1-7b9c1d3f5a7d",
      "couponId": "019525fd-d3a4-7baf-a7c3-9d1e3f5b7c9f",
      "status": "ACTIVE",
      "externalRef": "di_stripe_abc",
      "createdAt": "2026-03-25T14:00:00.000Z",
      "updatedAt": "2026-03-25T14:00:00.000Z"
    }
  ],
  "createdBy": "019525fd-56a8-7db4-8c3e-2a1b4d6f8e0c",
  "createdAt": "2026-01-15T10:00:00.000Z",
  "updatedBy": "019525fd-56a8-7db4-8c3e-2a1b4d6f8e0c",
  "updatedAt": "2026-03-25T14:00:00.000Z"
}
Attaches a coupon to the organization’s active subscription.
Requer permissao coupon:attach.

​
Headers

​
Authorization
string
required
Bearer token.

​
Parametros de Path

​
organizationId
string
required
O UUID da organizacao.

​
Corpo da Requisicao

​
couponCode
string
required
The coupon code to attach.

​
Resposta

​
subscriptionId
string
O ID da assinatura.
​
organizationId
string
O UUID da organizacao.
​
planId
string
O ID do plano.
​
planIntervalId
string
O ID do intervalo do plano.
​
currency
string
O codigo da moeda.
​
status
string
O status da assinatura.
​
coupons
array
Attached subscription coupons.
​
createdAt
string
Timestamp de criacao (ISO 8601).
​
updatedAt
string
Timestamp da ultima atualizacao (ISO 8601).
{
  "subscriptionId": "019525fd-b17c-7f8d-e5a1-7b9c1d3f5a7d",
  "organizationId": "019525fd-4c38-7e30-a5c1-b6e3f4d8a9c2",
  "planId": "019525fd-6b2c-7a1e-9d4f-3c5e7a9b1d3f",
  "planIntervalId": "019525fd-7e40-7c5a-b2d8-4e6f8a0c2e4a",
  "externalPlanRef": "sub_stripe_abc",
  "externalFeeRef": null,
  "currency": "BRL",
  "status": "ACTIVE",
  "pastDueReason": null,
  "pastDueAt": null,
  "pausedBy": null,
  "pausedAt": null,
  "cancelledBy": null,
  "cancelledAt": null,
  "coupons": [
    {
      "id": "019525fd-d3a4-7baf-a7c3-9d1e3f5b7c9f",
      "subscriptionId": "019525fd-b17c-7f8d-e5a1-7b9c1d3f5a7d",
      "couponId": "019525fd-d3a4-7baf-a7c3-9d1e3f5b7c9f",
      "status": "ACTIVE",
      "externalRef": "di_stripe_abc",
      "createdAt": "2026-03-25T14:00:00.000Z",
      "updatedAt": "2026-03-25T14:00:00.000Z"
    }
  ],
  "createdBy": "019525fd-56a8-7db4-8c3e-2a1b4d6f8e0c",
  "createdAt": "2026-01-15T10:00:00.000Z",
  "updatedBy": "019525fd-56a8-7db4-8c3e-2a1b4d6f8e0c",
  "updatedAt": "2026-03-25T14:00:00.000Z"
}

​
Exemplos de Codigo

curl -X POST https://api.awsales.io/admin/organizations/019525fd-4c38-7e30-a5c1-b6e3f4d8a9c2/subscriptions/attach-coupon \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "couponCode": "WELCOME20"
}'

​
Codigos de Erro

StatusCodigoDescricao
400validation_errorEntrada invalida ou campos obrigatorios ausentes
401unauthorizedAutenticacao ausente ou invalida
403forbiddenPermissoes insuficientes
404organization.not_foundOrganizacao nao encontrada
404subscription.not_foundAssinatura nao encontrada
409coupon.not_availableCoupon is invalid, expired, or depleted
500internal_server_errorOcorreu um erro inesperado