Payment status for lease signing

Retrieves the payment status required to initiate electronic signing of the lease. Includes tracking of invitations sent and authorized limits.

get/leases/{lease_id}/payment/signature-status

Request

Base URL: https://api.faireplace.com/api
URL: https://api.faireplace.com/api/leases/{lease_id}/payment/signature-status
Auth: HTTP bearer

Path parameters

lease_idstring uuid required

Lease ID

Response

Signature payment status retrieved successfully

is_paidboolean required

Indicates whether payment has been made

payment_idstring uuid nullable

Associated payment ID (null if unpaid)

statusstring nullable

Payment status (e.g., succeeded, pending)

paid_atstring date-time nullable

Payment date and time

total_invitations_sentinteger required

Total number of signature invitations sent

max_invitationsinteger required

Maximum number of authorized invitations

remaining_invitationsinteger required

Number of remaining invitations

payment_requiredboolean required

Indicates whether payment is required to initiate signing

Example response

{
  "is_paid": true,
  "payment_id": "550e8400-e29b-41d4-a716-446655440001",
  "status": "succeeded",
  "paid_at": "2024-01-15T10:00:00Z",
  "total_invitations_sent": 2,
  "max_invitations": 5,
  "remaining_invitations": 3
}

Changes

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