Subscription Details

`$subscription->id`

The subscription ID. If you did not specify an ID when the subscription was created, the gateway will generate a 4-character alphanumeric ID.

Details

Attributes that need a bit more explaining:

$subscription->billingDayOfMonth - This is the day of the month that we will charge the subscription on every billing cycle. The value of this field will be 1-28 or 31. A value of 31 means bill on the last day of the month, regardless of how many days are in the month.
$subscription->billingPeriodEndDate - This is the end date for the current billing period and gets adjusted each time we try to charge the subscription. When doing automatic retries we do not adjust this date.
$subscription->billingPeriodStartDate - This is the start date for the current billing period and gets adjusted each time we try to charge the subscription. When doing automatic retries we do not adjust this date.
$subscription->failureCount - This is the number of times we have retried a charge on a past due subscription. Once this count reaches 2 we will stop automatically trying to charge the subscription. You can continue to manually retry the charge even after the count has reached 2.
$subscription->firstBillingDate - This is the day the subscription starts billing.
$subscription->neverExpires - If this is set to true the subscription does not have an end date and the number_of_billing_cycles will be returned as null.
$subscription->nextBillingDate - This is the date that we will try to bill the subscription again. We adjust this date each time we try to charge the subscription. If the subscription is past due we will continue to adjust this date, advancing it by 10 days until the failure_count reaches 2.
$subscription->numberOfBillingCycles - This is the total number of billing cycles the subscription will be billed.
$subscription->nextBillingPeriodAmount - This is the total subscription amount for the next billing period. This amount includes add-ons and discounts but does not include the current balance.
$subscription->paidThroughDate - This is the date through which the subscription has been paid. It is the billingPeriodEndDate at the time of the last successful transaction. If the subscription is pending (has a future start date), this field will be null.

More familiar attributes:

$subscription->balance
$subscription->merchantAccountId
$subscription->paymentMethodToken
$subscription->planId
$subscription->price
$subscription->status
$subscription->trialDuration
$subscription->trialDurationUnit
$subscription->trialPeriod

Associations

`$subscription->addOns`

A collection of add-ons that were added to this subscription.

`$subscription->discounts`

A collection of discounts that were added to this subscription.

`$subscription->transactions`

A collection of transactions that were created from this subscription.