Pular para o conteúdo
MyClinicAPI Docs
POST

/v1/automations/{id}/subscription

Contratar ou iniciar teste de 7 dias

mode: "trial" só na primeira vez (409 trial_unavailable depois). mode: "active" cobra o proporcional do ciclo atual; reativar no mesmo ciclo após desativar mantém a data original (já cobrada).

E-mail verificado: quando a verificação de e-mail está ligada no ambiente, contas com e-mail ainda não confirmado recebem 403 email_not_verified.

Permissão:automations:manageDispara:automation.subscribed

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

Parâmetros de caminho

  • idstringObrigatório

    Id do recurso. · Entre 1 e 64 caracteres · Padrão (regex): ^[A-Za-z0-9._-]+$

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

  • modestringObrigatório

    Valores: trial, active

  • settingsobjectOpcional

Exemplo de requisição

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

const res = await fetch("https://myclinc.leadpoint.com.br/v1/automations/<id>/subscription", {  method: "POST",  headers: {    Authorization: "Bearer <TOKEN>",    "X-Clinic-Id": "<clinic_id>",    "Content-Type": "application/json",  },  body: JSON.stringify({    "mode": "trial",    "settings": {}  }),})​if (!res.ok) {  const { error } = await res.json()  throw new Error(`${error.code}: ${error.message} (${error.requestId})`)}const { data } = await res.json()

Resposta

201Created — Sucesso.
JSON
{  "data": {    "id": "<id>",    "name": "<name>",    "summary": "<summary>",    "about": "<about>",    "category": "<category>",    "categoryLabel": "<categoryLabel>",    "highlight": "premium",    "price": 1,    "agent": {      "key": "<key>",      "name": "<name>",      "image": "<image>"    },    "benefits": [      "<benefit>"    ],    "potential": 1,    "potentialLabel": "<potentialLabel>",    "settings": [      {        "id": "<id>",        "kind": "toggle",        "label": "<label>",        "description": "<description>",        "options": [          "<option>"        ],        "default": true      }    ],    "subscription": {      "status": "ativa",      "since": "2026-09-18T14:00:00.000Z",      "trialEndsAt": "2026-09-18T14:00:00.000Z",      "trialDaysLeft": 1,      "activeUntil": "2026-09-18T14:00:00.000Z",      "settings": {},      "cycleCharge": 1    },    "trialAvailable": true,    "pricing": {      "monthly": 1,      "nextInvoiceAmount": 1,      "proRataDays": 1,      "cycleDays": 1,      "trialEndsAt": "2026-09-18T14:00:00.000Z",      "noticeAt": "2026-09-18T14:00:00.000Z",      "terms": "<terms>"    },    "automation": {      "id": "<id>",      "name": "<name>",      "summary": "<summary>",      "about": "<about>",      "category": "<category>",      "categoryLabel": "<categoryLabel>",      "highlight": "premium",      "price": 1,      "agent": {        "key": "<key>",        "name": "<name>",        "image": "<image>"      },      "benefits": [        "<benefit>"      ],      "potential": 1,      "potentialLabel": "<potentialLabel>",      "settings": [        {          "id": "<id>",          "kind": "toggle",          "label": "<label>",          "description": "<description>",          "options": [],          "default": true        }      ],      "subscription": {        "status": "ativa",        "since": "2026-09-18T14:00:00.000Z",        "trialEndsAt": "2026-09-18T14:00:00.000Z",        "trialDaysLeft": 1,        "activeUntil": "2026-09-18T14:00:00.000Z",        "settings": {},        "cycleCharge": 1      },      "trialAvailable": 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)