{"_id":"5adf4e5bac13b80003d231e8","category":{"_id":"5adf4e59ac13b80003d2315b","version":"5adf4e59ac13b80003d23152","project":"57336fd5a6a9c40e00e13a0b","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-10-15T16:20:51.519Z","from_sync":false,"order":8,"slug":"resources","title":"Resources"},"parentDoc":null,"project":"57336fd5a6a9c40e00e13a0b","user":"560d5913af97231900938124","version":{"_id":"5adf4e59ac13b80003d23152","project":"57336fd5a6a9c40e00e13a0b","__v":1,"createdAt":"2018-04-24T15:33:45.744Z","releaseDate":"2018-04-24T15:33:45.744Z","categories":["5adf4e59ac13b80003d23153","5adf4e59ac13b80003d23154","5adf4e59ac13b80003d23155","5adf4e59ac13b80003d23156","5adf4e59ac13b80003d23157","5adf4e59ac13b80003d23158","5adf4e59ac13b80003d23159","5adf4e59ac13b80003d2315a","5adf4e59ac13b80003d2315b","5adf4e59ac13b80003d2315c","5adf4e59ac13b80003d2315d"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":false,"codename":"3.25.1 Release","version_clean":"8976.0.0-Extended","version":"8976-Extended"},"__v":0,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-06-28T11:14:41.493Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":123,"body":"###Request\n[block:parameters]\n{\n \"data\": {\n \"h-0\": \"Property Name\",\n \"h-1\": \"Type\",\n \"h-2\": \"Required\",\n \"0-0\": \"`charge-upon-plan-change`\",\n \"0-1\": \"*boolean*\",\n \"h-3\": \"Description\",\n \"0-3\": \"Indicates whether to charge shopper upon subscription plan change.\",\n \"1-0\": \"`grace-period-length`\",\n \"1-1\": \"*integer*\",\n \"1-3\": \"Grace period in days.\",\n \"h-4\": \"Description\",\n \"0-2\": \"Optional\",\n \"1-2\": \"Optional\",\n \"4-0\": \"`plan-max-charge-number-limit`\",\n \"4-1\": \"*integer*\",\n \"4-2\": \"Optional\",\n \"4-3\": \"Max charge limit (max installations).\",\n \"2-0\": \"`plan-charge-amount-limit`\",\n \"2-1\": \"container\",\n \"2-2\": \"Optional\",\n \"2-3\": \"Container of [plan-charge-amount-limit](doc:plan-charge-amount-limit) properties.\",\n \"3-3\": \"Plan duration period (expiration) in days.\",\n \"3-0\": \"`plan-duration-period`\",\n \"3-1\": \"*integer*\",\n \"3-2\": \"Optional\"\n },\n \"cols\": 4,\n \"rows\": 5\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 \"0-0\": \"`charge-upon-plan-change`\",\n \"0-1\": \"*boolean*\",\n \"h-3\": \"Description\",\n \"0-3\": \"Defines the type of transaction. Values can be:\\nAUTH_ONLY\\nAUTH_CAPTURE\\nCAPTURE\\nAUTH_REVERSAL\\nSee Transaction Types\",\n \"h-4\": \"Description\",\n \"0-2\": \"Indicates whether to charge shopper upon subscription plan change.\",\n \"3-0\": \"`plan-duration-period`\",\n \"3-1\": \"*integer*\",\n \"3-2\": \"Plan duration period (expiration) in days.\",\n \"1-0\": \"`grace-period-length`\",\n \"2-0\": \"`plan-charge-amount-limit`\",\n \"1-1\": \"*integer*\",\n \"2-1\": \"container\",\n \"1-2\": \"Grace period in days.\",\n \"2-2\": \"Container of [plan-charge-amount-limit](doc:plan-charge-amount-limit) properties.\",\n \"4-0\": \"`plan-max-charge-number-limit`\",\n \"4-1\": \"*integer*\",\n \"4-2\": \"Max charge limit (max installations).\"\n },\n \"cols\": 3,\n \"rows\": 5\n}\n[/block]","excerpt":"","slug":"recurring-plan-settings","type":"basic","title":"recurring-plan-settings"}recurring-plan-settings
Property Name
Type
Required
Description
charge-upon-plan-change
boolean
Optional
Indicates whether to charge shopper upon subscription plan change.
grace-period-length
integer
Optional
Grace period in days.
plan-duration-period
integer
Optional
Plan duration period (expiration) in days.
plan-max-charge-number-limit
integer
Optional
Max charge limit (max installations).
Property Name
Type
Description
charge-upon-plan-change
boolean
Indicates whether to charge shopper upon subscription plan change.
grace-period-length
integer
Grace period in days.
plan-duration-period
integer
Plan duration period (expiration) in days.
plan-max-charge-number-limit
integer
Max charge limit (max installations).