{"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  },\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]","updates":[],"order":12,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5ed5174637c3c607440c09aa","category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Resources","slug":"resources","order":14,"from_sync":false,"reference":false,"_id":"5ed5174637c3c607440c0997","version":"5ed5174637c3c607440c0a3c","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.34.0 Release","is_stable":false,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["5ed5174637c3c607440c098b","5ed5174637c3c607440c098c","5ed5174637c3c607440c098d","5ed5174637c3c607440c098e","5ed5174637c3c607440c098f","5ed5174637c3c607440c0990","5ed5174637c3c607440c0991","5ed5174637c3c607440c0992","5ed5174637c3c607440c0993","5ed5174637c3c607440c0994","5ed5174637c3c607440c0995","5ed5174637c3c607440c0996","5ed5174637c3c607440c0997","5ed5174637c3c607440c0998","5ed5174637c3c607440c0999","5ed5174637c3c607440c099a","5ed5174637c3c607440c099b","5ed5174637c3c607440c099c"],"_id":"5ed5174637c3c607440c0a3c","project":"57336fd5a6a9c40e00e13a0b","__v":0,"forked_from":"5e5d3a02fb6fb40050cb3c15","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

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