Pular para o conteúdo
MyClinicAPI Docs
POST

/v1/billing/plan-changes

Solicitar mudança de plano

Responde 202: a troca é agendada para o fim do ciclo (pendingPlanId) e efetivada pelo provedor de pagamento. Durante o teste grátis do plano (status teste) a troca vale na hora (appliedNow: true) e o fim do teste não muda. Plano sob consulta ("Rede de clínicas") NÃO agenda troca: registra um pedido de proposta (quoteRequest, webhook billing.quote_requested). Avisos de limite vêm em warnings.

Permissão:billing:manageDispara:billing.plan_change_requestedbilling.quote_requested

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}$

Corpo da requisição

application/json · obrigatório

  • planIdstringObrigatório

    Até 32 caracteres

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/plan-changes", {  method: "POST",  headers: {    Authorization: "Bearer <TOKEN>",    "X-Clinic-Id": "<clinic_id>",    "Content-Type": "application/json",  },  body: JSON.stringify({    "planId": "<planId>"  }),})​if (!res.ok) {  const { error } = await res.json()  throw new Error(`${error.code}: ${error.message} (${error.requestId})`)}const { data } = await res.json()

Resposta

202Accepted — Sucesso.
JSON
{  "data": {    "requestedPlanId": "<requestedPlanId>",    "contactSales": true,    "warnings": [      "<warning>"    ],    "quoteRequest": {      "planId": "<planId>",      "planName": "<planName>",      "requestedAt": "2026-09-18T14:00:00.000Z",      "status": "solicitada"    },    "appliedNow": true  },  "meta": {    "webhooks": [      {        "event": "appointment.cancelled",        "status": "sent"      }    ]  }}

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.

409

Conflict — Conflito de estado (duplicidade, transição inválida, conflito de agenda).

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)