Skip to content
FacilydevelopersDashboard
Build with Facily
DocsREST APIsApply Promotion To Lease
Search the full API reference Esc to close

Apply Promotion To Lease

Leases · REST API reference

Get support
POST/v1/leases/{lease_id}/promotions
Apply a promotion from the lease's next billing period. 409 `lease_busy` while a billing run holds the lease (retry shortly); 409 `promotion_not_attachable` with the reason; 409 `promotion_max_uses`.

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>/promotions' \
  --header "Authorization: Bearer $FACILY_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{
  "promotion_id": "00000000-0000-4000-8000-000000000001"
}'
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

promotion_idstringrequired

The promotion to apply from the lease's next billing period.

Format: uuid

Responses

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

201Successful Response
JSON · generated example
{
  "data": {
    "code": "string",
    "created_at": "2026-10-29T12:00:00Z",
    "current_month": 0,
    "discount_summary": "string",
    "ended_on": "2026-10-29",
    "facility_id": "00000000-0000-4000-8000-000000000001",
    "id": "00000000-0000-4000-8000-000000000001",
    "lease_id": "00000000-0000-4000-8000-000000000001",
    "name": "string",
    "promotion_id": "00000000-0000-4000-8000-000000000001",
    "source": "string",
    "starts_on": "2026-10-29",
    "status": "scheduled",
    "total_months": 0
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

dataLeasePromotionResponserequired
Show data schema
codestringrequired

The promotion's code.

created_atstringrequired

Format: date-time

current_monthinteger | nullrequired

While active: the month it is in ("month 2 of 4").

Show current_month schema
integer | null

While active: the month it is in ("month 2 of 4").

Variant 1: integer
integer
Variant 2: null
null
discount_summarystringrequired

The promotion's discount, as on the promotion.

ended_onstring | nullrequired

The last day it covers. Null while it runs.

Format: date

Show ended_on schema
string | null

The last day it covers. Null while it runs.

Variant 1: string
string
Variant 2: null
null
facility_idstringrequired

Format: uuid

idstringrequired

The lease promotion (attachment).

Format: uuid

lease_idstringrequired

Format: uuid

namestringrequired

The promotion's name.

promotion_idstringrequired

Format: uuid

sourcestringrequired

import, staff or move_in.

starts_onstringrequired

The start of the billing period that is month 1.

Format: date

statusstringrequired

Relative to the facility's today.

Values: "scheduled", "active", "ended"

total_monthsinteger | nullrequired

The schedule's length; null when the last month repeats.

Show total_months schema
integer | null

The schedule's length; null when the last month repeats.

Variant 1: integer
integer
Variant 2: null
null
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

Apply Promotion To Lease | Facily Developers