Skip to main content

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.

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

​
Autenticação

TokenHeaderEscopo do retorno
Organization API key (read/write/admin)Authorization: Bearer ch_live_...Links da própria org da key.
Platform API key (platform_admin)+ Organization: <suborg_id>Links apenas da sub-org indicada.
Para uma plataforma listar links de todas as sub-orgs ativas de uma vez, use o dashboard ou a futura listagem agregada (roadmap).

​
Parâmetros de Query

​
limit
integer
default:"50"
Itens por página. Máximo 100.
​
page
integer
default:"1"
Página (começa em 1).
​
active
boolean
Filtra por status. Quando omitido, retorna apenas active: true. Envie false pra ver arquivados, ou omita o filtro pra incluir os dois.
​
sort_by
string
default:"created_at"
created_at ou modified_at.
​
sort_order
string
default:"desc"
asc ou desc.

​
Resposta

200 OK.
​
items
array
Lista de objetos canônicos do payment link (mesma forma da resposta de POST /v1/payment-links).
​
pagination
object

​
Exemplo

cURL
curl -X GET "https://api.chargefy.io/v1/payment-links?page=1&limit=20" \
  -H "Authorization: Bearer $CHARGEFY_API_KEY"

​
Resposta de exemplo

{
  "items": [
    {
      "id": "plink_demo_z2kkA78c1aCGhiEj",
      "organization_id": "org_demo_clinic",
      "label": "Bio Instagram - Plano Pro",
      "url": "https://pay.chargefy.io/link/9a1bc3d2e4f5...",
      "active": true,
      "livemode": true,
      "success_url": "https://plataforma.com/sucesso",
      "cancel_url": null,
      "allow_discount_codes": true,
      "discount_id": null,
      "require_billing_address": false,
      "no_fees_installments": false,
      "metadata": { "campaign": "spring2026" },
      "created_at": "2026-05-02T18:31:00Z",
      "modified_at": null,
      "line_items": [ /* ... */ ]
    }
  ],
  "pagination": {
    "total_count": 42,
    "max_page": 3
  }
}