Payment schedules for an invoice refer to a payment structure where the amount_due
on an invoice is divided into smaller, more manageable parts, each of which is paid over a specified period. Payment schedule scheme is a configuration or set of rules for creating payment schedules. After creating a payment schedule scheme, you can use it to generate payment schedules for multiple invoices.
Sample Payment schedule schemeJSON
Payment schedule schemes attributes
An auto-generated unique identifier for the payment schedule scheme.
Specifies the total number of payment schedules for the invoice. The maximum number_of_schedules
varies based on the period_unit
: - Day: Up to 30 schedules
- Week: Up to 52 schedules
- Month: Up to 12 schedules
Defines the time unit for intervals between payment schedules. Possible values are: day, week, and month.
When the time unit for intervals between payment schedules is set as day
When the time unit for intervals between payment schedules is set as week
When the time unit for intervals between payment schedules is set as month
The time period between the effective dates of two consecutive payment schedules, expressed in period_units. Use this parameter to have fixed intervals between payment schedules. The maximum period
varies based on the period_unit
: - Day: Up to 30 days
- Week: Up to 6 weeks
- Month: Up to 6 months
The timestamp at which the payment_schedule_scheme
was created.
Version number of this resource. The resource_version
is updated with a new timestamp in milliseconds for every change made to the resource. This attribute will be present only if the resource has been updated after 2016-09-28.