AgreementRent

object

agreement_idrequired: Id
Opaque record id.
set_uprequired: boolean
problemrequired: string or null
Why a schedule cannot be generated yet (no due day …).
rent_amountrequired: Paise
Money in paise (₹1 = 100), an exact integer.
due_dayrequired: integer or null
pan_requiredrequired: boolean
Annual rent above ₹1,00,000: receipts need the landlord’s PAN.
profilerequired: object or null
profile.payee_namerequired: string or null
profile.upi_vparequired: string or null
profile.landlord_panrequired: string or null
Masked (XXXXXX1234D); the full PAN prints only on the HRA receipt.
profile.reminders_enabledrequired: boolean
profile.late_fees_enabledrequired: boolean
profile.generated_atrequired: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
instalmentsrequired: array of RentInstalment
paymentsrequired: array of RentPayment
mandaterequired: object or null
mandate.idrequired: Id
Opaque record id.
mandate.kindrequired: "autopay" | "enach"
mandate.statusrequired: "created" | "pending" | "active" | "paused" | "revoked" | "failed"
mandate.max_amountrequired: Paise
Money in paise (₹1 = 100), an exact integer.
mandate.setup_urlrequired: string or null
mandate.failure_reasonrequired: string or null
mandate.activated_atrequired: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
mandate.created_atrequired: DateTime
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
totalsrequired: object
totals.outstandingrequired: Paise
Money in paise (₹1 = 100), an exact integer.
totals.overduerequired: Paise
Money in paise (₹1 = 100), an exact integer.
totals.collectedrequired: Paise
Money in paise (₹1 = 100), an exact integer.
totals.advancerequired: Paise
Money in paise (₹1 = 100), an exact integer.
totals.pending_claimsrequired: integer
capabilitiesrequired: object
capabilities.managerequired: boolean
capabilities.late_feesrequired: boolean
capabilities.autopayrequired: boolean
A Razorpay connection can carry AutoPay / e-NACH mandates.
capabilities.reveal_panrequired: boolean
May reveal the landlord’s full PAN (audited, step-up).

Example

{
  "agreement_id": "cmusrceel0000q7kaafxqi1om",
  "set_up": true,
  "problem": "string",
  "rent_amount": 850000000,
  "due_day": 0,
  "pan_required": true,
  "profile": {
    "payee_name": "string",
    "upi_vpa": "string",
    "landlord_pan": "string",
    "reminders_enabled": true,
    "late_fees_enabled": true,
    "generated_at": "2026-10-06T05:30:00.000Z"
  },
  "instalments": [
    {
      "id": "cmusrceel0000q7kaafxqi1om",
      "seq": 0,
      "period_label": "string",
      "period_start": "2026-10-06",
      "period_end": "2026-10-06",
      "due_on": "2026-10-06",
      "amount": 850000000,
      "prorated": true,
      "late_fee": 850000000,
      "paid": 850000000,
      "outstanding": 850000000,
      "status": "scheduled",
      "waived_reason": "string",
      "late_fee_proposed": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "amount": 850000000
      }
    }
  ],
  "payments": [
    {
      "id": "cmusrceel0000q7kaafxqi1om",
      "kind": "payment",
      "status": "pending",
      "source": "member",
      "method": "upi",
      "amount": 850000000,
      "advance": 850000000,
      "utr": "string",
      "received_on": "2026-10-06",
      "receipt_number": "string",
      "notes": "string",
      "rejected_reason": "string",
      "reverses_id": "cmusrceel0000q7kaafxqi1om",
      "reversed": true,
      "created_at": "2026-10-06T05:30:00.000Z",
      "created_by": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      }
    }
  ],
  "mandate": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "kind": "autopay",
    "status": "created",
    "max_amount": 850000000,
    "setup_url": "string",
    "failure_reason": "string",
    "activated_at": "2026-10-06T05:30:00.000Z",
    "created_at": "2026-10-06T05:30:00.000Z"
  },
  "totals": {
    "outstanding": 850000000,
    "overdue": 850000000,
    "collected": 850000000,
    "advance": 850000000,
    "pending_claims": 0
  },
  "capabilities": {
    "manage": true,
    "late_fees": true,
    "autopay": true,
    "reveal_pan": true
  }
}

{ "agreement_id": "cmusrceel0000q7kaafxqi1om", "set_up": true, "problem": "string", "rent_amount": 850000000, "due_day": 0, "pan_required": true, "profile": { "payee_name": "string", "upi_vpa": "string", "landlord_pan": "string", "reminders_enabled": true, "late_fees_enabled": true, "generated_at": "2026-10-06T05:30:00.000Z" }, "instalments": [ { "id": "cmusrceel0000q7kaafxqi1om", "seq": 0, "period_label": "string", "period_start": "2026-10-06", "period_end": "2026-10-06", "due_on": "2026-10-06", "amount": 850000000, "prorated": true, "late_fee": 850000000, "paid": 850000000, "outstanding": 850000000, "status": "scheduled", "waived_reason": "string", "late_fee_proposed": { "id": "cmusrceel0000q7kaafxqi1om", "amount": 850000000 } } ], "payments": [ { "id": "cmusrceel0000q7kaafxqi1om", "kind": "payment", "status": "pending", "source": "member", "method": "upi", "amount": 850000000, "advance": 850000000, "utr": "string", "received_on": "2026-10-06", "receipt_number": "string", "notes": "string", "rejected_reason": "string", "reverses_id": "cmusrceel0000q7kaafxqi1om", "reversed": true, "created_at": "2026-10-06T05:30:00.000Z", "created_by": { "id": "cmusrceel0000q7kaafxqi1om", "name": "string" } } ], "mandate": { "id": "cmusrceel0000q7kaafxqi1om", "kind": "autopay", "status": "created", "max_amount": 850000000, "setup_url": "string", "failure_reason": "string", "activated_at": "2026-10-06T05:30:00.000Z", "created_at": "2026-10-06T05:30:00.000Z" }, "totals": { "outstanding": 850000000, "overdue": 850000000, "collected": 850000000, "advance": 850000000, "pending_claims": 0 }, "capabilities": { "manage": true, "late_fees": true, "autopay": true, "reveal_pan": true } }