{"_id":"5adf4e5bac13b80003d231a7","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"},"project":"57336fd5a6a9c40e00e13a0b","user":"560d5913af97231900938124","parentDoc":null,"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-24T17:52:48.597Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":58,"body":"###Request\nN/A\n\n###Response\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Property Name\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Description\",\n    \"2-0\": \"`currency`\",\n    \"2-1\": \"*string*\",\n    \"2-2\": \"Currency code (ISO 4217). See [Currency codes](/docs/currency-codes).\",\n    \"0-0\": \"`charge-type`\",\n    \"0-2\": \"Charge type:\\n  * **initial**: Relevant for both one-time and subscription-based SKUs, and means that the given amount will be charged only for this current order.\\n  * **recurring**: Relevant for subscription-based SKUs, and means that the given amount will be charged only in future charges.\",\n    \"0-1\": \"*string*\",\n    \"1-0\": \"`value`\",\n    \"1-1\": \"*decimal*\",\n    \"1-2\": \"\",\n    \"3-0\": \"`formatted-price`\",\n    \"4-0\": \"`tax-included`\",\n    \"3-1\": \"container\",\n    \"4-1\": \"*boolean*\",\n    \"3-2\": \"Container of formatted-price properties.\",\n    \"4-2\": \"\"\n  },\n  \"cols\": 3,\n  \"rows\": 5\n}\n[/block]","excerpt":"","slug":"charge-price","type":"basic","title":"charge-price"}

Extended Payment API

Orders

Shopping Context

Shoppers

Catalog

Subscriptions

Wallets

Errors

Resources

Test Data & Codes

Guides & Tools

charge-price

Request

N/A

Response

Property Name
Type
Description

charge-type

string

Charge type:

  • initial: Relevant for both one-time and subscription-based SKUs, and means that the given amount will be charged only for this current order.
  • recurring: Relevant for subscription-based SKUs, and means that the given amount will be charged only in future charges.

value

decimal

currency

string

Currency code (ISO 4217). See Currency codes.

formatted-price

container

Container of formatted-price properties.

tax-included

boolean