The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.

NAME

Paymill::REST::Item::Subscription - Item class for a subscription

SYNOPSIS

  my $subscription_api = Paymill::REST::Subscriptions->new;
  $subscription = $subscription_api->find('sub_lk2j34h5lk34h5lkjh2');

  say $subscription->id;  # Prints the id of the subscription

DESCRIPTION

Represents a subscription with all attributes and all sub items.

ATTRIBUTES

id

String containing the identifier of the client

livemode

Boolean indicating whether this preauthorization has been made with the live keys or not

created_at

DateTime object indicating the date of the creation as returned by the API

updated_at

DateTime object indicating the date of the last update as returned by the API

canceled_at

DateTime object indicating the cancellation date of the subcription

trial_start

DateTime object indicating the date the trial period started

trial_end

DateTime object indicating the date the trial period ended

next_capture_at

DateTime object indicating the date of the next charging, or boolean if subscription is cancelled

cancel_at_period_end

Boolean indicating whether the subscription will be cancelled at the end of this period

app_id

String representing the app id that created this subscription

SUB ITEMS

client

A client object.

See also Paymill::REST::Item::Client.

offer

An offer object.

See also Paymill::REST::Item::Offer.

payment

A payment object.

See also Paymill::REST::Item::Payment.

AVAILABLE OPERATIONS

delete

Paymill::REST::Operations::Delete

SEE ALSO

Paymill::REST for more documentation.

AUTHOR

Matthias Dietrich <perl@rainboxx.de>

COPYRIGHT

Copyright 2013 - Matthias Dietrich

LICENSE

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.