{ "uuid": "53a832f9-e85e-44b5-af03-2ef26110686d", "status": "awaiting_gateway", "status_label": "Waiting for payment", "progress_message": "Opening the payment form…", "last_error_code": null, "description": "Account credit · 25.00 USD", "line_items": [ { "label": "Account credit", "amount": "25.00 USD" }, { "label": "Added to your balance once the payment clears", "amount": null } ], "amount": "25.00", "currency": "USD", "total_display": "25.00 USD", "option": "paddle_once", "options": [ { "value": "paddle_once", "label": "Credit Card or PayPal", "shortLabel": "Paddle", "description": "Pay once by card, PayPal or wallet. Nothing is stored and nothing renews by itself.", "provider": "paddle", "providerName": "Paddle", "recurring": false }, { "value": "btcpay_once", "label": "Cryptocurrency (one-time payment)", "shortLabel": "BTCPay", "description": "Pay once in Bitcoin or another supported coin. Confirmations can take a few minutes.", "provider": "btcpay", "providerName": "BTCPay Server", "recurring": false } ], "merchant_of_record": true, "notes": null, "promo_code": null, "redirect_url": null, "paddle": { "transaction_id": "txn_01j8m4x7c2k9q5v3r6t1w8y0za", "client_token": "live_7d0b6c1f3e9a24c58b71e2f4d93", "environment": "production" }, "return_path": "/add-funds", "expires_at": "2026-09-14T17:12:09+00:00", "settled_at": null, "created_at": "2026-09-14T16:42:09+00:00", "is_live": true, "can_choose": false, "is_settling": false, "paypal_account": "Paypal account", "enabled": true}
{
"message": "Unauthenticated."
}
{
"message": "This API key is not allowed to do that in this team. It needs the \"snapshot.delete\" permission."
}
{
"message": "Not found."
}
{
"message": "The name field is required.",
"errors": {}
}
{
"message": "Too Many Attempts."
}
Checkout
Start a checkout payment
Overview
Selects a payment option and returns the next payment step. Send option from the checkout’s options. The amount charged is read from the invoice again, and a payment whose amount changed since the checkout opened is refused. notes and promo_code are optional.
This request does not take payment. The response includes either a redirect_url for the browser or details for opening an embedded payment widget. Rate limits apply per account, not per IP address.
Permissions
Requires the billing.purchase (Make purchases) permission for the selected team. Resources outside that team return 404.
Your API key, sent as a bearer token. Create one in the control panel under API Keys, give it only the permissions the integration needs, and copy it when it is created. It cannot be shown again. Each key is restricted to one owned team. The key determines the team for every request.
[ { "value": "paddle_once", "label": "Credit Card or PayPal", "shortLabel": "Paddle", "description": "Pay once by card, PayPal or wallet. Nothing is stored and nothing renews by itself.", "provider": "paddle", "providerName": "Paddle", "recurring": false }, { "value": "btcpay_once", "label": "Cryptocurrency (one-time payment)", "shortLabel": "BTCPay", "description": "Pay once in Bitcoin or another supported coin. Confirmations can take a few minutes.", "provider": "btcpay", "providerName": "BTCPay Server", "recurring": false } ]
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Advin Servers","colors":{"primary":"#232323","light":"#ffffff","dark":"#232323"},"logo":{"light":"https://mintcdn.com/advinservers/hsoR78mplm26jwSe/logo/light.svg?fit=max\u0026auto=format\u0026n=hsoR78mplm26jwSe\u0026q=85\u0026s=5adfd787faa2746d42842a3dbe9d5c55","dark":"https://mintcdn.com/advinservers/pwCfGukIkzeLYqrm/logo/dark.svg?fit=max\u0026auto=format\u0026n=pwCfGukIkzeLYqrm\u0026q=85\u0026s=97d478977cc103da1d2432e03943b388"},"favicon":"https://mintcdn.com/advinservers/MD6yusifmHDEhuzq/logo/logo.jpg?fit=max\u0026auto=format\u0026n=MD6yusifmHDEhuzq\u0026q=85\u0026s=4a842dcaf66f28bd660d8b3448d9ca0c","appearance":{"default":"dark","strict":false},"background":{"color":{"dark":"#0d0d0d"}},"navbar":{"links":[{"href":"https://clients.advinservers.com/contact.php","label":"Support"}],"primary":{"type":"button","label":"Home","href":"https://clients.advinservers.com"}},"footer":{"socials":{"twitter":"https://x.com/@advinservers","linkedin":"https://www.linkedin.com/company/98505920","facebook":"https://www.facebook.com/profile.php?id=61554233398872","instagram":"https://www.instagram.com/advin_servers"}},"fonts":{"family":"Geist"},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"Console","icon":"terminal","href":"https://console.advinservers.com"},{"anchor":"Network Status","icon":"signal-bars","href":"https://status.advinservers.com"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"advinservers","hasAudioNarration":false,"actualSubdomain":"advinservers","customDomains":["docs.advinservers.com"],"gitSource":{"type":"github","owner":"advin-servers","repo":"documentation","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"entitlements":{},"buildId":"6af2def2a8d5ba2dc2cd4074","clientVersion":"0.0.4102","searchFilterCounts":[{"language":"default","tag":"API","count":219},{"language":"default","tag":"Endpoints","count":218},{"language":"default","tag":"Console","count":30},{"language":"default","tag":"Billing","count":24},{"language":"default","tag":"Servers","count":19},{"language":"default","tag":"General","count":15},{"language":"default","tag":"Bandwidth","count":15},{"language":"default","tag":"Firewall groups","count":15},{"language":"default","tag":"Server settings","count":15},{"language":"default","tag":"Snapshots","count":15}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":true},"customCss":[{"filePath":"style.css","content":".dark{--background-dark: 13 13 13;--gray-50: 237 237 237;--gray-100: 237 237 237;--gray-200: 237 237 237;--gray-300: 204 204 204;--gray-400: 161 161 161;--gray-500: 138 138 138;--gray-600: 52 52 52;--gray-700: 44 44 44;--gray-800: 30 30 30;--gray-900: 22 22 22;--gray-950: 15 15 15;--primary-dark: 212 212 212}.dark #navbar>div:first-child{background-color:#0f0f0f;border-color:#343434}.dark #search-bar-entry,.dark #search-bar-entry-mobile{background-color:#0f0f0f;border-color:#404040;color:#a1a1a1}.dark #topbar-cta-button a>div,.dark #topbar-cta-button a>div>*{color:#0d0d0d}.dark #sidebar [aria-current=\"page\"],.dark #sidebar .bg-primary\\/10{background-color:#1e1e1e;color:#ededed}.dark .code-block{background-color:#0f0f0f;border-color:#343434}.dark .prose :not(pre)>code{background-color:#161616;border-color:#343434;color:#ededed}.dark .card,.dark [data-component-part=\"card\"],.dark .accordion,.dark [data-component-part=\"accordion\"]{background-color:#0f0f0f;border-color:#343434}.dark .callout{--callout-rgb: 59 130 246;--callout-text: 147 197 253;--callout-icon: 96 165 250;--callout-bg-alpha: 0.07;--callout-border-alpha: 0.25;background-color:rgb(var(--callout-rgb) / var(--callout-bg-alpha));border-color:rgb(var(--callout-rgb) / var(--callout-border-alpha));color:rgb(var(--callout-text) / 0.8)}.dark .callout [data-component-part=\"callout-icon\"],.dark .callout [data-component-part=\"callout-icon\"] svg{color:rgb(var(--callout-icon))}.dark .callout [data-component-part=\"callout-content\"],.dark .callout [data-component-part=\"callout-content\"] :is(p,li,strong,a,span){color:rgb(var(--callout-text) / 0.8)}.dark .callout[data-callout-type=\"tip\"],.dark .callout[data-callout-type=\"check\"]{--callout-rgb: 22 163 74;--callout-text: 134 239 172;--callout-icon: 74 222 128}.dark .callout[data-callout-type=\"warning\"]{--callout-rgb: 228 158 34;--callout-text: 247 185 85;--callout-icon: 247 185 85;--callout-bg-alpha: 0.09;--callout-border-alpha: 0.3}.dark .callout[data-callout-type=\"danger\"]{--callout-rgb: 189 65 63;--callout-text: 211 117 115;--callout-icon: 211 117 115}.dark .mdx-content img{border:1px solid #343434}"}],"page":{"pagePath":"api-reference/checkout/start-a-checkout-payment","slug":"/api-reference/checkout/start-a-checkout-payment","pageMetadata":{"title":"Start a checkout payment","description":"### Overview\n\nSelects a payment option and returns the next payment step. Send `option` from the checkout's options. The amount charged is read from the invoice again, and a payment whose amount changed since the checkout opened is refused. `notes` and `promo_code` are optional.\n\nThis request does not take payment. The response includes either a `redirect_url` for the browser or details for opening an embedded payment widget. Rate limits apply per account, not per IP address.\n\n### Permissions\n\nRequires the `billing.purchase` (Make purchases) permission for the selected team. Resources outside that team return 404.","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json post /checkout/{uuid}/start","href":"/api-reference/checkout/start-a-checkout-payment","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n h3: \"h3\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsx(_components.h3, {\n children: \"Overview\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"Selects a payment option and returns the next payment step. Send \", _jsx(_components.code, {\n children: \"option\"\n }), \" from the checkout’s options. The amount charged is read from the invoice again, and a payment whose amount changed since the checkout opened is refused. \", _jsx(_components.code, {\n children: \"notes\"\n }), \" and \", _jsx(_components.code, {\n children: \"promo_code\"\n }), \" are optional.\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"This request does not take payment. The response includes either a \", _jsx(_components.code, {\n children: \"redirect_url\"\n }), \" for the browser or details for opening an embedded payment widget. Rate limits apply per account, not per IP address.\"]\n }), \"\\n\", _jsx(_components.h3, {\n children: \"Permissions\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"Requires the \", _jsx(_components.code, {\n children: \"billing.purchase\"\n }), \" (Make purchases) permission for the selected team. Resources outside that team return 404.\"]\n })]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Start a checkout payment","description":"### Overview\n\nSelects a payment option and returns the next payment step. Send `option` from the checkout's options. The amount charged is read from the invoice again, and a payment whose amount changed since the checkout opened is refused. `notes` and `promo_code` are optional.\n\nThis request does not take payment. The response includes either a `redirect_url` for the browser or details for opening an embedded payment widget. Rate limits apply per account, not per IP address.\n\n### Permissions\n\nRequires the `billing.purchase` (Make purchases) permission for the selected team. Resources outside that team return 404.","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json post /checkout/{uuid}/start","href":"/api-reference/checkout/start-a-checkout-payment","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"client.checkout.start","description":"### Overview\n\nSelects a payment option and returns the next payment step. Send `option` from the checkout's options. The amount charged is read from the invoice again, and a payment whose amount changed since the checkout opened is refused. `notes` and `promo_code` are optional.\n\nThis request does not take payment. The response includes either a `redirect_url` for the browser or details for opening an embedded payment widget. Rate limits apply per account, not per IP address.\n\n### Permissions\n\nRequires the `billing.purchase` (Make purchases) permission for the selected team. Resources outside that team return 404.","summary":"Start a checkout payment","tags":["Checkout"],"parameters":["5ed18d29-e3df-40c3-a3a0-890a2350819a"],"requestBody":"afb65923-fdcf-46b1-935c-59d1ebcea47c","responses":{"200":"34c7f45d-4623-4f78-b0c3-98005f3c0f09","401":"c7cf0b8f-03ea-4395-97a7-79d6dd870fbd","403":"f65a1e33-4e52-48db-be19-220e783f1d40","404":"a28c6605-7129-4e9f-9876-3041699fc722","422":"bb410afc-3255-4fd8-9f02-589c1aa0751d","429":"b6e116bd-b4b9-4f21-a810-da0f47b490e3"},"method":"post","type":"path","servers":["49ace053-d2ae-45c8-8b5e-9b487eb81f6a"],"security":["f8b33b37-6c4c-4349-ac95-09bac911f9ea"],"path":"/checkout/{uuid}/start","baseUrlOptions":["https://console.advinservers.com/api/v1/client"],"title":"Start a checkout payment","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"5ed18d29-e3df-40c3-a3a0-890a2350819a":{"name":"uuid","in":"path","required":true,"description":"The uuid ID.","schema":{"type":"string","examples":["53a832f9-e85e-44b5-af03-2ef26110686d"],"isRequired":true,"description":"The uuid ID.","uniqueKey":"","typeLabel":"string"},"example":"53a832f9-e85e-44b5-af03-2ef26110686d"}},"requestBody":{"description":"Send a JSON object containing the fields below. Required fields are marked in the schema.","required":true,"content":{"application/json":{"schema":{"type":"object","title":"StartCheckoutRequest","required":["option"],"example":{"option":"paddle_once","notes":null,"promo_code":null},"properties":{"option":{"type":"string","description":"The value of `option`.","enum":["paddle_once","paddle_subscription","stripe_once","stripe_subscription","paypal_once","paypal_subscription","btcpay_once","nowpayments_once"],"isRequired":true,"uniqueKey":"option","typeLabel":"enum\u003cstring>"},"notes":{"oneOf":[{"type":"string","description":"Optional notes about the request.","maxLength":2000,"uniqueKey":"notes.oneOf.0","typeLabel":"string"},{"type":"null","description":"Optional notes about the request.","maxLength":2000,"uniqueKey":"notes.oneOf.1","typeLabel":"null"}],"uniqueKey":"notes","typeLabel":"string | null"},"promo_code":{"oneOf":[{"type":"string","description":"The value of `promo_code`.","pattern":"^[A-Za-z0-9_-]+$","maxLength":64,"uniqueKey":"promo_code.oneOf.0","typeLabel":"string"},{"type":"null","description":"The value of `promo_code`.","pattern":"^[A-Za-z0-9_-]+$","maxLength":64,"uniqueKey":"promo_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"promo_code","typeLabel":"string | null"},"paypal_account":{"oneOf":[{"type":"string","format":"uuid","description":"The value of `paypal_account`.","uniqueKey":"paypal_account.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","format":"uuid","description":"The value of `paypal_account`.","uniqueKey":"paypal_account.oneOf.1","typeLabel":"null"}],"uniqueKey":"paypal_account","typeLabel":"string\u003cuuid> | null"}},"uniqueKey":"","typeLabel":"StartCheckoutRequest · object"},"examples":{"Example":{"title":"Example","value":{"option":"paddle_once","notes":null,"promo_code":null}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"34c7f45d-4623-4f78-b0c3-98005f3c0f09":{"description":"The record, as a JSON object. There is no envelope.","content":{"application/json":{"schema":{"type":"object","title":"CheckoutData","description":"A checkout and its available payment options.","required":["enabled","uuid","status","status_label","progress_message","last_error_code","description","line_items","amount","currency","total_display","option","options","merchant_of_record","notes","promo_code","redirect_url","paddle","return_path","expires_at","settled_at","created_at","is_live","can_choose","is_settling","paypal_account"],"example":{"uuid":"53a832f9-e85e-44b5-af03-2ef26110686d","status":"awaiting_gateway","status_label":"Waiting for payment","progress_message":"Opening the payment form…","last_error_code":null,"description":"Account credit · 25.00 USD","line_items":[{"label":"Account credit","amount":"25.00 USD"},{"label":"Added to your balance once the payment clears","amount":null}],"amount":"25.00","currency":"USD","total_display":"25.00 USD","option":"paddle_once","options":[{"value":"paddle_once","label":"Credit Card or PayPal","shortLabel":"Paddle","description":"Pay once by card, PayPal or wallet. Nothing is stored and nothing renews by itself.","provider":"paddle","providerName":"Paddle","recurring":false},{"value":"btcpay_once","label":"Cryptocurrency (one-time payment)","shortLabel":"BTCPay","description":"Pay once in Bitcoin or another supported coin. Confirmations can take a few minutes.","provider":"btcpay","providerName":"BTCPay Server","recurring":false}],"merchant_of_record":true,"notes":null,"promo_code":null,"redirect_url":null,"paddle":{"transaction_id":"txn_01j8m4x7c2k9q5v3r6t1w8y0za","client_token":"live_7d0b6c1f3e9a24c58b71e2f4d93","environment":"production"},"return_path":"/add-funds","expires_at":"2026-09-14T17:12:09+00:00","settled_at":null,"created_at":"2026-09-14T16:42:09+00:00","is_live":true,"can_choose":false,"is_settling":false,"paypal_account":"Paypal account","enabled":true},"properties":{"uuid":{"type":"string","description":"The uuid UUID.","examples":["53a832f9-e85e-44b5-af03-2ef26110686d"],"isRequired":true,"uniqueKey":"uuid","typeLabel":"string"},"status":{"type":"string","description":"The value of `status`.","enum":["draft","awaiting_gateway","charging","recording","paid","expired","cancelled"],"examples":["awaiting_gateway"],"isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"status_label":{"type":"string","description":"The status in the customer's words, written once on the enum.","examples":["Waiting for payment"],"isRequired":true,"uniqueKey":"status_label","typeLabel":"string"},"progress_message":{"oneOf":[{"type":"string","description":"The value of `progress_message`.","examples":["Opening the payment form…"],"isRequired":true,"uniqueKey":"progress_message.oneOf.0","typeLabel":"string"},{"type":"null","description":"The value of `progress_message`.","examples":["Opening the payment form…"],"isRequired":true,"uniqueKey":"progress_message.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"progress_message","typeLabel":"string | null"},"last_error_code":{"oneOf":[{"type":"string","description":"The value of `last_error_code`.","examples":[null],"isRequired":true,"uniqueKey":"last_error_code.oneOf.0","typeLabel":"string"},{"type":"null","description":"The value of `last_error_code`.","examples":[null],"isRequired":true,"uniqueKey":"last_error_code.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"last_error_code","typeLabel":"string | null"},"description":{"type":"string","description":"What is being bought, or the invoice number when no name is available.","examples":["Account credit · 25.00 USD"],"isRequired":true,"uniqueKey":"description","typeLabel":"string"},"line_items":{"type":"array","description":"The value of `line_items`.","examples":[[{"label":"Account credit","amount":"25.00 USD"},{"label":"Added to your balance once the payment clears","amount":null}]],"items":{"type":"object","description":"One item in the checkout order summary.","examples":[{"label":"Account credit","amount":"25.00 USD"}],"properties":{"label":{"type":"string","description":"A short label shown to customers.","examples":["Account credit"],"isRequired":true,"uniqueKey":"line_items.items.[INDEX].label","typeLabel":"string"},"amount":{"oneOf":[{"type":"string","description":"The amount in the currency shown by `currency`.","examples":["25.00 USD"],"isRequired":true,"uniqueKey":"line_items.items.[INDEX].amount.oneOf.0","typeLabel":"string"},{"type":"null","description":"The amount in the currency shown by `currency`.","examples":["25.00 USD"],"isRequired":true,"uniqueKey":"line_items.items.[INDEX].amount.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"line_items.items.[INDEX].amount","typeLabel":"string | null"}},"required":["label","amount"],"title":"CheckoutLineItemData","uniqueKey":"line_items.items.[INDEX]","typeLabel":"CheckoutLineItemData · object"},"isRequired":true,"uniqueKey":"line_items","typeLabel":"CheckoutLineItemData · object[]"},"amount":{"type":"string","description":"The decimal string the row holds. Money is never a float here: this is the figure the customer is about to be charged.","examples":["25.00"],"isRequired":true,"uniqueKey":"amount","typeLabel":"string"},"currency":{"type":"string","description":"The three-letter currency code used for monetary amounts.","examples":["USD"],"isRequired":true,"uniqueKey":"currency","typeLabel":"string"},"total_display":{"type":"string","description":"The amount and its currency, rendered ready to print.","examples":["25.00 USD"],"isRequired":true,"uniqueKey":"total_display","typeLabel":"string"},"option":{"oneOf":[{"type":"string","description":"The value of `option`.","enum":["paddle_once","paddle_subscription","stripe_once","stripe_subscription","paypal_once","paypal_subscription","btcpay_once","nowpayments_once",null],"examples":["paddle_once"],"isRequired":true,"uniqueKey":"option.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"The value of `option`.","enum":["paddle_once","paddle_subscription","stripe_once","stripe_subscription","paypal_once","paypal_subscription","btcpay_once","nowpayments_once",null],"examples":["paddle_once"],"isRequired":true,"uniqueKey":"option.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"option","typeLabel":"enum\u003cstring> | null"},"options":{"type":"array","description":"The value of `options`.","examples":[[{"value":"paddle_once","label":"Credit Card or PayPal","shortLabel":"Paddle","description":"Pay once by card, PayPal or wallet. Nothing is stored and nothing renews by itself.","provider":"paddle","providerName":"Paddle","recurring":false},{"value":"btcpay_once","label":"Cryptocurrency (one-time payment)","shortLabel":"BTCPay","description":"Pay once in Bitcoin or another supported coin. Confirmations can take a few minutes.","provider":"btcpay","providerName":"BTCPay Server","recurring":false}]],"items":{"type":"object","description":"One way a purchase may be paid for.","examples":[{"value":"paddle_once","label":"Credit Card or PayPal","shortLabel":"Paddle","description":"Pay once by card, PayPal or wallet. Nothing is stored and nothing renews by itself.","provider":"paddle","providerName":"Paddle","recurring":false}],"properties":{"value":{"type":"string","description":"The enum's own value, which is what a start request sends back.","examples":["paddle_once"],"isRequired":true,"uniqueKey":"options.items.[INDEX].value","typeLabel":"string"},"label":{"type":"string","description":"A short label shown to customers.","examples":["Credit Card or PayPal"],"isRequired":true,"uniqueKey":"options.items.[INDEX].label","typeLabel":"string"},"shortLabel":{"type":"string","description":"What the picker prints once a choice has been made, where the full label is too long to sit on a button.","examples":["Paddle"],"isRequired":true,"uniqueKey":"options.items.[INDEX].shortLabel","typeLabel":"string"},"description":{"type":"string","description":"An optional description shown to customers.","examples":["Pay once by card, PayPal or wallet. Nothing is stored and nothing renews by itself."],"isRequired":true,"uniqueKey":"options.items.[INDEX].description","typeLabel":"string"},"provider":{"type":"string","description":"The value of `provider`.","examples":["paddle"],"isRequired":true,"uniqueKey":"options.items.[INDEX].provider","typeLabel":"string"},"providerName":{"type":"string","description":"The value of `provider_name`.","examples":["Paddle"],"isRequired":true,"uniqueKey":"options.items.[INDEX].providerName","typeLabel":"string"},"recurring":{"type":"boolean","description":"Whether choosing this hands the provider a standing schedule rather than taking one payment. Only ever offered where this invoice's amount is what falls due each cycle.","examples":[false],"isRequired":true,"uniqueKey":"options.items.[INDEX].recurring","typeLabel":"boolean"}},"required":["value","label","shortLabel","description","provider","providerName","recurring"],"title":"CheckoutPaymentOptionData","uniqueKey":"options.items.[INDEX]","typeLabel":"CheckoutPaymentOptionData · object"},"isRequired":true,"uniqueKey":"options","typeLabel":"CheckoutPaymentOptionData · object[]"},"merchant_of_record":{"type":"boolean","description":"The value of `merchant_of_record`.","examples":[true],"isRequired":true,"uniqueKey":"merchant_of_record","typeLabel":"boolean"},"notes":{"oneOf":[{"type":"string","description":"Optional notes about the request.","examples":[null],"isRequired":true,"uniqueKey":"notes.oneOf.0","typeLabel":"string"},{"type":"null","description":"Optional notes about the request.","examples":[null],"isRequired":true,"uniqueKey":"notes.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"notes","typeLabel":"string | null"},"promo_code":{"oneOf":[{"type":"string","description":"The value of `promo_code`.","examples":[null],"isRequired":true,"uniqueKey":"promo_code.oneOf.0","typeLabel":"string"},{"type":"null","description":"The value of `promo_code`.","examples":[null],"isRequired":true,"uniqueKey":"promo_code.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"promo_code","typeLabel":"string | null"},"redirect_url":{"oneOf":[{"type":"string","description":"The value of `redirect_url`.","examples":[null],"isRequired":true,"uniqueKey":"redirect_url.oneOf.0","typeLabel":"string"},{"type":"null","description":"The value of `redirect_url`.","examples":[null],"isRequired":true,"uniqueKey":"redirect_url.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"redirect_url","typeLabel":"string | null"},"paddle":{"oneOf":[{"type":"object","title":"CheckoutPaddleHandoffData","description":"The value of `paddle`.","required":["transaction_id","client_token","environment"],"example":{"transaction_id":"txn_01j8m4x7c2k9q5v3r6t1w8y0za","client_token":"live_7d0b6c1f3e9a24c58b71e2f4d93","environment":"production"},"properties":{"transaction_id":{"type":"string","description":"The transaction id ID.","examples":["txn_01j8m4x7c2k9q5v3r6t1w8y0za"],"isRequired":true,"uniqueKey":"paddle.oneOf.0.transaction_id","typeLabel":"string"},"client_token":{"type":"string","description":"The value of `client_token`.","examples":["live_7d0b6c1f3e9a24c58b71e2f4d93"],"isRequired":true,"uniqueKey":"paddle.oneOf.0.client_token","typeLabel":"string"},"environment":{"type":"string","description":"The value of `environment`.","examples":["production"],"isRequired":true,"uniqueKey":"paddle.oneOf.0.environment","typeLabel":"string"}},"isRequired":true,"uniqueKey":"paddle.oneOf.0","typeLabel":"CheckoutPaddleHandoffData · object"},{"type":"null","description":"The value of `paddle`.","example":{"transaction_id":"txn_01j8m4x7c2k9q5v3r6t1w8y0za","client_token":"live_7d0b6c1f3e9a24c58b71e2f4d93","environment":"production"},"isRequired":true,"uniqueKey":"paddle.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"paddle","typeLabel":"CheckoutPaddleHandoffData · object | null"},"return_path":{"oneOf":[{"type":"string","description":"The value of `return_path`.","examples":["/add-funds"],"isRequired":true,"uniqueKey":"return_path.oneOf.0","typeLabel":"string"},{"type":"null","description":"The value of `return_path`.","examples":["/add-funds"],"isRequired":true,"uniqueKey":"return_path.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"return_path","typeLabel":"string | null"},"expires_at":{"oneOf":[{"type":"string","description":"When this action or checkout expires, in UTC.","examples":["2026-09-14T17:12:09+00:00"],"isRequired":true,"uniqueKey":"expires_at.oneOf.0","typeLabel":"string"},{"type":"null","description":"When this action or checkout expires, in UTC.","examples":["2026-09-14T17:12:09+00:00"],"isRequired":true,"uniqueKey":"expires_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"expires_at","typeLabel":"string | null"},"settled_at":{"oneOf":[{"type":"string","description":"The date and time for settled at, in UTC.","examples":[null],"isRequired":true,"uniqueKey":"settled_at.oneOf.0","typeLabel":"string"},{"type":"null","description":"The date and time for settled at, in UTC.","examples":[null],"isRequired":true,"uniqueKey":"settled_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"settled_at","typeLabel":"string | null"},"created_at":{"oneOf":[{"type":"string","description":"The date and time for created at, in UTC.","examples":["2026-09-14T16:42:09+00:00"],"isRequired":true,"uniqueKey":"created_at.oneOf.0","typeLabel":"string"},{"type":"null","description":"The date and time for created at, in UTC.","examples":["2026-09-14T16:42:09+00:00"],"isRequired":true,"uniqueKey":"created_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"created_at","typeLabel":"string | null"},"is_live":{"type":"boolean","description":"Whether the checkout can still accept another payment attempt.","examples":[true],"isRequired":true,"uniqueKey":"is_live","typeLabel":"boolean"},"can_choose":{"type":"boolean","description":"Whether the customer can choose.","examples":[false],"isRequired":true,"uniqueKey":"can_choose","typeLabel":"boolean"},"is_settling":{"type":"boolean","description":"Whether the resource is settling.","examples":[false],"isRequired":true,"uniqueKey":"is_settling","typeLabel":"boolean"},"paypal_account":{"oneOf":[{"type":"string","description":"The saved PayPal account this attempt charges, by its `uuid`.","examples":["Paypal account"],"isRequired":true,"uniqueKey":"paypal_account.oneOf.0","typeLabel":"string"},{"type":"null","description":"The saved PayPal account this attempt charges, by its `uuid`.","examples":["Paypal account"],"isRequired":true,"uniqueKey":"paypal_account.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"paypal_account","typeLabel":"string | null"},"enabled":{"type":"boolean","description":"Whether the panel is taking payments at all.","examples":[true],"isRequired":true,"uniqueKey":"enabled","typeLabel":"boolean"}},"uniqueKey":"","typeLabel":"CheckoutData · object"},"examples":{"Example":{"title":"Example","value":{"uuid":"53a832f9-e85e-44b5-af03-2ef26110686d","status":"awaiting_gateway","status_label":"Waiting for payment","progress_message":"Opening the payment form…","last_error_code":null,"description":"Account credit · 25.00 USD","line_items":[{"label":"Account credit","amount":"25.00 USD"},{"label":"Added to your balance once the payment clears","amount":null}],"amount":"25.00","currency":"USD","total_display":"25.00 USD","option":"paddle_once","options":[{"value":"paddle_once","label":"Credit Card or PayPal","shortLabel":"Paddle","description":"Pay once by card, PayPal or wallet. Nothing is stored and nothing renews by itself.","provider":"paddle","providerName":"Paddle","recurring":false},{"value":"btcpay_once","label":"Cryptocurrency (one-time payment)","shortLabel":"BTCPay","description":"Pay once in Bitcoin or another supported coin. Confirmations can take a few minutes.","provider":"btcpay","providerName":"BTCPay Server","recurring":false}],"merchant_of_record":true,"notes":null,"promo_code":null,"redirect_url":null,"paddle":{"transaction_id":"txn_01j8m4x7c2k9q5v3r6t1w8y0za","client_token":"live_7d0b6c1f3e9a24c58b71e2f4d93","environment":"production"},"return_path":"/add-funds","expires_at":"2026-09-14T17:12:09+00:00","settled_at":null,"created_at":"2026-09-14T16:42:09+00:00","is_live":true,"can_choose":false,"is_settling":false,"paypal_account":"Paypal account","enabled":true}}},"exampleType":"generated"}},"exampleType":"generated"},"c7cf0b8f-03ea-4395-97a7-79d6dd870fbd":{"description":"The key was missing, malformed, revoked, or belongs to an account that no longer exists.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","examples":["Unauthenticated."],"isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"required":["message"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"Unauthenticated."}}},"exampleType":"generated"}},"exampleType":"generated"},"f65a1e33-4e52-48db-be19-220e783f1d40":{"description":"Access denied. Check the key's team, permissions and allowed IP addresses. Some actions, such as managing API keys, require a browser session. The response message explains the reason.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","examples":["This API key is not allowed to do that in this team. It needs the \"snapshot.delete\" permission."],"isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"required":["message"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"This API key is not allowed to do that in this team. It needs the \"snapshot.delete\" permission."}}},"exampleType":"generated"}},"exampleType":"generated"},"a28c6605-7129-4e9f-9876-3041699fc722":{"description":"The resource was not found in the selected team. Resources in another account or team also return 404.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","examples":["Not found."],"isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"required":["message"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"Not found."}}},"exampleType":"generated"}},"exampleType":"generated"},"bb410afc-3255-4fd8-9f02-589c1aa0751d":{"description":"A field is missing or invalid, or the resource cannot accept this change in its current state. Check `message` for details. Field validation also includes an `errors` object keyed by field name.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"A summary of the validation error or the reason the change was refused.","examples":["The name field is required."],"isRequired":true,"uniqueKey":"message","typeLabel":"string"},"errors":{"type":"object","description":"Validation errors grouped by field name.","additionalProperties":{"type":"array","items":{"type":"string","uniqueKey":"errors.additionalProperties.items.[INDEX]","typeLabel":"string"},"uniqueKey":"errors.additionalProperties","typeLabel":"string[]"},"uniqueKey":"errors","typeLabel":"object"}},"required":["message"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"The name field is required.","errors":{}}}},"exampleType":"generated"}},"exampleType":"generated"},"b6e116bd-b4b9-4f21-a810-da0f47b490e3":{"description":"Too many requests. The `Retry-After` header says how many seconds to wait. Limits are per account, so several keys on one account share them.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","examples":["Too Many Attempts."],"isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"required":["message"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"Too Many Attempts."}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"f8b33b37-6c4c-4349-ac95-09bac911f9ea":{"http":{"type":"http","description":"Your API key, sent as a bearer token. Create one in the control panel under API Keys, give it only the permissions the integration needs, and copy it when it is created. It cannot be shown again. Each key is restricted to one owned team. The key determines the team for every request.","scheme":"bearer","scopes":[],"schemeName":"http"}}},"servers":{"49ace053-d2ae-45c8-8b5e-9b487eb81f6a":{"url":"https://console.advinservers.com/api/v1/client"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","description":"Your API key, sent as a bearer token. Create one in the control panel under API Keys, give it only the permissions the integration needs, and copy it when it is created. It cannot be shown again. Each key is restricted to one owned team. The key determines the team for every request.","scheme":"bearer","scopes":[],"schemeName":"http"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Your API key, sent as a bearer token. Create one in the control panel under API Keys, give it only the permissions the integration needs, and copy it when it is created. It cannot be shown again. Each key is restricted to one owned team. The key determines the team for every request.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"http","name":"Authorization"}],"title":"http"}]},"originalFileLocation":"https://console.advinservers.com/docs/openapi.json"},"subdomain":"advinservers","siteName":"Advin Servers","title":"Start a checkout payment - Advin Servers","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-10T09:08:16.912Z","originalFileLocation":"api-reference/checkout/start-a-checkout-payment.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"dark\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"### Overview Selects a payment option and returns the next payment step. Send option from the checkout\u0026#x27;s options. The amount charged is read from the invoice again, and a payment whose amount changed since the checkout opened is refused. notes and promo_code are optional. This request does not take payment. The response includes either a redirect_url for the browser or details for opening an embedded payment widget. Rate limits apply per account, not per IP address. ### Permissions Requires the billing.purchase (Make purchases) permission for the selected team. Resources outside that team return 404.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Advin Servers\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/advinservers/RPny3aqgeedmf-mE/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/advinservers/RPny3aqgeedmf-mE/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/advinservers/RPny3aqgeedmf-mE/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/advinservers/RPny3aqgeedmf-mE/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/advinservers/RPny3aqgeedmf-mE/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/advinservers/RPny3aqgeedmf-mE/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/advinservers/RPny3aqgeedmf-mE/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/advinservers/RPny3aqgeedmf-mE/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/advinservers/RPny3aqgeedmf-mE/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Start a checkout payment - Advin Servers\">\u003cmeta data-mint-head property=\"og:description\" content=\"### Overview Selects a payment option and returns the next payment step. Send option from the checkout\u0026#x27;s options. The amount charged is read from the invoice again, and a payment whose amount changed since the checkout opened is refused. notes and promo_code are optional. This request does not take payment. The response includes either a redirect_url for the browser or details for opening an embedded payment widget. Rate limits apply per account, not per IP address. ### Permissions Requires the billing.purchase (Make purchases) permission for the selected team. Resources outside that team return 404.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Advin Servers\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.advinservers.com/api-reference/checkout/start-a-checkout-payment\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://advinservers.mintlify.site/_mintlify/api/og/v2?division=Checkout\u0026amp;title=Start+a+checkout+payment\u0026amp;description=%23%23%23+Overview%0A%0ASelects+a+payment+option+and+returns+the+next+payment+step.+Send+%60option%60+from+the+checkout%27s+options.+The+amount+charged+is+read+from+the+invoice\u0026amp;theme=d60cb8f636d682ed22c76013\u0026amp;signature=dc6c12c5b00a1104038933fb4fed06bc96115c92b8c726973a7cc5fe6c179a86\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Start a checkout payment - Advin Servers\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"### Overview Selects a payment option and returns the next payment step. Send option from the checkout\u0026#x27;s options. The amount charged is read from the invoice again, and a payment whose amount changed since the checkout opened is refused. notes and promo_code are optional. This request does not take payment. The response includes either a redirect_url for the browser or details for opening an embedded payment widget. Rate limits apply per account, not per IP address. ### Permissions Requires the billing.purchase (Make purchases) permission for the selected team. Resources outside that team return 404.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://advinservers.mintlify.site/_mintlify/api/og/v2?division=Checkout\u0026amp;title=Start+a+checkout+payment\u0026amp;description=%23%23%23+Overview%0A%0ASelects+a+payment+option+and+returns+the+next+payment+step.+Send+%60option%60+from+the+checkout%27s+options.+The+amount+charged+is+read+from+the+invoice\u0026amp;theme=d60cb8f636d682ed22c76013\u0026amp;signature=dc6c12c5b00a1104038933fb4fed06bc96115c92b8c726973a7cc5fe6c179a86\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/advinservers/RPny3aqgeedmf-mE/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Advin Servers\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#232323\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.advinservers.com/api-reference/checkout/start-a-checkout-payment\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/checkout/start-a-checkout-payment.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.advinservers.com/#organization\",\"name\":\"Advin Servers\",\"url\":\"https://docs.advinservers.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/advinservers/hsoR78mplm26jwSe/logo/light.svg?fit=max\u0026auto=format\u0026n=hsoR78mplm26jwSe\u0026q=85\u0026s=5adfd787faa2746d42842a3dbe9d5c55\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.advinservers.com#website\",\"name\":\"Advin Servers\",\"url\":\"https://docs.advinservers.com\",\"publisher\":{\"@id\":\"https://docs.advinservers.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.advinservers.com/api-reference/checkout/start-a-checkout-payment#webpage\",\"url\":\"https://docs.advinservers.com/api-reference/checkout/start-a-checkout-payment\",\"name\":\"Start a checkout payment\",\"description\":\"### Overview Selects a payment option and returns the next payment step. Send option from the checkout's options. The amount charged is read from the invoice again, and a payment whose amount changed since the checkout opened is refused. notes and promo_code are optional. This request does not take payment. The response includes either a redirect_url for the browser or details for opening an embedded payment widget. Rate limits apply per account, not per IP address. ### Permissions Requires the billing.purchase (Make purchases) permission for the selected team. Resources outside that team return 404.\",\"dateModified\":\"2026-11-10T09:08:16.912Z\",\"isPartOf\":{\"@id\":\"https://docs.advinservers.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.advinservers.com/api-reference/checkout/start-a-checkout-payment#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.advinservers.com/api-reference/checkout/start-a-checkout-payment#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Endpoints\",\"item\":\"https://docs.advinservers.com/api-reference/account/get-account-details\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Checkout\",\"item\":\"https://docs.advinservers.com/api-reference/checkout/list-payment-options\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Start a checkout payment\",\"item\":\"https://docs.advinservers.com/api-reference/checkout/start-a-checkout-payment\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.advinservers.com/api-reference/checkout/start-a-checkout-payment#apireference\",\"headline\":\"Start a checkout payment\",\"name\":\"Start a checkout payment\",\"description\":\"### Overview Selects a payment option and returns the next payment step. Send option from the checkout's options. The amount charged is read from the invoice again, and a payment whose amount changed since the checkout opened is refused. notes and promo_code are optional. This request does not take payment. The response includes either a redirect_url for the browser or details for opening an embedded payment widget. Rate limits apply per account, not per IP address. ### Permissions Requires the billing.purchase (Make purchases) permission for the selected team. Resources outside that team return 404.\",\"url\":\"https://docs.advinservers.com/api-reference/checkout/start-a-checkout-payment\",\"mainEntityOfPage\":{\"@id\":\"https://docs.advinservers.com/api-reference/checkout/start-a-checkout-payment#webpage\"},\"dateModified\":\"2026-11-10T09:08:16.912Z\",\"publisher\":{\"@id\":\"https://docs.advinservers.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.advinservers.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Advin Servers\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Advin Servers\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/checkout/start-a-checkout-payment.md","siteName":"Advin Servers","nav":{"global":{"anchors":[{"anchor":"Console","icon":"terminal","href":"https://console.advinservers.com"},{"anchor":"Network Status","icon":"signal-bars","href":"https://status.advinservers.com"}]},"tabs":[{"tab":"General","icon":"book-open","pages":[{"title":"General","href":"/introduction"}]},{"tab":"Console","icon":"terminal","pages":[{"title":"Console","href":"/guides/controlpanel"}]},{"tab":"Policies","icon":"scale-balanced","pages":[{"title":"Policies","href":"/policies/fair-use"}]},{"tab":"API","icon":"code","groups":[{"group":"Getting Started","pages":[{"title":"API Introduction","sidebarTitle":"Introduction","icon":"code","href":"/api-reference/introduction"}]},{"group":"Endpoints","pages":[{"group":"Account","pages":[{"title":"Get account details","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /account","href":"/api-reference/account/get-account-details"},{"title":"Update account details","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json patch /account","href":"/api-reference/account/update-account-details"},{"title":"Check account setup progress","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /account/setup","href":"/api-reference/account/check-account-setup-progress"},{"title":"Accept the terms of service","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json post /account/setup/terms","href":"/api-reference/account/accept-the-terms-of-service"}]},{"group":"Account activity","pages":[{"title":"List account activity","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /audit-logs","href":"/api-reference/account-activity/list-account-activity"}]},{"group":"Backups","pages":[{"title":"List a server's backups","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /servers/{server}/backups","href":"/api-reference/backups/list-a-servers-backups"},{"title":"Restore a backup","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json post /servers/{server}/backups/{backup}/restore","href":"/api-reference/backups/restore-a-backup"},{"title":"Delete a backup","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json delete /servers/{server}/backups/{backup}","href":"/api-reference/backups/delete-a-backup"},{"title":"Delete multiple backups","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json post /servers/{server}/backups/bulk/delete","href":"/api-reference/backups/delete-multiple-backups"},{"title":"Get the nightly backup setting","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /servers/{server}/backups/schedule","href":"/api-reference/backups/get-the-nightly-backup-setting"},{"title":"Enable or disable nightly backups","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json post /servers/{server}/backups/schedule","href":"/api-reference/backups/enable-or-disable-nightly-backups"}]},{"group":"Bandwidth","pages":[{"title":"List bandwidth blocks","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /bandwidth-blocks","href":"/api-reference/bandwidth/list-bandwidth-blocks"},{"title":"Buy a bandwidth block","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json post /bandwidth-blocks","href":"/api-reference/bandwidth/buy-a-bandwidth-block"},{"title":"Get bandwidth prices","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /bandwidth-blocks/catalog","href":"/api-reference/bandwidth/get-bandwidth-prices"},{"title":"List bandwidth usage by location","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /bandwidth-blocks/pools","href":"/api-reference/bandwidth/list-bandwidth-usage-by-location"},{"title":"List locations for bandwidth pools","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /bandwidth-blocks/locations","href":"/api-reference/bandwidth/list-locations-for-bandwidth-pools"},{"title":"Enable or disable bandwidth pooling for a location","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json patch /bandwidth-blocks/pooling","href":"/api-reference/bandwidth/enable-or-disable-bandwidth-pooling-for-a-location"},{"title":"Preview a bandwidth pooling change","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /bandwidth-blocks/pooling/preview","href":"/api-reference/bandwidth/preview-a-bandwidth-pooling-change"},{"title":"Get a quote for a bandwidth block","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json post /bandwidth-blocks/quote","href":"/api-reference/bandwidth/get-a-quote-for-a-bandwidth-block"},{"title":"List servers a bandwidth block can be assigned to","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /bandwidth-blocks/{bandwidthBlock}/servers","href":"/api-reference/bandwidth/list-servers-a-bandwidth-block-can-be-assigned-to"},{"title":"List bandwidth block usage","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /bandwidth-blocks/{bandwidthBlock}/draws","href":"/api-reference/bandwidth/list-bandwidth-block-usage"},{"title":"Assign a bandwidth block to a server","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json post /bandwidth-blocks/{bandwidthBlock}/attach","href":"/api-reference/bandwidth/assign-a-bandwidth-block-to-a-server"},{"title":"Remove a bandwidth block from a server","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json post /bandwidth-blocks/{bandwidthBlock}/detach","href":"/api-reference/bandwidth/remove-a-bandwidth-block-from-a-server"},{"title":"Assign a bandwidth block to a location pool","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json post /bandwidth-blocks/{bandwidthBlock}/bind","href":"/api-reference/bandwidth/assign-a-bandwidth-block-to-a-location-pool"},{"title":"Remove a bandwidth block from a location pool","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json post /bandwidth-blocks/{bandwidthBlock}/unbind","href":"/api-reference/bandwidth/remove-a-bandwidth-block-from-a-location-pool"},{"title":"Cancel an unpaid bandwidth block","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json post /bandwidth-blocks/{bandwidthBlock}/cancel","href":"/api-reference/bandwidth/cancel-an-unpaid-bandwidth-block"}]},{"group":"Billing","pages":[{"title":"List service billing details","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /billing/services","href":"/api-reference/billing/list-service-billing-details"},{"title":"List services with payment settings","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /billing/managed-services","href":"/api-reference/billing/list-services-with-payment-settings"},{"title":"Get a service","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /billing/managed-services/{service}","href":"/api-reference/billing/get-a-service"},{"title":"Set up automatic payment for a service","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json post /billing/managed-services/{service}/subscription","href":"/api-reference/billing/set-up-automatic-payment-for-a-service"},{"title":"Stop a service's automatic payment","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json delete /billing/managed-services/{service}/subscription","href":"/api-reference/billing/stop-a-services-automatic-payment"},{"title":"List billing cycle prices","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /billing/managed-services/{service}/billing-cycle","href":"/api-reference/billing/list-billing-cycle-prices"},{"title":"Change a service's billing cycle","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json patch /billing/managed-services/{service}/billing-cycle","href":"/api-reference/billing/change-a-services-billing-cycle"},{"title":"Enable or disable account credit for a service","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json patch /billing/managed-services/{service}/account-credit","href":"/api-reference/billing/enable-or-disable-account-credit-for-a-service"},{"title":"Cancel a service","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json post /billing/managed-services/{service}/cancel","href":"/api-reference/billing/cancel-a-service"},{"title":"Withdraw a service cancellation","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json delete /billing/managed-services/{service}/cancel","href":"/api-reference/billing/withdraw-a-service-cancellation"},{"title":"List automatic payments","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /billing/subscriptions","href":"/api-reference/billing/list-automatic-payments"},{"title":"Cancel an automatic payment","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json post /billing/subscriptions/{subscription}/cancel","href":"/api-reference/billing/cancel-an-automatic-payment"},{"title":"Get the display currency","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /billing/currency","href":"/api-reference/billing/get-the-display-currency"},{"title":"Get account credit","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /billing/credit","href":"/api-reference/billing/get-account-credit"},{"title":"List top-ups","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /billing/deposits","href":"/api-reference/billing/list-top-ups"},{"title":"Add funds to the account","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json post /billing/deposits","href":"/api-reference/billing/add-funds-to-the-account"},{"title":"Cancel a top-up","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json post /billing/deposits/{fundDeposit}/cancel","href":"/api-reference/billing/cancel-a-top-up"},{"title":"List saved PayPal accounts","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /billing/paypal-accounts","href":"/api-reference/billing/list-saved-paypal-accounts"},{"title":"Remove a saved PayPal account","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json delete /billing/paypal-accounts/{paypalAccount}","href":"/api-reference/billing/remove-a-saved-paypal-account"},{"title":"List saved payment methods","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /billing/payment-methods","href":"/api-reference/billing/list-saved-payment-methods"},{"title":"Delete a saved payment method","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json delete /billing/payment-methods/{payMethod}","href":"/api-reference/billing/delete-a-saved-payment-method"}]},{"group":"Checkout","pages":[{"title":"List payment options","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /checkout/options","href":"/api-reference/checkout/list-payment-options"},{"title":"Get a checkout","description":"### Overview\n\nReturns a checkout's purchase details, itemised total, payment options and next payment step. `enabled` is false if payments are unavailable. Checkouts belonging to another account return 404.\n\n### Permissions\n\nRequires the `billing.purchase` (Make purchases) permission for the selected team. Resources outside that team return 404.","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /checkout/{uuid}","href":"/api-reference/checkout/get-a-checkout"},{"title":"Start a checkout payment","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json post /checkout/{uuid}/start","href":"/api-reference/checkout/start-a-checkout-payment"},{"title":"Cancel a checkout","description":"### Overview\n\nCancels a checkout before payment begins. Cancellation is rejected if a payment has been recorded, is being processed, or the customer has already been directed to the payment provider. Once directed there, the customer can abandon the payment and let the checkout expire.\n\nThe underlying order, plan change or top-up remains unpaid and must be cancelled through its own endpoint. Returns the updated checkout.\n\n### Permissions\n\nRequires the `billing.purchase` (Make purchases) permission for the selected team. Resources outside that team return 404.","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json post /checkout/{uuid}/cancel","href":"/api-reference/checkout/cancel-a-checkout"}]},{"group":"DDoS protection","pages":[{"title":"Get a server's DDoS protection","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /servers/{server}/ddos-protection","href":"/api-reference/ddos-protection/get-a-servers-ddos-protection"},{"title":"List DDoS filtering presets","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /servers/{server}/ddos-protection/presets","href":"/api-reference/ddos-protection/list-ddos-filtering-presets"},{"title":"List DDoS filtering presets for an IP address","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /servers/{server}/ddos-protection/ip/{ip}/presets","href":"/api-reference/ddos-protection/list-ddos-filtering-presets-for-an-ip-address"},{"title":"Get DDoS filtering settings for an IP address","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /servers/{server}/ddos-protection/ip/{ip}/settings","href":"/api-reference/ddos-protection/get-ddos-filtering-settings-for-an-ip-address"},{"title":"Update DDoS filtering settings for an IP address","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json post /servers/{server}/ddos-protection/ip/{ip}/settings","href":"/api-reference/ddos-protection/update-ddos-filtering-settings-for-an-ip-address"},{"title":"List DDoS filtering rules for an IP address","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /servers/{server}/ddos-protection/ip/{ip}/profiles","href":"/api-reference/ddos-protection/list-ddos-filtering-rules-for-an-ip-address"},{"title":"Add a DDoS filtering rule to an IP address","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json post /servers/{server}/ddos-protection/ip/{ip}/profiles","href":"/api-reference/ddos-protection/add-a-ddos-filtering-rule-to-an-ip-address"},{"title":"Delete a DDoS filtering rule from an IP address","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json delete /servers/{server}/ddos-protection/ip/{ip}/profiles/{profileId}","href":"/api-reference/ddos-protection/delete-a-ddos-filtering-rule-from-an-ip-address"},{"title":"List DDoS attacks on an IP address","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /servers/{server}/ddos-protection/ip/{ip}/attacks","href":"/api-reference/ddos-protection/list-ddos-attacks-on-an-ip-address"},{"title":"Reset DDoS filtering for an IP address","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json post /servers/{server}/ddos-protection/ip/{ip}/reset","href":"/api-reference/ddos-protection/reset-ddos-filtering-for-an-ip-address"}]},{"group":"Firewall groups","pages":[{"title":"List firewall groups","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /firewall-groups","href":"/api-reference/firewall-groups/list-firewall-groups"},{"title":"Create a firewall group","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json post /firewall-groups","href":"/api-reference/firewall-groups/create-a-firewall-group"},{"title":"Get a firewall group","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /firewall-groups/{firewallGroup}","href":"/api-reference/firewall-groups/get-a-firewall-group"},{"title":"Delete a firewall group","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json delete /firewall-groups/{firewallGroup}","href":"/api-reference/firewall-groups/delete-a-firewall-group"},{"title":"Rename a firewall group","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json patch /firewall-groups/{firewallGroup}","href":"/api-reference/firewall-groups/rename-a-firewall-group"},{"title":"Set a firewall group's servers","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json put /firewall-groups/{firewallGroup}/servers","href":"/api-reference/firewall-groups/set-a-firewall-groups-servers"},{"title":"Reorder firewall rules","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json put /firewall-groups/{firewallGroup}/rules/reorder","href":"/api-reference/firewall-groups/reorder-firewall-rules"},{"title":"Add a firewall rule","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json post /firewall-groups/{firewallGroup}/rules","href":"/api-reference/firewall-groups/add-a-firewall-rule"},{"title":"Delete a firewall rule","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json delete /firewall-groups/{firewallGroup}/rules/{rule}","href":"/api-reference/firewall-groups/delete-a-firewall-rule"},{"title":"Update a firewall rule","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json patch /firewall-groups/{firewallGroup}/rules/{rule}","href":"/api-reference/firewall-groups/update-a-firewall-rule"},{"title":"List firewall groups for a server","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /servers/{server}/firewall-groups","href":"/api-reference/firewall-groups/list-firewall-groups-for-a-server"},{"title":"Create a firewall group for a server","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json post /servers/{server}/firewall-groups","href":"/api-reference/firewall-groups/create-a-firewall-group-for-a-server"},{"title":"Reorder a server's firewall groups","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json put /servers/{server}/firewall-groups/reorder","href":"/api-reference/firewall-groups/reorder-a-servers-firewall-groups"},{"title":"Apply a firewall group to a server","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json post /servers/{server}/firewall-groups/{firewallGroup}/attach","href":"/api-reference/firewall-groups/apply-a-firewall-group-to-a-server"},{"title":"Remove a firewall group from a server","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json post /servers/{server}/firewall-groups/{firewallGroup}/detach","href":"/api-reference/firewall-groups/remove-a-firewall-group-from-a-server"}]},{"group":"IP addresses","pages":[{"title":"List floating IPs","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /floating-ips","href":"/api-reference/ip-addresses/list-floating-ips"},{"title":"Buy a floating IP","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json post /floating-ips","href":"/api-reference/ip-addresses/buy-a-floating-ip"},{"title":"List locations for floating IPs","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /floating-ips/locations","href":"/api-reference/ip-addresses/list-locations-for-floating-ips"},{"title":"Get a quote for a floating IP","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json post /floating-ips/quote","href":"/api-reference/ip-addresses/get-a-quote-for-a-floating-ip"},{"title":"List servers a floating IP can attach to","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /floating-ips/{floatingIp}/servers","href":"/api-reference/ip-addresses/list-servers-a-floating-ip-can-attach-to"},{"title":"Attach a floating IP to a server","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json post /floating-ips/{floatingIp}/attach","href":"/api-reference/ip-addresses/attach-a-floating-ip-to-a-server"},{"title":"Detach a floating IP from a server","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json post /floating-ips/{floatingIp}/detach","href":"/api-reference/ip-addresses/detach-a-floating-ip-from-a-server"},{"title":"Swap a floating IP with the primary address","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json post /floating-ips/{floatingIp}/swap-primary","href":"/api-reference/ip-addresses/swap-a-floating-ip-with-the-primary-address"},{"title":"Cancel an unpaid floating IP order","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json post /floating-ips/{floatingIp}/cancel-checkout","href":"/api-reference/ip-addresses/cancel-an-unpaid-floating-ip-order"},{"title":"Cancel a floating IP","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json post /floating-ips/{floatingIp}/cancel","href":"/api-reference/ip-addresses/cancel-a-floating-ip"},{"title":"Withdraw a floating IP cancellation","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json post /floating-ips/{floatingIp}/withdraw-cancellation","href":"/api-reference/ip-addresses/withdraw-a-floating-ip-cancellation"},{"title":"Release a floating IP","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json delete /floating-ips/{floatingIp}","href":"/api-reference/ip-addresses/release-a-floating-ip"},{"title":"Set a server's primary IP address","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json post /servers/{server}/addresses/{addressId}/primary","href":"/api-reference/ip-addresses/set-a-servers-primary-ip-address"}]},{"group":"IP groups","pages":[{"title":"List IP groups","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /ip-groups","href":"/api-reference/ip-groups/list-ip-groups"},{"title":"Create an IP group","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json post /ip-groups","href":"/api-reference/ip-groups/create-an-ip-group"},{"title":"Get an IP group","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /ip-groups/{firewallIpGroup}","href":"/api-reference/ip-groups/get-an-ip-group"},{"title":"Delete an IP group","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json delete /ip-groups/{firewallIpGroup}","href":"/api-reference/ip-groups/delete-an-ip-group"},{"title":"Rename an IP group","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json patch /ip-groups/{firewallIpGroup}","href":"/api-reference/ip-groups/rename-an-ip-group"},{"title":"Add addresses to an IP group","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json post /ip-groups/{firewallIpGroup}/entries","href":"/api-reference/ip-groups/add-addresses-to-an-ip-group"},{"title":"Remove an address from an IP group","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json delete /ip-groups/{firewallIpGroup}/entries/{entry}","href":"/api-reference/ip-groups/remove-an-address-from-an-ip-group"},{"title":"Update an address in an IP group","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json patch /ip-groups/{firewallIpGroup}/entries/{entry}","href":"/api-reference/ip-groups/update-an-address-in-an-ip-group"}]},{"group":"ISO images","pages":[{"title":"List ISOs","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /isos","href":"/api-reference/iso-images/list-isos"},{"title":"Download an ISO","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json post /isos","href":"/api-reference/iso-images/download-an-iso"},{"title":"Check an ISO download link","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json post /isos/query-link","href":"/api-reference/iso-images/check-an-iso-download-link"},{"title":"Delete an ISO","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json delete /isos/{iso}","href":"/api-reference/iso-images/delete-an-iso"},{"title":"Rename an ISO","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json patch /isos/{iso}","href":"/api-reference/iso-images/rename-an-iso"},{"title":"List ISOs available to a server","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /servers/{server}/isos","href":"/api-reference/iso-images/list-isos-available-to-a-server"}]},{"group":"Invoices","pages":[{"title":"List invoices","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /invoices","href":"/api-reference/invoices/list-invoices"},{"title":"Get an invoice","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /invoices/{invoice}","href":"/api-reference/invoices/get-an-invoice"},{"title":"Download an invoice PDF","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /invoices/{invoice}/pdf","href":"/api-reference/invoices/download-an-invoice-pdf"},{"title":"Create a checkout for an invoice","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json post /invoices/{invoice}/pay","href":"/api-reference/invoices/create-a-checkout-for-an-invoice"},{"title":"List invoices that can be paid together","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /invoices/bulk-payment","href":"/api-reference/invoices/list-invoices-that-can-be-paid-together"},{"title":"Create a checkout for several invoices","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json post /invoices/bulk-payment","href":"/api-reference/invoices/create-a-checkout-for-several-invoices"}]},{"group":"Private networks","pages":[{"title":"List private networks","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /private-networks","href":"/api-reference/private-networks/list-private-networks"},{"title":"Create a private network","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json post /private-networks","href":"/api-reference/private-networks/create-a-private-network"},{"title":"List locations for private networks","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /private-networks/locations","href":"/api-reference/private-networks/list-locations-for-private-networks"},{"title":"Get a private network","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /private-networks/{privateNetwork}","href":"/api-reference/private-networks/get-a-private-network"},{"title":"Delete a private network","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json delete /private-networks/{privateNetwork}","href":"/api-reference/private-networks/delete-a-private-network"},{"title":"Rename a private network","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json patch /private-networks/{privateNetwork}","href":"/api-reference/private-networks/rename-a-private-network"},{"title":"List servers that can join a private network","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /private-networks/{privateNetwork}/eligible-servers","href":"/api-reference/private-networks/list-servers-that-can-join-a-private-network"},{"title":"List a server's private networks","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /servers/{server}/private-networks","href":"/api-reference/private-networks/list-a-servers-private-networks"},{"title":"Create a private network in a server's location","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json post /servers/{server}/private-networks","href":"/api-reference/private-networks/create-a-private-network-in-a-servers-location"},{"title":"Attach a server to a private network","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json post /servers/{server}/private-networks/{privateNetwork}/attach","href":"/api-reference/private-networks/attach-a-server-to-a-private-network"},{"title":"Detach a server from a private network","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json post /servers/{server}/private-networks/{privateNetwork}/detach","href":"/api-reference/private-networks/detach-a-server-from-a-private-network"},{"title":"Delete a server's private network","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json delete /servers/{server}/private-networks/{privateNetwork}","href":"/api-reference/private-networks/delete-a-servers-private-network"}]},{"group":"Reverse DNS","pages":[{"title":"List a server's reverse DNS addresses","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /servers/{server}/rdns","href":"/api-reference/reverse-dns/list-a-servers-reverse-dns-addresses"},{"title":"List reverse DNS records for an address","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /servers/{server}/rdns/{ipId}","href":"/api-reference/reverse-dns/list-reverse-dns-records-for-an-address"},{"title":"Create a reverse DNS record","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json post /servers/{server}/rdns/{ipId}","href":"/api-reference/reverse-dns/create-a-reverse-dns-record"},{"title":"Delete a reverse DNS record","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json delete /servers/{server}/rdns/{ipId}/{recordId}","href":"/api-reference/reverse-dns/delete-a-reverse-dns-record"}]},{"group":"SSH keys","pages":[{"title":"List SSH keys","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /ssh-keys","href":"/api-reference/ssh-keys/list-ssh-keys"},{"title":"Add an SSH key","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json post /ssh-keys","href":"/api-reference/ssh-keys/add-an-ssh-key"},{"title":"Delete an SSH key","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json delete /ssh-keys/{sshKey}","href":"/api-reference/ssh-keys/delete-an-ssh-key"},{"title":"Update an SSH key","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json patch /ssh-keys/{sshKey}","href":"/api-reference/ssh-keys/update-an-ssh-key"},{"title":"Delete multiple SSH keys","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json post /ssh-keys/bulk/delete","href":"/api-reference/ssh-keys/delete-multiple-ssh-keys"},{"title":"List SSH keys for a reinstall","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /servers/{server}/settings/ssh-keys","href":"/api-reference/ssh-keys/list-ssh-keys-for-a-reinstall"}]},{"group":"Server firewall","pages":[{"title":"Get a server's default firewall policy","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /servers/{server}/firewall/policy","href":"/api-reference/server-firewall/get-a-servers-default-firewall-policy"},{"title":"List externally managed firewall rules","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /servers/{server}/firewall-groups/unmanaged-rules","href":"/api-reference/server-firewall/list-externally-managed-firewall-rules"}]},{"group":"Server settings","pages":[{"title":"Rename a server","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json post /servers/{server}/settings/rename","href":"/api-reference/server-settings/rename-a-server"},{"title":"Change a server's icon","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json put /servers/{server}/settings/icon","href":"/api-reference/server-settings/change-a-servers-icon"},{"title":"List templates for a reinstall","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /servers/{server}/settings/template-groups","href":"/api-reference/server-settings/list-templates-for-a-reinstall"},{"title":"Reinstall a server","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json post /servers/{server}/settings/reinstall","href":"/api-reference/server-settings/reinstall-a-server"},{"title":"Get the boot order","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /servers/{server}/settings/hardware/boot-order","href":"/api-reference/server-settings/get-the-boot-order"},{"title":"Set the boot order","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json put /servers/{server}/settings/hardware/boot-order","href":"/api-reference/server-settings/set-the-boot-order"},{"title":"Get hardware settings","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /servers/{server}/settings/hardware/options","href":"/api-reference/server-settings/get-hardware-settings"},{"title":"Update hardware settings","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json put /servers/{server}/settings/hardware/options","href":"/api-reference/server-settings/update-hardware-settings"},{"title":"Change the boot firmware","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json put /servers/{server}/settings/hardware/bios","href":"/api-reference/server-settings/change-the-boot-firmware"},{"title":"Mount an ISO","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json post /servers/{server}/settings/hardware/isos/{iso}/mount","href":"/api-reference/server-settings/mount-an-iso"},{"title":"Unmount an ISO","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json post /servers/{server}/settings/hardware/isos/{iso}/unmount","href":"/api-reference/server-settings/unmount-an-iso"},{"title":"Get DNS resolvers","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /servers/{server}/settings/network","href":"/api-reference/server-settings/get-dns-resolvers"},{"title":"Set DNS resolvers","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json put /servers/{server}/settings/network","href":"/api-reference/server-settings/set-dns-resolvers"},{"title":"Get a server's SSH keys","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /servers/{server}/settings/auth","href":"/api-reference/server-settings/get-a-servers-ssh-keys"},{"title":"Change a server's password or SSH keys","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json put /servers/{server}/settings/auth","href":"/api-reference/server-settings/change-a-servers-password-or-ssh-keys"}]},{"group":"Server upgrades","pages":[{"title":"List upgrade plans for a server","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /servers/{server}/upgrades/catalog","href":"/api-reference/server-upgrades/list-upgrade-plans-for-a-server"},{"title":"Get the current plan change","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /servers/{server}/upgrades/current","href":"/api-reference/server-upgrades/get-the-current-plan-change"},{"title":"Get a quote for a plan change","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json post /servers/{server}/upgrades/quote","href":"/api-reference/server-upgrades/get-a-quote-for-a-plan-change"},{"title":"Buy a plan change","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json post /servers/{server}/upgrades","href":"/api-reference/server-upgrades/buy-a-plan-change"},{"title":"Cancel a plan change","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json post /servers/{server}/upgrades/{upgrade}/cancel","href":"/api-reference/server-upgrades/cancel-a-plan-change"}]},{"group":"Servers","pages":[{"title":"List servers","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /servers","href":"/api-reference/servers/list-servers"},{"title":"Order servers","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json post /servers","href":"/api-reference/servers/order-servers"},{"title":"List server plans","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /servers/catalog","href":"/api-reference/servers/list-server-plans"},{"title":"List templates","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /servers/templates","href":"/api-reference/servers/list-templates"},{"title":"Get a quote for a server order","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json post /servers/quote","href":"/api-reference/servers/get-a-quote-for-a-server-order"},{"title":"List outstanding server orders","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /servers/orders","href":"/api-reference/servers/list-outstanding-server-orders"},{"title":"Cancel a server order","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json post /servers/orders/{serverOrder}/cancel","href":"/api-reference/servers/cancel-a-server-order"},{"title":"Get power states for multiple servers","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /servers/power-states","href":"/api-reference/servers/get-power-states-for-multiple-servers"},{"title":"Get a server","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /servers/{server}","href":"/api-reference/servers/get-a-server"},{"title":"Get a server's billing service","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /servers/{server}/billing","href":"/api-reference/servers/get-a-servers-billing-service"},{"title":"Get a server's unpaid invoice","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /servers/{server}/billing/overdue-invoice","href":"/api-reference/servers/get-a-servers-unpaid-invoice"},{"title":"Get a server's live configuration","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /servers/{server}/details","href":"/api-reference/servers/get-a-servers-live-configuration"},{"title":"Dismiss an installation failure notice","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json delete /servers/{server}/install-failure","href":"/api-reference/servers/dismiss-an-installation-failure-notice"},{"title":"Get all usage graphs","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /servers/{server}/metrics","href":"/api-reference/servers/get-all-usage-graphs"},{"title":"Get one usage graph","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /servers/{server}/metrics-data/{type}/{period}","href":"/api-reference/servers/get-one-usage-graph"},{"title":"List a server's audit log","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /servers/{server}/audit-log","href":"/api-reference/servers/list-a-servers-audit-log"},{"title":"Get a server's live status","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /servers/{server}/state","href":"/api-reference/servers/get-a-servers-live-status"},{"title":"Send a power command","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json patch /servers/{server}/state","href":"/api-reference/servers/send-a-power-command"},{"title":"Open a console session","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json post /servers/{server}/create-console-session","href":"/api-reference/servers/open-a-console-session"}]},{"group":"Setup scripts","pages":[{"title":"List setup scripts","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /user-scripts","href":"/api-reference/setup-scripts/list-setup-scripts"},{"title":"Add a setup script","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json post /user-scripts","href":"/api-reference/setup-scripts/add-a-setup-script"},{"title":"Delete a setup script","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json delete /user-scripts/{userScript}","href":"/api-reference/setup-scripts/delete-a-setup-script"},{"title":"Update a setup script","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json patch /user-scripts/{userScript}","href":"/api-reference/setup-scripts/update-a-setup-script"},{"title":"List setup scripts for a reinstall","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /servers/{server}/settings/user-scripts","href":"/api-reference/setup-scripts/list-setup-scripts-for-a-reinstall"}]},{"group":"Snapshots","pages":[{"title":"List the team's snapshots","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /snapshots","href":"/api-reference/snapshots/list-the-teams-snapshots"},{"title":"List snapshot storages","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /snapshots/storages","href":"/api-reference/snapshots/list-snapshot-storages"},{"title":"Buy a snapshot storage","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json post /snapshots/storages","href":"/api-reference/snapshots/buy-a-snapshot-storage"},{"title":"Get a snapshot storage","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /snapshots/storages/{snapshotStorage}","href":"/api-reference/snapshots/get-a-snapshot-storage"},{"title":"Rename a snapshot storage","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json patch /snapshots/storages/{snapshotStorage}","href":"/api-reference/snapshots/rename-a-snapshot-storage"},{"title":"Get a quote for resizing a snapshot storage","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json post /snapshots/storages/{snapshotStorage}/resize/quote","href":"/api-reference/snapshots/get-a-quote-for-resizing-a-snapshot-storage"},{"title":"Resize a snapshot storage","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json post /snapshots/storages/{snapshotStorage}/resize","href":"/api-reference/snapshots/resize-a-snapshot-storage"},{"title":"Cancel a snapshot storage","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json post /snapshots/storages/{snapshotStorage}/cancel","href":"/api-reference/snapshots/cancel-a-snapshot-storage"},{"title":"Withdraw a snapshot storage cancellation","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json post /snapshots/storages/{snapshotStorage}/withdraw-cancellation","href":"/api-reference/snapshots/withdraw-a-snapshot-storage-cancellation"},{"title":"Move a snapshot to another storage","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json post /snapshots/{snapshot}/move","href":"/api-reference/snapshots/move-a-snapshot-to-another-storage"},{"title":"Delete a snapshot by ID","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json delete /snapshots/{snapshot}","href":"/api-reference/snapshots/delete-a-snapshot-by-id"},{"title":"List snapshots available to a server","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /servers/{server}/snapshots","href":"/api-reference/snapshots/list-snapshots-available-to-a-server"},{"title":"Take a snapshot","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json post /servers/{server}/snapshots","href":"/api-reference/snapshots/take-a-snapshot"},{"title":"Restore a snapshot","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json post /servers/{server}/snapshots/{snapshot}/restore","href":"/api-reference/snapshots/restore-a-snapshot"},{"title":"Delete a snapshot","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json delete /servers/{server}/snapshots/{snapshot}","href":"/api-reference/snapshots/delete-a-snapshot"}]},{"group":"Support tickets","pages":[{"title":"List support tickets","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /tickets","href":"/api-reference/support-tickets/list-support-tickets"},{"title":"Open a support ticket","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json post /tickets","href":"/api-reference/support-tickets/open-a-support-ticket"},{"title":"List ticket departments","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /tickets/departments","href":"/api-reference/support-tickets/list-ticket-departments"},{"title":"Get a ticket","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /tickets/{ticket}","href":"/api-reference/support-tickets/get-a-ticket"},{"title":"Download a ticket attachment","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /tickets/{ticket}/messages/{message}/attachments/{index}","href":"/api-reference/support-tickets/download-a-ticket-attachment"},{"title":"Close a ticket","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json post /tickets/{ticket}/close","href":"/api-reference/support-tickets/close-a-ticket"},{"title":"Reply to a ticket","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json post /tickets/{ticket}/reply","href":"/api-reference/support-tickets/reply-to-a-ticket"}]},{"group":"Team activity","pages":[{"title":"List a team's audit log","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /teams/{team}/audit-logs","href":"/api-reference/team-activity/list-a-teams-audit-log"}]},{"group":"Team members","pages":[{"title":"List a team's members","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /teams/{team}/members","href":"/api-reference/team-members/list-a-teams-members"},{"title":"Invite a team member","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json post /teams/{team}/members","href":"/api-reference/team-members/invite-a-team-member"},{"title":"Remove a team member","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json delete /teams/{team}/members/{member}","href":"/api-reference/team-members/remove-a-team-member"},{"title":"Change a member's role","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json patch /teams/{team}/members/{member}","href":"/api-reference/team-members/change-a-members-role"},{"title":"Withdraw an invitation","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json delete /teams/{team}/invitations/{invitation}","href":"/api-reference/team-members/withdraw-an-invitation"}]},{"group":"Team roles","pages":[{"title":"List role permissions","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /teams/permissions","href":"/api-reference/team-roles/list-role-permissions"},{"title":"List a team's roles","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /teams/{team}/roles","href":"/api-reference/team-roles/list-a-teams-roles"},{"title":"Create a role","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json post /teams/{team}/roles","href":"/api-reference/team-roles/create-a-role"},{"title":"Get a role","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /teams/{team}/roles/{role}","href":"/api-reference/team-roles/get-a-role"},{"title":"Delete a role","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json delete /teams/{team}/roles/{role}","href":"/api-reference/team-roles/delete-a-role"},{"title":"Update a role","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json patch /teams/{team}/roles/{role}","href":"/api-reference/team-roles/update-a-role"}]},{"group":"Teams","pages":[{"title":"List teams","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /teams","href":"/api-reference/teams/list-teams"},{"title":"Create a team","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json post /teams","href":"/api-reference/teams/create-a-team"},{"title":"Get the current team","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json get /teams/context","href":"/api-reference/teams/get-the-current-team"},{"title":"Delete a team","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json delete /teams/{team}","href":"/api-reference/teams/delete-a-team"},{"title":"Rename a team","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json patch /teams/{team}","href":"/api-reference/teams/rename-a-team"},{"title":"Set the default team","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json post /teams/{team}/default","href":"/api-reference/teams/set-the-default-team"}]},{"group":"Transfers","pages":[{"title":"Transfer resources to another team","deprecated":null,"version":null,"openapi":"https://console.advinservers.com/docs/openapi.json post /transfers","href":"/api-reference/transfers/transfer-resources-to-another-team"}]}]}]}]},"basePath":"","title":"Start a checkout payment - Advin Servers","buildId":"dpl_596ePT575z4qnAFksq1biRW97aLY","deploymentId":"dpl_596ePT575z4qnAFksq1biRW97aLY","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-C9Wu0MeN.js","utils-jWgu-6Qf.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DBD8f9qn.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-BGuX1ui5.js","snippetPresets-Evy63nQB.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-BQHO1lnV.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-B6C8m-t_.js","shallow-BG4cT0fH.js","getApiPlaygroundDisplay-CgEPrE-D.js","CodeSnippet-CU8JyZ9N.js","CodeSnippets-BnxHU32T.js","Page-D6S0Yh6q.js","getPastedJson-CwiYOonh.js","icon-DYDpWmDf.js","MethodPill-C-J-l7_c.js","DuplicateIcon-B6ARwg9w.js","createIcon-Dsv4MtDq.js","DynamicMarkdown-CtasenyM.js","SectionHeading-YNcgYwjB.js","axios-vUo_bRtp.js","Markdown-CwLx6PAg.js","clsx-C3kuh_dz.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CmKHfscc.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-U3mI6Ljh.js"]}