{"_id":"572be26cc310640e008f623d","project":"55dd0853d2d97337001800e2","version":{"_id":"55de36ec9067202b00de0015","__v":33,"project":"55dd0853d2d97337001800e2","createdAt":"2015-08-26T22:00:12.384Z","releaseDate":"2015-08-26T22:00:12.383Z","categories":["55de36ed9067202b00de0016","55de36ed9067202b00de0017","55de36ed9067202b00de0018","55df7dcd437b3f0d004ba204","55e4e014177b6e0d00333141","55e4e01fe252ac0d00303a99","55e4e05240cda60d003bad67","55e4e070177b6e0d00333142","55e4e0753325e60d007fbee6","55e4e0803325e60d007fbee7","55e4e086177b6e0d00333143","55e4e0a1177b6e0d00333144","55e4e0aa3325e60d007fbee8","55e4e0b140cda60d003bad6b","55e4e0bae252ac0d00303a9d","55e4e0c5177b6e0d00333145","55e4e0ee3325e60d007fbeea","55e4e0fae252ac0d00303a9e","55e4e100177b6e0d00333147","55f85c8ba3271b0d00498d55","56092e1ac5cff70d007d0131","564b64a3ee12850d0095866e","564b64b5791099170071e9ea","565cd0bfd18ae50d007183d8","565f5f5d6bafd40d0030a063","565f790d6bafd40d0030a09f","56611c464851190d003f9f5d","56637d5b7988ab0d00d0522e","56637d687988ab0d00d0522f","567835df6928b40d009dd650","56e59c043c29b117008dae5b","5704013559c5190e000ab646","572be252de40590e00026934","58af1bf6ebd7370f0078ba09","5cdad81d912ece0039e9a939"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"3.0.0","version":"3.0"},"category":{"_id":"572be252de40590e00026934","project":"55dd0853d2d97337001800e2","version":"55de36ec9067202b00de0015","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2016-05-06T00:16:18.383Z","from_sync":false,"order":5,"slug":"billing-portal","title":"Billing Portal"},"user":"55dd080d0efd5821000d53b3","parentDoc":null,"__v":9,"githubsync":"","updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-05-06T00:16:44.844Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":0,"body":"The Billing Portal allows Merchant Customers to collect payment information from their Payer Customers using a hosted version of checkout.\n\nThe Billing Portal's primary use cases are situations where the environment from which a payment, payment method or scheduled payment needs to be collected, is not an active website.\n\nExample use cases are payment or schedule buttons in an HTML email or PDF document.\n[block:callout]\n{\n  \"type\": \"success\",\n  \"title\": \"Billing Portal Unified Resource Locator (URL)\",\n  \"body\": \"The Billing Portal URL supports the same parameters as the checkout Init object described in [Init Object Reference](doc:checkout-init-object). These parameters can be passed along with the URL in 2 GET parameter formats:\\n  * 1 parameter called \\\"init\\\" with a **URL encoded json formatted** value (See: [Init JSON Parameter](doc:portal-init-json-parameter) \\n  * multiple single value parameters named using a [Flattened Dot Notation Parameters](doc:portal-flattened-dot-notation-parameters)  representing the hierarchy inside the Init object.\"\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Billing Portal Base URL\",\n  \"body\": \"The Base URL for loading the **Production** Billing Portal is https://api.paystand.com/v3/plugins/paystand/checkout\"\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"https://api.paystand.co/v3/plugins/paystand/checkout\",\n      \"language\": \"http\",\n      \"name\": \"Sandbox Base Url\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"https://api.paystand.co/v3/plugins/paystand/checkout?init={\\\"publishableKey\\\":\\\"bkba5nienlzbnb6ub2chmcsp\\\", \\\"payment\\\": {\\\"amount\\\": \\\"1.00\\\"}, \\\"currency\\\": \\\"USD\\\"}\",\n      \"language\": \"http\",\n      \"name\": \"Init JSON Parameter\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"https://api.paystand.co/v3/plugins/paystand/checkout?k=bkba5nienlzbnb6ub2chmcsp&p.a=1.00&c=USD\",\n      \"language\": \"http\",\n      \"name\": \"Flattened Dot Notation Parameters\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"danger\",\n  \"title\": \"Required Fields\",\n  \"body\": \"Whether using dot notation or a single init parameter, each Billing Portal URL must specify at a minimum publishableKey (k) and currency (c).  See [Init Object Reference](doc:checkout-init-object) and [Scheduled Payments](doc:checkout-scheduled-payments)  for details.\"\n}\n[/block]","excerpt":"The Billing Portal loads a prepopulated checkout from a simple URL","slug":"portal-introduction","type":"basic","title":"Introduction"}

Introduction

The Billing Portal loads a prepopulated checkout from a simple URL

The Billing Portal allows Merchant Customers to collect payment information from their Payer Customers using a hosted version of checkout. The Billing Portal's primary use cases are situations where the environment from which a payment, payment method or scheduled payment needs to be collected, is not an active website. Example use cases are payment or schedule buttons in an HTML email or PDF document. [block:callout] { "type": "success", "title": "Billing Portal Unified Resource Locator (URL)", "body": "The Billing Portal URL supports the same parameters as the checkout Init object described in [Init Object Reference](doc:checkout-init-object). These parameters can be passed along with the URL in 2 GET parameter formats:\n * 1 parameter called \"init\" with a **URL encoded json formatted** value (See: [Init JSON Parameter](doc:portal-init-json-parameter) \n * multiple single value parameters named using a [Flattened Dot Notation Parameters](doc:portal-flattened-dot-notation-parameters) representing the hierarchy inside the Init object." } [/block] [block:callout] { "type": "info", "title": "Billing Portal Base URL", "body": "The Base URL for loading the **Production** Billing Portal is https://api.paystand.com/v3/plugins/paystand/checkout" } [/block] [block:code] { "codes": [ { "code": "https://api.paystand.co/v3/plugins/paystand/checkout", "language": "http", "name": "Sandbox Base Url" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "https://api.paystand.co/v3/plugins/paystand/checkout?init={\"publishableKey\":\"bkba5nienlzbnb6ub2chmcsp\", \"payment\": {\"amount\": \"1.00\"}, \"currency\": \"USD\"}", "language": "http", "name": "Init JSON Parameter" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "https://api.paystand.co/v3/plugins/paystand/checkout?k=bkba5nienlzbnb6ub2chmcsp&p.a=1.00&c=USD", "language": "http", "name": "Flattened Dot Notation Parameters" } ], "sidebar": true } [/block] [block:callout] { "type": "danger", "title": "Required Fields", "body": "Whether using dot notation or a single init parameter, each Billing Portal URL must specify at a minimum publishableKey (k) and currency (c). See [Init Object Reference](doc:checkout-init-object) and [Scheduled Payments](doc:checkout-scheduled-payments) for details." } [/block]