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

# List Payment Links

> Lista payment links.

Retorna uma página de payment links da organização. Para plataformas, restringe à organização conectada indicada no header `Organization`.

## Autenticação

| Token                                               | Header                              | Escopo do retorno                               |
| --------------------------------------------------- | ----------------------------------- | ----------------------------------------------- |
| **API key da organização** (`read`/`write`/`admin`) | `Authorization: Bearer ch_live_...` | Links da própria organização da chave.          |
| **API key da plataforma** (`platform_admin`)        | + `Organization: <organization_id>` | Links apenas da organização conectada indicada. |

Para uma plataforma listar links de **todas** as organizações conectadas ativas de uma vez, use o dashboard ou a futura listagem agregada (roadmap).

## Parâmetros de query

<ParamField query="limit" type="integer" default="10">
  Itens por página. Máximo `100`.
</ParamField>

<ParamField query="starting_after" type="string">
  Cursor para buscar a próxima página depois do ID informado.
</ParamField>

<ParamField query="ending_before" type="string">
  Cursor para buscar a página anterior antes do ID informado.
</ParamField>

<ParamField query="is_active" type="boolean | string">
  Filtra por status. Quando omitido, retorna apenas `is_active=true`. Envie `false` para ver desativados, ou `all` para incluir ambos.
</ParamField>

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

## Resposta

`200 OK`.

<ResponseField name="object" type="string">
  Sempre `list`.
</ResponseField>

<ResponseField name="data" type="array">
  Lista de objetos canônicos do payment link (mesma forma da resposta de [POST /v1/payment-links](/api-reference/payment-links/create)).
</ResponseField>

<ResponseField name="has_more" type="boolean">
  `true` quando existe próxima página.
</ResponseField>

<ResponseField name="url" type="string">
  Caminho canônico da coleção: `/v1/payment-links`.
</ResponseField>

<ResponseExample>
  ```json 200 theme={}
  {
    "object": "list",
    "data": [
      {
        "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": [],
        "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": null,
        "url": "https://pay.chargefy.io/link/9a1bc3d2e4f5..."
      }
    ],
    "has_more": true,
    "url": "/v1/payment-links"
  }
  ```
</ResponseExample>