Payment schedules

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.

Sample Payment scheduleJSON

Payment schedules attributes

required, string, max chars=40

An auto-generated unique identifier for the payment schedule.

scheme_id

required, string, max chars=40

The identifier of the payment_schedule_scheme , used to create the payment schedules.

entity_type

required, enumerated string

Specifies the types of entity this payment schedule is based on.

Enum Values

invoice

Indicates the invoice entity type

entity_id

required, string, max chars=50

The identifier of the entity this payment schedule is based on.

amount

optional, in cents, min=0

The part of the invoice.amount_due to be distributed across the payment schedules. If not specified, the entire invoice.amount_due is considered by default.

created_at

required, timestamp(UTC) in seconds

The timestamp at which the payment_schedule was created.

resource_version

optional, long

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.

updated_at

optional, timestamp(UTC) in seconds

Specifies when these payment schedules are updated recently.

currency_code

optional, string, max chars=3

The currency code (ISO 4217 format) of the transaction amount.

schedule_entries

List of schedule entries