Account Invoice

Information about the invoice.

APIs.ioEngineeringPlatform

Properties

Name Type Description
id string The invoice's ID.
status string The invoice's status.
issuedAt string The date on which the invoice was issued.
totalAmount object Information about the invoice's total billed amount.
links object A [JSON API spec](https://jsonapi.org/format/#document-links) object containing hypermedia links.
View JSON Schema on GitHub

JSON Schema

apis-io-engineering-platform-invoicedata-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/invoiceData",
  "title": "Account Invoice",
  "type": "object",
  "description": "Information about the invoice.",
  "properties": {
    "id": {
      "type": "string",
      "description": "The invoice's ID.",
      "example": "inv_7UDSYBJPGQU93N7M"
    },
    "status": {
      "type": "string",
      "description": "The invoice's status.",
      "example": "PAID"
    },
    "issuedAt": {
      "type": "string",
      "format": "date",
      "description": "The date on which the invoice was issued.",
      "example": "2023-10-12"
    },
    "totalAmount": {
      "type": "object",
      "description": "Information about the invoice's total billed amount.",
      "properties": {
        "value": {
          "type": "integer",
          "description": "The amount billed.",
          "example": 440
        },
        "currency": {
          "type": "string",
          "description": "The currency of the billed amount. Currently only supports the `USD` value.",
          "example": "USD"
        }
      }
    },
    "links": {
      "type": "object",
      "description": "A [JSON API spec](https://jsonapi.org/format/#document-links) object containing hypermedia links.",
      "properties": {
        "web": {
          "type": "object",
          "description": "An object containing web-based account references.",
          "properties": {
            "href": {
              "type": "string",
              "format": "url",
              "description": "A URL where you can download the invoice in PDF and view details.",
              "example": "https://pay.postman.com/invoices/pay?invoice_public_id=inv_7UDSYBJPGQU93N7M"
            }
          }
        }
      }
    }
  }
}