{"_id":"59cc3055235d480010a19544","category":{"_id":"59cc3054235d480010a1952d","version":"59cc3054235d480010a19527","project":"54cc14d03be4370d0082ac5d","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-01-30T23:49:07.487Z","from_sync":false,"order":5,"slug":"managed-billing","title":"Managed Billing"},"user":"54595f39df560c0800b40fc0","project":"54cc14d03be4370d0082ac5d","parentDoc":null,"version":{"_id":"59cc3054235d480010a19527","project":"54cc14d03be4370d0082ac5d","__v":1,"createdAt":"2017-09-27T23:12:20.008Z","releaseDate":"2017-09-27T23:12:20.008Z","categories":["59cc3054235d480010a19528","59cc3054235d480010a19529","59cc3054235d480010a1952a","59cc3054235d480010a1952b","59cc3054235d480010a1952c","59cc3054235d480010a1952d","59cc3054235d480010a1952e","59cc3054235d480010a1952f","59cc3054235d480010a19530"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.9.0","version":"1.9.0"},"githubsync":"","__v":0,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-01-30T23:50:55.624Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":0,"body":"Hosted Checkout Retail allows you to create Recurring Billing Plans so that you can automatically bill your customers using simple rules on a regular basis.\n\nTo create Billing Subscriptions for your customers, you first need to create a Plan that defines the rules for a Subscription.\n\nTo create a Plan, first select Plans from the Billing Tab at the top of the Hosted Checkout Retail interface:\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/62pbyJYTtKmrFzaJnpnQ_Tab%20-%20Plans.png\",\n        \"Tab - Plans.png\",\n        \"1140\",\n        \"230\",\n        \"#1d1f23\",\n        \"\"\n      ],\n      \"caption\": \"Plans Tab\"\n    }\n  ]\n}\n[/block]\nYou will now see your Plans View. Click the \"New\" button in the top right corner to create a new Plan:\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/gRPz8r0kS4u1jcyBPs7Q_Plans%20-%20New%20Plan%20Dialog%20-%20Empty.png\",\n        \"Plans - New Plan Dialog - Empty.png\",\n        \"1158\",\n        \"1216\",\n        \"#5ba3a3\",\n        \"\"\n      ],\n      \"caption\": \"New Plan Dialog - Empty\"\n    }\n  ]\n}\n[/block]\nYou will now see the New Plan Dialog. New Plans are defined by providing a simple but powerful set of rules for how to process subscriptions.\n\nA Plan has the following attributes:\n* Name\n* Type: Prepaid or Postpaid\n  * Prepaid plans bill customers at the start of each upcoming service Interval.\n  * Postpaid plans bill customers at the end of each service Interval.\n* Number of Intervals\n  * This defines the number of times that a Customer is billed when signed up for a Subscription using this Plan\n* Amount\n  * The amount to be billed for each Interval or Instalment\n* Trial Period\n  * A period before the first billing occurs. Subscriptions that are canceled during the trial period will never be billed.\n\nWe will create a Prepaid Plan that bills $29.00 every month, with a 15 day trial period.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/n0WxBPDDRwmfbRGf8NDP_Plans%20-%20New%20Plan%20Dialog%20-%20Details%20Entered.png\",\n        \"Plans - New Plan Dialog - Details Entered.png\",\n        \"1160\",\n        \"1214\",\n        \"#63a2a2\",\n        \"\"\n      ],\n      \"caption\": \"New Plan Dialog - Details Entered\"\n    }\n  ]\n}\n[/block]\nWhen you have entered this info, click the Create button in the lower right of the Dialog to proceed.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/Cr5n8vLWSH6beI1LJPJF_Plans%20-%20Plans%20View.png\",\n        \"Plans - Plans View.png\",\n        \"2502\",\n        \"536\",\n        \"#6ca1a1\",\n        \"\"\n      ],\n      \"caption\": \"Plans View\"\n    }\n  ]\n}\n[/block]\nYou will now see your newly created Plan in the Plans View list. Click the Plan \"Monthly Billing - Promotional\" to review the Plan's details.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/hA1wvRNqQtKycIFcckcx_Plans%20-%20Detail%20View.png\",\n        \"Plans - Detail View.png\",\n        \"2496\",\n        \"668\",\n        \"#64a4a4\",\n        \"\"\n      ],\n      \"caption\": \"Plan Detail View\"\n    }\n  ]\n}\n[/block]\nYou will now see the Plan's Detail View, indicating the Plan parameters we specified. This Plan is now available for use in Customer Subscriptions.\n[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"To learn how to create a new Subscription for a Customer using this Plan, read Creating Customers from Transactions, read [Setting up Recurring Billing for a Customer](doc:setting-up-recurring-billing-for-a-customer).\"\n}\n[/block]","excerpt":"","slug":"creating-a-recurring-billing-plan","type":"basic","title":"Creating a Recurring Billing Plan"}

Creating a Recurring Billing Plan


Hosted Checkout Retail allows you to create Recurring Billing Plans so that you can automatically bill your customers using simple rules on a regular basis. To create Billing Subscriptions for your customers, you first need to create a Plan that defines the rules for a Subscription. To create a Plan, first select Plans from the Billing Tab at the top of the Hosted Checkout Retail interface: [block:image] { "images": [ { "image": [ "https://files.readme.io/62pbyJYTtKmrFzaJnpnQ_Tab%20-%20Plans.png", "Tab - Plans.png", "1140", "230", "#1d1f23", "" ], "caption": "Plans Tab" } ] } [/block] You will now see your Plans View. Click the "New" button in the top right corner to create a new Plan: [block:image] { "images": [ { "image": [ "https://files.readme.io/gRPz8r0kS4u1jcyBPs7Q_Plans%20-%20New%20Plan%20Dialog%20-%20Empty.png", "Plans - New Plan Dialog - Empty.png", "1158", "1216", "#5ba3a3", "" ], "caption": "New Plan Dialog - Empty" } ] } [/block] You will now see the New Plan Dialog. New Plans are defined by providing a simple but powerful set of rules for how to process subscriptions. A Plan has the following attributes: * Name * Type: Prepaid or Postpaid * Prepaid plans bill customers at the start of each upcoming service Interval. * Postpaid plans bill customers at the end of each service Interval. * Number of Intervals * This defines the number of times that a Customer is billed when signed up for a Subscription using this Plan * Amount * The amount to be billed for each Interval or Instalment * Trial Period * A period before the first billing occurs. Subscriptions that are canceled during the trial period will never be billed. We will create a Prepaid Plan that bills $29.00 every month, with a 15 day trial period. [block:image] { "images": [ { "image": [ "https://files.readme.io/n0WxBPDDRwmfbRGf8NDP_Plans%20-%20New%20Plan%20Dialog%20-%20Details%20Entered.png", "Plans - New Plan Dialog - Details Entered.png", "1160", "1214", "#63a2a2", "" ], "caption": "New Plan Dialog - Details Entered" } ] } [/block] When you have entered this info, click the Create button in the lower right of the Dialog to proceed. [block:image] { "images": [ { "image": [ "https://files.readme.io/Cr5n8vLWSH6beI1LJPJF_Plans%20-%20Plans%20View.png", "Plans - Plans View.png", "2502", "536", "#6ca1a1", "" ], "caption": "Plans View" } ] } [/block] You will now see your newly created Plan in the Plans View list. Click the Plan "Monthly Billing - Promotional" to review the Plan's details. [block:image] { "images": [ { "image": [ "https://files.readme.io/hA1wvRNqQtKycIFcckcx_Plans%20-%20Detail%20View.png", "Plans - Detail View.png", "2496", "668", "#64a4a4", "" ], "caption": "Plan Detail View" } ] } [/block] You will now see the Plan's Detail View, indicating the Plan parameters we specified. This Plan is now available for use in Customer Subscriptions. [block:callout] { "type": "info", "body": "To learn how to create a new Subscription for a Customer using this Plan, read Creating Customers from Transactions, read [Setting up Recurring Billing for a Customer](doc:setting-up-recurring-billing-for-a-customer)." } [/block]