Skip to content
FacilydevelopersDashboard
Build with Facily
DocsREST APIsAttach Lease Fee
Search the full API reference Esc to close

Attach Lease Fee

Leases · REST API reference

Get support
POST/v1/leases/{lease_id}/fees

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/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"
}'
An example for building your request, not an executed call. Check required fields, allowed values, and environment configuration before sending.

Parameters

lease_idpath · stringrequired

Format: uuid

Request body

application/json · Required

amountnumber | string | null

Required 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 | null

Required for a custom fee; refused otherwise.

Variant 1: number
number
Variant 2: string
string
Variant 3: null
null
fee_rule_idstringrequired

Format: uuid

starts_onstring | null

The first day it may bill. Default and minimum: the lease's next billing date.

Format: date

Show starts_on schema
string | null

The first day it may bill. Default and minimum: the lease's next billing date.

Variant 1: string
string
Variant 2: null
null

Responses

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

201Successful Response
JSON · generated example
{
  "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

dataLeaseFeeResponserequired
Show data schema
amountstring | nullrequired

What this lease is charged each time; null for a percentage fee.

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

Show amount schema
string | null

What this lease is charged each time; null for a percentage fee.

Variant 1: string
string
Variant 2: null
null
codestringrequired

The catalog fee's product code.

created_atstringrequired

Format: date-time

ended_onstring | nullrequired

The last day it covers; null while live.

Format: date

Show ended_on schema
string | null

The last day it covers; null while live.

Variant 1: string
string
Variant 2: null
null
facility_idstringrequired

Format: uuid

fee_basestring | nullrequired

What a percentage fee is a percentage of.

Show fee_base schema
string | null

What a percentage fee is a percentage of.

Variant 1: string
string
Variant 2: null
null
fee_rule_idstringrequired

Format: uuid

fee_typestringrequired

flat, percentage, or custom.

frequencystringrequired

monthly or annual.

idstringrequired

Unique identifier for this attachment.

Format: uuid

is_taxablebooleanrequired
kindstringrequired

fee or service.

lease_idstringrequired

Format: uuid

namestringrequired

The catalog fee's description.

percentagestring | nullrequired

The catalog percentage, for a percentage fee.

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

Show percentage schema
string | null

The catalog percentage, for a percentage fee.

Variant 1: string
string
Variant 2: null
null
requiredbooleanrequired

Added at move-in because the fee is required; cannot be ended on one lease.

sourcestringrequired

staff, bulk, backfill, import, or move_in.

starts_onstringrequired

The first day it may bill.

Format: date

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
Continue exploringAll leases operations
Build something that works beautifully.

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

Attach Lease Fee | Facily Developers