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

# Get Subscription

> Devolve a assinatura com o estado da autorização, o próximo débito e cada cobrança recorrente já enviada ao banco, com as tentativas de liquidação. O id pode ser o paymentId (psa_sub_…) ou o subscriptionId.



## OpenAPI

````yaml /api-reference/openapi.yaml get /v1/subscriptions/{id}
openapi: 3.1.0
info:
  title: PurinCash API
  version: 1.0.0
servers:
  - url: https://api.purincash.com
    description: Produção
security:
  - bearerAuth: []
tags:
  - name: Cartao
    description: Pagamentos no cartao de credito.
  - name: Cobrancas
    description: Cobrancas PIX avulsas com valor livre.
  - name: Entregas
    description: Conteudo entregue automaticamente apos o pagamento.
  - name: Disputas
    description: Contestacoes (MED) e envio de evidencias.
  - name: Pagamentos
    description: Pagamentos PIX e LTC vinculados ou nao a um produto.
  - name: Saques
    description: Saques em PIX, LTC e USDT.
  - name: Produtos
    description: Produtos de cobranca criados pela API.
  - name: Sandbox
    description: Simulacao de pagamentos e saldo de teste.
  - name: Splits
    description: Cobrancas divididas entre varias contas.
  - name: Loja
    description: Produtos da loja do Discord (somente leitura).
  - name: Subcontas
    description: Ledger de saldo por cliente do integrador.
  - name: Assinaturas
    description: PIX recorrente.
  - name: Carteira
    description: Saldo, retencoes e valores a liberar.
paths:
  /v1/subscriptions/{id}:
    get:
      tags:
        - Assinaturas
      summary: Get Subscription
      description: >-
        Devolve a assinatura com o estado da autorização, o próximo débito e
        cada cobrança recorrente já enviada ao banco, com as tentativas de
        liquidação. O id pode ser o paymentId (psa_sub_…) ou o subscriptionId.
      operationId: getSubscription
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: paymentId (psa_sub_…) ou subscriptionId.
      responses:
        '200':
          description: A assinatura.
          content:
            application/json:
              schema:
                type: object
                properties:
                  paymentId:
                    type: string
                  subscriptionId:
                    type: string
                  status:
                    type: string
                    description: Status do primeiro pagamento.
                  authorizationStatus:
                    type: string
                    description: >-
                      pending_authorization, active, rejected, expired,
                      cancelled, ended ou sandbox.
                  type:
                    type: string
                  environment:
                    type: string
                  amountCents:
                    type: integer
                  currency:
                    type: string
                  productName:
                    type: string
                  frequency:
                    type: string
                  nextChargeDate:
                    type:
                      - string
                      - 'null'
                    format: date
                  firstChargeDate:
                    type:
                      - string
                      - 'null'
                    format: date
                    description: Data do primeiro débito automático.
                  cyclesPaid:
                    type: integer
                  customer:
                    type: object
                  metadata:
                    type: string
                  pix:
                    type: object
                    properties:
                      brCode:
                        type:
                          - string
                          - 'null'
                  paidAt:
                    type:
                      - string
                      - 'null'
                    format: date-time
                  authorizedAt:
                    type:
                      - string
                      - 'null'
                    format: date-time
                  cancelledAt:
                    type:
                      - string
                      - 'null'
                    format: date-time
                  cancellationReason:
                    type: string
                    description: Código e descrição do encerramento, quando há.
                  lastError:
                    type: string
                    description: >-
                      Último problema ao enviar uma cobrança recorrente, quando
                      há.
                  createdAt:
                    type: string
                    format: date-time
                  charges:
                    type: array
                    description: >-
                      As cobranças recorrentes já enviadas ao banco, em ordem de
                      ciclo.
                    items:
                      type: object
                      properties:
                        cycle:
                          type: integer
                          description: Número do ciclo (1 = primeira renovação).
                        paymentId:
                          type:
                            - string
                            - 'null'
                          description: >-
                            O pagamento da renovação (psa_sub_…_cN), criado
                            quando ela liquida.
                        dueDate:
                          type: string
                          format: date
                        amountCents:
                          type: integer
                        status:
                          type: string
                          description: >-
                            criada, ativa, concluida, expirada, rejeitada ou
                            cancelada.
                        paidAt:
                          type:
                            - string
                            - 'null'
                          format: date-time
                        endToEndId:
                          type: string
                        attempts:
                          type: array
                          description: >-
                            Tentativas de liquidação, com o código do banco
                            quando falharam.
                          items:
                            type: object
                            properties:
                              settlementDate:
                                type: string
                                format: date
                              status:
                                type: string
                              code:
                                type: string
                              description:
                                type: string
              example:
                paymentId: psa_sub_a1b2c3d4...
                subscriptionId: RN12345678202609200000000001
                status: paid
                authorizationStatus: active
                type: subscription
                environment: live
                amountCents: 4990
                currency: BRL
                productName: Premium Plan
                frequency: MONTHLY
                nextChargeDate: '2026-11-20'
                firstChargeDate: '2026-10-20'
                cyclesPaid: 2
                customer:
                  name: João Silva
                  email: joao@exemplo.com
                  externalId: user_123
                metadata: '{}'
                pix:
                  brCode: 00020101021226760014br.gov.bcb.pix...
                paidAt: '2026-09-20T10:03:00.000Z'
                authorizedAt: '2026-09-20T13:43:53.000Z'
                cancelledAt: null
                createdAt: '2026-09-20T10:00:00.000Z'
                charges:
                  - cycle: 1
                    paymentId: psa_sub_a1b2c3d4..._c1
                    dueDate: '2026-10-20'
                    amountCents: 4990
                    status: concluida
                    paidAt: '2026-10-20T09:10:00.000Z'
                    endToEndId: E12345678202610200910abcdef12345
                    attempts:
                      - settlementDate: '2026-10-20'
                        status: PAGA
        '401':
          description: Chave de API inválida, ausente ou revogada.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Assinatura não encontrada neste ambiente.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: Subscription not found
components:
  schemas:
    Error:
      type: object
      properties:
        error:
          type: string
          description: >-
            Mensagem de erro legivel. Trate pelo codigo HTTP; o texto pode
            mudar.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Chave de API gerada no dashboard da PurinCash (ps_live_ ou ps_test_).

````