## GET /api/v2/billing/invoices/{id}/payg-breakdown

**Attribute PAYG invoice to Cloud VPS servers**

Attribute a pay-as-you-go usage invoice back to the Cloud VPS servers that generated the charges — including servers deleted since. PAYG is billed at the account level, so the invoice line items carry no server identity; this sub-resource joins the invoice's metered period against recorded per-server usage and apportions each resource amount by usage share, so per-server amounts sum to `attributedAmount`. `resources` is always present: one plain-language row per metered resource (extra IPv4 addresses, CPU, memory, storage, data transfer) with the billed amount and approximate equivalents such as address count × days or average cores/GB over the period — use it to explain the invoice even when `vms` is empty (for example a floating-IP-only invoice on an account with no PAYG servers). `coverage` says how much of the period the per-server recording spans: `full` (reliable), `partial` (amounts are a lower bound), or `none` (pre-recording invoice — `vms` lists which Cloud VPS servers existed in the window without amounts, and can be empty). Invoices without PAYG line items return `available: false`.

### Related Endpoints

- `GET /api/v2/billing/invoices/{id}`: Get invoice details
- `GET /api/v2/billing/invoices/{id}/pdf`: Get invoice PDF
- `GET /api/v2/billing/invoices/{id}/email-info`: Get invoice email info

### Headers

- `Accept`: application/json
- `Authorization`: Bearer YOUR_API_KEY
- Required API scope: `read:billing`

### Parameters

- `id` (path, string, required): Public invoice ID from `GET /api/v2/billing/invoices` `data[].id` or invoice detail. Do not invent this value; use the exact ID returned by the referenced API response. Example: `inv_01hxa3b4c5d6e7f8g9h0j1k2m3`

### Request Example

```bash
curl -X GET "https://cloud.hostup.se/api/v2/billing/invoices/inv_01hxa3b4c5d6e7f8g9h0j1k2m3/payg-breakdown" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"
```

### Response Schema

- `available` (boolean, required) Example: `true`
  Allowed values: true
- `period` (object, required)
- `period.startAt` (string, required) Example: `2026-05-31T16:00:03.000Z`
- `period.endAt` (string, required) Example: `2026-06-30T00:00:00.000Z`
- `coverage` (string, required) Example: `full`
  Allowed values: full, partial, none
- `currencyCode` (string, required) Example: `SEK`
- `amountsExclVat` (boolean, required): All amounts in this response are pre-tax (excl. VAT); reconcile against the invoice subtotal, not the grand total. Example: `true`
  Allowed values: true
- `attributedAmount` (number, required): Total amount apportioned across servers, in major units of `currencyCode`, excl. VAT. Per-server `estimatedAmount` values sum to this. Example: `118.17`
- `resources` (array<object>, required): One row per metered resource on the invoice, with the billed amount (excl. VAT) and approximate plain-language equivalents. Always derivable from the invoice lines, so it is populated regardless of `coverage`. Sorted by amount, largest first.
- `resources[].key` (string, required) Example: `ipv4`
  Allowed values: cpu, memory, storage, ipv4, bandwidth
- `resources[].amount` (number, required): Billed amount for this resource, in major units of `currencyCode`, excl. VAT. Example: `13.21`
- `resources[].quantityHours` (number, optional): Metered quantity in hours (core-hours, GB-hours, IP-hours). Absent for bandwidth rows. Example: `440.5`
- `resources[].quantityGb` (number, optional): Metered quantity in GB. Bandwidth rows only. Example: `82.4`
- `resources[].ipCountApprox` (number, optional): ipv4 only: approximate number of concurrent extra IPv4 addresses billed. Example: `1`
- `resources[].ipDaysApprox` (number, optional): ipv4 only: approximate days each address was held. Example: `18`
- `resources[].averageCoresApprox` (number, optional): cpu only: average vCPU cores in use across the metered period. Example: `3.5`
- `resources[].averageGbApprox` (number, optional): memory/storage only: average GB in use across the metered period. Example: `8.2`
- `vms` (array<object>, required)
- `vms[].id` (string, required, nullable): Nullable (may be null when not applicable). Example: `vps_06eywdj26ccqd4sg5qxm80pmyr`
- `vms[].name` (string, required, nullable): Nullable (may be null when not applicable). Example: `yopass`
- `vms[].displayName` (string, optional) Example: `Password server`
- `vms[].firstObservedAt` (string, optional) Example: `2026-05-31T00:00:00.000Z`
- `vms[].lastObservedAt` (string, optional) Example: `2026-06-30T00:00:00.000Z`
- `vms[].latestObservedAt` (string, optional) Example: `2026-07-06T00:00:00.000Z`
- `vms[].usage` (object, optional)
- `vms[].usage.cpuCoreHours` (number, required) Example: `1394`
- `vms[].usage.ramGbHours` (number, required) Example: `2788`
- `vms[].usage.diskGbHours` (number, required) Example: `34850`
- `vms[].usage.bandwidthGb` (number, required) Example: `82.4`
- `vms[].usage.ipHours` (number, required) Example: `697`
- `vms[].estimatedAmount` (number, optional): This server's estimated share of `attributedAmount`, in major units of `currencyCode`, excl. VAT. Example: `64.2`
- `unattributedAmount` (number, optional): Amount that could not be tied to a specific server, in major units of `currencyCode`, excl. VAT. Example: `12.5`
- `unattributedNote` (string, optional) Example: `Part of this invoice is metered usage that cannot be tied to a specific VM (e.g. object storage, mail relay, or usage outside the recorded window).`
- `note` (string, optional) Example: `Per-VM usage recording covers only part of this invoice period, so per-VM amounts are a lower bound for the covered days.`

