> ## Documentation Index
> Fetch the complete documentation index at: https://api.monument.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Enable autopay for a unit rental record

> Sets the specified payment profile as the autopay method for a unit rental record.
      Validates that the payment profile belongs to the merchant account assigned to the facility
      and that the payment profile is associated with the same account as the rental record.
      If a previous autopay profile was set, its autoPayEnabled flag will be set to false.
      The autoPayOffset query parameter controls how many days before the billing cycle the
      payment is processed (0 = billing date, 3 = 3 days before). If omitted, the existing offset is preserved.



## OpenAPI

````yaml /openapi/integration-openapi.json patch /api/{portfolio}/portfolios/v1/facilities/{facilityUuid}/rentalRecords/{unitRentalRecordUuid}/enableAutoPay/{paymentProfileUuid}
openapi: 3.0.0
info:
  title: Monument Integration API
  description: Monument Integration API
  version: '1.0'
  contact: {}
servers:
  - url: https://public-api.prd.monument.io
    description: Production
  - url: https://public-api.stg.monument.io
    description: Staging
security: []
tags:
  - name: Portfolios
    description: List portfolios accessible to the API key
  - name: Facilities
    description: Facility retrieval and coverage-option configuration
  - name: Units
    description: Unit listing and MORA execution
  - name: Unit Groups
    description: Unit group listing, rate management, and unit assignment
  - name: Rental Records
    description: Rental record listing, coverage, fees, autopay, and payment links
  - name: Ledger Entries
    description: Ledger entry retrieval at facility and rental-record level
  - name: Leads
    description: Lead listing and lease sending
  - name: Tasks
    description: Task creation and listing for integrations
  - name: Tenants
    description: Tenant listing and person updates
  - name: People
    description: Person listing
  - name: Notes
    description: Note listing and creation for tenants and leads
  - name: Auctions
    description: Auction listing
  - name: Coverage
    description: Portfolio-level coverage CRUD and coverage history
  - name: Summary
    description: Portfolio-level aggregate summaries (insurance enrollment/occupancy)
  - name: Promotions
    description: Promotion listing
  - name: ECRI
    description: Effective Current Rent Increase scheduling
  - name: Item Types
    description: Item type listing per facility
  - name: Delinquencies
    description: Delinquency listing per facility
  - name: Physical Locks
    description: Physical lock assignment and unassignment
  - name: Lead Source Options
    description: Lead source option listing
  - name: Webhooks
    description: Webhook subscription management
  - name: Payments
    description: Payment profile creation
paths:
  /api/{portfolio}/portfolios/v1/facilities/{facilityUuid}/rentalRecords/{unitRentalRecordUuid}/enableAutoPay/{paymentProfileUuid}:
    patch:
      tags:
        - Rental Records
      summary: Enable autopay for a unit rental record
      description: >-
        Sets the specified payment profile as the autopay method for a unit
        rental record.
              Validates that the payment profile belongs to the merchant account assigned to the facility
              and that the payment profile is associated with the same account as the rental record.
              If a previous autopay profile was set, its autoPayEnabled flag will be set to false.
              The autoPayOffset query parameter controls how many days before the billing cycle the
              payment is processed (0 = billing date, 3 = 3 days before). If omitted, the existing offset is preserved.
      operationId: FacilityRentalRecordsController_enableAutoPay
      parameters:
        - name: facilityUuid
          required: true
          in: path
          schema:
            type: string
        - name: unitRentalRecordUuid
          required: true
          in: path
          schema:
            type: string
        - name: paymentProfileUuid
          required: true
          in: path
          schema:
            type: string
        - name: autoPayOffset
          required: false
          in: query
          description: >-
            Number of days before the billing cycle to process the autopay
            payment. Must be an integer.
                  If omitted, the existing autoPayOffset on the payment profile is preserved.
          example: 3
          schema:
            minimum: 0
            maximum: 10
            type: number
        - in: path
          required: true
          name: portfolio
          schema:
            example: abc_selfstorage
        - in: header
          required: true
          name: x-api-key
          schema:
            example: monument-2230012-2312321
            description: >-
              Api key required to authenticate your request. Please reach out to
              monument for a key.
      responses:
        '200':
          description: Autopay enabled successfully
        '400':
          description: Invalid payment profile for this rental record

````