plan

Contains details for a subscription billing plan

Request

Property NameTypeRequiredDescription
namestringRequiredName of the plan. Maximum 199 characters.
For example: Gold Plan
recurring-charge-amountdecimalRequiredRecurring amount to be charged.
For example: 29.99
currencystringRequiredCurrency code (ISO 4217) of the amount to be charged. See Currency codes.
charge-frequencystringRequiredPermitted values:
ONCE
DAILY
WEEKLY
EVERY 2 WEEKS
MONTHLY
EVERY 2 MONTHS
QUARTERLY
EVERY 6 MONTHS
ANNUALLY
EVERY 2 YEARS
* EVERY 3 YEARS
trial-period-daysintegerOptional
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
initial-charge-amountdecimalOptional
Cannot be included in Update Plan requests unless the plan already has an initial charge
Amount of the initial charge.
For example: 99.00
charge-on-plan-switchbooleanOptionalDetermines 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)
max-number-of-chargesintegerOptionalMaximum number of charges (after the initial charge) that can be processed for a subscription on this plan.
For example: 12
grace-period-daysintegerOptionalNumber 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.
statusstringOptional
Update Plan requests only
Permitted values:
ACTIVE
INACTIVE

Response

Property NameTypeDescription
plan-idintegerBlueSnap identifier for the plan.
namestringName of the plan.
For example: Gold Plan
recurring-charge-amountdecimalRecurring amount to be charged.
For example: 29.99
currencystringCurrency code (ISO 4217) of the amount to be charged. See Currency codes.
charge-frequencystringPossible values:
ONCE
DAILY
WEEKLY
EVERY 2 WEEKS
MONTHLY
EVERY 2 MONTHS
QUARTERLY
EVERY 6 MONTHS
ANNUALLY
EVERY 2 YEARS
* EVERY 3 YEARS
trial-period-daysintegerNumber of days in the trial period.
For example: 14
initial-charge-amountdecimalAmount of the initial charge.
For example: 99.00
charge-on-switchbooleanDetermines 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)
max-number-of-chargesintegerMaximum number of charges that can be processed for a subscription on this plan.
For example: 12
grace-period-daysintegerNumber of days in the grace period.
For example: 10
In case of payment failure, automatic retries will be attempted during this grace period.
statusstringPossible values:
ACTIVE
INACTIVE