Contains details for a subscription billing plan
Request
Property Name | Type | Required | Description |
---|---|---|---|
| string | Required | Name of the plan. Maximum 199 characters. For example: Gold Plan |
| decimal | Required | Recurring amount to be charged. For example: 29.99 |
| string | Required | Currency code (ISO 4217) of the amount to be charged. See Currency codes. |
| string | Required | Permitted values:
|
| 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 |
| 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 |
| boolean | Optional | Determines whether subscriptions that are switched to this plan are charged immediately.
|
| integer | Optional | Maximum number of charges (after the initial charge) that can be processed for a subscription on this plan. For example: 12 |
| 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. |
| string | Optional Update Plan requests only | Permitted values:
|
Response
Property Name | Type | Description |
---|---|---|
| integer | BlueSnap identifier for the plan. |
| string | Name of the plan. For example: Gold Plan |
| decimal | Recurring amount to be charged. For example: 29.99 |
| string | Currency code (ISO 4217) of the amount to be charged. See Currency codes. |
| string | Possible values:
|
| integer | Number of days in the trial period. For example: 14 |
| decimal | Amount of the initial charge. For example: 99.00 |
| boolean | Determines whether subscriptions that are switched to this plan are charged immediately.
|
| integer | Maximum number of charges that can be processed for a subscription on this plan. For example: 12 |
| 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. |
| string | Possible values:
|