Sign in
OpenMeter Billing Settings

Advance billing invoice's next status

Advance a billing invoice.

Advances the invoice to the next workflow state. The next state is determined by the invoice's current status and workflow configuration. Only invoices in draft or issued status can be advanced.

post/openmeter/billing/invoices/{invoiceId}/advance

Path parameters

invoiceIdstring required

ULID (Universally Unique Lexicographically Sortable Identifier).

Example:01G65Z755AFWAKHE12NY0CQ9FH

Response

The updated invoice after advancing to the next state.

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 62 revisions of this API.14

  • v3ae31232bc5571See the full diff
    • ○

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

      response-optional-property-added

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

  • v39bca44e2d61d1See the full diff
    • ○

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

      response-optional-property-added

  • v3a10b6108f8f81See the full diff
    • ○

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

      response-optional-property-added

  • v396078cb479471See the full diff
    • ○

      endpoint added

      endpoint-added

  • 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