Returned directly or within a successful result object from the following requests:

getAddOns() Array AddOn

The collection of AddOn objects associated with a subscription.

getBalance() BigDecimal

The amount of outstanding charges associated with a subscription.

getBillingDayOfMonth() int

The value that specifies the day of the month that the gateway will charge the subscription on every billing cycle.

getBillingPeriodEndDate() Calendar

The end date for the current billing period, regardless of subscription status. Automatic retries on past due subscriptions do not change the start and end dates of the current billing period.

getBillingPeriodStartDate() Calendar

The start date for the current billing period, regardless of subscription status. Automatic retries on past due subscriptions do not change the start and end dates of the current billing period.

getCreatedAt() Calendar

The date/time the object was created. Returned in UTC.

getCurrentBillingCycle() int

The subscription's current billing cycle. It is incremented each time the subscription passes the billingPeriodEndDate().

getDaysPastDue() int

The number of days that the subscription is past due. Read more about the past due status in the Recurring Billing guide.

getDescription() string

The description of the transaction that is displayed to customers in email receipts from PayPal. 127 character maximum.


The descriptive value on bank statements. This value may comprise static or dynamic information, and is passed on a per-transaction basis. See the descriptor() of Transaction: Sale for more information.

getName() string

The value in the business name field of a customer's statement.

getPhone() string

The value in the phone number field of a customer's statement.

getUrl() string

The value in the URL/web address field of a customer's statement.

getDiscounts() Array Discount

The collection of Discount objects associated with a subscription.

getFailureCount() int

The number of consecutive failed attempts by our recurring billing engine to charge a subscription. This count includes the transaction attempt that caused the subscription's status to become past due, starting at 0 and increasing for each failed attempt. If the subscription is active and no charge attempts failed, the count is 0.


The day the subscription starts billing.

getId() string

The string value representing a specific subscription in the Vault. Length and format of gateway-generated tokens and IDs may change at any time.

getMerchantAccountId() string

The merchant account ID used for the subscription. Currency is also determined by merchant account ID.

neverExpires() boolean

Whether a subscription's billing cycle is set to never expire instead of running for a specific number of billing cycles.

getNextBillAmount() BigDecimal

Do not use. This is the deprecated version of next_billing_period_amount.


The date that the gateway will try to bill the subscription again. The gateway adjusts this date each time it tries to charge the subscription. If the subscription is past due and you have set your processing options to automatically retry failed transactions, the gateway will continue to adjust this date, advancing it based on the settings that you configured in advanced settings.

getNextBillingPeriodAmount() BigDecimal

The total subscription amount for the next billing period. This amount includes add-ons and discounts but does not include the current balance.

getNumberOfBillingCycles() int

The number of billing cycles of the subscription.


The date through which the subscription has been paid. It is the billing_period_end_date at the time of the last successful transaction. If the subscription is pending (has a future start date), this field is null.

getPaymentMethodToken() string

An alphanumeric value that references a specific payment method stored in your Vault.

getPlanId() string

The plan identifier.

getPrice() BigDecimal

The base price specified for a subscription, formatted like "10" or "10.00".

getStatus() string

See the recurring billing overview. Possible values:

  • Subscription.Status.ACTIVE,
  • Subscription.Status.CANCELED,
  • Subscription.Status.EXPIRED,
  • Subscription.Status.PAST_DUE,
  • Subscription.Status.PENDING

Array of up to 50 subscription history events.

getTransactions() Array Transaction

Transactions associated with the subscription, sorted by creation date with the most recent first. When returned in a subscription webhook, this array contains only the 20 most recent transactions; otherwise, it contains all transactions associated with the subscription.

getTrialDuration() int

The trial timeframe specified in a plan.

getTrialDurationUnit() string

The trial unit specified in a plan. Specify day or month. Specifying a trial duration unit via the API will override the subscription's plan details.

isTrialPeriod() boolean

A value indicating whether a subscription should begin with a trial period. Specifying a trial period via the API will override the subscription's plan details.

getUpdatedAt() Calendar

The date/time the object was last updated. If a subscription has been canceled, this value will represent the date/time of cancellation. Returned in UTC.

Subscription history

Each subscription history object returned on a subscription includes the following details:

Field Name Description
balance The balance of the subscription.
price The price of the subscription.
status The subscription status. Possible values:
  • Active
  • Canceled
  • Expired
  • PastDue
  • Pending
subscriptionSource Where the subscription event was created. Possible values:
  • api
  • control_panel
  • recurring

Here's an example of how to get a subscription's history using the Subscription: Find method:

Subscription subscription = gateway.subscription().find("a_subscription_id");
// "12.34"