Payment schedule schemes

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

API Index URL

https://[site].chargebee.com/api/v2/payment_schedule_schemes

Payment schedule schemes attributes

required, string, max chars=40

An auto-generated unique identifier for the payment schedule scheme.

name

optional, string, max chars=100

The name of a payment schedule scheme.

description

optional, string, max chars=200

A brief description for this payment schedule scheme.

number_of_schedules

required, integer, min=1, max=52

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

period_unit

required, enumerated string

Defines the time unit for intervals between payment schedules. Possible values are: day, week, and month.

Enum Values

day

When the time unit for intervals between payment schedules is set as day

week

When the time unit for intervals between payment schedules is set as week

month

When the time unit for intervals between payment schedules is set as month

period

optional, integer, min=1, max=30

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

created_at

required, timestamp(UTC) in seconds

The timestamp at which the payment_schedule_scheme 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

Defines the timestamp when the config was last updated