latestOpenAPI 3.1.02026-08-194237902.5 MB

563848e0ecc0

Plan

Fully replace an existing plan by ID

Replaces the entire plan record identified by {id} with the supplied payload. This is a full replacement — fields omitted from data are not preserved from the prior version, so submit the complete desired plan data on every call, not a partial diff. Submitting the same payload twice for the same {id} is idempotent. The caller must hold the UPDATE_PLAN permission. As with plan creation, data.payer is extracted and stored as payerId, and the referenced payer is not validated for existence. data's full shape is defined by the external Plan JSON schema and may include required fields beyond payer.

put/plans/{id}

Path parameters

idstring required

The plan's server-assigned identifier, as returned by POST /plans.

Headers

tenant-idstring required

The tenant identifier that must own the plan being replaced.

Request body

Response

The plan as it exists after the replacement.

idstring

Server-assigned unique identifier for the plan.

tenantIdstring

Identifier of the tenant that owns this plan.

payerIdstring

Identifier of the payer this plan is associated with. Extracted server-side from data.payer at creation time.

dataobject

The plan's domain data, validated against the Plan JSON schema at creation/update time.