{"metadata":{"image":[],"title":"","description":""},"api":{"url":"","auth":"required","results":{"codes":[]},"settings":"","params":[]},"next":{"description":"","pages":[]},"title":"recurring-period","type":"basic","slug":"recurring-period","excerpt":"","body":"###Request\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Property Name\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Required\",\n    \"0-0\": \"`catalog-prices`\",\n    \"0-1\": \"container\",\n    \"h-3\": \"Description\",\n    \"0-3\": \"Container of [catalog-prices](doc:catalog-prices) properties.\",\n    \"1-0\": \"`period-frequency`\",\n    \"1-1\": \"*string*\",\n    \"1-3\": \"Period frequency of the payment:\\n  * **NONE**\\n  * **ONCE**\\n  * **DAILY**\\n  * **WEEKLY**\\n  * **BIWEEKLY**\\n  * **MONTHLY**\\n  * **BIMONTHLY**\\n  * **QUARTERLY**\\n  * **SEMIANNUALLY**\\n  * **ANNUALLY**\\n  * **BIANNUALLY**\\n  * **TRIANNUALLY**\\n  * **UPON_DEMAND**\",\n    \"h-4\": \"Description\",\n    \"0-2\": \"Optional\",\n    \"1-2\": \"Optional\"\n  },\n  \"cols\": 4,\n  \"rows\": 2\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    \"h-3\": \"Description\",\n    \"0-0\": \"`catalog-prices`\",\n    \"0-1\": \"container\",\n    \"0-3\": \"BlueSnap identifier for the transaction.\",\n    \"h-4\": \"Description\",\n    \"0-2\": \"Container of [catalog-prices](doc:catalog-prices) properties.\",\n    \"1-0\": \"`period-frequency`\",\n    \"1-1\": \"*string*\",\n    \"1-2\": \"Period frequency of the payment:\\n  * **NONE**\\n  * **ONCE**\\n  * **DAILY**\\n  * **WEEKLY**\\n  * **BIWEEKLY**\\n  * **MONTHLY**\\n  * **BIMONTHLY**\\n  * **QUARTERLY**\\n  * **SEMIANNUALLY**\\n  * **ANNUALLY**\\n  * **BIANNUALLY**\\n  * **TRIANNUALLY**\\n  * **UPON_DEMAND**\"\n  },\n  \"cols\": 3,\n  \"rows\": 2\n}\n[/block]","updates":[],"order":82,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"6040037678d626005641a111","category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Resources","slug":"resources","order":8,"from_sync":false,"reference":false,"_id":"6040037678d626005641a08c","version":"6040037678d626005641a154","project":"57336fd5a6a9c40e00e13a0b","createdAt":"2015-10-15T16:20:51.519Z","__v":0},"parentDoc":null,"project":"57336fd5a6a9c40e00e13a0b","user":"560d5913af97231900938124","version":{"version":"8976-Extended","version_clean":"8976.0.0-Extended","codename":"3.37 Release","is_stable":false,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["6040037678d626005641a084","6040037678d626005641a085","6040037678d626005641a086","6040037678d626005641a087","6040037678d626005641a088","6040037678d626005641a089","6040037678d626005641a08a","6040037678d626005641a08b","6040037678d626005641a08c","6040037678d626005641a08d","6040037678d626005641a08e"],"_id":"6040037678d626005641a154","project":"57336fd5a6a9c40e00e13a0b","__v":0,"forked_from":"5c742637ad58c70033b9c762","createdAt":"2018-04-24T15:33:45.744Z","releaseDate":"2018-04-24T15:33:45.744Z"},"createdAt":"2016-06-28T10:47:03.841Z","githubsync":"","__v":0}

Extended Payment API

Orders

Shopping Context

Shoppers

Catalog

Subscriptions

Wallets

Errors

Resources

Test Data & Codes

Guides & Tools

recurring-period

Request

Property Name
Type
Required
Description

catalog-prices

container

Optional

Container of catalog-prices properties.

period-frequency

string

Optional

Period frequency of the payment:

  • NONE
  • ONCE
  • DAILY
  • WEEKLY
  • BIWEEKLY
  • MONTHLY
  • BIMONTHLY
  • QUARTERLY
  • SEMIANNUALLY
  • ANNUALLY
  • BIANNUALLY
  • TRIANNUALLY
  • UPON_DEMAND

Response

Property Name
Type
Description

catalog-prices

container

Container of catalog-prices properties.

period-frequency

string

Period frequency of the payment:

  • NONE
  • ONCE
  • DAILY
  • WEEKLY
  • BIWEEKLY
  • MONTHLY
  • BIMONTHLY
  • QUARTERLY
  • SEMIANNUALLY
  • ANNUALLY
  • BIANNUALLY
  • TRIANNUALLY
  • UPON_DEMAND