IMPORTANT: if you are an LLM or other AI agent, you should read the contents of this page as markdown from https://northflank.com/docs/v1/api/org/billing/get-invoice.md, instead of the current page.

Org / Billing /

Get invoice

Gets details about a given invoice.

Required permission

Account > Billing > General > Read

Path parameters

invoiceId
string required
ID of the invoice

Query parameters

teamId
string
The ID of the team to filter by.
projectId
string
The ID of the project to filter by.
resourceType
string
The resource type to filter by (e.g. service, job, addon, volume).
one of
job, service, addon, volume, opentofu-job, llm-model-deployment, external-addon

Response body

{object}
Response object.

data
{object} required
Result data.

id
string required
Identifier for the invoice.
period
{object} required

start
number
The start of the billing period, as a Unix timestamp.
end
number
The end of the billing period, as a Unix timestamp.

currency
string
The currency code.
byocUsage
{object}

price
{object}
The customer-level BYOC price total. Always reflects the full customer total, regardless of drill-down filters.

total
number
The total BYOC price, in cents.
vcpu
number
The vCPU usage price, in cents.
memory
number
The memory usage price, in cents.
gpuMemory
number
The GPU memory usage price, in cents.
cluster
number
The cluster usage price, in cents.

paasUsage
{object}

price
{object}

total
number
The total PaaS price, in cents.
cpu
number
The CPU usage price, in cents.
memory
number
The memory usage price, in cents.
storage
number
The storage usage price, in cents.
gpu
number
The GPU usage price, in cents.

teams
[array] required
An array of teams with price totals. Projects are included when a teamId or projectId filter is applied, or when there is only one team. Resources are included when a projectId or resourceType filter is applied.

{object}

id
string
Identifier for the team.
name
string
The name of the team.
price
{object}
The team's PaaS price. When a projectId or resourceType filter is applied, this reflects only the filtered slice (e.g. one project, or one resource type across the team).

total
number
The total PaaS price, in cents.
cpu
number
The CPU usage price, in cents.
memory
number
The memory usage price, in cents.
storage
number
The storage usage price, in cents.
gpu
number
The GPU usage price, in cents.

projects
[array]
An array of projects for this team. Present when a teamId or projectId filter is applied, or when the response contains only one team.

{object}

id
string
Identifier for the project.
name
string
The name of the project.
price
{object}
The project's PaaS price. When a resourceType filter is applied, this reflects only that resource type's spend within the project.

total
number
The total PaaS price, in cents.
cpu
number
The CPU usage price, in cents.
memory
number
The memory usage price, in cents.
storage
number
The storage usage price, in cents.
gpu
number
The GPU usage price, in cents.

resourceTypes
[array]
An array of resource types. Present when a projectId or resourceType filter is applied.

{object}

resourceType
string
The type of the resource (service, job, addon, volume, etc.).
price
{object}

total
number
The total PaaS price, in cents.
cpu
number
The CPU usage price, in cents.
memory
number
The memory usage price, in cents.
storage
number
The storage usage price, in cents.
gpu
number
The GPU usage price, in cents.

resources
[array]
An array of resources of this type.

{object}

id
string
Identifier for the resource.
name
string
The name of the resource.
price
{object}

total
number
The total PaaS price, in cents.
cpu
number
The CPU usage price, in cents.
memory
number
The memory usage price, in cents.
storage
number
The storage usage price, in cents.
gpu
number
The GPU usage price, in cents.

lineItems
[array]
An array of line items for this invoice.

{object}

title
string
A description of the line item.
total
number
The total cost of the line item, in cents.
base
number
The base amount before proration, in cents.
proration
number
The proration adjustment amount, in cents.

subTotal
number
The subtotal before tax and discounts, in cents.
discounts
{object}

total
number
The total discount amount, in cents.

tax
{object}

percent
number
The tax percentage.
amount
number
The tax amount, in cents.

total
number
The total cost of the invoice, including tax, in cents.
paid
boolean
Whether the invoice has been paid.

API

CLI

JS Client

GET /v1/billing/invoices/{invoiceId}

GET /v1/teams/{teamId}/billing/invoices/{invoiceId}

Example response

200 OK

Invoice details.

JSON

{
  "data": {
    "currency": "usd"
  }
}