Sign in
latestOpenAPI 3.1.02026-08-194237902.5 MB

563848e0ecc0

Plan

Create a new plan for a tenant

Creates a new plan and associates it with the specified tenant. This operation is not idempotent — submitting the same payload twice creates two separate plan records. The caller must hold the CREATE_PLAN permission. The request body's data.payer field is extracted and stored as the plan's payerId; the referenced payer is not validated for existence before the plan is created. data's full shape is defined by the external Plan JSON schema and may include required fields beyond payer.

post/plans

Headers

tenant-idstring required

The tenant identifier to associate the new plan with.

Request body

Response

The created plan, including the server-assigned id. Store this id to reference the plan in subsequent calls (e.g. PUT /plans/{id}).

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.