Skip to content
FacilydevelopersDashboard
Build with Facily
DocsREST APIsCreate Insurance Plan
Search the full API reference Esc to close

Create Insurance Plan

Organization · REST API reference

Get support
POST/v1/facilities/{facility_id}/insurance-plans

Authentication

Bearer API key or Facily session, subject to permissions and facility scope.

Authentication and scope

Request example

Replace bracketed path values with real IDs from your environment. The body, where shown, is generated from the schema and uses illustrative values.

cURL
curl --request POST \
  --url 'https://api.staging.facily.ai/v1/facilities/<FACILITY_ID>/insurance-plans' \
  --header "Authorization: Bearer $FACILY_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{
  "coverage_amount": 0,
  "monthly_premium": 0,
  "name": "string",
  "coverage_percentage": 0,
  "description": "string",
  "is_active": true,
  "provider": "string",
  "provider_key": "string",
  "provider_name": "string"
}'
An example for building your request, not an executed call. Check required fields, allowed values, and environment configuration before sending.

Parameters

facility_idpath · stringrequired

Format: uuid

Request body

application/json · Required

coverage_amountnumber | stringrequired

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$

Show coverage_amount schema
number | string
Variant 1: number
number
Variant 2: string
string
coverage_percentagenumber | string | null

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$

Show coverage_percentage schema
number | string | null
Variant 1: number
number
Variant 2: string
string
Variant 3: null
null
descriptionstring | null
Show description schema
string | null
Variant 1: string
string
Variant 2: null
null
is_activeboolean

Default: true

monthly_premiumnumber | stringrequired

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$

Show monthly_premium schema
number | string
Variant 1: number
number
Variant 2: string
string
namestringrequired
providerstring | null
Show provider schema
string | null
Variant 1: string
string
Variant 2: null
null
provider_keystring | null
Show provider_key schema
string | null
Variant 1: string
string
Variant 2: null
null
provider_namestring | null
Show provider_name schema
string | null
Variant 1: string
string
Variant 2: null
null

Responses

Expand a status to inspect its schema. Generated examples show structure and synthetic values.

200Successful Response
JSON · generated example
{
  "data": {
    "coverage_amount": "<VALUE_MATCHING_PATTERN>",
    "coverage_percentage": "<VALUE_MATCHING_PATTERN>",
    "created_at": "2026-10-29T12:00:00Z",
    "description": "string",
    "facility_id": "00000000-0000-4000-8000-000000000001",
    "id": "00000000-0000-4000-8000-000000000001",
    "is_active": false,
    "monthly_premium": "<VALUE_MATCHING_PATTERN>",
    "name": "string",
    "provider": "string",
    "provider_key": "string",
    "provider_name": "string"
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

dataInsurancePlanResponserequired
Show data schema
coverage_amountstringrequired

Maximum amount of stored goods covered, in the facility's currency.

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$

coverage_percentagestring | nullrequired

Proportion of the declared value covered, for plans that pay a percentage rather than a fixed sum.

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$

Show coverage_percentage schema
string | null

Proportion of the declared value covered, for plans that pay a percentage rather than a fixed sum.

Variant 1: string
string
Variant 2: null
null
created_atstringrequired

When the plan was created.

Format: date-time

descriptionstring | nullrequired

Longer description of what the plan covers.

Show description schema
string | null

Longer description of what the plan covers.

Variant 1: string
string
Variant 2: null
null
facility_idstringrequired

The facility offering this plan.

Format: uuid

idstringrequired

Unique identifier for this protection plan.

Format: uuid

is_activebooleanrequired

Whether the plan may currently be selected. Deactivating a plan does not affect leases already enrolled on it.

monthly_premiumstringrequired

Amount charged to the tenant each month for this plan.

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$

namestringrequired

Operator-facing plan name, typically naming the coverage tier.

providerstring | nullrequired

The protection-plan provider underwriting this tier.

Show provider schema
string | null

The protection-plan provider underwriting this tier.

Variant 1: string
string
Variant 2: null
null
provider_keystring | nullrequired

Stable machine-readable identifier for the provider, for use by an integration rather than a person.

Show provider_key schema
string | null

Stable machine-readable identifier for the provider, for use by an integration rather than a person.

Variant 1: string
string
Variant 2: null
null
provider_namestring | nullrequired

Display name of the provider, for showing to staff and tenants.

Show provider_name schema
string | null

Display name of the provider, for showing to staff and tenants.

Variant 1: string
string
Variant 2: null
null
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
400Validation error
JSON · generated example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

errorErrorBodyrequired

The shape of error.* in an error response.

Show error schema
codestringrequired
detailsobject | null
Show details schema
object | null
Variant 1: object
object
Variant 2: null
null
messagestringrequired
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
401Unauthenticated
JSON · generated example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

errorErrorBodyrequired

The shape of error.* in an error response.

Show error schema
codestringrequired
detailsobject | null
Show details schema
object | null
Variant 1: object
object
Variant 2: null
null
messagestringrequired
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
403Permission denied
JSON · generated example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

errorErrorBodyrequired

The shape of error.* in an error response.

Show error schema
codestringrequired
detailsobject | null
Show details schema
object | null
Variant 1: object
object
Variant 2: null
null
messagestringrequired
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
404Not found
JSON · generated example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

errorErrorBodyrequired

The shape of error.* in an error response.

Show error schema
codestringrequired
detailsobject | null
Show details schema
object | null
Variant 1: object
object
Variant 2: null
null
messagestringrequired
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
409Business logic error
JSON · generated example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

errorErrorBodyrequired

The shape of error.* in an error response.

Show error schema
codestringrequired
detailsobject | null
Show details schema
object | null
Variant 1: object
object
Variant 2: null
null
messagestringrequired
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
503Temporary failure
JSON · generated example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

errorErrorBodyrequired

The shape of error.* in an error response.

Show error schema
codestringrequired
detailsobject | null
Show details schema
object | null
Variant 1: object
object
Variant 2: null
null
messagestringrequired
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
Build something that works beautifully.

Facily API · Contract v1.200 · Reviewed October 29, 2026

Create Insurance Plan | Facily Developers