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 schedule [ JSON ]
{
"entity_type": "invoice",
"scheme_id": "__dev__3Nl7O2OURL9Ph52C",
"created_at": 1713242812,
"id": "__dev__3Nl7O2OURL9Suc2r",
"entity_id": "1",
"schedule_entries": [
{
"date": 1713242812,
"amount": 150000,
"id": "__dev__3Nl7O2OURL9Sui2s",
"status": "paid",
"object": "schedule_entry"
},
{
"date": 1713502012,
"amount": 150000,
"id": "__dev__3Nl7O2OURL9Suk2t",
"status": "posted",
"object": "schedule_entry"
},
{
"date": 1713761212,
"amount": 150000,
"id": "__dev__3Nl7O2OURL9Suk2u",
"status": "posted",
"object": "schedule_entry"
}
],
"object": "payment_schedule"
}
API Index URL
https://{site}.chargebee.com/api/v2/payment_schedules
string, max chars=40 An auto-generated unique identifier for the payment schedule.
string, max chars=40 The identifier of the payment_schedule_scheme
, used to create the payment schedules.
enumerated string Specifies the types of entity this payment schedule is based on.
string, max chars=50 The identifier of the entity this payment schedule is based on.
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.
timestamp(UTC) in seconds The timestamp at which the payment_schedule
was created.
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.
optional, timestamp(UTC) in seconds Specifies when these payment schedules are updated recently.
optional, string, max chars=3 The currency code (ISO 4217 format) of the transaction amount.
optional, list of schedule_entry List of schedule entries
Schedule entry attributes
string, max chars=40 An auto-generated unique identifier for the payment schedules.
timestamp(UTC) in seconds Date at which this payment schedule is scheduled.
in cents, min=0 Maximum amount that this payment schedule is allowed to collect.
enumerated string Defines the status for each payment schedule.
Possible values are
postedThe installment is unpaid or partially paid and the due date (date) has not passed.
payment_dueThe installment is unpaid or partially paid and the due date (date) has passed.
paidThe installment has been paid.
Show all values[+]
string, max chars=40 An auto-generated unique identifier for the payment schedule.
string, max chars=40 The identifier of the payment_schedule_scheme
, used to create the payment schedules.
enumerated string Specifies the types of entity this payment schedule is based on.
string, max chars=50 The identifier of the entity this payment schedule is based on.
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.
timestamp(UTC) in seconds The timestamp at which the payment_schedule
was created.
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.
optional, timestamp(UTC) in seconds Specifies when these payment schedules are updated recently.
optional, string, max chars=3 The currency code (ISO 4217 format) of the transaction amount.
optional, list of schedule_entry List of schedule entries
Settings
Configure SDK
