{"_id":"59dfa5868b51880010b74b00","category":{"_id":"59dfa5828b51880010b74ac2","version":"59dfa5828b51880010b74ab6","project":"57336fd5a6a9c40e00e13a0b","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-10-15T16:20:51.519Z","from_sync":false,"order":11,"slug":"resources","title":"JSON Objects"},"user":"560d5913af97231900938124","parentDoc":null,"project":"57336fd5a6a9c40e00e13a0b","version":{"_id":"59dfa5828b51880010b74ab6","project":"57336fd5a6a9c40e00e13a0b","__v":1,"createdAt":"2017-10-12T17:25:22.850Z","releaseDate":"2017-10-12T17:25:22.850Z","categories":["59dfa5828b51880010b74ab7","59dfa5828b51880010b74ab8","59dfa5828b51880010b74ab9","59dfa5828b51880010b74aba","59dfa5828b51880010b74abb","59dfa5828b51880010b74abc","59dfa5828b51880010b74abd","59dfa5828b51880010b74abe","59dfa5828b51880010b74abf","59dfa5828b51880010b74ac0","59dfa5828b51880010b74ac1","59dfa5828b51880010b74ac2","59dfa5828b51880010b74ac3","59dfa5828b51880010b74ac4","59dfa5828b51880010b74ac5"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":false,"codename":"3.23 Release","version_clean":"8976.0.0-JSON","version":"8976-JSON"},"__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":7,"body":"###Request\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Property Name\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Required\",\n    \"1-0\": \"`fromDate`\",\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\": \"`toDate`\",\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\": \"`chargeDescription`\",\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\": \"`fromDate`\",\n    \"2-0\": \"`toDate`\",\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\": \"`chargeDescription`\",\n    \"0-1\": \"*string*\",\n    \"0-2\": \"Description of the subscription.\",\n    \"3-0\": \"`chargeType`\",\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 object","slug":"charge-info","type":"basic","title":"chargeInfo"}

chargeInfo

Appears within the charge object

Request

Property Name
Type
Required
Description

chargeDescription

string

Required

Description of the subscription, up to 1000 characters.

fromDate

date

Optional

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

toDate

date

Optional

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

Response

Property Name
Type
Description

chargeDescription

string

Description of the subscription.

fromDate

date

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

toDate

date

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

chargeType

string

Possible values:

  • INITIAL
  • RECURRING