Sign in
OpenMeter Billing Settings

Get a billing invoice

Get a billing invoice by ID.

Returns the full invoice resource including line items, status details, totals, and workflow configuration snapshot.

get/openmeter/billing/invoices/{invoiceId}

Path parameters

invoiceIdstring required

ULID (Universally Unique Lexicographically Sortable Identifier).

Example:01G65Z755AFWAKHE12NY0CQ9FH

Response

Invoice response.

idstring required

ULID (Universally Unique Lexicographically Sortable Identifier).

descriptionstring

Optional description of the resource.

Maximum 1024 characters.

labelsLabels

Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.

Keys must be of length 1-63 characters, and cannot start with "kong", "konnect", "mesh", "kic", or "_".

created_atstring date-time required

RFC3339 formatted date-time string in UTC.

updated_atstring date-time required

RFC3339 formatted date-time string in UTC.

deleted_atstring date-time

RFC3339 formatted date-time string in UTC.

numberstring required

InvoiceNumber is a unique identifier for the invoice, generated by the invoicing app.

The uniqueness depends on a lot of factors:

  • app setting (unique per app or unique per customer)
  • multiple app scenarios (multiple apps generating invoices with the same prefix)
currencystring required

Three-letter ISO4217 currency code. Custom three-letter currency codes are also supported for convenience.

type'standard' required

Discriminator field identifying this as a standard invoice.

status'draft' | 'issuing' | 'issued' | 'payment_processing' | 'overdue' | 'paid' | 'uncollectible' | 'voided' required

Lifecycle status of a standard invoice.

issued_atstring date-time

RFC3339 formatted date-time string in UTC.

draft_untilstring date-time

RFC3339 formatted date-time string in UTC.

quantity_snapshotted_atstring date-time

RFC3339 formatted date-time string in UTC.

collection_atstring date-time

RFC3339 formatted date-time string in UTC.

due_atstring date-time

RFC3339 formatted date-time string in UTC.

sent_to_customer_atstring date-time

RFC3339 formatted date-time string in UTC.

Changes

Changed in 5 of the 61 revisions of this API.222

  • v39bca44e2d61d1See the full diff
    • ○

      added the optional property oneOf[BillingInvoiceStandard]/lines/items/oneOf[BillingInvoiceStandardLine]/usage_quantity_detail to the response with the 200 status

      response-optional-property-added

  • v3a10b6108f8f81See the full diff
    • ○

      added the optional property oneOf[BillingInvoiceStandard]/lines/items/oneOf[BillingInvoiceStandardLine]/rate_card/allOf[BillingInvoiceLineRateCard]/unit_config to the response with the 200 status

      response-optional-property-added

  • v39d1396ec00b3119See the full diff
    • ▲

      the response property oneOf[BillingInvoiceStandard]/lines/items/oneOf[BillingInvoiceStandardLine]/id became optional for the status 200

      response-property-became-optional

    • ○

      added the optional property oneOf[BillingInvoiceStandard]/workflow/allOf[BillingInvoiceWorkflowSettings]/workflow/allOf[BillingInvoiceWorkflow]/invoicing/allOf[BillingInvoiceWorkflowInvoicingSettings]/due_after to the response with the 200 status

      response-optional-property-added

    • ○

      the response optional property oneOf[BillingInvoiceStandard]/lines became not read-only for the status 200

      response-optional-property-became-not-read-only

    • ○

      the response optional property oneOf[BillingInvoiceStandard]/lines/items/oneOf[BillingInvoiceStandardLine]/rate_card/allOf[BillingInvoiceLineRateCard]/discounts became not read-only for the status 200

      response-optional-property-became-not-read-only

    • ○

      the response optional property oneOf[BillingInvoiceStandard]/lines/items/oneOf[BillingInvoiceStandardLine]/rate_card/allOf[BillingInvoiceLineRateCard]/feature_key became not read-only for the status 200

      response-optional-property-became-not-read-only

    • ○

      the response optional property oneOf[BillingInvoiceStandard]/lines/items/oneOf[BillingInvoiceStandardLine]/rate_card/allOf[BillingInvoiceLineRateCard]/tax_config became not read-only for the status 200

      response-optional-property-became-not-read-only

    • ○

      the response optional property oneOf[BillingInvoiceStandard]/workflow/allOf[BillingInvoiceWorkflowSettings]/workflow/allOf[BillingInvoiceWorkflow]/invoicing became not read-only for the status 200

      response-optional-property-became-not-read-only

    • ○

      the response optional property oneOf[BillingInvoiceStandard]/workflow/allOf[BillingInvoiceWorkflowSettings]/workflow/allOf[BillingInvoiceWorkflow]/invoicing/allOf[BillingInvoiceWorkflowInvoicingSettings]/auto_advance became not read-only for the status 200

      response-optional-property-became-not-read-only

    • ○

      the response optional property oneOf[BillingInvoiceStandard]/workflow/allOf[BillingInvoiceWorkflowSettings]/workflow/allOf[BillingInvoiceWorkflow]/invoicing/allOf[BillingInvoiceWorkflowInvoicingSettings]/draft_period became not read-only for the status 200

      response-optional-property-became-not-read-only

    • ○

      the response optional property oneOf[BillingInvoiceStandard]/workflow/allOf[BillingInvoiceWorkflowSettings]/workflow/allOf[BillingInvoiceWorkflow]/payment became not read-only for the status 200

      response-optional-property-became-not-read-only

    • ○

      the response required property oneOf[BillingInvoiceStandard]/customer became not read-only for the status 200

      response-required-property-became-not-read-only

    • ○

      the response required property oneOf[BillingInvoiceStandard]/lines/items/oneOf[BillingInvoiceStandardLine]/id became not read-only for the status 200

      response-required-property-became-not-read-only

    • ○

      the response required property oneOf[BillingInvoiceStandard]/lines/items/oneOf[BillingInvoiceStandardLine]/rate_card became not read-only for the status 200

      response-required-property-became-not-read-only

    • ○

      the response required property oneOf[BillingInvoiceStandard]/lines/items/oneOf[BillingInvoiceStandardLine]/rate_card/allOf[BillingInvoiceLineRateCard]/price became not read-only for the status 200

      response-required-property-became-not-read-only

    • ○

      the response required property oneOf[BillingInvoiceStandard]/lines/items/oneOf[BillingInvoiceStandardLine]/service_period became not read-only for the status 200

      response-required-property-became-not-read-only

    • ○

      the response required property oneOf[BillingInvoiceStandard]/lines/items/oneOf[BillingInvoiceStandardLine]/type became not read-only for the status 200

      response-required-property-became-not-read-only

    • ○

      the response required property oneOf[BillingInvoiceStandard]/supplier became not read-only for the status 200

      response-required-property-became-not-read-only

    • ○

      the response required property oneOf[BillingInvoiceStandard]/type became not read-only for the status 200

      response-required-property-became-not-read-only

    • ○

      the response required property oneOf[BillingInvoiceStandard]/workflow became not read-only for the status 200

      response-required-property-became-not-read-only

    • ○

      the response required property oneOf[BillingInvoiceStandard]/workflow/allOf[BillingInvoiceWorkflowSettings]/workflow became not read-only for the status 200

      response-required-property-became-not-read-only

  • v3ec36b1a6d6761See the full diff
    • ○

      endpoint added

      endpoint-added

    This revision also has 8 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • v39d0042cb38151See the full diff
    • ▲

      api path removed without deprecation

      api-path-removed-without-deprecation

    This revision also has 112 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog