{"_id":"58e3076590f5250f0081f007","category":{"_id":"58112e72ded0340f0085d034","project":"551e85be610f400d00837db7","version":"58112e71ded0340f0085d02a","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-09-18T15:57:19.874Z","from_sync":false,"order":9,"slug":"api-subresources","title":"Merchant API Subresources"},"version":{"_id":"58112e71ded0340f0085d02a","project":"551e85be610f400d00837db7","__v":4,"createdAt":"2016-10-26T22:30:09.862Z","releaseDate":"2016-10-26T22:30:09.862Z","categories":["58112e72ded0340f0085d02b","58112e72ded0340f0085d02c","58112e72ded0340f0085d02d","58112e72ded0340f0085d02e","58112e72ded0340f0085d02f","58112e72ded0340f0085d030","58112e72ded0340f0085d031","58112e72ded0340f0085d032","58112e72ded0340f0085d033","58112e72ded0340f0085d034","581137cc604d3c230048b7e4","58dc367221742d0f00a73f98","590768e54669da0f00db5c0b"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"new designer","version_clean":"2.0.0","version":"2.0"},"__v":0,"project":"551e85be610f400d00837db7","user":"58a36246b2c9e91b00e551cb","parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-04-04T02:39:33.058Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":13,"body":"A subscription term represents the cycle information associated with a given subscription. A sample call for viewing a shipment's fulfillments might be `http://api.cratejoy.com/v1/subscriptions/{ID}/?with=term`.\n[block:api-header]\n{\n  \"title\": \"Properties\"\n}\n[/block]\n\n[block:html]\n{\n  \"html\": \"<div class=\\\"property-table-wrap\\\">\\n    <table class=\\\"property-table\\\">\\n        <thead>\\n            <tr>\\n                <th class=\\\"prop-col\\\">Property</th>\\n                <th class=\\\"filter-col\\\">Filter</th>\\n                <th class=\\\"editable-col\\\">Edit</th>\\n                <th class=\\\"type-col\\\">Type</th>\\n                <th class=\\\"description-col\\\">Description</th>\\n            </tr>\\n        </thead>\\n\\n        <tbody class=\\\"properties\\\">\\n\\n            <tr class=\\\"fil ro\\\">\\n                <td class=\\\"prop-col\\\">id</td>\\n                <td class=\\\"filter-col\\\"></td>\\n                <td class=\\\"editable-col\\\"></td>\\n                <td class=\\\"type-col\\\">INT</td>\\n                <td class=\\\"description-col\\\">Unique identifier</td>\\n            </tr>\\n\\n            <tr class=\\\"ro\\\">\\n                <td class=\\\"prop-col\\\">description</td>\\n                <td class=\\\"filter-col\\\"></td>\\n                <td class=\\\"editable-col\\\"></td>\\n                <td class=\\\"type-col\\\">STRING</td>\\n                <td class=\\\"description-col\\\">Seller-provided descripition of this subscription term</td>\\n            </tr>\\n          \\n            <tr class=\\\"fil ro\\\">\\n                <td class=\\\"prop-col\\\">enabled</td>\\n                <td class=\\\"filter-col\\\"></td>\\n                <td class=\\\"editable-col\\\"></td>\\n                <td class=\\\"type-col\\\">BOOL</td>\\n                <td class=\\\"description-col\\\">Whether the term is set to be subscriber-visible or not.</td>\\n            </tr>          \\n\\n            <tr class=\\\"ro\\\">\\n                <td class=\\\"prop-col\\\">name</td>\\n                <td class=\\\"filter-col\\\"></td>\\n                <td class=\\\"editable-col\\\"></td>\\n                <td class=\\\"type-col\\\">STRING</td>\\n              <td class=\\\"description-col\\\">Name of the term, e.g. <code>\\\"Month to Month\\\"</code></td>\\n            </tr>\\n          \\n            <tr class=\\\"fil ro\\\">\\n                <td class=\\\"prop-col\\\">num_cycles</td>\\n                <td class=\\\"filter-col\\\"></td>\\n                <td class=\\\"editable-col\\\"></td>\\n                <td class=\\\"type-col\\\">INT</td>\\n                <td class=\\\"description-col\\\">The number of rebill cycles in the term. E.g. <code>3</code> for a 3-month prepay, or <code>1</code> for a month-to-month subsription.</td>\\n            </tr>\\n\\n            <tr class=\\\"ro\\\">\\n                <td class=\\\"prop-col\\\">type</td>\\n                <td class=\\\"filter-col\\\"></td>\\n                <td class=\\\"editable-col\\\"></td>\\n                <td class=\\\"type-col\\\">STRING</td>\\n                <td class=\\\"description-col\\\">Always <code>subscription_type_term</td>\\n            </tr>\\n            </tbody>\\n    </table>\\n</div>\"\n}\n[/block]\n## RELATION PROPERTIES\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Property\",\n    \"h-1\": \"Resource\",\n    \"h-2\": \"Description\",\n    \"h-3\": \"Filter?\",\n    \"0-0\": \"image\",\n    \"0-1\": \"Images\",\n    \"0-2\": \"Images associated with the subscription term.\",\n    \"0-3\": \"No\"\n  },\n  \"cols\": 4,\n  \"rows\": 1\n}\n[/block]","excerpt":"Subscription term data object specification for the Cratejoy Merchant API","slug":"subscription-term","type":"basic","title":"Subscription Term"}

Subscription Term

Subscription term data object specification for the Cratejoy Merchant API

A subscription term represents the cycle information associated with a given subscription. A sample call for viewing a shipment's fulfillments might be `http://api.cratejoy.com/v1/subscriptions/{ID}/?with=term`. [block:api-header] { "title": "Properties" } [/block] [block:html] { "html": "<div class=\"property-table-wrap\">\n <table class=\"property-table\">\n <thead>\n <tr>\n <th class=\"prop-col\">Property</th>\n <th class=\"filter-col\">Filter</th>\n <th class=\"editable-col\">Edit</th>\n <th class=\"type-col\">Type</th>\n <th class=\"description-col\">Description</th>\n </tr>\n </thead>\n\n <tbody class=\"properties\">\n\n <tr class=\"fil ro\">\n <td class=\"prop-col\">id</td>\n <td class=\"filter-col\"></td>\n <td class=\"editable-col\"></td>\n <td class=\"type-col\">INT</td>\n <td class=\"description-col\">Unique identifier</td>\n </tr>\n\n <tr class=\"ro\">\n <td class=\"prop-col\">description</td>\n <td class=\"filter-col\"></td>\n <td class=\"editable-col\"></td>\n <td class=\"type-col\">STRING</td>\n <td class=\"description-col\">Seller-provided descripition of this subscription term</td>\n </tr>\n \n <tr class=\"fil ro\">\n <td class=\"prop-col\">enabled</td>\n <td class=\"filter-col\"></td>\n <td class=\"editable-col\"></td>\n <td class=\"type-col\">BOOL</td>\n <td class=\"description-col\">Whether the term is set to be subscriber-visible or not.</td>\n </tr> \n\n <tr class=\"ro\">\n <td class=\"prop-col\">name</td>\n <td class=\"filter-col\"></td>\n <td class=\"editable-col\"></td>\n <td class=\"type-col\">STRING</td>\n <td class=\"description-col\">Name of the term, e.g. <code>\"Month to Month\"</code></td>\n </tr>\n \n <tr class=\"fil ro\">\n <td class=\"prop-col\">num_cycles</td>\n <td class=\"filter-col\"></td>\n <td class=\"editable-col\"></td>\n <td class=\"type-col\">INT</td>\n <td class=\"description-col\">The number of rebill cycles in the term. E.g. <code>3</code> for a 3-month prepay, or <code>1</code> for a month-to-month subsription.</td>\n </tr>\n\n <tr class=\"ro\">\n <td class=\"prop-col\">type</td>\n <td class=\"filter-col\"></td>\n <td class=\"editable-col\"></td>\n <td class=\"type-col\">STRING</td>\n <td class=\"description-col\">Always <code>subscription_type_term</td>\n </tr>\n </tbody>\n </table>\n</div>" } [/block] ## RELATION PROPERTIES [block:parameters] { "data": { "h-0": "Property", "h-1": "Resource", "h-2": "Description", "h-3": "Filter?", "0-0": "image", "0-1": "Images", "0-2": "Images associated with the subscription term.", "0-3": "No" }, "cols": 4, "rows": 1 } [/block]