Server-Side Response Objects/
Plan

Plan

Server-side response object returned directly or within a successful result object from the following requests:
Attributes
add_onsarray

The collection of add-ons associated with a subscription.

billing_day_of_monthint

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

billing_frequency

Specifies the billing interval of the plan in months.

created_atdatetime

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

currency_iso_codestr

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

descriptionstr

A description of the plan.

discountsarray

A collection of discounts associated with this subscription.

idstr

The plan identifier.

namestr

The name of the plan.

number_of_billing_cycles

Specifies the number of billing cycles of the plan.

priceDecimal

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

trial_duration

The trial timeframe specified in a plan.

trial_duration_unitstr

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.

trial_period

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.

updated_atdatetime

The date/time the plan was last updated. Returned in UTC.