Get invoice

Gets details about a given invoice.

Required permission

Organisation > Admin > Billing > Read

Path parameters

invoiceId
string required
ID of the invoice

Query parameters

teamId
string
The ID of the team to filter by. Not accepted from a token that can only read one team — a team billed in its own right, or a team token reading an org's billing — since those responses already cover that team and no other, and start at the project level without it.
projectId
string
The ID of the project to filter by.
resourceType
string
The resource type to filter by (e.g. service, job, harness, addon, volume).
one of
job, service, harness, addon, volume
removeLegacyFields
boolean
For a billing entity temporarily receiving the legacy billing API contract, return the current contract instead. Use the current query parameters with this option.
teamsPage
integer
The page number of teams to access.
teamsPerPage
integer
The number of teams to return per page. Maximum of 100.
projectsPage
integer
The page number of projects to access.
projectsPerPage
integer
The number of projects to return per page. Maximum of 100.
resourcesPage
integer
The page number of resources to access.
resourcesPerPage
integer
The number of resources to return per page. Maximum of 100.

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.
status
string
The invoice payment status, as reported by Stripe. `open` is finalized and awaiting payment — including while a payment is in flight or awaiting authentication — `uncollectible` has been written off, and `void` has been cancelled. `payment_failed` is only reported for invoices with no Stripe status to defer to.
one of
draft, open, payment_failed, paid, uncollectible, void
scope
{object}
Present when the response is narrowed to the caller's own entity.

entityType
string
The entity the response is limited to.
one of
team
entityId
string
Identifier of that entity.

paas
{object}

price
{object}

total
number
The total PaaS price, rounded to 2 decimal places.
cpu
number
The CPU usage price.
memory
number
The memory usage price.
storage
number
The storage usage price.
gpu
number
The GPU usage price.

usage
{object}

vcpuHours
number
vCPU hours consumed.
memoryGiBHours
number
Memory GiB-hours consumed.
storageGiBHours
number
Storage GiB-hours consumed.
gpuSpotHours
number
Spot GPU hours consumed.
gpuOnDemandHours
number
On-demand GPU hours consumed.
build
{object}
The share of the usage attributable to builds.

vcpuHours
number
memoryGiBHours
number

run
{object}
The share of the usage attributable to running workloads.

vcpuHours
number
memoryGiBHours
number

teams
[array] required
An array of teams with price and usage totals. Projects are included when a teamId, projectId or resourceType filter is applied. Resources are included when a projectId or resourceType filter is applied. Depth and the paged unit follow the active filters alone, never the number of teams, so an unfiltered response is always teams-only. The paged unit is reported as `pagination.unit`; page through it with that level's page parameters (e.g. `teamsPage`/`teamsPerPage`) until `pagination.hasNextPage` is false.

