> ## 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. # List payment options > ### Overview Lists payment options available at checkout. Call this before creating a purchase so the customer can choose how to pay. Send `renews=true` when the first invoice amount is also the recurring renewal amount. This includes automatic renewal options, which are otherwise omitted. ### Permissions Requires the account permission `billing.purchase` (Make purchases). ## OpenAPI ````yaml https://console.advinservers.com/docs/openapi.json get /checkout/options 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/options: get: tags: - Checkout summary: List payment options description: >- ### Overview Lists payment options available at checkout. Call this before creating a purchase so the customer can choose how to pay. Send `renews=true` when the first invoice amount is also the recurring renewal amount. This includes automatic renewal options, which are otherwise omitted. ### Permissions Requires the account permission `billing.purchase` (Make purchases). operationId: client.checkout.options parameters: - name: renews in: query description: The value of `renews`. schema: type: boolean default: false examples: - true example: true responses: '200': description: The whole set, as a JSON array. There is no envelope and no paging. content: application/json: schema: type: array 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 - - 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 items: $ref: '#/components/schemas/CheckoutPaymentOptionData' '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 '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: 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 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.