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

# Consultar assinatura

> Por `id` interno (`clx_...`) ou `providerSubscriptionId`.

<RequestExample>
  ```bash cURL theme={null}
  curl -X GET 'https://api.goatpay.com.br/v1/subscriptions/get/clx_sub' \
    -H 'X-API-Key: gp_live_SUA_CHAVE'
  ```
</RequestExample>

<ResponseExample>
  ```json Success theme={null}
  {
    "success": true,
    "message": "Assinatura encontrada",
    "data": {
      "id": "clx_sub",
      "providerSubscriptionId": "sub_ext_xyz",
      "status": "ACTIVE",
      "cycle": "MONTHLY",
      "billingType": "BOLETO",
      "value": 99.9,
      "description": "Plano Premium",
      "nextDueDate": "2026-08-01T00:00:00.000Z",
      "createdAt": "2026-07-01T12:00:00.000Z",
      "customer": {
        "id": "clx_customer",
        "name": "Maria Silva",
        "taxId": "12345678909"
      },
      "plan": {
        "id": "clx_plan",
        "name": "Plano Premium"
      }
    },
    "requestId": "req_abc123"
  }
  ```
</ResponseExample>

### Envelope da resposta

| Campo     | Tipo    | Descrição                                          |
| --------- | ------- | -------------------------------------------------- |
| success   | boolean | `true` em sucesso HTTP 2xx                         |
| message   | string  | Mensagem legível (ex.: "Transação PIX encontrada") |
| data      | object  | Payload do recurso (formato abaixo)                |
| requestId | string  | ID da requisição para suporte (`req_...`)          |

### Status em `data.status` (assinatura)

| Status   | Significado                                       |
| -------- | ------------------------------------------------- |
| ACTIVE   | Assinatura ativa — cobranças geradas a cada ciclo |
| CANCELED | Recorrência encerrada                             |
| INACTIVE | Inativa                                           |

### Campos em `data`

| Campo                  | Descrição                                       |
| ---------------------- | ----------------------------------------------- |
| id                     | ID interno GoatPay                              |
| providerSubscriptionId | ID externo da assinatura                        |
| billingType            | Forma de pagamento (BOLETO, CREDIT\_CARD, etc.) |
| value                  | Valor de cada ciclo em reais                    |
| cycle                  | Ciclo de cobrança                               |
| nextDueDate            | Próximo vencimento (ISO 8601)                   |
| customer               | Cliente vinculado                               |
| plan                   | Plano vinculado (se houver)                     |

### Parâmetros de rota

<ParamField path="id" type="string" required>
  ID interno (`clx_...`) ou `providerSubscriptionId` da assinatura.
</ParamField>


## OpenAPI

````yaml GET /subscriptions/get/{id}
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:
  /subscriptions/get/{id}:
    get:
      tags:
        - subscriptions
      summary: Consultar assinatura
      operationId: getSubscription
      parameters:
        - $ref: '#/components/parameters/ResourceId'
      responses:
        '200':
          $ref: '#/components/responses/SuccessEnvelope'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  parameters:
    ResourceId:
      name: id
      in: path
      required: true
      schema:
        type: string
      description: ID do recurso (transação, cobrança, webhook, etc.)
  responses:
    SuccessEnvelope:
      description: Operação concluída.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/SuccessEnvelope'
          examples:
            default:
              summary: Sucesso
              value:
                success: true
                message: Operação concluída com sucesso
                data: {}
                requestId: req_abc123
    NotFound:
      description: Recurso não encontrado.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
  schemas:
    SuccessEnvelope:
      type: object
      required:
        - success
        - message
        - data
      properties:
        success:
          type: boolean
          example: true
        message:
          type: string
          example: Operação concluída com sucesso
        data:
          type: object
          additionalProperties: true
        requestId:
          type: string
    ErrorEnvelope:
      type: object
      required:
        - success
        - message
        - error
      properties:
        success:
          type: boolean
          example: false
        message:
          type: string
          example: Subconta inativa
        error:
          type: object
          properties:
            code:
              type: string
              example: Bad Request
            statusCode:
              type: integer
              example: 400
        requestId:
          type: string
          example: req_abc123
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: Chave `gp_live_...` criada em Integrações → Chaves de API no dashboard.

````