/v1/leases/{lease_id}/feesAuthentication
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 POST \
--url 'https://api.staging.facily.ai/v1/leases/<LEASE_ID>/fees' \
--header "Authorization: Bearer $FACILY_API_KEY" \
--header 'Content-Type: application/json' \
--data '{
"fee_rule_id": "00000000-0000-4000-8000-000000000001",
"amount": 0,
"starts_on": "2026-10-29"
}'Parameters
lease_idpath · stringrequiredFormat: uuid
Request body
application/json · Required
amountnumber | string | nullRequired for a custom fee; refused otherwise.
Pattern: ^(?!^[-+.]*$)[+-]?0*(?:\d{0,8}|(?=[\d.]{1,11}0*$)\d{0,8}\.\d{0,2}0*$)
Show amount schema
number | string | nullRequired for a custom fee; refused otherwise.
Variant 1: number
numberVariant 2: string
stringVariant 3: null
nullfee_rule_idstringrequiredFormat: uuid
starts_onstring | nullThe first day it may bill. Default and minimum: the lease's next billing date.
Format: date
Show starts_on schema
string | nullThe first day it may bill. Default and minimum: the lease's next billing date.
Variant 1: string
stringVariant 2: null
nullResponses
Expand a status to inspect its schema. Generated examples show structure and synthetic values.
201Successful Response
{
"data": {
"amount": "<VALUE_MATCHING_PATTERN>",
"code": "string",
"created_at": "2026-10-29T12:00:00Z",
"ended_on": "2026-10-29",
"facility_id": "00000000-0000-4000-8000-000000000001",
"fee_base": "string",
"fee_rule_id": "00000000-0000-4000-8000-000000000001",
"fee_type": "string",
"frequency": "string",
"id": "00000000-0000-4000-8000-000000000001",
"is_taxable": false,
"kind": "string",
"lease_id": "00000000-0000-4000-8000-000000000001",
"name": "string",
"percentage": "<VALUE_MATCHING_PATTERN>",
"required": false,
"source": "string",
"starts_on": "2026-10-29"
},
"meta": {
"request_id": "string"
}
}application/json
dataLeaseFeeResponserequiredShow data schema
amountstring | nullrequiredWhat this lease is charged each time; null for a percentage fee.
Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
Show amount schema
string | nullWhat this lease is charged each time; null for a percentage fee.
Variant 1: string
stringVariant 2: null
nullcodestringrequiredThe catalog fee's product code.
created_atstringrequiredFormat: date-time
ended_onstring | nullrequiredThe last day it covers; null while live.
Format: date
Show ended_on schema
string | nullThe last day it covers; null while live.
Variant 1: string
stringVariant 2: null
nullfacility_idstringrequiredFormat: uuid
fee_basestring | nullrequiredWhat a percentage fee is a percentage of.
Show fee_base schema
string | nullWhat a percentage fee is a percentage of.
Variant 1: string
stringVariant 2: null
nullfee_rule_idstringrequiredFormat: uuid
fee_typestringrequiredflat, percentage, or custom.
frequencystringrequiredmonthly or annual.
idstringrequiredUnique identifier for this attachment.
Format: uuid
is_taxablebooleanrequiredkindstringrequiredfee or service.
lease_idstringrequiredFormat: uuid
namestringrequiredThe catalog fee's description.
percentagestring | nullrequiredThe catalog percentage, for a percentage fee.
Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
Show percentage schema
string | nullThe catalog percentage, for a percentage fee.
Variant 1: string
stringVariant 2: null
nullrequiredbooleanrequiredAdded at move-in because the fee is required; cannot be ended on one lease.
sourcestringrequiredstaff, bulk, backfill, import, or move_in.
starts_onstringrequiredThe first day it may bill.
Format: date
metaMetarequiredEnvelope 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