/v1/leases/{lease_id}/fees/eligibleAuthentication
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 GET \
--url 'https://api.staging.facily.ai/v1/leases/<LEASE_ID>/fees/eligible' \
--header "Authorization: Bearer $FACILY_API_KEY"Try a request
Staging · read-onlyExplore your organization with a read-only request to staging.
Parameters
lease_idpath · stringrequiredFormat: uuid
Responses
Expand a status to inspect its schema. Generated examples show structure and synthetic values.
200Successful Response
{
"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
dataLeaseFeeEligibilityResponserequiredShow data schema
feesEligibleFeeResponse[]requiredShow fees schema
actionstringrequiredattach for a recurring fee, charge for a one-time fee.
Values: "attach", "charge"
amountstring | nullrequiredPattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
Show amount schema
string | nullVariant 1: string
stringVariant 2: null
nullcodestringrequiredfee_basestring | nullrequiredShow fee_base schema
string | nullVariant 1: string
stringVariant 2: null
nullfee_rule_idstringrequiredFormat: uuid
fee_typestringrequiredfrequencystringrequiredis_taxablebooleanrequiredkindstringrequirednamestringrequiredpercentagestring | nullrequiredPattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
Show percentage schema
string | nullVariant 1: string
stringVariant 2: null
nullreasonstring | nullrequiredWhy it cannot be added or charged now; null when it can.
Show reason schema
string | nullWhy it cannot be added or charged now; null when it can.
Variant 1: string
stringVariant 2: null
nullrequiredbooleanrequiredlease_idstringrequiredFormat: uuid
next_billing_datestringrequiredWhere a new attachment starts by default.
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