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

Charge Lease Fee

Leases · REST API reference

Get support
POST/v1/leases/{lease_id}/fee-charges
Charge a one-time catalog fee now. A repeated Idempotency-Key returns the first charge (`replayed: true`); the same key with a different body is a 409.

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>/fee-charges' \
  --header "Authorization: Bearer $FACILY_API_KEY" \
  --header 'Idempotency-Key: <IDEMPOTENCY_KEY>' \
  --header 'Content-Type: application/json' \
  --data '{
  "fee_rule_id": "00000000-0000-4000-8000-000000000001",
  "amount": 0,
  "note": "string"
}'
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

Idempotency-Keyheader · stringrequired

Min length: 1 · Max length: 100

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

notestring | null

Why, kept in the audit trail.

Max length: 255

Show note schema
string | null

Why, kept in the audit trail.

Variant 1: string
string
Variant 2: null
null

Responses

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

200Successful Response
JSON · generated example
{
  "data": {
    "amount": "<VALUE_MATCHING_PATTERN>",
    "description": "string",
    "effective_date": "2026-10-29",
    "fee_rule_id": "00000000-0000-4000-8000-000000000001",
    "lease_id": "00000000-0000-4000-8000-000000000001",
    "ledger_entry_id": "00000000-0000-4000-8000-000000000001",
    "ledger_id": "00000000-0000-4000-8000-000000000001",
    "replayed": false,
    "subtotal": "<VALUE_MATCHING_PATTERN>",
    "tax_amount": "<VALUE_MATCHING_PATTERN>"
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

dataLeaseFeeChargeResponserequired
Show data schema
amountstringrequired

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

descriptionstringrequired
effective_datestringrequired

Format: date

fee_rule_idstringrequired

Format: uuid

lease_idstringrequired

Format: uuid

ledger_entry_idstringrequired

Format: uuid

ledger_idstringrequired

Format: uuid

replayedbooleanrequired

True when this Idempotency-Key had already charged; nothing new was written.

subtotalstringrequired

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

tax_amountstringrequired

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

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

Charge Lease Fee | Facily Developers