> ## 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 licenses > ### Overview Lists the licenses in the current team that have not ended, oldest first. Each license includes its key once it has been issued, and a link to download the software. The response also includes the plans for sale. ### Permissions Requires the `license.read` (View licenses) permission for the selected team. Resources outside that team return 404. ## OpenAPI ````yaml https://console.advinservers.com/docs/openapi.json get /licenses 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: Licenses description: >- Buy and cancel licenses for billing applications that run on your servers. Each license is billed monthly as its own service. - 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: /licenses: get: tags: - Licenses summary: List licenses description: >- ### Overview Lists the licenses in the current team that have not ended, oldest first. Each license includes its key once it has been issued, and a link to download the software. The response also includes the plans for sale. ### Permissions Requires the `license.read` (View licenses) permission for the selected team. Resources outside that team return 404. operationId: license.list responses: '200': description: The record, as a JSON object. There is no envelope. content: application/json: schema: type: object examples: - items: - uuid: 5d0c8f6e-3b1a-4e27-9f45-1c7a2b8d6e90 type: whmcs type_label: WHMCS plan_name: Plus name: WHMCS Plus status: active status_label: Active progress_message: null needs_funds: false awaits_staff: false license_key: Leased-3f9a2c71e8b4d065 is_suspended: false download_url: https://download.whmcs.com/ billing: service_id: 7452 invoice_id: 16741 invoice_url: null checkout_uuid: null invoice_status: Paid amount: '27.60' currency: USD billing_cycle: Monthly payment_due_at: null payment_window_minutes: 30 paid_at: '2026-07-21T09:12:41+00:00' cancellation_type: null cancellation_requested_at: null autopay: false can_cancel: true can_withdraw_cancellation: false infrastructure_agreed_at: '2026-07-21T09:12:33+00:00' issued_at: '2026-07-21T09:12:58+00:00' created_at: '2026-07-21T09:12:33+00:00' catalog: enabled: true currency: USD billing_cycle: Monthly plans: - id: 2 type: whmcs type_label: WHMCS name: Plus description: Up to 250 clients, no branding price: '27.60' - id: 13 type: blesta type_label: Blesta name: Unlimited description: Unlimited clients price: '2.70' properties: items: type: array description: The licenses, oldest first. examples: - - uuid: 5d0c8f6e-3b1a-4e27-9f45-1c7a2b8d6e90 type: whmcs type_label: WHMCS plan_name: Plus name: WHMCS Plus status: active status_label: Active progress_message: null needs_funds: false awaits_staff: false license_key: Leased-3f9a2c71e8b4d065 is_suspended: false download_url: https://download.whmcs.com/ billing: service_id: 7452 invoice_id: 16741 invoice_url: null checkout_uuid: null invoice_status: Paid amount: '27.60' currency: USD billing_cycle: Monthly payment_due_at: null payment_window_minutes: 30 paid_at: '2026-07-21T09:12:41+00:00' cancellation_type: null cancellation_requested_at: null autopay: false can_cancel: true can_withdraw_cancellation: false infrastructure_agreed_at: '2026-07-21T09:12:33+00:00' issued_at: '2026-07-21T09:12:58+00:00' created_at: '2026-07-21T09:12:33+00:00' items: $ref: '#/components/schemas/LicenseData' catalog: description: The plans for sale and their monthly prices. examples: - enabled: true currency: USD billing_cycle: Monthly plans: - id: 2 type: whmcs type_label: WHMCS name: Plus description: Up to 250 clients, no branding price: '27.60' - id: 13 type: blesta type_label: Blesta name: Unlimited description: Unlimited clients price: '2.70' allOf: - $ref: '#/components/schemas/LicenseCatalogData' required: - items - catalog '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: LicenseData: type: object description: >- A software license: which product and plan it is, its key, what it costs, and what may be done with it right now. examples: - uuid: 5d0c8f6e-3b1a-4e27-9f45-1c7a2b8d6e90 type: whmcs type_label: WHMCS plan_name: Plus name: WHMCS Plus status: active status_label: Active progress_message: null needs_funds: false awaits_staff: false license_key: Leased-3f9a2c71e8b4d065 is_suspended: false download_url: https://download.whmcs.com/ billing: service_id: 7452 invoice_id: 16741 invoice_url: null checkout_uuid: null invoice_status: Paid amount: '27.60' currency: USD billing_cycle: Monthly payment_due_at: null payment_window_minutes: 30 paid_at: '2026-07-21T09:12:41+00:00' cancellation_type: null cancellation_requested_at: null autopay: false can_cancel: true can_withdraw_cancellation: false infrastructure_agreed_at: '2026-07-21T09:12:33+00:00' issued_at: '2026-07-21T09:12:58+00:00' created_at: '2026-07-21T09:12:33+00:00' properties: uuid: type: string description: The uuid UUID. examples: - 5d0c8f6e-3b1a-4e27-9f45-1c7a2b8d6e90 type: type: string description: The product the license is for. enum: - whmcs - blesta examples: - whmcs type_label: type: string description: The product's name as the panel writes it. examples: - WHMCS plan_name: type: string description: The plan it was bought on, such as "Plus" or "Unlimited". examples: - Plus name: type: string description: The product and plan together, such as "Blesta Unlimited". examples: - WHMCS Plus status: type: string description: The value of `status`. enum: - pending_payment - issuing - active - pending_cancellation - cancelled - expired - payment_review examples: - active status_label: type: string description: The status in the customer's words, with suspension first. examples: - Active progress_message: type: - string - 'null' description: What the license is waiting on, when it is waiting on something. examples: - null needs_funds: type: boolean description: >- Whether the purchase is waiting for the account to hold enough credit. examples: - false awaits_staff: type: boolean description: >- Whether our team is issuing the license or looking at its purchase by hand. examples: - false license_key: type: - string - 'null' description: The license key, once the license has been issued. examples: - Leased-3f9a2c71e8b4d065 is_suspended: type: boolean description: >- Whether billing has suspended the license because a renewal is unpaid. examples: - false download_url: type: - string - 'null' description: Where the licensed software can be downloaded, when one is set. examples: - https://download.whmcs.com/ billing: $ref: '#/components/schemas/BillingData' description: The value of `billing`. examples: - service_id: 7452 invoice_id: 16741 invoice_url: null checkout_uuid: null invoice_status: Paid amount: '27.60' currency: USD billing_cycle: Monthly payment_due_at: null payment_window_minutes: 30 paid_at: '2026-07-21T09:12:41+00:00' cancellation_type: type: - string - 'null' description: The value of `cancellation_type`. enum: - immediate - end_of_billing - null examples: - null cancellation_requested_at: type: - string - 'null' description: The date and time for cancellation requested at, in UTC. examples: - null autopay: type: boolean description: The value of `autopay`. examples: - false can_cancel: type: boolean description: Whether the customer can cancel. examples: - true can_withdraw_cancellation: type: boolean description: Whether an end-of-period cancellation can still be taken back. examples: - false infrastructure_agreed_at: type: - string - 'null' description: >- When the customer agreed to use the license on our infrastructure only. Null for a license bought before licenses were sold here. examples: - '2026-07-21T09:12:33+00:00' issued_at: type: - string - 'null' description: The date and time for issued at, in UTC. examples: - '2026-07-21T09:12:58+00:00' created_at: type: - string - 'null' description: The date and time for created at, in UTC. examples: - '2026-07-21T09:12:33+00:00' required: - uuid - type - type_label - plan_name - name - status - status_label - progress_message - needs_funds - awaits_staff - license_key - is_suspended - download_url - billing - cancellation_type - cancellation_requested_at - autopay - can_cancel - can_withdraw_cancellation - infrastructure_agreed_at - issued_at - created_at title: LicenseData LicenseCatalogData: type: object description: The license plans for sale and what they cost. examples: - enabled: true currency: USD billing_cycle: Monthly plans: - id: 2 type: whmcs type_label: WHMCS name: Plus description: Up to 250 clients, no branding price: '27.60' - id: 13 type: blesta type_label: Blesta name: Unlimited description: Unlimited clients price: '2.70' properties: enabled: type: boolean description: Whether any plan is for sale. examples: - true currency: type: string description: The currency plan prices are written in. examples: - USD billing_cycle: type: string description: How often a license renews. Licenses are sold monthly. examples: - Monthly plans: type: array description: The value of `plans`. examples: - - id: 2 type: whmcs type_label: WHMCS name: Plus description: Up to 250 clients, no branding price: '27.60' - id: 13 type: blesta type_label: Blesta name: Unlimited description: Unlimited clients price: '2.70' items: $ref: '#/components/schemas/LicensePlanData' required: - enabled - currency - billing_cycle - plans title: LicenseCatalogData BillingData: type: object description: >- The billing details shared by customer-owned resources and pending orders. examples: - service_id: 7312 invoice_id: 15542 invoice_url: null checkout_uuid: null invoice_status: Paid amount: '12.00' currency: USD billing_cycle: monthly payment_due_at: null payment_window_minutes: null paid_at: '2026-03-02T19:13:58+00:00' properties: service_id: type: - integer - 'null' description: The customer's service number, once a recurring service exists. examples: - 7312 invoice_id: type: - integer - 'null' description: The customer's invoice number, once an invoice exists. examples: - 15542 invoice_url: type: - string - 'null' description: A complete URL where the invoice can be paid. examples: - null checkout_uuid: type: - string - 'null' description: The checkout UUID, or null when no checkout is available. examples: - null invoice_status: type: - string - 'null' description: The current invoice status, or null before an invoice exists. examples: - Paid amount: type: - string - 'null' description: The amount in the currency shown by `currency`. examples: - '12.00' currency: type: - string - 'null' description: The three-letter currency code used for `amount`. examples: - USD billing_cycle: type: - string - 'null' description: How often the service renews, or null for a one-time charge. examples: - monthly payment_due_at: type: - string - 'null' description: When payment is due before the reservation is released. examples: - null payment_window_minutes: type: - integer - 'null' description: How many minutes the original payment window allowed. examples: - null paid_at: type: - string - 'null' description: When the charge was paid, or null while payment is outstanding. examples: - '2026-03-02T19:13:58+00:00' required: - service_id - invoice_id - invoice_url - checkout_uuid - invoice_status - amount - currency - billing_cycle - payment_due_at - payment_window_minutes - paid_at title: BillingData LicensePlanData: type: object description: A plan a license can be bought on. examples: - id: 2 type: whmcs type_label: WHMCS name: Plus description: Up to 250 clients, no branding price: '27.60' properties: id: type: integer description: Send this as `license_plan_id` to buy a license on the plan. examples: - 2 type: type: string description: The product the plan is for. enum: - whmcs - blesta examples: - whmcs type_label: type: string description: The product's name as the panel writes it. examples: - WHMCS name: type: string description: The name shown to customers. examples: - Plus description: type: - string - 'null' description: What the plan allows, such as how many clients. examples: - Up to 250 clients, no branding price: type: string description: The monthly price, in the catalogue's currency. examples: - '27.60' required: - id - type - type_label - name - description - price title: LicensePlanData 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.