/v1/insurance-plans/{plan_id}Authentication
Bearer API key or Facily session, subject to permissions and facility scope.
Authentication and scopeRequest 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 --request PATCH \
--url 'https://api.staging.facily.ai/v1/insurance-plans/<PLAN_ID>' \
--header "Authorization: Bearer $FACILY_API_KEY" \
--header 'Content-Type: application/json' \
--data '{
"coverage_amount": 0,
"coverage_percentage": 0,
"description": "string",
"is_active": false,
"monthly_premium": 0,
"name": "string",
"provider": "string",
"provider_key": "string",
"provider_name": "string"
}'Parameters
plan_idpath · stringrequiredFormat: uuid
Request body
application/json · Required
coverage_amountnumber | string | nullPattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
Show coverage_amount schema
number | string | nullVariant 1: number
numberVariant 2: string
stringVariant 3: null
nullcoverage_percentagenumber | string | nullPattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
Show coverage_percentage schema
number | string | nullVariant 1: number
numberVariant 2: string
stringVariant 3: null
nulldescriptionstring | nullShow description schema
string | nullVariant 1: string
stringVariant 2: null
nullis_activeboolean | nullShow is_active schema
boolean | nullVariant 1: boolean
booleanVariant 2: null
nullmonthly_premiumnumber | string | nullPattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
Show monthly_premium schema
number | string | nullVariant 1: number
numberVariant 2: string
stringVariant 3: null
nullnamestring | nullShow name schema
string | nullVariant 1: string
stringVariant 2: null
nullproviderstring | nullShow provider schema
string | nullVariant 1: string
stringVariant 2: null
nullprovider_keystring | nullShow provider_key schema
string | nullVariant 1: string
stringVariant 2: null
nullprovider_namestring | nullShow provider_name schema
string | nullVariant 1: string
stringVariant 2: null
nullResponses
Expand a status to inspect its schema. Generated examples show structure and synthetic values.
200Successful Response
{
"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
dataInsurancePlanResponserequiredShow data schema
coverage_amountstringrequiredMaximum amount of stored goods covered, in the facility's currency.
Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
coverage_percentagestring | nullrequiredProportion 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 | nullProportion of the declared value covered, for plans that pay a percentage rather than a fixed sum.
Variant 1: string
stringVariant 2: null
nullcreated_atstringrequiredWhen the plan was created.
Format: date-time
descriptionstring | nullrequiredLonger description of what the plan covers.
Show description schema
string | nullLonger description of what the plan covers.
Variant 1: string
stringVariant 2: null
nullfacility_idstringrequiredThe facility offering this plan.
Format: uuid
idstringrequiredUnique identifier for this protection plan.
Format: uuid
is_activebooleanrequiredWhether the plan may currently be selected. Deactivating a plan does not affect leases already enrolled on it.
monthly_premiumstringrequiredAmount charged to the tenant each month for this plan.
Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
namestringrequiredOperator-facing plan name, typically naming the coverage tier.
providerstring | nullrequiredThe protection-plan provider underwriting this tier.
Show provider schema
string | nullThe protection-plan provider underwriting this tier.
Variant 1: string
stringVariant 2: null
nullprovider_keystring | nullrequiredStable machine-readable identifier for the provider, for use by an integration rather than a person.
Show provider_key schema
string | nullStable machine-readable identifier for the provider, for use by an integration rather than a person.
Variant 1: string
stringVariant 2: null
nullprovider_namestring | nullrequiredDisplay name of the provider, for showing to staff and tenants.
Show provider_name schema
string | nullDisplay name of the provider, for showing to staff and tenants.
Variant 1: string
stringVariant 2: null
nullmetaMetarequiredEnvelope metadata. Every response carries one.
Show meta schema
request_idstringrequired400Validation error
{
"error": {
"code": "string",
"message": "string",
"details": {}
},
"meta": {
"request_id": "string"
}
}application/json
errorErrorBodyrequiredThe shape of error.* in an error response.
Show error schema
codestringrequireddetailsobject | nullShow details schema
object | nullVariant 1: object
objectVariant 2: null
nullmessagestringrequiredmetaMetarequiredEnvelope metadata. Every response carries one.
Show meta schema
request_idstringrequired401Unauthenticated
{
"error": {
"code": "string",
"message": "string",
"details": {}
},
"meta": {
"request_id": "string"
}
}application/json
errorErrorBodyrequiredThe shape of error.* in an error response.
Show error schema
codestringrequireddetailsobject | nullShow details schema
object | nullVariant 1: object
objectVariant 2: null
nullmessagestringrequiredmetaMetarequiredEnvelope metadata. Every response carries one.
Show meta schema
request_idstringrequired403Permission denied
{
"error": {
"code": "string",
"message": "string",
"details": {}
},
"meta": {
"request_id": "string"
}
}application/json
errorErrorBodyrequiredThe shape of error.* in an error response.
Show error schema
codestringrequireddetailsobject | nullShow details schema
object | nullVariant 1: object
objectVariant 2: null
nullmessagestringrequiredmetaMetarequiredEnvelope metadata. Every response carries one.
Show meta schema
request_idstringrequired404Not found
{
"error": {
"code": "string",
"message": "string",
"details": {}
},
"meta": {
"request_id": "string"
}
}application/json
errorErrorBodyrequiredThe shape of error.* in an error response.
Show error schema
codestringrequireddetailsobject | nullShow details schema
object | nullVariant 1: object
objectVariant 2: null
nullmessagestringrequiredmetaMetarequiredEnvelope metadata. Every response carries one.
Show meta schema
request_idstringrequired409Business logic error
{
"error": {
"code": "string",
"message": "string",
"details": {}
},
"meta": {
"request_id": "string"
}
}application/json
errorErrorBodyrequiredThe shape of error.* in an error response.
Show error schema
codestringrequireddetailsobject | nullShow details schema
object | nullVariant 1: object
objectVariant 2: null
nullmessagestringrequiredmetaMetarequiredEnvelope metadata. Every response carries one.
Show meta schema
request_idstringrequired503Temporary failure
{
"error": {
"code": "string",
"message": "string",
"details": {}
},
"meta": {
"request_id": "string"
}
}application/json
errorErrorBodyrequiredThe shape of error.* in an error response.
Show error schema
codestringrequireddetailsobject | nullShow details schema
object | nullVariant 1: object
objectVariant 2: null
nullmessagestringrequiredmetaMetarequiredEnvelope metadata. Every response carries one.
Show meta schema
request_idstringrequired