Pular para o conteúdo
MyClinicAPI Docs
GET

/v1/billing

Plano atual, uso, automações e próxima fatura

Permissão:billing:read

Autenticação

Envie o token de acesso do usuário no cabeçalho Authorization e, se ele tiver mais de uma clínica, o X-Clinic-Id. Integrações servidor a servidor usam o token de serviço com X-Clinic-Id e X-Agent-Key. Como autenticar

Authorization: Bearer <TOKEN>X-Clinic-Id: <clinic_id>

Parâmetros

Cabeçalhos

  • X-Clinic-IdstringOpcional

    Clínica ativa. Obrigatório só para quem tem acesso a mais de uma clínica (ou token de serviço). Validado contra o vínculo do usuário. · Padrão (regex): ^[A-Za-z0-9._-]{1,64}$

Exemplo de requisição

Gerado do contrato. Troque os marcadores entre < > pelos seus valores.

const res = await fetch("https://myclinc.leadpoint.com.br/v1/billing", {  method: "GET",  headers: {    Authorization: "Bearer <TOKEN>",    "X-Clinic-Id": "<clinic_id>",  },})​if (!res.ok) {  const { error } = await res.json()  throw new Error(`${error.code}: ${error.message} (${error.requestId})`)}const { data } = await res.json()

Resposta

200OK — Sucesso.
JSON
{  "data": {    "plan": {      "id": "<id>",      "name": "<name>",      "description": "<description>",      "price": 1,      "priceAnnual": 1,      "period": "<period>",      "features": [        "<feature>"      ]    },    "status": "ativa",    "trialEndsAt": "2026-09-18T14:00:00.000Z",    "trialDaysLeft": 1,    "trialExpired": true,    "cycle": {      "label": "<label>",      "start": "2026-09-18T14:00:00.000Z",      "end": "2026-09-18T14:00:00.000Z"    },    "nextChargeAt": "2026-09-18T14:00:00.000Z",    "paymentMethod": {      "brand": "<brand>",      "last4": "<last4>",      "expires": "<expires>",      "primary": true    },    "billingProfile": {      "cycle": "<cycle>",      "invoiceEmail": "<invoiceEmail>",      "invoiceEmailEnabled": true,      "reminderDays": 1,      "reminderEnabled": true,      "legalName": "<legalName>",      "cnpj": "<cnpj>"    },    "usage": [      {        "key": "patients",        "label": "<label>",        "used": 1,        "unit": "<unit>",        "limit": 1,        "percent": 1,        "fairUse": true      }    ],    "addons": {      "monthlyTotal": 1,      "items": [        {          "automationId": "<automationId>",          "name": "<name>",          "status": "<status>",          "monthly": 1,          "cycleCharge": 1        }      ]    },    "nextInvoice": {      "date": "2026-09-18T14:00:00.000Z",      "items": [        {          "label": "<label>",          "amount": 1        }      ],      "total": 1    },    "pendingPlanId": "<pendingPlanId>",    "quoteRequest": {      "planId": "<planId>",      "planName": "<planName>",      "requestedAt": "2026-09-18T14:00:00.000Z",      "status": "solicitada"    },    "cancelRequestedAt": "2026-09-18T14:00:00.000Z",    "policies": {      "priceTaxNote": "<priceTaxNote>",      "fairUsePolicy": "<fairUsePolicy>",      "trialDays": 1,      "planTrialDays": 1,      "dataRetentionDays": 1    }  }}

Exemplo gerado do esquema da resposta; valores entre < > são ilustrativos.

Códigos de erro

Corpo no formato padrão { error: { code, message, requestId } }. Veja todos os códigos.

400

Bad Request — Requisição malformada (JSON inválido, cursor inválido ou clínica ativa não informada).

401

Unauthorized — Token ausente, inválido ou expirado.

403

Forbidden — Autenticado, mas sem permissão (perfil ou clínica).

404

Not Found — Recurso não encontrado na clínica ativa.

422

Unprocessable Entity — Dados semanticamente inválidos (erros por campo em details).

429

Too Many Requests — Limite de requisições excedido (veja Retry-After).

500

Internal Server Error — Erro interno (sem detalhes expostos).

503

Service Unavailable — Banco de dados indisponível ou não configurado.

Limites

Limite padrão: 120 requisições a cada 60 segundos por token. Sobre limites

Testar no Swagger(abre em nova aba)