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

Eligible Lease Fees

Leases · REST API reference

Get support
GET/v1/leases/{lease_id}/fees/eligible

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 GET \
  --url 'https://api.staging.facily.ai/v1/leases/<LEASE_ID>/fees/eligible' \
  --header "Authorization: Bearer $FACILY_API_KEY"
An example for building your request, not an executed call. Check required fields, allowed values, and environment configuration before sending.

Try a request

Staging · read-only

Explore your organization with a read-only request to staging.

Kept in this tab only. Sent directly to api.staging.facily.ai.

GET

Replace the {placeholders} in the path with your resource IDs.

Response
Your response will appear here.

Parameters

lease_idpath · stringrequired

Format: uuid

Responses

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

200Successful Response
JSON · generated example
{
  "data": {
    "fees": [
      {
        "action": "attach",
        "amount": "<VALUE_MATCHING_PATTERN>",
        "code": "string",
        "fee_base": "string",
        "fee_rule_id": "00000000-0000-4000-8000-000000000001",
        "fee_type": "string",
        "frequency": "string",
        "is_taxable": false,
        "kind": "string",
        "name": "string",
        "percentage": "<VALUE_MATCHING_PATTERN>",
        "reason": "string",
        "required": false
      }
    ],
    "lease_id": "00000000-0000-4000-8000-000000000001",
    "next_billing_date": "2026-10-29"
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

dataLeaseFeeEligibilityResponserequired
Show data schema
feesEligibleFeeResponse[]required
Show fees schema
actionstringrequired

attach for a recurring fee, charge for a one-time fee.

Values: "attach", "charge"

amountstring | nullrequired

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

Show amount schema
string | null
Variant 1: string
string
Variant 2: null
null
codestringrequired
fee_basestring | nullrequired
Show fee_base schema
string | null
Variant 1: string
string
Variant 2: null
null
fee_rule_idstringrequired

Format: uuid

fee_typestringrequired
frequencystringrequired
is_taxablebooleanrequired
kindstringrequired
namestringrequired
percentagestring | nullrequired

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

Show percentage schema
string | null
Variant 1: string
string
Variant 2: null
null
reasonstring | nullrequired

Why it cannot be added or charged now; null when it can.

Show reason schema
string | null

Why it cannot be added or charged now; null when it can.

Variant 1: string
string
Variant 2: null
null
requiredbooleanrequired
lease_idstringrequired

Format: uuid

next_billing_datestringrequired

Where a new attachment starts by default.

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

Eligible Lease Fees | Facily Developers