Get invoice payment link state

Return active and previous payment-link state for one invoice. Use this to avoid generating a new link unnecessarily; use POST /api/v2/billing/invoices/{id}/actions/generate-payment-link when hasActiveLink is false or the active URL should be refreshed.

Billing & Orders Invoices

Authentication

Required API scope: read:billing

Use Authorization: Bearer <token> for API keys. Dashboard sessions may also use hostup_session.

Context

Related endpoints

POST /api/v2/billing/invoices/{id}/actions/generate-payment-link Generate invoice payment link GET /api/v2/billing/invoices/{id} Get invoice details POST /api/v2/billing/invoices/{id}/actions/pay Pay invoice by saved card

Path Parameters

id string required Example: inv_01hxa3b4c5d6e7f8g9h0j1k2m3

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.

Headers

Accept Example

Content-Type Example

Responses

200 Invoice payment-link state.

hasActiveLink boolean · Example: false

paymentUrl stringnull · Example: https://cloud.hostup.se/billing/pay/550e8400-e29b-41d4-a716-446655440000

Present when `hasActiveLink` is true; omitted when there is no active link.

expiresAt stringnull · Example: 2026-05-27T12:00:00.000Z

Present when `hasActiveLink` is true; omitted when there is no active link.

viewCount integer · Example: 3

lastViewedAt string · Example: 2026-04-27T12:30:00.000Z

previousLinks array<object>

previousLinks[].createdAt stringnull required · Example: 2026-04-01T09:00:00.000Z

previousLinks[].expired boolean required · Example: true

previousLinks[].invalidatedAt stringnull required · Example: 2026-04-10T09:00:00.000Z

previousLinks[].invalidationReason stringnull required · Example: replaced

previousLinks[].views integer · Example: 1

400 Invalid request. The response body is an RFC 7807 Problem Details document.

type string · Example: https://developer.hostup.se/errors/invalid_request

title string · Example: Validation failed

status integer · Example: 400

detail string · Example: The request body failed validation.

code string · Example: invalid_request

Stable machine-readable code. Branch on this field, not on `detail`.

instance string · Example: /api/v2/orders

requestId string · Example: req_01hxa3b4c5d6e7f8g9h0j1k2m3

timestamp string · Example: 2026-04-27T12:34:56.000Z

errors array<object>

Field-level validation errors when `code` is `invalid_request`.

errors[].pointer string required · Example: /items/0/eppCode

errors[].detail string required · Example: `eppCode` is required for this transfer.

errors[].code string required · Example: missing_required

extensions object

401 Unauthorized. Authentication is required.

type string · Example: https://developer.hostup.se/errors/invalid_request

title string · Example: Validation failed

status integer · Example: 400

detail string · Example: The request body failed validation.

code string · Example: invalid_request

Stable machine-readable code. Branch on this field, not on `detail`.

instance string · Example: /api/v2/orders

requestId string · Example: req_01hxa3b4c5d6e7f8g9h0j1k2m3

timestamp string · Example: 2026-04-27T12:34:56.000Z

errors array<object>

Field-level validation errors when `code` is `invalid_request`.

errors[].pointer string required · Example: /items/0/eppCode

errors[].detail string required · Example: `eppCode` is required for this transfer.

errors[].code string required · Example: missing_required

extensions object

403 Forbidden. The caller lacks a required scope or does not own the resource.

type string · Example: https://developer.hostup.se/errors/invalid_request

title string · Example: Validation failed

status integer · Example: 400

detail string · Example: The request body failed validation.

code string · Example: invalid_request

Stable machine-readable code. Branch on this field, not on `detail`.

instance string · Example: /api/v2/orders

requestId string · Example: req_01hxa3b4c5d6e7f8g9h0j1k2m3

timestamp string · Example: 2026-04-27T12:34:56.000Z

errors array<object>

Field-level validation errors when `code` is `invalid_request`.

errors[].pointer string required · Example: /items/0/eppCode

errors[].detail string required · Example: `eppCode` is required for this transfer.

errors[].code string required · Example: missing_required

extensions object

404 Not found. The resource does not exist or is not owned by the caller.

type string · Example: https://developer.hostup.se/errors/invalid_request

title string · Example: Validation failed

status integer · Example: 400

detail string · Example: The request body failed validation.

code string · Example: invalid_request

Stable machine-readable code. Branch on this field, not on `detail`.

instance string · Example: /api/v2/orders

requestId string · Example: req_01hxa3b4c5d6e7f8g9h0j1k2m3

timestamp string · Example: 2026-04-27T12:34:56.000Z

errors array<object>

Field-level validation errors when `code` is `invalid_request`.

errors[].pointer string required · Example: /items/0/eppCode

errors[].detail string required · Example: `eppCode` is required for this transfer.

errors[].code string required · Example: missing_required

extensions object

429 Rate limited. Retry after the limit resets. 429 responses include `Retry-After` seconds plus `X-RateLimit-*` headers.

type string · Example: https://developer.hostup.se/errors/invalid_request

title string · Example: Validation failed

status integer · Example: 400

detail string · Example: The request body failed validation.

code string · Example: invalid_request

Stable machine-readable code. Branch on this field, not on `detail`.

instance string · Example: /api/v2/orders

requestId string · Example: req_01hxa3b4c5d6e7f8g9h0j1k2m3

timestamp string · Example: 2026-04-27T12:34:56.000Z

errors array<object>

Field-level validation errors when `code` is `invalid_request`.

errors[].pointer string required · Example: /items/0/eppCode

errors[].detail string required · Example: `eppCode` is required for this transfer.

errors[].code string required · Example: missing_required

extensions object

500 Internal error. Retry later or contact support if the issue persists.

type string · Example: https://developer.hostup.se/errors/invalid_request

title string · Example: Validation failed

status integer · Example: 400

detail string · Example: The request body failed validation.

code string · Example: invalid_request

Stable machine-readable code. Branch on this field, not on `detail`.

instance string · Example: /api/v2/orders

requestId string · Example: req_01hxa3b4c5d6e7f8g9h0j1k2m3

timestamp string · Example: 2026-04-27T12:34:56.000Z

errors array<object>

Field-level validation errors when `code` is `invalid_request`.

errors[].pointer string required · Example: /items/0/eppCode

errors[].detail string required · Example: `eppCode` is required for this transfer.

errors[].code string required · Example: missing_required

extensions object

GET https://cloud.hostup.se/api/v2/billing/invoices/{id}/payment-link

For AI assistants

View as Markdown

cURL

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

Response

{
  "hasActiveLink": false,
  "previousLinks": []
}

{
  "type": "object",
  "properties": {
    "hasActiveLink": {
      "type": "boolean"
    },
    "paymentUrl": {
      "type": [
        "string",
        "null"
      ],
      "description": "Present when `hasActiveLink` is true; omitted when there is no active link."
    },
    "expiresAt": {
      "type": [
        "string",
        "null"
      ],
      "description": "Present when `hasActiveLink` is true; omitted when there is no active link."
    },
    "viewCount": {
      "type": "integer"
    },
    "lastViewedAt": {
      "type": "string"
    },
    "previousLinks": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "createdAt": {
            "type": [
              "string",
              "null"
            ]
          },
          "expired": {
            "type": "boolean"
          },
          "invalidatedAt": {
            "type": [
              "string",
              "null"
            ]
          },
          "invalidationReason": {
            "type": [
              "string",
              "null"
            ]
          },
          "views": {
            "type": "integer"
          }
        }
      }
    }
  }
}