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

# Get a Payment Link

> Retorna um payment link pelo ID.

Retorna o objeto canônico de um payment link pelo ID.

## Autenticação

| Token                                                                              | Acesso                                                                                 |
| ---------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- |
| **API key da organização** (`read`, `write` ou `admin`)                            | Acessa links da própria org.                                                           |
| **API key da plataforma** (`platform_admin`) com `Organization: <organization_id>` | Acessa links da organização conectada indicada (precisa estar ativa sob a plataforma). |

## Parâmetros de caminho

<ParamField path="id" type="string" required>
  ID do payment link, prefixo `plink_`.
</ParamField>

<RequestExample>
  ```bash cURL theme={}
  curl -X GET "https://api.chargefy.io/v1/payment-links/plink_demo_z2kkA78c" \
    -H "Authorization: Bearer {{API_KEY}}"
  ```
</RequestExample>

## Resposta

`200 OK` com o objeto canônico do payment link. Mesma forma da resposta de [POST /v1/payment-links](/api-reference/payment-links/create).

Links arquivados também são retornados. Diferencie pelo campo `is_active`:

* `is_active: true` → cliques materializam sessões.
* `is_active: false` → cliques retornam 404. Sessões já materializadas continuam vivas.

<ResponseExample>
  ```json 200 theme={}
  {
    "id": "plink_demo_z2kkA78c1aCGhiEj",
    "object": "payment_link",
    "allow_discount_codes": true,
    "cancel_url": null,
    "created_at": "2026-05-02T18:31:00Z",
    "discount": null,
    "is_active": true,
    "label": "Bio Instagram - Plano Pro",
    "line_items": [
      {
        "amount_discount": 0,
        "amount_subtotal": 19990,
        "amount_tax": 0,
        "amount_total": 19990,
        "currency": "brl",
        "description": "Plano Pro",
        "metadata": {},
        "position": 0,
        "price": "price_demo_pro_monthly",
        "price_data": null,
        "product": "prod_demo_pro",
        "quantity": 1,
        "recurring_interval": "month",
        "recurring_interval_count": 1,
        "unit_amount": 19990
      }
    ],
    "livemode": true,
    "metadata": {
      "campaign": "spring2026"
    },
    "payment_method_options": {
      "credit_card": {
        "installments": {
          "has_interest": true,
          "max_count": 12
        }
      }
    },
    "require_billing_address": false,
    "require_document": true,
    "require_phone": false,
    "success_url": "https://plataforma.com/sucesso",
    "updated_at": "2026-05-03T10:14:22Z",
    "url": "https://pay.chargefy.io/link/9a1bc3d2e4f5..."
  }
  ```
</ResponseExample>

## Erros comuns

| HTTP  | Razão                                                                             |
| ----- | --------------------------------------------------------------------------------- |
| `404` | `id` não existe ou não pertence à org acessível.                                  |
| `403` | O header `Organization` aponta pra organização conectada não-ativa da plataforma. |