{"metadata":{"image":[],"title":"","description":""},"api":{"url":"","auth":"required","results":{"codes":[]},"settings":"","params":[]},"next":{"description":"","pages":[]},"title":"free-trial","type":"basic","slug":"free-trial","excerpt":"","body":"###Request\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Property Name\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Required\",\n    \"1-0\": \"`interval`\",\n    \"1-1\": \"*string*\",\n    \"h-3\": \"Description\",\n    \"1-3\": \"Period type for the trial period:\\n  * **DAYS**\\n  * **MONTHS**\\n  * **YEARS**\",\n    \"1-2\": \"Optional\",\n    \"0-0\": \"`period-length`\",\n    \"0-1\": \"*integer*\",\n    \"0-2\": \"**Required**\",\n    \"0-3\": \"Number of days of the trial period.\"\n  },\n  \"cols\": 4,\n  \"rows\": 2\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\": \"`interval`\",\n    \"1-1\": \"*string*\",\n    \"1-2\": \"Period type for the trial period:\\n  * **DAYS**\\n  * **MONTHS**\\n  * **YEARS**\",\n    \"0-0\": \"`period-length`\",\n    \"0-1\": \"*integer*\",\n    \"0-2\": \"Number of days of the trial period.\"\n  },\n  \"cols\": 3,\n  \"rows\": 2\n}\n[/block]","updates":[],"order":44,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5c742637ad58c70033b9c706","category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Resources","slug":"resources","order":8,"from_sync":false,"reference":false,"_id":"5c742637ad58c70033b9c6a1","version":"5c742637ad58c70033b9c762","project":"57336fd5a6a9c40e00e13a0b","createdAt":"2015-10-15T16:20:51.519Z","__v":0},"project":"57336fd5a6a9c40e00e13a0b","parentDoc":null,"user":"560d5913af97231900938124","version":{"version":"8976-Extended","version_clean":"8976.0.0-Extended","codename":"Main","is_stable":false,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["5c742637ad58c70033b9c699","5c742637ad58c70033b9c69a","5c742637ad58c70033b9c69b","5c742637ad58c70033b9c69c","5c742637ad58c70033b9c69d","5c742637ad58c70033b9c69e","5c742637ad58c70033b9c69f","5c742637ad58c70033b9c6a0","5c742637ad58c70033b9c6a1","5c742637ad58c70033b9c6a2","5c742637ad58c70033b9c6a3"],"_id":"5c742637ad58c70033b9c762","project":"57336fd5a6a9c40e00e13a0b","__v":0,"forked_from":"5bedbcf19b49e8004462d199","createdAt":"2018-04-24T15:33:45.744Z","releaseDate":"2018-04-24T15:33:45.744Z"},"createdAt":"2016-06-24T19:17:19.097Z","githubsync":"","__v":0}

Extended Payment API

Orders

Shopping Context

Shoppers

Catalog

Subscriptions

Wallets

Errors

Resources

Test Data & Codes

Guides & Tools

free-trial

Request

Property Name
Type
Required
Description

period-length

integer

Required

Number of days of the trial period.

interval

string

Optional

Period type for the trial period:

  • DAYS
  • MONTHS
  • YEARS

Response

Property Name
Type
Description

period-length

integer

Number of days of the trial period.

interval

string

Period type for the trial period:

  • DAYS
  • MONTHS
  • YEARS