Update a recurring resident charge

Update a recurring resident charge for an integration.

Path parameters

recurring_resident_charge_idstringRequired

The Propexo unique identifier for the recurring resident charge

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
financial_account_idstringOptional

The Propexo unique identifier for the financial account

is_activebooleanOptionalDefaults to false

Whether the recurring resident charge is active

amount_in_centsintegerOptional

The amount of the resident charge, in cents

descriptionstringOptional

Description of the recurring resident charge

charge_due_dayintegerOptional>=1<=31

The day of the month the charge is due

start_datedatetime or stringOptional

The start date associated with the recurring resident charge. Required if frequency is DAILY or WEEKLY

frequency_normalizedenumOptional

The frequency of the recurring resident charge

Allowed values:
end_datedatetime or stringOptional

The end date associated with the recurring resident charge

reference_numberstringOptional

The reference number for the recurring resident charge

charge_code_idstringOptional

The Propexo unique identifier for the charge code

Response

Successful response

job_idstring

The ID of the job created to handle this operation

dataobject

Errors