plan

Contains details for a subscription billing plan

Request

Property NameTypeRequiredDescription
chargeFrequencystringRequiredPermitted values:
ONCE
DAILY
WEEKLY
EVERY 2 WEEKS
MONTHLY
EVERY 2 MONTHS
QUARTERLY
EVERY 6 MONTHS
ANNUALLY
EVERY 2 YEARS
* EVERY 3 YEARS
gracePeriodDaysintegerOptionalNumber of days in the grace period. For example: 10

In case of payment failure, automatic retries will be attempted during this grace period.

If this property is not set and a payment fails, the subscription will remain active until you cancel it. Make sure you have the Subscription Charge Failure IPN enabled to be notified when a subscription payment fails.
trialPeriodDaysintegerOptional
Cannot be included in Update Plan requests unless the plan already has a trial period
Number of days in the trial period.
For example: 14
initialChargeAmountdecimalOptional
Cannot be included in Update Plan requests unless the plan already has an initial charge
Amount of the initial charge.
For example: 99.00
namestringRequiredName of the plan. Maximum 199 characters.
For example: Gold Plan
currencystringRequiredCurrency code (ISO 4217) of the amount to be charged. See Currency codes.
maxNumberOfChargesintegerOptionalMaximum number of charges (after the initial charge) that can be processed for a subscription on this plan.
For example: 12
recurringChargeAmountdecimalRequiredRecurring amount to be charged.
For example: 29.99
chargeOnPlanSwitchbooleanOptionalDetermines whether subscriptions that are switched to this plan are charged immediately.
true = Immediate charge on switch.
false = Subscription will be charged at the next scheduled recurring payment. (default)
statusstringOptional
Update Plan requests only
Permitted values:
ACTIVE
INACTIVE

Response

Property NameTypeDescription
chargeFrequencystringPossible values:
ONCE
DAILY
WEEKLY
EVERY 2 WEEKS
MONTHLY
EVERY 2 MONTHS
QUARTERLY
EVERY 6 MONTHS
ANNUALLY
EVERY 2 YEARS
* EVERY 3 YEARS
gracePeriodDaysintegerNumber of days in the grace period.
For example: 10
In case of payment failure, automatic retries will be attempted during this grace period.
trialPeriodDaysintegerNumber of days in the trial period.
For example: 14
initialChargeAmountdecimalAmount of the initial charge.
For example: 99.00
namestringName of the plan.
For example: Gold Plan
planIdintegerBlueSnap identifier for the plan.
currencystringCurrency code (ISO 4217) of the amount to be charged. See Currency codes.
maxNumberOfChargesintegerMaximum number of charges that can be processed for a subscription on this plan.
For example: 12
recurringChargeAmountdecimalRecurring amount to be charged.
For example: 29.99
chargeOnPlanSwitchbooleanDetermines whether subscriptions that are switched to this plan are charged immediately.
true = Immediate charge on switch.
false = Subscription will be charged at the next scheduled recurring payment. (default)
statusstringPossible values:
ACTIVE
INACTIVE