{"metadata":{"image":[],"title":"","description":""},"api":{"url":"","auth":"required","results":{"codes":[]},"settings":"","params":[]},"next":{"description":"","pages":[]},"title":"recurring-plan-settings","type":"basic","slug":"recurring-plan-settings","excerpt":"","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]","updates":[],"order":83,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5c742637ad58c70033b9c72c","category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Resources","slug":"resources","order":8,"from_sync":false,"reference":false,"_id":"5c742637ad58c70033b9c6a1","version":"5c742637ad58c70033b9c762","project":"57336fd5a6a9c40e00e13a0b","createdAt":"2015-10-15T16:20:51.519Z","__v":0},"parentDoc":null,"project":"57336fd5a6a9c40e00e13a0b","user":"560d5913af97231900938124","version":{"version":"8976-Extended","version_clean":"8976.0.0-Extended","codename":"Main","is_stable":false,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["5c742637ad58c70033b9c699","5c742637ad58c70033b9c69a","5c742637ad58c70033b9c69b","5c742637ad58c70033b9c69c","5c742637ad58c70033b9c69d","5c742637ad58c70033b9c69e","5c742637ad58c70033b9c69f","5c742637ad58c70033b9c6a0","5c742637ad58c70033b9c6a1","5c742637ad58c70033b9c6a2","5c742637ad58c70033b9c6a3"],"_id":"5c742637ad58c70033b9c762","project":"57336fd5a6a9c40e00e13a0b","__v":0,"forked_from":"5bedbcf19b49e8004462d199","createdAt":"2018-04-24T15:33:45.744Z","releaseDate":"2018-04-24T15:33:45.744Z"},"createdAt":"2016-06-28T11:14:41.493Z","githubsync":"","__v":0}

recurring-plan-settings


Request

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-charge-amount-limit

container

Optional

Container of plan-charge-amount-limit properties.

plan-duration-period

integer

Optional

Plan duration period (expiration) in days.

plan-max-charge-number-limit

integer

Optional

Max charge limit (max installations).

Response

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-charge-amount-limit

container

Container of plan-charge-amount-limit properties.

plan-duration-period

integer

Plan duration period (expiration) in days.

plan-max-charge-number-limit

integer

Max charge limit (max installations).