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

Get Fee Rule

Billing · REST API reference

Get support
GET/v1/fee-rules/{fee_rule_id}

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/fee-rules/<FEE_RULE_ID>' \
  --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

fee_rule_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": {
    "amount": "<VALUE_MATCHING_PATTERN>",
    "applicable_unit_group_ids": [
      "00000000-0000-4000-8000-000000000001"
    ],
    "code": "string",
    "created_at": "2026-10-29T12:00:00Z",
    "facility_ids": [
      "00000000-0000-4000-8000-000000000001"
    ],
    "fee_base": "string",
    "fee_type": "string",
    "frequency": "string",
    "id": "00000000-0000-4000-8000-000000000001",
    "is_active": false,
    "is_taxable": false,
    "kind": "string",
    "name": "string",
    "percentage": "<VALUE_MATCHING_PATTERN>",
    "required": false
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

dataFeeRuleResponserequired
Show data schema
amountstring | nullrequired

The fixed amount of a flat fee.

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

Show amount schema
string | null

The fixed amount of a flat fee.

Variant 1: string
string
Variant 2: null
null
applicable_unit_group_idsstring[] | nullrequired

Unit groups the fee applies to; null for all.

Show applicable_unit_group_ids schema
string[] | null

Unit groups the fee applies to; null for all.

Variant 1: string[]
string[]
Variant 2: null
null
codestringrequired

Product code, upper-case.

created_atstringrequired

When the fee was created.

Format: date-time

facility_idsstring[]required

Facilities the fee applies at. Empty means every facility.

Show facility_ids schema
string
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_typestringrequired

flat, percentage, or custom.

frequencystringrequired

one_time, monthly or annual.

idstringrequired

Unique identifier for this fee.

Format: uuid

is_activebooleanrequired

Whether the fee can be added or charged now.

is_taxablebooleanrequired

Whether sales tax is charged on this fee.

kindstringrequired

fee or service.

live_attachment_countinteger

Leases currently carrying this fee.

Default: 0

namestringrequired

Description shown to staff and on the ledger line.

percentagestring | nullrequired

The percentage of a percentage fee.

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

Show percentage schema
string | null

The percentage of a percentage fee.

Variant 1: string
string
Variant 2: null
null
requiredbooleanrequired

Added to every new lease at move-in.

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 billing operations
Build something that works beautifully.

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

Get Fee Rule | Facily Developers