Sign in
User

Get Invoice

Get the current user invoice by ID

get/api/users/@me/invoices/{id}

Request

  • Base URL: https://nodesty.com
  • URL: https://nodesty.com/api/users/@me/invoices/{id}
  • Auth: API key in header Authorization

Path parameters

idstring required
Example:1

Invoice ID

Response

Invoice details for the specified ID

appliedBalancenumber

Balance applied to the invoice

dateinteger

Unix timestamp of the invoice creation date

datePaidinteger nullable

Unix timestamp of the invoice payment date, null if not paid

dueDateinteger

Unix timestamp of the invoice due date

idinteger

Unique identifier for the invoice

isServiceInvoiceboolean

Whether the invoice is for a service or an add funds invoice

status'Draft' | 'Paid' | 'Unpaid' | 'Overdue' | 'Cancelled' | 'Refunded' | 'Payment Pending'

Status of the invoice

subTotalnumber

Subtotal amount of the invoice

totalnumber

Total amount of the invoice

Example response

{
  "appliedBalance": 20,
  "date": 1700000000000,
  "datePaid": 1700000000000,
  "dueDate": 1700000000000,
  "id": 1,
  "isServiceInvoice": true,
  "items": [
    {
      "amount": 10,
      "description": "Web Hosting Service",
      "id": 1,
      "type": "Hosting"
    }
  ],
  "status": "Unpaid",
  "subTotal": 100,
  "total": 120
}

Changes

No recorded changes to this operation across all 3 revisions of this API.