Server-Side Response Objects/
Plan

Plan

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

The collection of add-ons associated with a subscription.

billingDayOfMonthint

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.

createdAtDateTime

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

currencyIsoCodestring

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

descriptionstring

A description of the plan.

discountsarray

A collection of discounts associated with this subscription.

idstring

The plan identifier.

namestring

The name of the plan.

numberOfBillingCycles

Specifies the number of billing cycles of the plan.

priceString

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

trialDuration

The trial timeframe specified in a plan.

trialDurationUnitstring

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.

updatedAtDateTime

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