SuccessResponse_InvoiceArray

successboolean

Constant value: true

data object[]

Array [

idinteger

organizationIdinteger

billingCurrencystring

ISO 4217 currency code the invoice's amounts are denominated in.

statusstring

Lifecycle status. The underlying model also has a draft status, but drafts are never returned by the organization-facing endpoints.

Possible values: [issued, paid, void]

totalAmountnumber

Total invoice amount in billingCurrency.

periodStartstring<date-time>

periodEndstring<date-time>

issuedAtstring,null<date-time>nullable

When the invoice was issued, null while still a draft.

dueAtstring,null<date-time>nullable

Net-term payment due date, stamped on issuance.

paidAtstring,null<date-time>nullable

When the invoice was marked paid, null until then.

createdAtstring<date-time>

updatedAtstring<date-time>

lines object[]

Array [

idinteger

invoiceIdinteger

subjectKindstring

Which kind of billable thing this line covers; subjectRef names the specific one.

Possible values: [dataset, endpoint, model]

subjectRefstring

ID of the specific dataset, endpoint, or AI model this line covers.

descriptionstring

quantitynumber

unitstring

ratePerUnitnumber

Rate applied per unit, in the invoice's billing currency.

amountnumber

Line amount in the invoice's billing currency (quantity * ratePerUnit, currency-converted from nativeAmount where applicable).

nativeAmountnumber

Line amount in its original native currency, before conversion to the invoice's billing currency.

nativeCurrencystring

ISO 4217 currency code nativeAmount is denominated in.

appliedRateIdinteger | nullnullable

ID of the rate-catalog entry applied to this line, null if none was applied.

sourceRefsobject | nullnullable

Free-form JSON pointing back to the usage records this line was generated from.

createdAtstring<date-time>

]

]

SuccessResponse_InvoiceArray

{
  "success": true,
  "data": [
    {
      "id": 0,
      "organizationId": 0,
      "billingCurrency": "string",
      "status": "issued",
      "totalAmount": 0,
      "periodStart": "2024-07-29T15:51:28.071Z",
      "periodEnd": "2024-07-29T15:51:28.071Z",
      "issuedAt": "2024-07-29T15:51:28.071Z",
      "dueAt": "2024-07-29T15:51:28.071Z",
      "paidAt": "2024-07-29T15:51:28.071Z",
      "createdAt": "2024-07-29T15:51:28.071Z",
      "updatedAt": "2024-07-29T15:51:28.071Z",
      "lines": [
        {
          "id": 0,
          "invoiceId": 0,
          "subjectKind": "dataset",
          "subjectRef": "string",
          "description": "string",
          "quantity": 0,
          "unit": "string",
          "ratePerUnit": 0,
          "amount": 0,
          "nativeAmount": 0,
          "nativeCurrency": "string",
          "appliedRateId": 0,
          "sourceRefs": "Unknown Type: object,null",
          "createdAt": "2024-07-29T15:51:28.071Z"
        }
      ]
    }
  ]
}