{"_id":"5adf4e5bac13b80003d231c2","category":{"_id":"5adf4e59ac13b80003d2315b","version":"5adf4e59ac13b80003d23152","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"},"project":"57336fd5a6a9c40e00e13a0b","parentDoc":null,"user":"560d5913af97231900938124","version":{"_id":"5adf4e59ac13b80003d23152","project":"57336fd5a6a9c40e00e13a0b","__v":1,"createdAt":"2018-04-24T15:33:45.744Z","releaseDate":"2018-04-24T15:33:45.744Z","categories":["5adf4e59ac13b80003d23153","5adf4e59ac13b80003d23154","5adf4e59ac13b80003d23155","5adf4e59ac13b80003d23156","5adf4e59ac13b80003d23157","5adf4e59ac13b80003d23158","5adf4e59ac13b80003d23159","5adf4e59ac13b80003d2315a","5adf4e59ac13b80003d2315b","5adf4e59ac13b80003d2315c","5adf4e59ac13b80003d2315d"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":false,"codename":"3.25.1 Release","version_clean":"8976.0.0-Extended","version":"8976-Extended"},"__v":0,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-06-24T19:17:19.097Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":85,"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]","excerpt":"","slug":"free-trial","type":"basic","title":"free-trial"}

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