Update Autopay

Updates a scheduled autopay. For example, you can change its payment amount option or apply date, move it to a different bank account or cancel it by sending status: cancelled.

To move the autopay to a different bank account, send the new bank account ID in bankAccountId. If you omit bankAccountId, the autopay stays on its current bank account.

Path Parameters

  • account_id — The unique identifier of the line of credit account.
  • autopay_id — The unique identifier of the autopay.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The unique identifier of the line of credit account.

string
required

The unique identifier of the autopay.

Body Params
string | null

The unique identifier (UUID) of the bank account to move the autopay to. If you omit this field, the autopay stays on its current bank account.

string
enum

Which amount to collect: minimum_payment, statement_balance, current_balance, past_due, or other_amount.

Allowed:
date | null

The date on which the payment will apply to the account. Required for the specific_date option and rejected for due_date.

string
enum

The status of the autopay. Send cancelled to cancel the autopay.

Allowed:
Responses

Language
Credentials
Bearer
LoadingLoading…
Response
Choose an example:
application/json