{"metadata":{"image":[],"title":"","description":""},"api":{"url":"","auth":"required","settings":"","results":{"codes":[]},"params":[]},"next":{"description":"","pages":[]},"title":"charge-info","type":"basic","slug":"charge-info","excerpt":"Appears within the charge resource","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 \"3-0\": \"`on-demand-soft-descriptor`\",\n \"3-1\": \"*string*\",\n \"3-2\": \"Optional\",\n \"3-3\": \"Description that appears on the credit card statement or bank statement.\"\n },\n \"cols\": 4,\n \"rows\": 4\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]","updates":[],"order":12,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"61a5208deadb750070998ea8","category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Resources","slug":"resources","order":16,"from_sync":false,"reference":false,"_id":"61a5208deadb750070998e93","version":"61a5208deadb750070998f48","project":"57336fd5a6a9c40e00e13a0b","createdAt":"2015-10-15T16:20:51.519Z","__v":0},"parentDoc":null,"project":"57336fd5a6a9c40e00e13a0b","user":"560d5913af97231900938124","version":{"version":"8976-XML","version_clean":"8976.0.0-XML","codename":"3.40 Release","is_stable":false,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["61a5208deadb750070998e87","61a5208deadb750070998e88","61a5208deadb750070998e89","61a5208deadb750070998e8a","61a5208deadb750070998e8b","61a5208deadb750070998e8c","61a5208deadb750070998e8d","61a5208deadb750070998e8e","61a5208deadb750070998e8f","61a5208deadb750070998e90","61a5208deadb750070998e91","61a5208deadb750070998e92","61a5208deadb750070998e93","61a5208deadb750070998e94","61a5208deadb750070998e95","61a5208deadb750070998e96","61a5208deadb750070998e97","61a5208deadb750070998e98","61a5208deadb750070998e99","61a5208deadb750070998e9a"],"_id":"61a5208deadb750070998f48","project":"57336fd5a6a9c40e00e13a0b","__v":0,"forked_from":"60fed269718a45001c25b4a0","createdAt":"2018-04-24T15:24:22.608Z","releaseDate":"2018-04-24T15:24:22.608Z"},"createdAt":"2016-07-28T19:30:41.886Z","githubsync":"","__v":0}
charge-info
Appears within the charge resource
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
on-demand-soft-descriptor
string
Optional
Description that appears on the credit card statement or bank statement.
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