Changelog
Back to All
Added

v0.19.0 Renewals

16 days ago by Jakub Such

New in Platform API 0.19.0

The Renewals API lets you manage your company's Remote Health renewal end‑to‑end - mint per‑group renewal links, review each member's renewal request, and apply their renewal decision. All endpoints are under /api/remote-health/v1/renewal-request and authenticated with your X-API-KEY; your company is taken from the key, so you never pass it.

GET /renewal-request/contract-bundles - List contract bundle renewal requests

Returns the per‑member renewal requests for a contract.

  • Query: companyContractId (required), groupId (scope to one group / renewal link), page, size.
  • Returns a paginated list of contract‑bundle renewal requests.

PUT /renewal-request/contract-bundle - Update contract bundle during renewal

Applies one member's renewal decision.

  • Body: {requestChangeType, renew}
    • requestChangeType: NO_CHANGES (keep current plan & coverage), PLAN_CHANGE (switch to
      selectedPlanId - required for thisp this member's coverage atrenewal), or REVERT_CHANGES (undo a previous change).
    • renewalRequestId: which member
  • Returns 200 (no body).

Typical flow: POST /links → share links with groups → GET /contract-bundles to review → PUT /contract-bundle per member to setto track usage.


Renewal forms

POST /renewal-request/links — Generate renewal form links

Generates one renewal‑form link per member group, each carrying an expiring token scoped to that group's renewal. Safe to call repeatedly — existing links are reused, and only groups without one get a new link.

  • Body (optional): {"companyContractId": <id>} — defaults to your current company contract.
  • Returns: {renewalRequestId, sourceCompanyContractId, links: [ { groupId, url, token, expiresAt, … } ]}.

GET /renewal-request/links - List renewal form links

Lists your renewal‑form links, newest first, with expiry and whether each has been used.

  • Query: companyContractId (scope to one contract), all (default false, return every link), page (default 0), size (1–100, default 50).
  • Default scope is your current company contract. Returns a paginated list.