OpenMeter Billing Settings

Update a billing invoice

Changed on

Update a billing invoice.

Only the mutable fields of the invoice can be edited: description, labels, supplier, customer, workflow settings, and top-level lines. Top-level lines are matched by id; lines without an id are created, and existing lines omitted from lines are deleted. Detailed (child) lines are always computed and cannot be edited directly. Only invoices in draft status can be updated.

put/openmeter/billing/invoices/{invoiceId}

Request

  • Base URL: http://localhost:8888/api/v3
  • URL: http://localhost:8888/api/v3/openmeter/billing/invoices/{invoiceId}
  • Auth: none declared

Path parameters

invoiceIdstring required

ULID (Universally Unique Lexicographically Sortable Identifier).

Example:01G65Z755AFWAKHE12NY0CQ9FH

Request body

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 "_".

type'standard' required

Discriminator field identifying this as a standard invoice.

Response

Invoice updated 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

  • v3159bfd1e78cfRevision changes
    • breaking

      added to the /////////////// request property allOf list

    • warning

      removed from the /////////////// request property allOf list

    • info

      added to the /////////////// response property allOf list for the response status

    • info

      removed from the /////////////// response property allOf list for the response status

  • v39082b60c6dd4Revision changes
    • info

      added the optional property ////// to the response with the status

    • info

      added to the ////// response property allOf list for the response status

    • info

      removed from the ////// response property allOf list for the response status