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