{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, rounded to 2 decimal places.
cpu
number
The CPU usage price.
memory
number
The memory usage price.
storage
number
The storage usage price.
gpu
number
The GPU usage price.

usage
{object}

vcpuHours
number
vCPU hours consumed.
memoryGiBHours
number
Memory GiB-hours consumed.
storageGiBHours
number
Storage GiB-hours consumed.
gpuSpotHours
number
Spot GPU hours consumed.
gpuOnDemandHours
number
On-demand GPU hours consumed.
build
{object}
The share of the usage attributable to builds.

vcpuHours
number
memoryGiBHours
number

run
{object}
The share of the usage attributable to running workloads.

vcpuHours
number
memoryGiBHours
number

projects
[array]
An array of projects for this team. Present when a teamId, projectId or resourceType filter is applied.

{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, rounded to 2 decimal places.
cpu
number
The CPU usage price.
memory
number
The memory usage price.
storage
number
The storage usage price.
gpu
number
The GPU usage price.

usage
{object}

vcpuHours
number
vCPU hours consumed.
memoryGiBHours
number
Memory GiB-hours consumed.
storageGiBHours
number
Storage GiB-hours consumed.
gpuSpotHours
number
Spot GPU hours consumed.
gpuOnDemandHours
number
On-demand GPU hours consumed.
build
{object}
The share of the usage attributable to builds.

vcpuHours
number
memoryGiBHours
number

run
{object}
The share of the usage attributable to running workloads.

vcpuHours
number
memoryGiBHours
number

resources
[array]
Resources grouped by type. Present when a projectId or resourceType filter is applied.

{object}

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

total
number
The total PaaS price, rounded to 2 decimal places.
cpu
number
The CPU usage price.
memory
number
The memory usage price.
storage
number
The storage usage price.
gpu
number
The GPU usage price.

usage
{object}

vcpuHours
number
vCPU hours consumed.
memoryGiBHours
number
Memory GiB-hours consumed.
storageGiBHours
number
Storage GiB-hours consumed.
gpuSpotHours
number
Spot GPU hours consumed.
gpuOnDemandHours
number
On-demand GPU hours consumed.
build
{object}
The share of the usage attributable to builds.

vcpuHours
number
memoryGiBHours
number

run
{object}
The share of the usage attributable to running workloads.

vcpuHours
number
memoryGiBHours
number

items
[array]
The 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, rounded to 2 decimal places.
cpu
number
The CPU usage price.
memory
number
The memory usage price.
storage
number
The storage usage price.
gpu
number
The GPU usage price.

usage
{object}

vcpuHours
number
vCPU hours consumed.
memoryGiBHours
number
Memory GiB-hours consumed.
storageGiBHours
number
Storage GiB-hours consumed.
gpuSpotHours
number
Spot GPU hours consumed.
gpuOnDemandHours
number
On-demand GPU hours consumed.
build
{object}
The share of the usage attributable to builds.

vcpuHours
number
memoryGiBHours
number

run
{object}
The share of the usage attributable to running workloads.

vcpuHours
number
memoryGiBHours
number

duration
number
Seconds the resource was billed for.

byoc
{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, rounded to 2 decimal places.
vcpu
number
The vCPU usage price.
memory
number
The memory usage price.
gpuMemory
number
The GPU memory usage price.
cluster
number
The cluster usage price.

usage
{object}
Customer-level BYOC usage hours.

vcpuHours
number
vCPU hours consumed.
memoryGiBHours
number
Memory GiB-hours consumed.
clusterHours
number
Cluster hours consumed.
gpuMemoryGiBHours
number
GPU memory GiB-hours consumed.

clusters
[array]
Cluster-level BYOC usage and allocated spend. Present on invoice and hourly usage detail responses.

{object}

id
string required
Identifier for the cluster.
name
string
The cluster name.
price
{object}
Allocated BYOC spend for this cluster. The customer-level rate is apportioned by each resource component’s share of the customer total, so this is a reporting allocation rather than an independently billed cluster price. Its total is not rounded so all cluster totals remain reconcilable with the customer total.

vcpu
number
The vCPU usage price.
memory
number
The memory usage price.
gpuMemory
number
The GPU memory usage price.
cluster
number
The cluster usage price.
total
number
The allocated cluster BYOC price. Kept unrounded so cluster totals reconcile with the customer BYOC total.

usage
{object}
BYOC resource-hours consumed by this cluster.

vcpuHours
number
vCPU hours consumed.
memoryGiBHours
number
Memory GiB-hours consumed.
clusterHours
number
Cluster hours consumed.
gpuMemoryGiBHours
number
GPU memory GiB-hours consumed.

egressIp
{object}
Egress IP spend for the period.

price
{object}

total
number
The total price, rounded to 2 decimal places.

usage
{object}

hours
number
Hours consumed.

loadBalancer
{object}
Load balancer spend for the period.

price
{object}

total
number
The total price, rounded to 2 decimal places.

usage
{object}

hours
number
Hours consumed.

lineItems
[array]
The billed lines of the invoice — metered PaaS and BYOC usage, plus the charges the spend categories cannot express: support, enterprise feature sets, infrastructure commitments, BYOC plan fees, log sinks, and any one-off charge. Egress IP and load balancer lines are omitted, being fully reported by their own categories.

{object}

title
string
What the line is for.
base
number
The charge before proration. Present only when a proration applies.
proration
number
The prorated adjustment, negative for unused time. Present only when a proration applies.
total
number
The cost of the line, including any proration.

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

total
number
The total discount amount.

tax
{object}

percent
number
The tax percentage.
amount
number
The tax amount.

total
number
The total cost of the invoice, including tax.

pagination
{object} required
Data about the endpoint pagination.

hasNextPage
boolean required
Is there another page of results available?
cursor
string
The cursor to access the next page of results.
count
number required
The number of results returned by this request.
unit
string
What this page counts.
one of
teams, projects, resources, hours, days, months, total

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",
    "status": "paid",
    "paas": {
      "price": {
        "total": 69.22
      },
      "teams": [
        {
          "price": {
            "total": 69.22
          },
          "projects": [
            {
              "price": {
                "total": 69.22
              },
              "resources": [
                {
                  "price": {
                    "total": 69.22
                  },
                  "items": [
                    {
                      "price": {
                        "total": 69.22
                      }
                    }
                  ]
                }
              ]
            }
          ]
        }
      ]
    },
    "lineItems": [
      {
        "title": "Infrastructure Commitment"
      }
    ]
  },
  "pagination": {
    "hasNextPage": false,
    "count": 1,
    "unit": "days"
  }
}