NAME

WebService::Braintree::_::Subscription

PURPOSE

This class represents a subscription.

This class will only be created as part of a response or error response.

ATTRIBUTES

add_ons()

This returns the subscription's add-ons (if any). This will be an arrayref of "" in WebService::Braintree::_::AddOn.

balance()

This is the balance for this subscription.

billing_day_of_month()

This is the billing day of month for this subscription.

billing_period_end_date()

This is the billing period end date for this subscription.

billing_period_start_date()

This is the billing period start date for this subscription.

created_at()

This is when this subscription was created.

current_billing_cycle()

This is the current billing cycle for this subscription.

days_past_due()

This is the days past due for this subscription.

description()

This is the description for this subscription.

descriptor()

This returns the subscription's descriptor (if it exists). This will be an object of type "" in WebService::Braintree::_::Descriptor.

discounts()

This returns the subscription's discounts (if any). This will be an arrayref of "" in WebService::Braintree::_::Discount.

failure_count()

This is the failure count for this subscription.

first_billing_date()

This is the first billing date for this subscription.

id()

This is the id for this subscription.

merchant_account_id()

This is the merchant account id for this subscription.

never_expires()

This is true if this subscription never expires.

is_never_expires() is an alias for this attribute.

next_billing_date()

This is the next_billing_date for this subscription.

next_billing_period_amount()

This is the next billing period amount for this subscription.

next_bill_amount() is a deprecated alias for this attribute.

number_of_billing_cycles()

This is the number of billing cycles for this subscription.

This is the paid-through date for this subscription.

payment_method_token()

This is the payment-method token for this subscription.

plan_id()

This is the plan id for this subscription.

price()

This is the price for this subscription.

status()

This is the status for this subscription.

status_history()

This returns the subscription's status history (if any). This will be an arrayref of "" in WebService::Braintree::_::Subscription::StatusDetail.

transactions()

This returns the subscription's transactions (if any). This will be an arrayref of "" in WebService::Braintree::_::Transaction.

trial_duration()

This is the trial period duration for this subscription.

trial_duration_unit()

This is the unit for the "trial_duration" for this subscription.

trial_period()

This is the trial period for this subscription.

updated_at()

This is when this subscription was last updated. If it has never been updated, then this should equal the "created_at" date.