{"metadata":{"image":[],"title":"","description":""},"api":{"url":"","auth":"required","results":{"codes":[]},"settings":"","params":[]},"next":{"description":"","pages":[]},"title":"pricing-settings","type":"basic","slug":"pricing-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-policy-type`\",\n    \"0-1\": \"*string*\",\n    \"h-3\": \"Description\",\n    \"0-3\": \"Charge policy type:\\n  * **ONE TIME PAYMENT**\\n  * **ONE TIME PAYMENT WITH TRIAL**\\n  * **STANDARD SUBSCRIPTION**\\n  * **STANDARD SUBSCRIPTION WITH TRIAL**\\n  * **STANDARD SUBSCRIPTION WITH INITIAL CHARGE**\",\n    \"1-0\": \"`charge-policy`\",\n    \"1-1\": \"container\",\n    \"1-3\": \"Container of [charge-policy](doc:charge-policy) properties.\",\n    \"h-4\": \"Description\",\n    \"0-2\": \"**Required**\",\n    \"1-2\": \"**Required**\",\n    \"4-0\": \"`recurring-plan-settings`\",\n    \"4-1\": \"container\",\n    \"4-2\": \"Optional\",\n    \"4-3\": \"Container of [recurring-plan-settings](doc:recurring-plan-settings) properties.\",\n    \"2-0\": \"`include-tax-in-price`\",\n    \"2-1\": \"*boolean*\",\n    \"2-2\": \"Optional\",\n    \"2-3\": \"Indicates whether the tax is included in the price.\",\n    \"3-3\": \"Rounding policy:\\n  * **NO ROUNDING**\\n  * **ROUNDING UP TO 0.05**\\n  * **ROUNDING UP TO 0.10**\\n  * **ROUNDING UP TO 0.50**\\n  * **ROUNDING UP TO 0.95**\\n  * **ROUNDING UP TO 0.99**\\n  * **ROUNDING UP TO 1.0**0\\n  * **ROUNDING UP TO 5.00**\",\n    \"3-0\": \"`rounding-price-method`\",\n    \"3-1\": \"*string*\",\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-policy-type`\",\n    \"0-1\": \"*string*\",\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\": \"Charge policy type:\\n  * **ONE TIME PAYMENT**\\n  * **ONE TIME PAYMENT WITH TRIAL**\\n  * **STANDARD SUBSCRIPTION**\\n  * **STANDARD SUBSCRIPTION WITH TRIAL**\\n  * **STANDARD SUBSCRIPTION WITH INITIAL CHARGE**\",\n    \"3-0\": \"`rounding-price-method`\",\n    \"3-1\": \"*string*\",\n    \"3-2\": \"Rounding policy:\\n  * **NO ROUNDING**\\n  * **ROUNDING UP TO 0.05**\\n  * **ROUNDING UP TO 0.10**\\n  * **ROUNDING UP TO 0.50**\\n  * **ROUNDING UP TO 0.95**\\n  * **ROUNDING UP TO 0.99**\\n  * **ROUNDING UP TO 1.0**0\\n  * **ROUNDING UP TO 5.00**\",\n    \"1-0\": \"`charge-policy`\",\n    \"2-0\": \"`include-tax-in-price`\",\n    \"1-1\": \"container\",\n    \"2-1\": \"*boolean*\",\n    \"1-2\": \"Container of [charge-policy](doc:charge-policy) properties.\",\n    \"2-2\": \"Indicates whether the tax is included in the price.\",\n    \"4-0\": \"`recurring-plan-settings`\",\n    \"4-1\": \"container\",\n    \"4-2\": \"Container of [recurring-plan-settings](doc:recurring-plan-settings) properties.\"\n  },\n  \"cols\": 3,\n  \"rows\": 5\n}\n[/block]","updates":[],"order":79,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5c742637ad58c70033b9c728","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},"user":"560d5913af97231900938124","parentDoc":null,"project":"57336fd5a6a9c40e00e13a0b","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-27T19:45:28.732Z","githubsync":"","__v":0}

Extended Payment API

Orders

Shopping Context

Shoppers

Catalog

Subscriptions

Wallets

Errors

Resources

Test Data & Codes

Guides & Tools

pricing-settings

Request

Property Name
Type
Required
Description

charge-policy-type

string

Required

Charge policy type:

  • ONE TIME PAYMENT
  • ONE TIME PAYMENT WITH TRIAL
  • STANDARD SUBSCRIPTION
  • STANDARD SUBSCRIPTION WITH TRIAL
  • STANDARD SUBSCRIPTION WITH INITIAL CHARGE

charge-policy

container

Required

Container of charge-policy properties.

include-tax-in-price

boolean

Optional

Indicates whether the tax is included in the price.

rounding-price-method

string

Optional

Rounding policy:

  • NO ROUNDING
  • ROUNDING UP TO 0.05
  • ROUNDING UP TO 0.10
  • ROUNDING UP TO 0.50
  • ROUNDING UP TO 0.95
  • ROUNDING UP TO 0.99
  • ROUNDING UP TO 1.00
  • ROUNDING UP TO 5.00

recurring-plan-settings

container

Optional

Container of recurring-plan-settings properties.

Response

Property Name
Type
Description

charge-policy-type

string

Charge policy type:

  • ONE TIME PAYMENT
  • ONE TIME PAYMENT WITH TRIAL
  • STANDARD SUBSCRIPTION
  • STANDARD SUBSCRIPTION WITH TRIAL
  • STANDARD SUBSCRIPTION WITH INITIAL CHARGE

charge-policy

container

Container of charge-policy properties.

include-tax-in-price

boolean

Indicates whether the tax is included in the price.

rounding-price-method

string

Rounding policy:

  • NO ROUNDING
  • ROUNDING UP TO 0.05
  • ROUNDING UP TO 0.10
  • ROUNDING UP TO 0.50
  • ROUNDING UP TO 0.95
  • ROUNDING UP TO 0.99
  • ROUNDING UP TO 1.00
  • ROUNDING UP TO 5.00

recurring-plan-settings

container

Container of recurring-plan-settings properties.