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

> ## Agent Instructions
> Documentação oficial da sinnu, gateway de pagamento brasileiro: Pix e cartão de crédito. O índice de todas as páginas está em https://docs.sinnu.com.br/llms.txt.
> A API (https://api.sinnu.com.br) e o checkout (https://pay.sinnu.com.br) documentados são de produção. Não há ambiente público de testes: cada chamada cria ou altera dados reais.
> A chave secreta sk_live_ fica só no servidor. O navegador recebe apenas o slug do link ou a URL do checkout.
> Unidades: amountCents do link e os valores de /api/transactions/ estão em centavos (inteiro). data.amount do webhook e amount das transações de um link estão em reais. Compare na mesma unidade.
> Status: a API de transações usa approved; o corpo do webhook usa paid; o evento é transaction.approved.
> Libere o pedido só pelo webhook assinado (X-Sinnu-Signature, validado sobre o corpo cru com constructEvent({ payload, signature, secret })) e confirme com transactions.get. Nunca pelo evento completed do Sinnu Elements nem pelos parâmetros da URL de retorno.
> Estorno é sempre do valor total. Não invente métodos, campos ou eventos: confira na referência do SDK e da API.

# Arquive um link

> Retire um link de circulação.

Arquivar o link não estorna transações anteriores. O método `sinnu.links.archive(id)` não retorna um objeto.


## OpenAPI

````yaml DELETE /api/payment-links/{id}
openapi: 3.0.3
info:
  title: sinnu API
  version: 1.0.0
  description: >-
    API pública da sinnu para links, clientes e transações. Autentique com
    Bearer e a chave da empresa. Links usam amountCents em centavos; a API de
    transações usa centavos; webhooks e transações de um link usam reais.
    Consulte a unidade de cada recurso.
  x-source-sha256: 153c3fdb10dbb3d93407364e1d121b9565747a56c1b8db9ace49edcb2ef48d8a
servers:
  - url: https://api.sinnu.com.br
    description: Produção
security:
  - bearerAuth: []
paths:
  /api/payment-links/{id}:
    delete:
      tags:
        - payment-links
      summary: Arquivar link de pagamento
      description: Arquiva um link de pagamento da empresa autenticada.
      operationId: paymentLinks_destroy
      parameters:
        - in: path
          name: id
          schema:
            type: string
            format: uuid
          required: true
          example: 00000000-0000-4000-8000-000000000003
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentLinkArchiveResult'
          description: ''
        '403':
          description: >-
            Sua chave de API não tem permissão para criar ou alterar links de
            pagamento.
      security:
        - bearerAuth: []
      x-codeSamples:
        - lang: bash
          label: cURL
          source: |-
            curl --fail-with-body --request DELETE \
              'https://api.sinnu.com.br/api/payment-links/ID_DO_RECURSO' \
              --header "Authorization: Bearer $SINNU_API_KEY"
        - lang: javascript
          label: JavaScript · servidor
          source: >-
            const apiKey = process.env.SINNU_API_KEY;

            if (!apiKey) throw new Error("Configure SINNU_API_KEY no
            servidor.");

            const response = await
            fetch("https://api.sinnu.com.br/api/payment-links/ID_DO_RECURSO", {
              method: "DELETE",
              headers: {
                Authorization: `Bearer ${apiKey}`,
              },
            });

            if (!response.ok) throw new Error(`HTTP ${response.status}: ${await
            response.text()}`);

            console.log(response.status === 204 ? null : await response.json());
components:
  schemas:
    PaymentLinkArchiveResult:
      type: object
      description: >-
        Desfecho de `DELETE /api/payment-links/{id}` - o que aconteceu, em
        pt-BR.


        O endpoint deixou de ser um `DELETE` puro (decisão do dono, 10/09/2026):
        link

        com venda ou plano de assinatura é **arquivado**, e as assinaturas vivas
        seguem

        sendo cobradas. Só um link sem histórico nenhum é realmente apagado.
        Como as

        duas coisas atendem o mesmo clique, a resposta precisa dizer QUAL delas

        aconteceu - daí o corpo, no lugar do 204 vazio.


        `message` já vem pronta para a tela: painel e app mostram a MESMA frase,
        com o

        número real de assinaturas ativas. Nenhum dos dois monta texto por
        conta.
      properties:
        outcome:
          allOf:
            - $ref: '#/components/schemas/PaymentLinkArchiveOutcomeEnum'
          description: >-
            `archived` = saiu do catálogo e parou de vender; `deleted` =
            apagado.


            * `archived` - Arquivado

            * `deleted` - Excluído
        status:
          type: string
          nullable: true
          description: Status novo do link (`archived`), ou null quando foi apagado.
        archivedPrices:
          type: integer
          description: >-
            Quantos planos de assinatura foram arquivados junto (nunca
            apagados).
        activeSubscriptions:
          type: integer
          description: Assinaturas que CONTINUAM sendo cobradas (trialing/active/past_due).
        message:
          type: string
          description: Frase pt-BR pronta para exibir ao vendedor, sem jargão de ORM.
      required:
        - activeSubscriptions
        - archivedPrices
        - message
        - outcome
        - status
    PaymentLinkArchiveOutcomeEnum:
      enum:
        - archived
        - deleted
      type: string
      description: |-
        * `archived` - Arquivado
        * `deleted` - Excluído
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Chave secreta sk_live_ da empresa. Use somente no servidor.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.