plan

Request

Property Name	Type	Required	Description
`chargeFrequency`	string	Required	Permitted values: ONCE DAILY WEEKLY EVERY 2 WEEKS MONTHLY EVERY 2 MONTHS QUARTERLY EVERY 6 MONTHS ANNUALLY EVERY 2 YEARS * EVERY 3 YEARS
`gracePeriodDays`	integer	Optional	Number 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.
`trialPeriodDays`	integer	Optional 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
`initialChargeAmount`	decimal	Optional Cannot be included in Update Plan requests unless the plan already has an initial charge	Amount of the initial charge. For example: 99.00
`name`	string	Required	Name of the plan. Maximum 199 characters. For example: Gold Plan
`currency`	string	Required	Currency code (ISO 4217) of the amount to be charged. See Currency codes.
`maxNumberOfCharges`	integer	Optional	Maximum number of charges (after the initial charge) that can be processed for a subscription on this plan. For example: 12
`recurringChargeAmount`	decimal	Required	Recurring amount to be charged. For example: 29.99
`chargeOnPlanSwitch`	boolean	Optional	Determines 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)
`status`	string	Optional Update Plan requests only	Permitted values: ACTIVE INACTIVE

Response

Property Name	Type	Description
`chargeFrequency`	string	Possible values: ONCE DAILY WEEKLY EVERY 2 WEEKS MONTHLY EVERY 2 MONTHS QUARTERLY EVERY 6 MONTHS ANNUALLY EVERY 2 YEARS * EVERY 3 YEARS
`gracePeriodDays`	integer	Number of days in the grace period. For example: 10 In case of payment failure, automatic retries will be attempted during this grace period.
`trialPeriodDays`	integer	Number of days in the trial period. For example: 14
`initialChargeAmount`	decimal	Amount of the initial charge. For example: 99.00
`name`	string	Name of the plan. For example: Gold Plan
`planId`	integer	BlueSnap identifier for the plan.
`currency`	string	Currency code (ISO 4217) of the amount to be charged. See Currency codes.
`maxNumberOfCharges`	integer	Maximum number of charges that can be processed for a subscription on this plan. For example: 12
`recurringChargeAmount`	decimal	Recurring amount to be charged. For example: 29.99
`chargeOnPlanSwitch`	boolean	Determines 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)
`status`	string	Possible values: ACTIVE INACTIVE