> ## 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 postpaid invoices > ### Overview Lists the account's monthly postpaid invoices. One invoice a month covers every postpaid team the account owns, and each line names the team it was billed in. The current month comes first as a `draft`, its `total` worked out to this moment, followed by every earlier month, newest first. A month too small to invoice on its own is `deferred` and carried onto the next invoice. Once published, `invoice_id` names the invoice to pay with the invoice endpoints, and `can_pay` is true while it is owed. `id` is null while nothing has been billed this month. ### Permissions Requires the account permission `invoices.read` (View invoices). ## OpenAPI ````yaml https://console.advinservers.com/docs/openapi.json get /postpaid-invoices openapi: 3.1.2 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. They cannot be deleted, and they are kept when the server is deleted. - 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 address lists for the source or destination of 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: Domain name description: Give a server its own domain name that points at one of its IP addresses. - 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: /postpaid-invoices: get: tags: - Invoices summary: List postpaid invoices description: >- ### Overview Lists the account's monthly postpaid invoices. One invoice a month covers every postpaid team the account owns, and each line names the team it was billed in. The current month comes first as a `draft`, its `total` worked out to this moment, followed by every earlier month, newest first. A month too small to invoice on its own is `deferred` and carried onto the next invoice. Once published, `invoice_id` names the invoice to pay with the invoice endpoints, and `can_pay` is true while it is owed. `id` is null while nothing has been billed this month. ### Permissions Requires the account permission `invoices.read` (View invoices). operationId: client.postpaid-invoices.index responses: '200': description: The whole set, as a JSON array. There is no envelope and no paging. content: application/json: schema: type: array examples: - - id: 8f9b2a4c-6d1e-4f3a-9b7c-2e5d8a1f4c6b uuid_short: Uuid short month: 2026-09 month_label: September 2026 status: unpaid status_label: Unpaid total: '16.00' currency: USD invoice_date: Invoice date due_date: '2026-10-07' credit_hold_date: '2026-10-14' suspension_date: '2026-10-14' termination_date: '2026-10-21' paid_at: null invoice_id: 18342 can_pay: true lines: - type: usage description: lambda-core resource: Virtual Server team_name: Anomalous Materials month: 2026-09 hours: 672 hourly_rate: '0.02381' monthly_rate: '16.00' amount: '16.00032' started_at: '2026-09-01T00:00:00+00:00' ended_at: '2026-09-30T23:59:59+00:00' - type: monthly_cap description: 'Monthly cap adjustment: lambda-core' resource: Virtual Server team_name: Anomalous Materials month: 2026-09 hours: null hourly_rate: null monthly_rate: null amount: '-0.00032' started_at: null ended_at: null items: $ref: '#/components/schemas/PostpaidInvoiceData' '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: PostpaidInvoiceData: type: object description: >- An account's invoice for one calendar month, covering every postpaid team it owns, billed by the hour. examples: - id: 8f9b2a4c-6d1e-4f3a-9b7c-2e5d8a1f4c6b uuid_short: Uuid short month: 2026-09 month_label: September 2026 status: unpaid status_label: Unpaid total: '16.00' currency: USD invoice_date: Invoice date due_date: '2026-10-07' credit_hold_date: '2026-10-14' suspension_date: '2026-10-14' termination_date: '2026-10-21' paid_at: null invoice_id: 18342 can_pay: true lines: - type: usage description: lambda-core resource: Virtual Server team_name: Anomalous Materials month: 2026-09 hours: 672 hourly_rate: '0.02381' monthly_rate: '16.00' amount: '16.00032' started_at: '2026-09-01T00:00:00+00:00' ended_at: '2026-09-30T23:59:59+00:00' - type: monthly_cap description: 'Monthly cap adjustment: lambda-core' resource: Virtual Server team_name: Anomalous Materials month: 2026-09 hours: null hourly_rate: null monthly_rate: null amount: '-0.00032' started_at: null ended_at: null properties: id: type: - string - 'null' description: Null for a month with nothing billed yet, which has no row. examples: - 8f9b2a4c-6d1e-4f3a-9b7c-2e5d8a1f4c6b uuid_short: type: - string - 'null' description: The value of `uuid_short`. examples: - Uuid short month: type: string description: The value of `month`. examples: - 2026-09 month_label: type: string description: The value of `month_label`. examples: - September 2026 status: type: string description: The value of `status`. enum: - draft - unpaid - credit_hold - suspended - termination_pending - paid - deferred - cancelled examples: - unpaid status_label: type: string description: The value of `status_label`. examples: - Unpaid total: type: string description: The value of `total`. examples: - '16.00' currency: type: string description: The three-letter currency code used for monetary amounts. examples: - USD invoice_date: type: - string - 'null' description: >- On a draft, the dates it will be issued (the next month's first day) and due. examples: - Invoice date due_date: type: - string - 'null' description: The value of `due_date`. examples: - '2026-10-07' credit_hold_date: type: - string - 'null' description: The value of `credit_hold_date`. examples: - '2026-10-14' suspension_date: type: - string - 'null' description: The value of `suspension_date`. examples: - '2026-10-14' termination_date: type: - string - 'null' description: The value of `termination_date`. examples: - '2026-10-21' paid_at: type: - string - 'null' description: When payment was recorded, in UTC. examples: - null invoice_id: type: - integer - 'null' description: >- The published invoice, paid like any other through the invoice endpoints. Null until it is published. examples: - 18342 can_pay: type: boolean description: Whether the customer can pay. examples: - true lines: type: - array - 'null' description: The value of `lines`. examples: - - type: usage description: lambda-core resource: Virtual Server team_name: Anomalous Materials month: 2026-09 hours: 672 hourly_rate: '0.02381' monthly_rate: '16.00' amount: '16.00032' started_at: '2026-09-01T00:00:00+00:00' ended_at: '2026-09-30T23:59:59+00:00' - type: monthly_cap description: 'Monthly cap adjustment: lambda-core' resource: Virtual Server team_name: Anomalous Materials month: 2026-09 hours: null hourly_rate: null monthly_rate: null amount: '-0.00032' started_at: null ended_at: null items: $ref: '#/components/schemas/PostpaidInvoiceLineData' required: - id - uuid_short - month - month_label - status - status_label - total - currency - invoice_date - due_date - credit_hold_date - suspension_date - termination_date - paid_at - invoice_id - can_pay - lines title: PostpaidInvoiceData PostpaidInvoiceLineData: type: object description: >- One line of a postpaid invoice: a resource's hours, a cap give-back, a one-off charge or the rounding. examples: - type: usage description: lambda-core resource: Virtual Server team_name: Anomalous Materials month: 2026-09 hours: 672 hourly_rate: '0.02381' monthly_rate: '16.00' amount: '16.00032' started_at: '2026-09-01T00:00:00+00:00' ended_at: '2026-09-30T23:59:59+00:00' properties: type: type: string description: usage, monthly_cap, charge or rounding. examples: - usage description: type: string description: An optional description shown to customers. examples: - lambda-core resource: type: - string - 'null' description: >- The kind of resource the line bills, such as "Virtual Server", which the invoice groups by. Null for the rounding line. examples: - Virtual Server team_name: type: - string - 'null' description: >- The team the line was billed in. Null for the rounding line and for a team since deleted. examples: - Anomalous Materials month: type: string description: >- The month the line was billed for, which is earlier than the invoice's on a carried-over line. examples: - 2026-09 hours: type: - integer - 'null' description: The value of `hours`. examples: - 672 hourly_rate: type: - string - 'null' description: Five decimal places, as charged. examples: - '0.02381' monthly_rate: type: - string - 'null' description: The value of `monthly_rate`. examples: - '16.00' amount: type: string description: >- Five decimal places; the invoice total is rounded up to the cent once, on its own line. examples: - '16.00032' started_at: type: - string - 'null' description: The date and time for started at, in UTC. examples: - '2026-09-01T00:00:00+00:00' ended_at: type: - string - 'null' description: The date and time for ended at, in UTC. examples: - '2026-09-30T23:59:59+00:00' required: - type - description - resource - team_name - month - hours - hourly_rate - monthly_rate - amount - started_at - ended_at title: PostpaidInvoiceLineData 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.