NAME

Business::GoCardless::InstalmentSchedule

DESCRIPTION

A class for a gocardless instalment schedule, extends Business::GoCardless::Resource

ATTRIBUTES

created_at
currency
id
links
metadata
name
payment_errors
status
total_amount

Operations on an instalment schedule

update

Update the instalment schedule's metadata:

$Schedule->update( metadata => { ... } );

cancel

Cancel the instalment schedule, cancelling any payments not yet submitted:

$Schedule->cancel;

Status checks on an instalment schedule

pending
active
creation_failed
completed
cancelled
errored

if ( $InstalmentSchedule->pending ) {
    ...
}

Links

Shortcut methods to get the IDs of the linked resources

mandate_id
customer_id

AUTHOR

Lee Johnson - lee@payprop.com

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself. If you would like to contribute documentation, features, bug fixes, or anything else then please raise an issue / pull request:

https://github.com/payprop/business-gocardless