> ## Documentation Index
> Fetch the complete documentation index at: https://docs.goatpay.com.br/llms.txt
> Use this file to discover all available pages before exploring further.

# Criar cupom

> Cria cupom de desconto para links de pagamento.

<Note>
  **URL:** `POST https://api.goatpay.com.br/v1/coupons/create` · Permissão: `coupons/create`
</Note>

<RequestExample>
  ```bash cURL theme={null}
  curl -X POST 'https://api.goatpay.com.br/v1/coupons/create' \
    -H 'X-API-Key: gp_live_SUA_CHAVE' \
    -H 'Content-Type: application/json' \
    -d '{
      "code": "VERAO10",
      "discountType": "PERCENT",
      "discountValue": 10,
      "maxUses": 100,
      "expiresAt": "2026-12-31T23:59:59.000Z",
      "paymentLinkIds": ["clx_link"]
    }'
  ```
</RequestExample>

<ResponseExample>
  ```json Success theme={null}
  {
    "success": true,
    "message": "Cupom criado",
    "data": {
      "id": "clx_coupon",
      "code": "VERAO10",
      "discountType": "PERCENT",
      "discountValue": 10,
      "maxUses": 100,
      "uses": 0,
      "status": "ACTIVE",
      "productIds": [],
      "paymentLinkIds": ["clx_link"]
    },
    "requestId": "req_abc"
  }
  ```
</ResponseExample>

### Corpo

<ParamField body="code" type="string" required>Código (até 32 caracteres, único na conta).</ParamField>
<ParamField body="discountType" type="string" required>`PERCENT` ou `FIXED`.</ParamField>
<ParamField body="discountValue" type="number" required>Percentual ou valor fixo em BRL.</ParamField>
<ParamField body="maxUses" type="number">Limite de usos.</ParamField>
<ParamField body="expiresAt" type="string">ISO 8601.</ParamField>
<ParamField body="productIds" type="array">Restringe a produtos.</ParamField>
<ParamField body="paymentLinkIds" type="array">Restringe a links.</ParamField>

Guia: [Cupons](/api-reference/guides/loja#cupons).


## OpenAPI

````yaml POST /coupons/create
openapi: 3.1.0
info:
  title: GoatPay API
  description: >
    API pública merchant da GoatPay. Autenticação via header `X-API-Key:
    gp_live_...`.

    Respostas de sucesso usam o envelope `{ success, message, data, requestId
    }`.

    Campos internos (`accountId`, `metadata`, histórico de entregas de webhook,
    etc.) não são expostos.

    `providerTransactionId` aparece como `referenceId`; `providerInfractionId`
    como `infractionId`.

    Rate limit global: 100 requisições por minuto por API key (HTTP 429). Sem
    chave, limite por IP.
  version: 1.0.0
servers:
  - url: https://api.goatpay.com.br/v1
    description: Produção
security:
  - apiKeyAuth: []
tags:
  - name: pix
    description: >-
      Cobranças PIX (receber), reembolsos de depósito recebido e transferências
      PIX (enviar). Alias legado em payouts/* para envios.
  - name: transfer-internal
    description: Transferências entre contas GoatPay
  - name: transfer-scheduled
    description: Transferências programadas (agendar, repetir ou por saldo)
  - name: crypto
    description: Depósitos e transferências em criptomoeda
  - name: billings
    description: >-
      Cobranças avulsas (pagamento único) — boleto, cartão ou PIX na Conta
      Padrão (PF ou PJ)
  - name: subscriptions
    description: >-
      Assinaturas recorrentes com ciclo fixo — boleto, cartão ou PIX na Conta
      Padrão (PF ou PJ)
  - name: account
    description: Saldo e extrato
  - name: subaccount
    description: Subcontas merchant (carteiras lógicas sob a conta principal)
  - name: meds
    description: Disputas MED
  - name: webhooks
    description: Endpoints de webhook de saída
  - name: payouts
    description: Alias de transfer-pix para saques PIX
  - name: customers
    description: Clientes da loja (CRM)
  - name: products
    description: Produtos e entregas digitais
  - name: coupons
    description: Cupons de desconto para links
  - name: payment-links
    description: Links de pagamento e checkout hospedado
paths:
  /coupons/create:
    post:
      tags:
        - coupons
      summary: Criar cupom
      operationId: createStoreCoupon
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateStoreCoupon'
      responses:
        '200':
          $ref: '#/components/responses/StoreCouponSuccess'
components:
  schemas:
    CreateStoreCoupon:
      type: object
      required:
        - code
        - discountType
        - discountValue
      properties:
        code:
          type: string
          maxLength: 32
        discountType:
          type: string
          enum:
            - PERCENT
            - FIXED
        discountValue:
          type: number
          minimum: 0.01
        maxUses:
          type: integer
          minimum: 1
        expiresAt:
          type: string
          format: date-time
        productIds:
          type: array
          items:
            type: string
        paymentLinkIds:
          type: array
          items:
            type: string
    PublicStoreCoupon:
      type: object
      properties:
        id:
          type: string
        code:
          type: string
        discountType:
          type: string
        discountValue:
          type: number
        maxUses:
          type: integer
        uses:
          type: integer
        expiresAt:
          type:
            - string
            - 'null'
          format: date-time
        status:
          type: string
        productIds:
          type: array
          items:
            type: string
        paymentLinkIds:
          type: array
          items:
            type: string
  responses:
    StoreCouponSuccess:
      description: Cupom criado, consultado ou atualizado.
      content:
        application/json:
          schema:
            type: object
            required:
              - success
              - message
              - data
            properties:
              success:
                type: boolean
              message:
                type: string
              data:
                $ref: '#/components/schemas/PublicStoreCoupon'
              requestId:
                type: string
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: Chave `gp_live_...` criada em Integrações → Chaves de API no dashboard.

````