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

Attributes
addOns Array of Braintree_AddOn objects

The collection of add-ons associated with a subscription.

billingDayOfMonth int

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

billingFrequency

Specifies the billing interval of the plan in months.

createdAt DateTime

The date/time the plan was created.

currencyIsoCode string

The currency for the transaction (e.g. "USD" for US dollars). See the ISO 4217 codes.

description string

A description of the plan.

discounts Array of Braintree_Discount objects

A collection of discounts associated with this subscription.

id string

The plan identifier.

name string

The name of the plan.

numberOfBillingCycles

Specifies the number of billing cycles of the plan.

price String

The price specified for a plan, add-on, discount, or subscription. Billing price is formatted like "10" or "10.00".

trialDuration

The trial timeframe specified in a plan.

trialDurationUnit 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.

trialPeriod

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.

updatedAt DateTime

The date/time the plan was last updated.

Still have questions?

If you can’t find an answer, contact our Support team.