{"_id":"5bcf37dfadc5b905136a3985","category":{"_id":"5bcf37dfadc5b905136a395e","version":"5bcf37dfadc5b905136a39f4","project":"57336fd5a6a9c40e00e13a0b","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-10-15T16:20:51.519Z","from_sync":false,"order":12,"slug":"resources","title":"Resources"},"parentDoc":null,"project":"57336fd5a6a9c40e00e13a0b","user":"560d5913af97231900938124","version":{"_id":"5bcf37dfadc5b905136a39f4","project":"57336fd5a6a9c40e00e13a0b","__v":0,"forked_from":"5b8ec61584303f0003a1159b","createdAt":"2018-04-24T15:24:22.608Z","releaseDate":"2018-04-24T15:24:22.608Z","categories":["5bcf37dfadc5b905136a3952","5bcf37dfadc5b905136a3953","5bcf37dfadc5b905136a3954","5bcf37dfadc5b905136a3955","5bcf37dfadc5b905136a3956","5bcf37dfadc5b905136a3957","5bcf37dfadc5b905136a3958","5bcf37dfadc5b905136a3959","5bcf37dfadc5b905136a395a","5bcf37dfadc5b905136a395b","5bcf37dfadc5b905136a395c","5bcf37dfadc5b905136a395d","5bcf37dfadc5b905136a395e","5bcf37dfadc5b905136a395f","5bcf37dfadc5b905136a3960","5bcf37dfadc5b905136a3961"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":false,"codename":"3.27.2 Release","version_clean":"8976.0.0-XML","version":"8976-XML"},"githubsync":"","__v":0,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-07-27T10:47:42.918Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"settings":"","results":{"codes":[]},"auth":"required","params":[],"url":""},"isReference":false,"order":30,"body":"###Request\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Property Name\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Required\",\n    \"0-0\": \"`name`\",\n    \"0-1\": \"*string*\",\n    \"h-3\": \"Description\",\n    \"0-3\": \"Name of the plan. Maximum 199 characters. \\nFor example: **Gold Plan**\",\n    \"1-0\": \"`recurring-charge-amount`\",\n    \"1-1\": \"*decimal*\",\n    \"1-3\": \"Recurring amount to be charged.\\nFor example: **29.99**\",\n    \"h-4\": \"Description\",\n    \"0-2\": \"**Required**\",\n    \"1-2\": \"**Required**\",\n    \"2-0\": \"`currency`\",\n    \"3-0\": \"`charge-frequency`\",\n    \"2-1\": \"*string*\",\n    \"3-1\": \"*string*\",\n    \"4-0\": \"`trial-period-days`\",\n    \"6-0\": \"`charge-on-plan-switch`\",\n    \"7-0\": \"`max-number-of-charges`\",\n    \"2-2\": \"**Required**\",\n    \"3-2\": \"**Required**\",\n    \"4-2\": \"Optional\\n*Cannot be included in Update Plan requests unless the plan already has a trial period*\",\n    \"4-3\": \"Number of days in the trial period.\\nFor example: **14**\",\n    \"2-3\": \"Currency code (ISO 4217) of the amount to be charged. See [Currency codes](/docs/currency-codes).\",\n    \"3-3\": \"Permitted values:\\n  * **ONCE**\\n  * **DAILY**\\n  * **WEEKLY**\\n  * **EVERY 2 WEEKS**\\n  * **MONTHLY**\\n  * **EVERY 2 MONTHS**\\n  * **QUARTERLY**\\n  * **EVERY 6 MONTHS**\\n  * **ANNUALLY**\\n  * **EVERY 2 YEARS**\\n  * **EVERY 3 YEARS**\",\n    \"6-3\": \"Determines whether subscriptions that are switched to this plan are charged immediately.\\n  * **true** = Immediate charge on switch.\\n  * **false** = Subscription will be charged at the next scheduled recurring payment. (default)\",\n    \"7-3\": \"Maximum number of charges that can be processed for a subscription on this plan.\\nFor example: **12**\",\n    \"6-2\": \"Optional\",\n    \"7-2\": \"Optional\",\n    \"4-1\": \"*integer*\",\n    \"6-1\": \"*boolean*\",\n    \"7-1\": \"*integer*\",\n    \"8-0\": \"`grace-period-days`\",\n    \"8-1\": \"*integer*\",\n    \"8-2\": \"Optional\",\n    \"8-3\": \"Number of days in the grace period.\\nFor example: **10** \\nIn case of payment failure, automatic retries will be attempted during this grace period.\",\n    \"5-0\": \"`initial-charge-amount`\",\n    \"5-1\": \"*decimal*\",\n    \"5-2\": \"Optional\\n*Cannot be included in Update Plan requests unless the plan already has an initial charge*\",\n    \"5-3\": \"Amount of the initial charge.\\nFor example: **99.00**\",\n    \"9-0\": \"`status`\",\n    \"9-3\": \"Permitted values:\\n  * **ACTIVE**\\n  * **INACTIVE**\",\n    \"9-2\": \"Optional\\n*Update Plan requests only*\",\n    \"9-1\": \"*string*\"\n  },\n  \"cols\": 4,\n  \"rows\": 10\n}\n[/block]\n###Response\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Property Name\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Description\",\n    \"1-0\": \"`name`\",\n    \"1-1\": \"*string*\",\n    \"h-3\": \"Description\",\n    \"1-3\": \"Name of the plan.\\nFor example: **Gold Plan**\",\n    \"2-0\": \"`recurring-charge-amount`\",\n    \"2-1\": \"*decimal*\",\n    \"2-3\": \"Recurring amount to be charged.\\nFor example: **29.99**\",\n    \"h-4\": \"Description\",\n    \"1-2\": \"Name of the plan.\\nFor example: **Gold Plan**\",\n    \"2-2\": \"Recurring amount to be charged.\\nFor example: **29.99**\",\n    \"3-0\": \"`currency`\",\n    \"4-0\": \"`charge-frequency`\",\n    \"3-1\": \"*string*\",\n    \"4-1\": \"*string*\",\n    \"5-0\": \"`trial-period-days`\",\n    \"7-0\": \"`charge-on-switch`\",\n    \"8-0\": \"`max-number-of-charges`\",\n    \"3-2\": \"Currency code (ISO 4217) of the amount to be charged. See [Currency codes](/docs/currency-codes).\",\n    \"4-2\": \"Possible values:\\n  * **ONCE**\\n  * **DAILY**\\n  * **WEEKLY**\\n  * **EVERY 2 WEEKS**\\n  * **MONTHLY**\\n  * **EVERY 2 MONTHS**\\n  * **QUARTERLY**\\n  * **EVERY 6 MONTHS**\\n  * **ANNUALLY**\\n  * **EVERY 2 YEARS**\\n  * **EVERY 3 YEARS**\",\n    \"5-2\": \"Number of days in the trial period.\\nFor example: **14**\",\n    \"5-3\": \"Number of days in the trial period.\\nFor example: **14**\",\n    \"3-3\": \"Currency code (ISO 4217) of the amount to be charged. See [Currency codes](/v1.0/docs/currency-codes).\",\n    \"4-3\": \"Permitted values:\\n  * **ONCE**\\n  * **DAILY**\\n  * **WEEKLY**\\n  * **EVERY 2 WEEKS**\\n  * **MONTHLY**\\n  * **EVERY 2 MONTHS**\\n  * **QUARTERLY**\\n  * **EVERY 6 MONTHS**\\n  * **ANNUALLY**\\n  * **EVERY 2 YEARS**\\n  * **EVERY 3 YEARS**\",\n    \"7-3\": \"Determines whether subscriptions that are switched to this plan are charged immediately.\\n  * **true** = Immediate charge on switch.\\n  * **false** = Subscription will be charged at the next scheduled recurring payment. (default)\",\n    \"8-3\": \"Maximum number of charges that can be processed for a subscription on this plan.\\nFor example: **12**\",\n    \"7-2\": \"Determines whether subscriptions that are switched to this plan are charged immediately.\\n  * **true** = Immediate charge on switch.\\n  * **false** = Subscription will be charged at the next scheduled recurring payment. (default)\",\n    \"8-2\": \"Maximum number of charges that can be processed for a subscription on this plan.\\nFor example: **12**\",\n    \"5-1\": \"*integer*\",\n    \"7-1\": \"*boolean*\",\n    \"8-1\": \"*integer*\",\n    \"9-0\": \"`grace-period-days`\",\n    \"9-1\": \"*integer*\",\n    \"9-2\": \"Number of days in the grace period.\\nFor example: **10** \\nIn case of payment failure, automatic retries will be attempted during this grace period.\",\n    \"9-3\": \"Number of days in the grace period.\\nFor example: **10** \\nIn case of payment failure, automatic retries will be attempted during this grace period.\",\n    \"6-0\": \"`initial-charge-amount`\",\n    \"6-1\": \"*decimal*\",\n    \"6-2\": \"Amount of the initial charge.\\nFor example: **99.00**\",\n    \"6-3\": \"Amount of the initial charge.\\nFor example: **99.00**\",\n    \"0-0\": \"`plan-id`\",\n    \"0-1\": \"*integer*\",\n    \"0-2\": \"BlueSnap identifier for the plan.\",\n    \"10-0\": \"`status`\",\n    \"10-1\": \"*string*\",\n    \"10-2\": \"Possible values:\\n  * **ACTIVE**\\n  * **INACTIVE**\"\n  },\n  \"cols\": 3,\n  \"rows\": 11\n}\n[/block]","excerpt":"Contains details for a subscription billing plan","slug":"plan","type":"basic","title":"plan"}

Payment API (XML)

Card/Wallet Transactions

PayPal Transactions

ACH/ECP Transactions

SEPA Direct Debit Transactions

Batch Transactions

Refunds

Vaulted Shoppers

Subscriptions

Marketplace

Wallets

Errors

Resources

Test Data & Codes

Guides & Tools

Mobile SDK

plan

Contains details for a subscription billing plan

Request

Property Name
Type
Required
Description

name

string

Required

Name of the plan. Maximum 199 characters.
For example: Gold Plan

recurring-charge-amount

decimal

Required

Recurring amount to be charged.
For example: 29.99

currency

string

Required

Currency code (ISO 4217) of the amount to be charged. See Currency codes.

charge-frequency

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

trial-period-days

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

initial-charge-amount

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

charge-on-plan-switch

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)

max-number-of-charges

integer

Optional

Maximum number of charges that can be processed for a subscription on this plan.
For example: 12

grace-period-days

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.

status

string

Optional
Update Plan requests only

Permitted values:

  • ACTIVE
  • INACTIVE

Response

Property Name
Type
Description

plan-id

integer

BlueSnap identifier for the plan.

name

string

Name of the plan.
For example: Gold Plan

recurring-charge-amount

decimal

Recurring amount to be charged.
For example: 29.99

currency

string

Currency code (ISO 4217) of the amount to be charged. See Currency codes.

charge-frequency

string

Possible values:

  • ONCE
  • DAILY
  • WEEKLY
  • EVERY 2 WEEKS
  • MONTHLY
  • EVERY 2 MONTHS
  • QUARTERLY
  • EVERY 6 MONTHS
  • ANNUALLY
  • EVERY 2 YEARS
  • EVERY 3 YEARS

trial-period-days

integer

Number of days in the trial period.
For example: 14

initial-charge-amount

decimal

Amount of the initial charge.
For example: 99.00

charge-on-switch

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)

max-number-of-charges

integer

Maximum number of charges that can be processed for a subscription on this plan.
For example: 12

grace-period-days

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.

status

string

Possible values:

  • ACTIVE
  • INACTIVE