{"_id":"5d3084287e5e410027a1e8d3","project":"57336fd5a6a9c40e00e13a0b","version":{"_id":"5c6c2407b8d4b2000e72da25","project":"57336fd5a6a9c40e00e13a0b","__v":0,"forked_from":"5beec5a5f95d82011c6f3714","createdAt":"2018-04-24T15:24:22.608Z","releaseDate":"2018-04-24T15:24:22.608Z","categories":["5c6c2407b8d4b2000e72d981","5c6c2407b8d4b2000e72d982","5c6c2407b8d4b2000e72d983","5c6c2407b8d4b2000e72d984","5c6c2407b8d4b2000e72d985","5c6c2407b8d4b2000e72d986","5c6c2407b8d4b2000e72d987","5c6c2407b8d4b2000e72d988","5c6c2407b8d4b2000e72d989","5c6c2407b8d4b2000e72d98a","5c6c2407b8d4b2000e72d98b","5c6c2407b8d4b2000e72d98c","5c6c2407b8d4b2000e72d98d","5c6c2407b8d4b2000e72d98e","5c6c2407b8d4b2000e72d98f","5c6c2407b8d4b2000e72d990"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":false,"codename":"Main","version_clean":"8976.0.0-XML","version":"8976-XML"},"category":{"_id":"5c6c2407b8d4b2000e72d98d","version":"5c6c2407b8d4b2000e72da25","project":"57336fd5a6a9c40e00e13a0b","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-10-15T16:20:51.519Z","from_sync":false,"order":12,"slug":"resources","title":"Resources"},"user":"5beb1b96bc2003003ecd645e","__v":0,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2019-07-18T14:37:28.411Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"settings":"","results":{"codes":[]},"auth":"required","params":[],"url":""},"isReference":false,"order":36,"body":"###Request\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Property Name\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Required\",\n    \"0-0\": \"`plan-id`\",\n    \"0-1\": \"*integer*\",\n    \"h-3\": \"Description\",\n    \"0-3\": \"ID of the billing [plan](doc:plan) associated with this subscription.\",\n    \"2-0\": \"`payer-info`\",\n    \"2-1\": \"container\",\n    \"2-3\": \"Container of [payer-info](doc:payer-info) properties.\",\n    \"h-4\": \"Description\",\n    \"0-2\": \"**Required** for Create Subscription\",\n    \"2-2\": \"Optional\\n*Do not include if sending* `vaulted-shopper-id`\",\n    \"3-0\": \"`payment-source`\",\n    \"3-1\": \"container\",\n    \"3-3\": \"Container of [payment-source](doc:payment-source) properties.\",\n    \"3-2\": \"**Required** for Create Subscription if sending `payer-info`\\n\\n**Optional** if sending `vaulted-shopper-id`\",\n    \"10-0\": \"`transaction-fraud-info`\",\n    \"10-1\": \"container\",\n    \"10-2\": \"**Required** for Create Subscription\",\n    \"10-3\": \"Container of [transaction-fraud-info](doc:transaction-fraud-info) properties.\",\n    \"4-0\": \"`quantity`\",\n    \"5-0\": \"`soft-descriptor`\",\n    \"7-0\": \"`override-trial-period-days`\",\n    \"8-0\": \"`override-recurring-charge-amount`\",\n    \"4-1\": \"*integer*\",\n    \"4-2\": \"Optional\\n*Create Subscription requests only*\",\n    \"4-3\": \"Quantity to apply to the subscription.\\nDefault is `1`.\\nFor example, to charge for 10 users in this subscription, set the quantity to 10. If the associated plan's price is $30 per month, then this subscription's recurring payment will be $300 per month (10 x $30).\",\n    \"5-3\": \"Description of the transaction, which appears on the shopper's credit card statement. Maximum 20 characters.\",\n    \"5-1\": \"*string*\",\n    \"5-2\": \"Optional\",\n    \"7-1\": \"*integer*\",\n    \"7-2\": \"Optional\",\n    \"7-3\": \"Number of days in the trial period. This overrides the trial period defined for the associated billing plan. The override applies only to this subscription.\\n\\n\\n**Note**: This value must be greater than **`0`**.  If the value is set to **`0`**, the property is ignored and the `trial-period-days` is used.\",\n    \"8-1\": \"*decimal*\",\n    \"8-2\": \"Optional\",\n    \"8-3\": \"Recurring amount to be charged. This overrides the charge amount defined for the associated billing plan. The override applies only to this subscription.\",\n    \"1-0\": \"`vaulted-shopper-id`\",\n    \"1-1\": \"*integer*\",\n    \"1-2\": \"Optional\\n*Do not include if sending* `payer-info`\",\n    \"1-3\": \"ID of an existing vaulted shopper.\",\n    \"11-0\": \"`auto-renew`\",\n    \"13-0\": \"`next-charge-date`\",\n    \"14-0\": \"`status`\",\n    \"14-3\": \"Permitted values:\\n`ACTIVE`\\n`CANCELED`\",\n    \"11-1\": \"*boolean*\",\n    \"13-1\": \"*string*\",\n    \"14-1\": \"*string*\",\n    \"14-2\": \"Optional\\n*Create/Update Subscription requests only*\",\n    \"13-2\": \"Optional\\n*Create/Update Subscription requests only*\",\n    \"11-2\": \"Optional\\n*Optional Update Subscription requests only*\",\n    \"11-3\": \"Determines whether the subscription automatically continues, or expires at the end of the current period.\",\n    \"13-3\": \"Next charge date.\\nIf you change this, the date of future recurring charges is adjusted accordingly. \\n\\nFormat: yyyy-mm-dd\",\n    \"9-0\": \"`override-initial-charge-amount`\",\n    \"9-1\": \"*decimal*\",\n    \"9-2\": \"Optional\",\n    \"9-3\": \"Initial amount to be charged. This overrides the charge amount defined for the associated billing plan. The override applies only to this subscription.\\nIf you override the price, any later changes to the plan's price are not applied to this subscription.\",\n    \"12-0\": \"`authorized-by-shopper`\",\n    \"12-1\": \"*boolean*\",\n    \"12-2\": \"**Required** for SEPA Direct Debit\\n\\n*Create Subscription requests only*\",\n    \"12-3\": \"Value must be `true`.\\n\\nPass this parameter to indicate that you have obtained the shopper's authorization of the [SEPA Direct Debit mandate](/docs/sepa-direct-debit#section-step-1-collect-a-mandate-acceptance-from-your-shopper).\",\n    \"6-0\": \"`descriptor-phone-number`\",\n    \"6-1\": \"*string*\",\n    \"6-2\": \"Optional\",\n    \"6-3\": \"Merchant's support phone number that appears on the shopper's bank statement. Maximum 20 characters.\",\n    \"15-0\": \"`level-3-data`\",\n    \"15-1\": \"container\",\n    \"15-2\": \"Optional\",\n    \"15-3\": \"Container of [level-3-data](doc:level-3-data) properties.\",\n    \"16-0\": \"`three-d-secure`\",\n    \"16-1\": \"container\",\n    \"16-2\": \"Optional\",\n    \"16-3\": \"Container of [three-d-secure](doc:three-d-secure) properties.\",\n    \"17-0\": \"`transaction-order-source`\",\n    \"17-1\": \"*string*\",\n    \"17-2\": \"Optional\",\n    \"17-3\": \"Identifies the order type.<br />The only option is `MOTO` &nbsp;(**M**ail **O**rder **T**elephone **O**rder). <br />Any other option is ignored.\"\n  },\n  \"cols\": 4,\n  \"rows\": 18\n}\n[/block]\n###Response\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Property Name\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Required\",\n    \"1-0\": \"`plan-id`\",\n    \"1-1\": \"*integer*\",\n    \"h-3\": \"Description\",\n    \"1-3\": \"ID of the billing [plan](doc:plan) associated with this subscription.\",\n    \"h-4\": \"Description\",\n    \"1-2\": \"ID of the billing [plan](doc:plan) associated with this subscription.\",\n    \"18-0\": \"`payment-source`\",\n    \"18-1\": \"container\",\n    \"18-3\": \"Container of [payment-source](doc:payment-source) properties.\",\n    \"18-2\": \"Container of [payment-source](doc:payment-source) properties.\",\n    \"20-0\": \"`fraud-result-info`\",\n    \"20-1\": \"container\",\n    \"20-2\": \"*Create Subscription response only*\\n\\nContainer of [fraud-result-info](doc:fraud-result-info) properties.\",\n    \"20-3\": \"Container of [transaction-fraud-info](doc:transaction-fraud-info) properties.\",\n    \"19-0\": \"`charge`\",\n    \"19-2\": \"*Create Subscription response only*\\n\\nContainer of [charge](doc:charge) properties.\",\n    \"19-3\": \"ID of an existing vaulted shopper.\",\n    \"19-1\": \"container\",\n    \"0-0\": \"`subscription-id`\",\n    \"0-3\": \"\",\n    \"0-1\": \"*integer*\",\n    \"0-2\": \"BlueSnap identifier for the subscription.\",\n    \"2-0\": \"`vaulted-shopper-id`\",\n    \"2-1\": \"*integer*\",\n    \"2-2\": \"ID of an existing vaulted shopper.\",\n    \"17-0\": \"`payer-info`\",\n    \"17-1\": \"container\",\n    \"17-2\": \"Container of [payer-info](doc:payer-info) properties.\",\n    \"3-0\": \"`status`\",\n    \"3-1\": \"*string*\",\n    \"3-2\": \"Possible values:\\n`ACTIVE`\\n`CANCELED`\\n`SUSPENDED`\\n`FINISHED` (the subscription reached the plan's `max-number-of-charges` limit)\",\n    \"4-0\": \"`quantity`\",\n    \"4-1\": \"*integer*\",\n    \"4-2\": \"Quantity to apply to the subscription.\\nDefault is `1`.\",\n    \"5-0\": \"`soft-descriptor`\",\n    \"5-1\": \"*string*\",\n    \"5-2\": \"Description of the transaction, which appears on the shopper's credit card statement.\",\n    \"7-0\": \"`charge-frequency`\",\n    \"7-1\": \"*string*\",\n    \"7-2\": \"Possible values:\\n`ONCE`\\n`DAILY`\\n`WEEKLY`\\n`EVERY 2 WEEKS`\\n`MONTHLY`\\n`EVERY 2 MONTHS`\\n`QUARTERLY`\\n`EVERY 6 MONTHS`\\n`ANNUALLY`\\n`EVERY 2 YEARS`\\n`EVERY 3 YEARS`\",\n    \"8-0\": \"`trial-period-days`\",\n    \"8-1\": \"*integer*\",\n    \"8-2\": \"Number of days in the trial period.\\nFor example: `14`\",\n    \"10-0\": \"`recurring-charge-amount`\",\n    \"10-1\": \"*decimal*\",\n    \"10-2\": \"Recurring amount to be charged.\\nFor example: `29.99`\",\n    \"11-0\": \"`override-recurring-charge-amount`\",\n    \"11-1\": \"*decimal*\",\n    \"11-2\": \"Recurring amount to be charged. This overrides the charge amount defined for the associated billing plan.  The override applies only to this subscription.\",\n    \"12-0\": \"`currency`\",\n    \"12-1\": \"*string*\",\n    \"12-2\": \"Currency code (ISO 4217) of the amount to be charged. Refer to [Currency codes](/docs/currency-codes).\",\n    \"13-0\": \"`initial-charge-amount`\",\n    \"13-1\": \"*decimal*\",\n    \"13-2\": \"Amount of the initial charge.\\nFor example: `99.00`\",\n    \"9-0\": \"`override-trial-period-days`\",\n    \"9-1\": \"*integer*\",\n    \"9-2\": \"Number of days in the trial period. This overrides the trial period defined for the associated billing plan. The override applies only to this subscription.\",\n    \"14-0\": \"`override-initial-charge-amount`\",\n    \"14-1\": \"*decimal*\",\n    \"14-2\": \"Initial amount to be charged. This overrides the charge amount defined for the associated billing plan. The override applies only to this subscription.\\nIf you override the price, any later changes to the plan's price are not applied to this subscription.\",\n    \"15-0\": \"`auto-renew`\",\n    \"15-1\": \"*boolean*\",\n    \"15-2\": \"Determines whether the subscription automatically continues, or expires at the end of the current period.\",\n    \"16-0\": \"`next-charge-date`\",\n    \"16-1\": \"*string*\",\n    \"16-2\": \"*Appears only if subscription is ACTIVE*\\nNext charge date.\\nFormat: yyyy-mm-dd\",\n    \"6-0\": \"`descriptor-phone-number`\",\n    \"6-1\": \"*string*\",\n    \"6-2\": \"Description of the transaction, which appears on the shopper's credit card statement.\",\n    \"21-0\": \"`level-3-data`\",\n    \"21-1\": \"container\",\n    \"21-2\": \"Container of [level-3-data](doc:level-3-data) properties.\",\n    \"22-0\": \"`three-d-secure`\",\n    \"22-1\": \"container\",\n    \"22-2\": \"Container of [three-d-secure](doc:three-d-secure) properties.\",\n    \"23-2\": \"Identifies if the transaction is a regularly scheduled event.\\n\\nPossible values:\\n`true`\\n`false` (default)\\n\\nRefer to [Card on File Guide](doc:card-on-file-guide).\",\n    \"23-0\": \"`scheduled`\",\n    \"23-1\": \"*boolean*\"\n  },\n  \"cols\": 3,\n  \"rows\": 24\n}\n[/block]","excerpt":"Contains information about a specific subscription","slug":"recurring-subscription","type":"basic","title":"recurring-subscription"}