{"metadata":{"image":[],"title":"","description":""},"api":{"url":"","auth":"required","settings":"","results":{"codes":[]},"params":[]},"next":{"description":"","pages":[]},"title":"plan","type":"basic","slug":"plan","excerpt":"Contains details for a subscription billing plan","body":"###Request\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Property Name\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Required\",\n    \"4-0\": \"`name`\",\n    \"4-1\": \"*string*\",\n    \"h-3\": \"Description\",\n    \"4-3\": \"Name of the plan. Maximum 199 characters. \\nFor example: **Gold Plan**\",\n    \"7-0\": \"`recurringChargeAmount`\",\n    \"7-1\": \"*decimal*\",\n    \"7-3\": \"Recurring amount to be charged.\\nFor example: **29.99**\",\n    \"h-4\": \"Description\",\n    \"4-2\": \"**Required**\",\n    \"7-2\": \"**Required**\",\n    \"8-0\": \"`chargeOnPlanSwitch`\",\n    \"8-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-2\": \"Optional\",\n    \"8-1\": \"*boolean*\",\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    \"0-0\": \"`chargeFrequency`\",\n    \"0-1\": \"*string*\",\n    \"0-2\": \"**Required**\",\n    \"0-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    \"1-0\": \"`gracePeriodDays`\",\n    \"1-1\": \"*integer*\",\n    \"1-2\": \"Optional\",\n    \"1-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    \"2-0\": \"`trialPeriodDays`\",\n    \"2-1\": \"*integer*\",\n    \"2-2\": \"Optional\\n*Cannot be included in Update Plan requests unless the plan already has a trial period*\",\n    \"2-3\": \"Number of days in the trial period.\\nFor example: **14**\",\n    \"3-0\": \"`initialChargeAmount`\",\n    \"3-1\": \"*decimal*\",\n    \"3-2\": \"Optional\\n*Cannot be included in Update Plan requests unless the plan already has an initial charge*\",\n    \"3-3\": \"Amount of the initial charge.\\nFor example: **99.00**\",\n    \"5-0\": \"`currency`\",\n    \"5-1\": \"*string*\",\n    \"5-2\": \"**Required**\",\n    \"5-3\": \"Currency code (ISO 4217) of the amount to be charged. See [Currency codes](/docs/currency-codes).\",\n    \"6-0\": \"`maxNumberOfCharges`\",\n    \"6-1\": \"*integer*\",\n    \"6-2\": \"Optional\",\n    \"6-3\": \"Maximum number of charges that can be processed for a subscription on this plan.\\nFor example: **12**\"\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    \"6-0\": \"`currency`\",\n    \"6-1\": \"*string*\",\n    \"h-3\": \"Description\",\n    \"6-3\": \"Name of the plan.\\nFor example: **Gold Plan**\",\n    \"8-0\": \"`recurringChargeAmount`\",\n    \"8-1\": \"*decimal*\",\n    \"8-3\": \"Recurring amount to be charged.\\nFor example: **29.99**\",\n    \"h-4\": \"Description\",\n    \"6-2\": \"Currency code (ISO 4217) of the amount to be charged. See [Currency codes](/docs/currency-codes).\",\n    \"8-2\": \"Recurring amount to be charged.\\nFor example: **29.99**\",\n    \"9-0\": \"`chargeOnPlanSwitch`\",\n    \"9-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    \"9-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    \"9-1\": \"*boolean*\",\n    \"5-0\": \"`planId`\",\n    \"5-1\": \"*integer*\",\n    \"5-2\": \"BlueSnap identifier for the plan.\",\n    \"10-0\": \"`status`\",\n    \"10-1\": \"*string*\",\n    \"10-2\": \"Possible values:\\n  * **ACTIVE**\\n  * **INACTIVE**\",\n    \"0-0\": \"`chargeFrequency`\",\n    \"0-1\": \"*string*\",\n    \"0-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    \"1-0\": \"`gracePeriodDays`\",\n    \"1-1\": \"*integer*\",\n    \"1-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    \"2-0\": \"`trialPeriodDays`\",\n    \"2-1\": \"*integer*\",\n    \"2-2\": \"Number of days in the trial period.\\nFor example: **14**\",\n    \"3-0\": \"`initialChargeAmount`\",\n    \"3-1\": \"*decimal*\",\n    \"3-2\": \"Amount of the initial charge.\\nFor example: **99.00**\",\n    \"4-0\": \"`name`\",\n    \"4-1\": \"*string*\",\n    \"4-2\": \"Name of the plan.\\nFor example: **Gold Plan**\",\n    \"7-0\": \"`maxNumberOfCharges`\",\n    \"7-1\": \"*integer*\",\n    \"7-2\": \"Maximum number of charges that can be processed for a subscription on this plan.\\nFor example: **12**\"\n  },\n  \"cols\": 3,\n  \"rows\": 11\n}\n[/block]","updates":[],"order":31,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5e5d3aa2dc4d35003d784d3e","category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"JSON Objects","slug":"resources","order":13,"from_sync":false,"reference":false,"_id":"5e5d3aa2dc4d35003d784cfb","version":"5e5d3aa2dc4d35003d784d9d","project":"57336fd5a6a9c40e00e13a0b","createdAt":"2015-10-15T16:20:51.519Z","__v":0},"project":"57336fd5a6a9c40e00e13a0b","parentDoc":null,"user":"560d5913af97231900938124","version":{"version":"8976-JSON","version_clean":"8976.0.0-JSON","codename":"Live","is_stable":false,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["5e5d3aa2dc4d35003d784cf0","5e5d3aa2dc4d35003d784cf1","5e5d3aa2dc4d35003d784cf2","5e5d3aa2dc4d35003d784cf3","5e5d3aa2dc4d35003d784cf4","5e5d3aa2dc4d35003d784cf5","5e5d3aa2dc4d35003d784cf6","5e5d3aa2dc4d35003d784cf7","5e5d3aa2dc4d35003d784cf8","5e5d3aa2dc4d35003d784cf9","5e5d3aa2dc4d35003d784cfa","5e5d3aa2dc4d35003d784cfb","5e5d3aa2dc4d35003d784cfc","5e5d3aa2dc4d35003d784cfd","5e5d3aa2dc4d35003d784cfe","5e5d57ed1362cf0064910881","5e7a7ac40efab8003ae688c3"],"_id":"5e5d3aa2dc4d35003d784d9d","project":"57336fd5a6a9c40e00e13a0b","__v":2,"forked_from":"5c6c23e4735b81006177d0a4","createdAt":"2018-04-24T15:22:41.561Z","releaseDate":"2018-04-24T15:22:41.561Z"},"createdAt":"2016-07-27T10:47:42.918Z","githubsync":"","__v":0}

Payment API (JSON)

Card/Wallet Transactions

PayPal Transactions

ACH/ECP Transactions

SEPA Direct Debit Transactions

Local Bank Transfer transactions

Refunds

Vaulted Shoppers

Subscriptions

Fraud Review

Marketplace

Wallets

Errors

JSON Objects

Test Data & Codes

Guides & Tools

Mobile SDK

plan

Contains details for a subscription billing 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.

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 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