Billing

Retrieve all invoices.

Admins and API key callers see every invoice. Non-admin users see only invoices belonging to the account they are the primary contact of. Pass excludeInvoiceUid as a query parameter to omit a specific invoice from the result set.

get/api/v1/billing/invoices

Request

  • Base URL: https://go.outseta.com
  • URL: https://go.outseta.com/api/v1/billing/invoices
  • Auth: one of:
    • HTTP bearer
    • API key in header Authorization

Query parameters

limitinteger

Requested page size. The server caps it at 100, or 25 when requested fields expand child objects or require additional queries; metadata.limit reports the applied value. Use offset=1 for the second page.

offsetinteger

Zero-based page number, not a record offset. With limit=50, the second page is offset=1; offset=50 is page index 50 (records 2501-2550).

excludeInvoiceUidstring

The invoice Uid to omit from the result set.

Response

Example response

{
  "metadata": {
    "limit": 0,
    "offset": 0,
    "total": 0
  },
  "items": [
    {
      "Uid": "string",
      "_objectType": "string",
      "Created": "string",
      "Updated": "string",
      "ActivityEventData": {},
      "InvoiceDate": "string",
      "PaymentReminderSentDate": "string",
      "Number": 0,
      "BillingInvoiceStatus": 1,
      "Subscription": {},
      "Amount": 0,
      "AmountOutstanding": 0,
      "InvoiceLineItems": [],
      "IsUserGenerated": false,
      "StripeTaxCalculationId": "string",
      "StripeTaxBehavior": "string",
      "AmountCredit": 0,
      "AmountDiscount": 0,
      "AmountPaid": 0,
      "AmountRefunded": 0,
      "AmountSubtotal": 0,
      "AmountTax": 0,
      "AmountTaxRefunded": 0,
      "IsTaxable": false,
      "HasPaymentGatewayTransactions": false,
      "StripePaymentTransactionIds": "string",
      "StripeRefundTransactionIds": "string",
      "StripeTaxRefundTransactionIds": "string"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.