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.

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

​
Autenticação

TokenAcesso
Organization API key (read, write ou admin)Acessa links da própria org.
Platform API key (platform_admin) com Organization: <suborg_id>Acessa links da sub-org indicada (precisa estar ativa sob a plataforma).

​
Parâmetros de Path

​
id
string
required
ID do payment link, prefixo plink_.

​
Resposta

200 OK com o objeto canônico do payment link. Mesma forma da resposta de POST /v1/payment-links. Links arquivados também são retornados — diferencie pelo campo active:
  • active: true → cliques materializam sessões.
  • active: false → cliques retornam 404. Sessões já materializadas continuam vivas.

​
Exemplo

cURL
curl -X GET "https://api.chargefy.io/v1/payment-links/plink_demo_z2kkA78c" \
  -H "Authorization: Bearer $CHARGEFY_API_KEY"

​
Resposta de exemplo

{
  "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": "2026-05-03T10:14:22Z",
  "line_items": [
    {
      "price_id": "price_demo_pro_monthly",
      "price_data": null,
      "product_id": "prod_demo_pro",
      "quantity": 1,
      "currency": "brl",
      "unit_amount": 19990,
      "amount_subtotal": 19990,
      "amount_discount": 0,
      "amount_tax": 0,
      "amount_total": 19990,
      "description": "Plano Pro",
      "metadata": {},
      "recurring_interval": "month",
      "recurring_interval_count": 1,
      "position": 0
    }
  ]
}

​
Erros comuns

HTTPRazão
404id não existe ou não pertence à org acessível.
403Header Organization aponta pra sub-org não-ativa da plataforma.