Skip to main content
GET
Get an autopay schedule

Authorizations

Authorization
string
header
required

Static API key issued via the client portal. Treat it like a password.

Path Parameters

autopay_id
string
required

Response

Successful Response

A recurring payment schedule tying an account to a stored payment method.

id
string
required
account_id
string
required

The account this schedule pays toward.

payment_method_id
string
required

The stored payment method charged on each run.

amount_cents
integer
required

Amount charged per run, in integer cents.

frequency_unit
string
required

Unit of the recurrence interval. One of: day, week, month, year.

frequency_interval
integer
required

Number of units between runs (e.g. 2 + week = every two weeks).

start_date
string<date>
required

Date of the first scheduled run.

next_run_date
string<date>
required

Date the next charge is scheduled to run.

status
string
required

Schedule state. One of: active, paused, cancelled, expired.

created_at
string<date-time>
required
updated_at
string<date-time>
required
anchor_day
integer | null

Day of month (1-31) runs are pinned to, for month/year cadences. Clamped to the last day of shorter months.

anchor_month
integer | null

Month (1-12) runs are pinned to, for yearly cadences.

end_date
string<date> | null

Last date a run may occur. Null for open-ended schedules.

cancelled_at
string<date-time> | null

When the schedule was cancelled. Null unless cancelled.