{"_id":"5adf4c270d03070003a2f5b1","category":{"_id":"5adf4c260d03070003a2f59e","version":"5adf4c260d03070003a2f591","project":"57336fd5a6a9c40e00e13a0b","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-10-15T16:20:51.519Z","from_sync":false,"order":12,"slug":"resources","title":"Resources"},"parentDoc":null,"project":"57336fd5a6a9c40e00e13a0b","user":"560d5913af97231900938124","version":{"_id":"5adf4c260d03070003a2f591","project":"57336fd5a6a9c40e00e13a0b","__v":1,"createdAt":"2018-04-24T15:24:22.608Z","releaseDate":"2018-04-24T15:24:22.608Z","categories":["5adf4c260d03070003a2f592","5adf4c260d03070003a2f593","5adf4c260d03070003a2f594","5adf4c260d03070003a2f595","5adf4c260d03070003a2f596","5adf4c260d03070003a2f597","5adf4c260d03070003a2f598","5adf4c260d03070003a2f599","5adf4c260d03070003a2f59a","5adf4c260d03070003a2f59b","5adf4c260d03070003a2f59c","5adf4c260d03070003a2f59d","5adf4c260d03070003a2f59e","5adf4c260d03070003a2f59f","5adf4c260d03070003a2f5a0","5adf4c260d03070003a2f5a1"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":false,"codename":"3.25.1 Release","version_clean":"8976.0.0-XML","version":"8976-XML"},"__v":0,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-07-28T19:30:41.886Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"settings":"","results":{"codes":[]},"auth":"required","params":[],"url":""},"isReference":false,"order":60,"body":"###Request\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Property Name\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Required\",\n    \"1-0\": \"`from-date`\",\n    \"1-1\": \"*date*\",\n    \"h-3\": \"Description\",\n    \"1-3\": \"Start date of the subscription renewal period.\\nFormat: yyyy-mm-dd\",\n    \"1-2\": \"Optional\",\n    \"2-0\": \"`to-date`\",\n    \"2-3\": \"End date of the subscription renewal period.\\nFormat: yyyy-mm-dd\",\n    \"2-2\": \"Optional\",\n    \"2-1\": \"*date*\",\n    \"0-0\": \"`charge-description`\",\n    \"0-1\": \"*string*\",\n    \"0-2\": \"**Required**\",\n    \"0-3\": \"Description of the subscription, up to 1000 characters.\"\n  },\n  \"cols\": 4,\n  \"rows\": 3\n}\n[/block]\n\n###Response\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Property Name\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Description\",\n    \"1-0\": \"`from-date`\",\n    \"2-0\": \"`to-date`\",\n    \"1-1\": \"*date*\",\n    \"2-1\": \"*date*\",\n    \"1-2\": \"Start date of the subscription renewal period.\\nFormat: yyyy-mm-dd\",\n    \"2-2\": \"End date of the subscription renewal period.\\nFormat: yyyy-mm-dd\",\n    \"0-0\": \"`charge-description`\",\n    \"0-1\": \"*string*\",\n    \"0-2\": \"Description of the subscription.\",\n    \"3-0\": \"`charge-type`\",\n    \"3-1\": \"*string*\",\n    \"3-2\": \"Possible values:\\n  * **INITIAL**\\n  * **RECURRING**\"\n  },\n  \"cols\": 3,\n  \"rows\": 4\n}\n[/block]","excerpt":"Appears within the charge resource","slug":"charge-info","type":"basic","title":"charge-info"}

charge-info

Appears within the charge resource

Request

Property Name
Type
Required
Description

charge-description

string

Required

Description of the subscription, up to 1000 characters.

from-date

date

Optional

Start date of the subscription renewal period.
Format: yyyy-mm-dd

to-date

date

Optional

End date of the subscription renewal period.
Format: yyyy-mm-dd

Response

Property Name
Type
Description

charge-description

string

Description of the subscription.

from-date

date

Start date of the subscription renewal period.
Format: yyyy-mm-dd

to-date

date

End date of the subscription renewal period.
Format: yyyy-mm-dd

charge-type

string

Possible values:

  • INITIAL
  • RECURRING