Pular para o conteúdo
MyClinicAPI Docs
PATCH

/v1/billing/profile

Dados e preferências de cobrança (frequência, notas por e-mail, lembrete de vencimento, razão social, CNPJ)

Cartão/forma de pagamento é alterado somente na página segura do provedor (nunca pela API). cycle (Mensal/Anual) vale a partir da próxima fatura; invoiceEmailEnabled e reminderEnabled são os interruptores da tela. Mudanças de frequência/preferências disparam billing.profile_updated para o provedor de pagamento.

Permissão:billing:manageDispara:billing.profile_updated

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

  • cyclestringOpcional

    Valores: Mensal, Anual

  • invoiceEmailstring (e-mail)Opcional

    Até 160 caracteres

  • invoiceEmailEnabledbooleanOpcional
  • reminderDaysintegerOpcional

    Entre 0 e 15

  • reminderEnabledbooleanOpcional
  • legalNamestringOpcional

    Até 160 caracteres

  • cnpjstringOpcional

    Padrão (regex): ^\d{2}\.?\d{3}\.?\d{3}/?\d{4}-?\d{2}$

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/profile", {  method: "PATCH",  headers: {    Authorization: "Bearer <TOKEN>",    "X-Clinic-Id": "<clinic_id>",    "Content-Type": "application/json",  },  body: JSON.stringify({    "cycle": "Mensal",    "invoiceEmail": "contato@exemplo.com",    "invoiceEmailEnabled": true,    "reminderDays": 1,    "reminderEnabled": true,    "legalName": "<legalName>",    "cnpj": "<cnpj>"  }),})​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": {    "cycle": "<cycle>",    "invoiceEmail": "<invoiceEmail>",    "invoiceEmailEnabled": true,    "reminderDays": 1,    "reminderEnabled": true,    "legalName": "<legalName>",    "cnpj": "<cnpj>"  },  "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.

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)