> ## Documentation Index > Fetch the complete documentation index at: https://docs.advinservers.com/llms.txt > Use this file to discover all available pages before exploring further. # Start a checkout payment > ### Overview Selects a payment option and returns the next payment step. Send `option` from the checkout's options and `payment_token` from a fresh checkout response. Tokens for a different amount are rejected. `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. ## OpenAPI ````yaml https://console.advinservers.com/docs/openapi.json post /checkout/{uuid}/start openapi: 3.1.0 info: title: API reference version: 1.0.0 description: >- Use this API to manage your team's servers, networks, backups, and other resources. ## Authentication Create an API key under **API Keys** and send it as a bearer token with every request: ``` Authorization: Bearer {YOUR_API_KEY} Accept: application/json ``` Copy the key when you create it. It cannot be shown again. Revoking a key takes effect immediately. ## Permissions Give each key only the permissions it needs. Every endpoint lists the required permission. Permissions cover servers and other resources in the key's team. ## Team scope A key can access resources in the team selected when it was created. This includes servers, snapshots, backups, firewall groups, images, SSH keys, scripts, networks and addresses. Resources in other teams return `404 Not Found`. Create a separate key for each team. The key determines the team for every request. Legacy keys that had no team are assigned to the account's first owned team. ## Actions that need the panel API keys cannot do the following, even with every permission. Sign in to the panel in a browser to do them: - Create, edit or revoke API keys - Edit the IP groups that restrict API keys - End signed-in sessions - Change two-factor authentication - Change the account's email address - Accept or decline team invitations - Switch or leave a team This keeps a leaked key from widening its own access or locking you out of your account. ## Source IP restrictions A key can be restricted to one or more IP groups. Requests from other addresses are rejected. ## Requests and responses Each endpoint lists its path, query, header, and body parameters. Examples use fictional data. Single records use JSON objects. Collections use JSON arrays unless the endpoint supports pagination. Timestamps use ISO 8601 in UTC. Error responses include `message`. Validation errors also include an `errors` object for each field. Each endpoint lists its status codes. ## Audit log Every API request, including reads, is recorded in the account audit log with the key that made it. servers: - url: https://console.advinservers.com/api/v1/client security: - http: [] tags: - name: Account description: Billing contact details and account setup progress. - name: Account activity description: Actions performed in the current team by people and API keys. - name: Servers description: >- Order and list servers, read their state and resource use, open a console, and control power. - name: Server settings description: >- Rename a server, rebuild it, and change its hardware, media, resolvers and credentials. - name: Backups description: Scheduled server copies stored separately from the server. - name: Snapshots description: >- Take, restore and move server snapshots. Snapshots are kept in snapshot storage that the team buys by the GiB. - name: Firewall groups description: Reusable sets of firewall rules, and the servers they apply to. - name: IP groups description: Reusable source address lists for firewall rules. - name: Server firewall description: >- Read default traffic policies and rules managed outside your firewall groups. - name: IP addresses description: Manage floating IPs and server address assignments. - name: Private networks description: Connect servers over a private network in the same location. - name: Reverse DNS description: Set the hostnames returned by IP address lookups. - name: DDoS protection description: Configure attack filtering for server addresses. - name: Bandwidth description: Buy extra bandwidth and share it between servers or location pools. - name: SSH keys description: Public keys the account can install on a server when it is built. - name: Setup scripts description: Scripts the account can run on a server when it is built. - name: ISO images description: ISO images you have downloaded, and the servers they are mounted on. - name: Server upgrades description: Change an existing server's plan. - name: Checkout description: Choose a payment method and pay for a purchase. - name: Invoices description: View and pay account invoices. - name: Billing description: Manage service renewals, payment methods and account credit. - name: Transfers description: Move resources between teams or transfer ownership. - name: Teams description: Manage the team assigned to your API key. - name: Team members description: Invite people and manage their team access. - name: Team roles description: Define the permissions granted to team members. - name: Team activity description: View actions performed in a team. - name: Support tickets description: >- Open, read, reply to and close support tickets. Tickets belong to the account holder and are not shared with team members. paths: /checkout/{uuid}/start: post: tags: - Checkout summary: Start a checkout payment description: >- ### Overview Selects a payment option and returns the next payment step. Send `option` from the checkout's options and `payment_token` from a fresh checkout response. Tokens for a different amount are rejected. `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. operationId: client.checkout.start parameters: - name: uuid in: path required: true description: The uuid ID. schema: type: string examples: - 53a832f9-e85e-44b5-af03-2ef26110686d 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: examples: - option: paddle_once payment_token: >- eyJ2ZXJzaW9uIjoxLCJub25jZSI6ImRkMzA4NTEwYWVjOGY5YmI1ZTgyYzZiOGMwZWUxNGJhODVhNGE1ODhkZGI0NzA4YTJiNzM3ZWU4MWJjYzZiYWIiLCJvd25lcl9pZCI6MTg3Mywib3duZXJfZW1haWwiOiJnb3Jkb24uZnJlZW1hbkBibGFja21lc2EuZXhhbXBsZS5jb20iLCJleHBpcmVzX2F0IjoxNzg5NDA0NDI5LCJ3aG1jc19jb25maWd1cmF0aW9uX2ZpbmdlcnByaW50IjoiZTY3ZDIzZTc4MjBjNDlhOCIsInBheW1lbnRfY29uZmlndXJhdGlvbl9maW5nZXJwcmludCI6IjViMWYwYzlhZDI3ZTRlMTMiLCJjaGVja291dF91dWlkIjoiNTNhODMyZjktZTg1ZS00NGI1LWFmMDMtMmVmMjYxMTA2ODZkIiwid2htY3NfaW52b2ljZV9pZCI6MTgzODYsImFtb3VudF9taW5vciI6MjUwMCwiY3VycmVuY3kiOiJVU0QifQ.a038063df5120b97140f1962351401be13540e9a3dfd19ff30248d53cdab66a3 notes: null promo_code: null allOf: - $ref: '#/components/schemas/StartCheckoutRequest' responses: '200': description: The record, as a JSON object. There is no envelope. content: application/json: schema: examples: - 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: Credit Card or PayPal 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 enabled: true payment_token: >- eyJ2ZXJzaW9uIjoxLCJub25jZSI6ImRkMzA4NTEwYWVjOGY5YmI1ZTgyYzZiOGMwZWUxNGJhODVhNGE1ODhkZGI0NzA4YTJiNzM3ZWU4MWJjYzZiYWIiLCJvd25lcl9pZCI6MTg3Mywib3duZXJfZW1haWwiOiJnb3Jkb24uZnJlZW1hbkBibGFja21lc2EuZXhhbXBsZS5jb20iLCJleHBpcmVzX2F0IjoxNzg5NDA0NDI5LCJ3aG1jc19jb25maWd1cmF0aW9uX2ZpbmdlcnByaW50IjoiZTY3ZDIzZTc4MjBjNDlhOCIsInBheW1lbnRfY29uZmlndXJhdGlvbl9maW5nZXJwcmludCI6IjViMWYwYzlhZDI3ZTRlMTMiLCJjaGVja291dF91dWlkIjoiNTNhODMyZjktZTg1ZS00NGI1LWFmMDMtMmVmMjYxMTA2ODZkIiwid2htY3NfaW52b2ljZV9pZCI6MTgzODYsImFtb3VudF9taW5vciI6MjUwMCwiY3VycmVuY3kiOiJVU0QifQ.a038063df5120b97140f1962351401be13540e9a3dfd19ff30248d53cdab66a3 allOf: - allOf: - $ref: '#/components/schemas/CheckoutData' - type: object properties: enabled: type: boolean description: Whether the panel is taking payments at all. examples: - true payment_token: type: - string - 'null' description: >- The token a start request sends back, tied to the amount shown. Null when no further payment attempt is allowed. examples: - >- eyJ2ZXJzaW9uIjoxLCJub25jZSI6ImRkMzA4NTEwYWVjOGY5YmI1ZTgyYzZiOGMwZWUxNGJhODVhNGE1ODhkZGI0NzA4YTJiNzM3ZWU4MWJjYzZiYWIiLCJvd25lcl9pZCI6MTg3Mywib3duZXJfZW1haWwiOiJnb3Jkb24uZnJlZW1hbkBibGFja21lc2EuZXhhbXBsZS5jb20iLCJleHBpcmVzX2F0IjoxNzg5NDA0NDI5LCJ3aG1jc19jb25maWd1cmF0aW9uX2ZpbmdlcnByaW50IjoiZTY3ZDIzZTc4MjBjNDlhOCIsInBheW1lbnRfY29uZmlndXJhdGlvbl9maW5nZXJwcmludCI6IjViMWYwYzlhZDI3ZTRlMTMiLCJjaGVja291dF91dWlkIjoiNTNhODMyZjktZTg1ZS00NGI1LWFmMDMtMmVmMjYxMTA2ODZkIiwid2htY3NfaW52b2ljZV9pZCI6MTgzODYsImFtb3VudF9taW5vciI6MjUwMCwiY3VycmVuY3kiOiJVU0QifQ.a038063df5120b97140f1962351401be13540e9a3dfd19ff30248d53cdab66a3 required: - enabled - payment_token '401': 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. required: - message '403': 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. required: - message '404': 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. required: - message '422': 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. errors: type: object description: Validation errors grouped by field name. additionalProperties: type: array items: type: string required: - message '429': 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. required: - message components: schemas: StartCheckoutRequest: type: object examples: - option: paddle_once payment_token: >- eyJ2ZXJzaW9uIjoxLCJub25jZSI6ImRkMzA4NTEwYWVjOGY5YmI1ZTgyYzZiOGMwZWUxNGJhODVhNGE1ODhkZGI0NzA4YTJiNzM3ZWU4MWJjYzZiYWIiLCJvd25lcl9pZCI6MTg3Mywib3duZXJfZW1haWwiOiJnb3Jkb24uZnJlZW1hbkBibGFja21lc2EuZXhhbXBsZS5jb20iLCJleHBpcmVzX2F0IjoxNzg5NDA0NDI5LCJ3aG1jc19jb25maWd1cmF0aW9uX2ZpbmdlcnByaW50IjoiZTY3ZDIzZTc4MjBjNDlhOCIsInBheW1lbnRfY29uZmlndXJhdGlvbl9maW5nZXJwcmludCI6IjViMWYwYzlhZDI3ZTRlMTMiLCJjaGVja291dF91dWlkIjoiNTNhODMyZjktZTg1ZS00NGI1LWFmMDMtMmVmMjYxMTA2ODZkIiwid2htY3NfaW52b2ljZV9pZCI6MTgzODYsImFtb3VudF9taW5vciI6MjUwMCwiY3VycmVuY3kiOiJVU0QifQ.a038063df5120b97140f1962351401be13540e9a3dfd19ff30248d53cdab66a3 notes: null promo_code: null properties: option: type: string description: The value of `option`. enum: - paddle_once - paddle_subscription - btcpay_once payment_token: type: string description: The value of `payment_token`. maxLength: 4096 notes: type: - string - 'null' description: Optional notes about the request. maxLength: 2000 promo_code: type: - string - 'null' description: The value of `promo_code`. pattern: ^[A-Za-z0-9_-]+$ maxLength: 64 required: - option - payment_token title: StartCheckoutRequest CheckoutData: type: object description: A checkout and its available payment options. examples: - 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: Credit Card or PayPal 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 properties: uuid: type: string description: The uuid UUID. examples: - 53a832f9-e85e-44b5-af03-2ef26110686d status: type: string description: The value of `status`. enum: - draft - awaiting_gateway - charging - recording - paid - expired - cancelled - payment_review examples: - awaiting_gateway status_label: type: string description: The status in the customer's words, written once on the enum. examples: - Waiting for payment progress_message: type: - string - 'null' description: The value of `progress_message`. examples: - Opening the payment form… last_error_code: type: - string - 'null' description: The value of `last_error_code`. examples: - null description: type: string description: >- What is being bought, or the invoice number when no name is available. examples: - Account credit · 25.00 USD 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: $ref: '#/components/schemas/CheckoutLineItemData' 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' currency: type: string description: The three-letter currency code used for monetary amounts. examples: - USD total_display: type: string description: The amount and its currency, rendered ready to print. examples: - 25.00 USD option: type: - string - 'null' description: The value of `option`. enum: - paddle_once - paddle_subscription - btcpay_once - null examples: - paddle_once options: type: array description: The value of `options`. examples: - - value: paddle_once label: Credit Card or PayPal shortLabel: Credit Card or PayPal 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: $ref: '#/components/schemas/CheckoutPaymentOptionData' merchant_of_record: type: boolean description: The value of `merchant_of_record`. examples: - true notes: type: - string - 'null' description: Optional notes about the request. examples: - null promo_code: type: - string - 'null' description: The value of `promo_code`. examples: - null redirect_url: type: - string - 'null' description: The value of `redirect_url`. examples: - null paddle: description: The value of `paddle`. examples: - transaction_id: txn_01j8m4x7c2k9q5v3r6t1w8y0za client_token: live_7d0b6c1f3e9a24c58b71e2f4d93 environment: production anyOf: - $ref: '#/components/schemas/CheckoutPaddleHandoffData' - type: 'null' return_path: type: - string - 'null' description: The value of `return_path`. examples: - /add-funds expires_at: type: - string - 'null' description: When this action or checkout expires, in UTC. examples: - '2026-09-14T17:12:09+00:00' settled_at: type: - string - 'null' description: The date and time for settled at, in UTC. examples: - null created_at: type: - string - 'null' description: The date and time for created at, in UTC. examples: - '2026-09-14T16:42:09+00:00' is_live: type: boolean description: Whether the checkout can still accept another payment attempt. examples: - true can_choose: type: boolean description: Whether the customer can choose. examples: - false is_settling: type: boolean description: Whether the resource is settling. examples: - false required: - 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 title: CheckoutData CheckoutLineItemData: 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 amount: type: - string - 'null' description: The amount in the currency shown by `currency`. examples: - 25.00 USD required: - label - amount title: CheckoutLineItemData CheckoutPaymentOptionData: type: object description: One way a purchase may be paid for. examples: - value: paddle_once label: Credit Card or PayPal shortLabel: Credit Card or PayPal 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 label: type: string description: A short label shown to customers. examples: - Credit Card or PayPal 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: - Credit Card or PayPal 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. provider: type: string description: The value of `provider`. examples: - paddle providerName: type: string description: The value of `provider_name`. examples: - Paddle 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 required: - value - label - shortLabel - description - provider - providerName - recurring title: CheckoutPaymentOptionData CheckoutPaddleHandoffData: type: object examples: - transaction_id: txn_01j8m4x7c2k9q5v3r6t1w8y0za client_token: live_7d0b6c1f3e9a24c58b71e2f4d93 environment: production properties: transaction_id: type: string description: The transaction id ID. examples: - txn_01j8m4x7c2k9q5v3r6t1w8y0za client_token: type: string description: The value of `client_token`. examples: - live_7d0b6c1f3e9a24c58b71e2f4d93 environment: type: string description: The value of `environment`. examples: - production required: - transaction_id - client_token - environment title: CheckoutPaddleHandoffData securitySchemes: 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 ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.