Check whether the organisation can send rent receipts

Reads the entitlement that gates the emailing of rent receipts.

Two things can grant it: a paid plan, or the €4.90 one-shot purchase which opens a one-year window. entitled already accounts for both: base your UI on it, not on access_until, which is null whenever the access comes from the plan.

Without entitlement, POST /leases/{lease_id}/receipts/{receipt_id}/send answers 402. Generation and the tenant's own access to the document are never gated.

get/quittance-access

Request

Base URL: https://api.faireplace.com/api
URL: https://api.faireplace.com/api/quittance-access
Auth: HTTP bearer

Response

entitledboolean required

true when rent receipts can be emailed: either because the plan includes them, or because a €4.90 one-shot window is still open.

access_untilstring date nullable

End of the one-shot window. null when there is none, which does not mean "no access": entitlement may come from the plan. Always read entitled for the decision, and use this only to display the renewal date.

Example response

{
  "access_until": "2027-03-14"
}

Changes

No recorded changes to this operation across all 1 revision of this API.