{"_id":"5a96ec9789442e00204111d7","category":{"_id":"5a96ec9189442e0020411156","version":"5a96ec9189442e002041114d","project":"57336fd5a6a9c40e00e13a0b","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-10-15T16:20:51.519Z","from_sync":false,"order":8,"slug":"resources","title":"Resources"},"parentDoc":null,"project":"57336fd5a6a9c40e00e13a0b","user":"560d5913af97231900938124","version":{"_id":"5a96ec9189442e002041114d","project":"57336fd5a6a9c40e00e13a0b","__v":1,"createdAt":"2018-02-28T17:53:21.809Z","releaseDate":"2018-02-28T17:53:21.809Z","categories":["5a96ec9189442e002041114e","5a96ec9189442e002041114f","5a96ec9189442e0020411150","5a96ec9189442e0020411151","5a96ec9189442e0020411152","5a96ec9189442e0020411153","5a96ec9189442e0020411154","5a96ec9189442e0020411155","5a96ec9189442e0020411156","5a96ec9189442e0020411157","5a96ec9189442e0020411158"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":false,"codename":"3.24.2 Release","version_clean":"8976.0.0-Extended","version":"8976-Extended"},"__v":0,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-06-27T18:14:42.591Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":112,"body":"###Request\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Property Name\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Required\",\n    \"1-0\": \"`trial-period`\",\n    \"1-1\": \"container\",\n    \"h-3\": \"Description\",\n    \"1-3\": \"Container of [trial-period](doc:trial-period) properties.\",\n    \"2-0\": \"`initial-period`\",\n    \"2-1\": \"container\",\n    \"2-3\": \"Container of [initial-period](doc:initial-period) properties.\",\n    \"h-4\": \"Description\",\n    \"1-2\": \"**Required**\",\n    \"2-2\": \"**Required**\",\n    \"3-1\": \"container\",\n    \"3-0\": \"`recurring-period`\",\n    \"3-2\": \"**Required**\",\n    \"3-3\": \"Container of [recurring-period](doc:recurring-period) properties.\",\n    \"0-0\": \"`currency`\",\n    \"0-1\": \"*string*\",\n    \"0-2\": \"**Required**\",\n    \"0-3\": \"Currency code (ISO 4217).\\nSee [Currency codes](/docs/currency-codes).\"\n  },\n  \"cols\": 4,\n  \"rows\": 4\n}\n[/block]\n###Response\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Property Name\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Description\",\n    \"1-0\": \"`trial-period`\",\n    \"1-1\": \"container\",\n    \"h-3\": \"Description\",\n    \"1-3\": \"Defines the type of transaction. Values can be:\\nAUTH_ONLY\\nAUTH_CAPTURE\\nCAPTURE\\nAUTH_REVERSAL\\nSee Transaction Types\",\n    \"2-0\": \"`initial-period`\",\n    \"2-1\": \"container\",\n    \"2-3\": \"BlueSnap identifier for the transaction.\",\n    \"h-4\": \"Description\",\n    \"1-2\": \"Container of [trial-period](doc:trial-period) properties.\",\n    \"2-2\": \"Container of [initial-period](doc:initial-period) properties.\",\n    \"3-0\": \"`recurring-period`\",\n    \"3-1\": \"container\",\n    \"3-2\": \"Container of [recurring-period](doc:recurring-period) properties.\",\n    \"0-0\": \"`currency`\",\n    \"0-1\": \"*string*\",\n    \"0-2\": \"Currency code (ISO 4217).\\nSee [Currency codes](/docs/currency-codes).\"\n  },\n  \"cols\": 3,\n  \"rows\": 4\n}\n[/block]","excerpt":"","slug":"periods","type":"basic","title":"periods"}

Request

Property Name
Type
Required
Description

currency

string

Required

Currency code (ISO 4217).
See Currency codes.

trial-period

container

Required

Container of trial-period properties.

initial-period

container

Required

Container of initial-period properties.

recurring-period

container

Required

Container of recurring-period properties.

Response

Property Name
Type
Description

currency

string

Currency code (ISO 4217).
See Currency codes.

trial-period

container

Container of trial-period properties.

initial-period

container

Container of initial-period properties.

recurring-period

container

Container of recurring-period properties.