### Responses

#### 200 - Per-server attribution for the invoice's metered period, or an unavailable response for non-PAYG invoices.
```json
{
  "available": true,
  "period": {
    "startAt": "2026-05-31T16:00:03.000Z",
    "endAt": "2026-06-30T00:00:00.000Z"
  },
  "coverage": "full",
  "currencyCode": "SEK",
  "amountsExclVat": true,
  "attributedAmount": 118.17,
  "resources": [
    {
      "key": "cpu",
      "amount": 48.79,
      "quantityHours": 1394,
      "averageCoresApprox": 2
    },
    {
      "key": "storage",
      "amount": 33.46,
      "quantityHours": 34850,
      "averageGbApprox": 49
    },
    {
      "key": "ipv4",
      "amount": 20.91,
      "quantityHours": 697,
      "ipCountApprox": 1,
      "ipDaysApprox": 29
    },
    {
      "key": "memory",
      "amount": 15.01,
      "quantityHours": 2788,
      "averageGbApprox": 3.9
    }
  ],
  "vms": [
    {
      "id": "vps_06eywdj26ccqd4sg5qxm80pmyr",
      "name": "yopass",
      "firstObservedAt": "2026-05-31T00:00:00.000Z",
      "lastObservedAt": "2026-06-30T00:00:00.000Z",
      "latestObservedAt": "2026-07-06T00:00:00.000Z",
      "usage": {
        "cpuCoreHours": 1394,
        "ramGbHours": 2788,
        "diskGbHours": 34850,
        "bandwidthGb": 82.4,
        "ipHours": 697
      },
      "estimatedAmount": 118.17
    }
  ]
}
```

#### 400 - Invalid request. The response body is an RFC 7807 Problem Details document.
```json
{
  "type": "https://developer.hostup.se/errors/invalid_request",
  "title": "Invalid request",
  "status": 400,
  "detail": "The request body failed validation.",
  "code": "invalid_request",
  "instance": "/api/v2/resource",
  "requestId": "req_01hxa3b4c5d6e7f8g9h0j1k2m3",
  "timestamp": "2026-04-27T12:34:56.000Z",
  "errors": [
    {
      "pointer": "/items/0/domainName",
      "detail": "`domainName` is required.",
      "code": "invalid_request"
    }
  ]
}
```

#### 401 - Unauthorized. Authentication is required.
```json
{
  "type": "https://developer.hostup.se/errors/unauthorized",
  "title": "Unauthorized",
  "status": 401,
  "detail": "Authentication is required.",
  "code": "unauthorized",
  "instance": "/api/v2/resource",
  "requestId": "req_01hxa3b4c5d6e7f8g9h0j1k2m3",
  "timestamp": "2026-04-27T12:34:56.000Z"
}
```

#### 403 - Forbidden. The caller lacks a required scope or does not own the resource.
```json
{
  "type": "https://developer.hostup.se/errors/forbidden",
  "title": "Forbidden",
  "status": 403,
  "detail": "The caller lacks a required scope or does not own the resource.",
  "code": "forbidden",
  "instance": "/api/v2/resource",
  "requestId": "req_01hxa3b4c5d6e7f8g9h0j1k2m3",
  "timestamp": "2026-04-27T12:34:56.000Z"
}
```

#### 404 - Not found. The resource does not exist or is not owned by the caller.
```json
{
  "type": "https://developer.hostup.se/errors/not_found",
  "title": "Not found",
  "status": 404,
  "detail": "The requested resource could not be found.",
  "code": "not_found",
  "instance": "/api/v2/resource",
  "requestId": "req_01hxa3b4c5d6e7f8g9h0j1k2m3",
  "timestamp": "2026-04-27T12:34:56.000Z"
}
```

#### 429 - Rate limited. Retry after the limit resets. 429 responses include `Retry-After` seconds plus `X-RateLimit-*` headers.
```json
{
  "type": "https://developer.hostup.se/errors/rate_limit_exceeded",
  "title": "Too many requests",
  "status": 429,
  "detail": "Too many requests. Retry after the limit resets.",
  "code": "rate_limit_exceeded",
  "instance": "/api/v2/resource",
  "requestId": "req_01hxa3b4c5d6e7f8g9h0j1k2m3",
  "timestamp": "2026-04-27T12:34:56.000Z"
}
```

#### 500 - Internal error. Retry later or contact support if the issue persists.
```json
{
  "type": "https://developer.hostup.se/errors/internal_error",
  "title": "Internal server error",
  "status": 500,
  "detail": "An unexpected error occurred. Retry later or contact support if the issue persists.",
  "code": "internal_error",
  "instance": "/api/v2/resource",
  "requestId": "req_01hxa3b4c5d6e7f8g9h0j1k2m3",
  "timestamp": "2026-04-27T12:34:56.000Z"
}
```