view release on metacpan or  search on metacpan

lib/Business/GoCardless/Subscription.pm  view on Meta::CPAN

    name
    next_interval_start
    parent_plan_paused
    payment_reference
    retry_if_possible
    setup_fee
    start_at
    start_date
    status
    sub_resource_uris
    uri
    user_id
    upcoming_payments
/ ] => (
    is => 'rw',
);

=head1 Operations on a subscription

=head2 cancel

    $Subscription->cancel

Cancels a subscription. With the Pro (v2) API you can optionally pass metadata:

    $Subscription->cancel( metadata => { ... } );

The following operations are only available with the Pro (v2) API:

=head2 update

Update the subscription, returns the updated Subscription object:

    $Subscription->update( amount => 1500,metadata => { ... } );

=head2 pause

Pause the subscription, optionally for a number of cycles:

    $Subscription->pause;
    $Subscription->pause( pause_cycles => 2,metadata => { ... } );

=head2 resume

Resume a paused subscription:

    $Subscription->resume;

=cut

sub cancel {
    my ( $self,%params ) = @_;

    if ( $self->client->api_version > 1 ) {
        return $self->_action( 'cancel',%params );
    } else {
        return $self->_operation( 'cancel','api_put' );
    }
}

sub update { shift->_update( @_ ); }
sub pause  { shift->_action( 'pause',@_ ); }
sub resume { shift->_action( 'resume',@_ ); }

=head1 Status checks on a subscription

    pending_customer_approval
    customer_approval_denied
    inactive
    active
    finished
    cancelled
    paused
    expired

    if ( $Subscription->active ) {
        ...
    }

=cut

sub pending_customer_approval { return shift->status eq 'pending_customer_approval' }
sub customer_approval_denied  { return shift->status eq 'customer_approval_denied' }
sub inactive  { return shift->status eq 'inactive' }
sub active    { return shift->status eq 'active' }
sub finished  { return shift->status eq 'finished' }
sub cancelled { return shift->status eq 'cancelled' }
sub paused    { return shift->status eq 'paused' }
sub expired   { return shift->status eq 'expired' }

=head1 AUTHOR

Lee Johnson - C<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

=cut

1;

# vim: ts=4:sw=4:et