{"_id":"5b19742cb3baf90003cab57c","category":{"_id":"5b19742cb3baf90003cab4f0","version":"5b19742cb3baf90003cab5ae","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":"5b19742cb3baf90003cab5ae","project":"57336fd5a6a9c40e00e13a0b","__v":0,"forked_from":"5adf4e59ac13b80003d23152","createdAt":"2018-04-24T15:33:45.744Z","releaseDate":"2018-04-24T15:33:45.744Z","categories":["5b19742cb3baf90003cab4e8","5b19742cb3baf90003cab4e9","5b19742cb3baf90003cab4ea","5b19742cb3baf90003cab4eb","5b19742cb3baf90003cab4ec","5b19742cb3baf90003cab4ed","5b19742cb3baf90003cab4ee","5b19742cb3baf90003cab4ef","5b19742cb3baf90003cab4f0","5b19742cb3baf90003cab4f1","5b19742cb3baf90003cab4f2"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":false,"codename":"3.26 Release","version_clean":"8976.0.0-Extended","version":"8976-Extended"},"githubsync":"","__v":0,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-06-28T10:47:03.841Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":81,"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]","excerpt":"","slug":"recurring-period","type":"basic","title":"recurring-period"}

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