billingAndPayments

Update a recurring resident charge

Update a recurring resident charge for an integration.

put/v1/recurring-resident-charges/{recurring_resident_charge_id}

Request

  • Base URL: https://api.propexo.com
  • URL: https://api.propexo.com/v1/recurring-resident-charges/{recurring_resident_charge_id}
  • Auth: HTTP bearer

Path parameters

recurring_resident_charge_idstring required

The Propexo unique identifier for the recurring resident charge

Request body

financial_account_idstring

The Propexo unique identifier for the financial account

is_activeboolean

Whether the recurring resident charge is active

amount_in_centsinteger

The amount of the recurring resident charge, in cents

descriptionstring

Description of the recurring resident charge

charge_due_dayinteger

The day of the month the charge is due

frequency_normalized'DAILY' | 'MONTHLY' | 'WEEKLY'

The frequency of the recurring resident charge

reference_numberstring

The reference number for the recurring resident charge

charge_code_idstring

The Propexo unique identifier for the charge code

day_dueinteger

The day of the month the charge is due

frequency_rawinteger

The raw value of the frequency of the recurring resident charge (in months)

Response

Successful response

job_idstring required

The ID of the job created to handle this operation

dataV1RecurringResidentChargesRecurringResidentChargeIdPutOutputData required

Changes

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