Sign in

v1

latestOpenAPI 3.1.02026-07-261444991.2 MB
Invoice

Issue invoice summary

This endpoint allows an eligible invoice to be issued manually. This is only possible with invoices where status is draft, will_auto_issue is false, and an eligible_to_issue_at is a time in the past. Issuing an invoice could possibly trigger side effects, some of which could be customer-visible (e.g. sending emails, auto-collecting payment, syncing the invoice to external providers, etc).

This is a lighter-weight alternative to the issue invoice endpoint, returning an invoice summary without any line item details.

post/invoices/summary/{invoice_id}/issue

Path parameters

invoice_idstring required

Request body

synchronousboolean

If true, the invoice will be issued synchronously. If false, the invoice will be issued asynchronously. The synchronous option is only available for invoices that have no usage fees. If the invoice is configured to sync to an external provider, a successful response from this endpoint guarantees the invoice is present in the provider.

Example request

{
  "synchronous": true
}

Response

OK

metadataobject required

User specified key-value pairs for the resource. If not present, this defaults to an empty dictionary. Individual keys can be removed by setting the value to null, and the entire metadata mapping can be cleared by setting metadata to null.

voided_atstring date-time nullable required

If the invoice has a status of void, this gives a timestamp when the invoice was voided.

paid_atstring date-time nullable required

If the invoice has a status of paid, this gives a timestamp when the invoice was paid.

issued_atstring date-time nullable required

If the invoice has been issued, this will be the time it transitioned to issued (even if it is now in a different state.)

scheduled_issue_atstring date-time nullable required

If the invoice is in draft, this timestamp will reflect when the invoice is scheduled to be issued.

issue_failed_atstring date-time nullable required

If the invoice failed to issue, this will be the last time it failed to issue (even if it is now in a different state.)

sync_failed_atstring date-time nullable required

If the invoice failed to sync, this will be the last time an external invoicing provider sync was attempted. This field will always be null for invoices using Orb Invoicing.

payment_failed_atstring date-time nullable required

If payment was attempted on this invoice but failed, this will be the time of the most recent attempt.

payment_started_atstring date-time nullable required

If payment was attempted on this invoice, this will be the start time of the most recent attempt. This field is especially useful for delayed-notification payment mechanisms (like bank transfers), where payment can take 3 days or more.

amount_duestring required

This is the final amount required to be charged to the customer and reflects the application of the customer balance to the total of the invoice.

created_atstring date-time required

The creation time of the resource in Orb.

currencystring required

An ISO 4217 currency string or credits

due_datestring date-time nullable required

When the invoice payment is due. The due date is null if the invoice is not yet finalized.

idstring required
invoice_pdfstring nullable required

The link to download the PDF representation of the Invoice.

invoice_numberstring required

Automatically generated invoice number to help track and reconcile invoices. Invoice numbers have a prefix such as RFOBWG. These can be sequential per account or customer.

totalstring required

The total after any minimums and discounts have been applied.

status'issued' | 'paid' | 'synced' | 'void' | 'draft' required
invoice_source'subscription' | 'partial' | 'one_off' required
hosted_invoice_urlstring nullable required

A URL for the customer-facing invoice portal. This URL expires 60 days after the link is generated, or 30 days after the invoice's due date — whichever is later.

will_auto_issueboolean required

This is true if the invoice will be automatically issued in the future, and false otherwise.

eligible_to_issue_atstring date-time nullable required

If the invoice has a status of draft, this will be the time that the invoice will be eligible to be issued, otherwise it will be null. If auto-issue is true, the invoice will automatically begin issuing at this time.

memostring nullable required

Free-form text which is available on the invoice PDF and the Orb invoice portal.

invoice_datestring date-time required

The scheduled date of the invoice

Example response

{
  "amount_due": "8.00",
  "created_at": "2022-05-01T07:01:31+00:00",
  "currency": "USD",
  "due_date": "2022-05-30T07:00:00+00:00",
  "invoice_pdf": "https://assets.withorb.com/invoice/rUHdhmg45vY45DX/qEAeuYePaphGMdFb",
  "invoice_number": "JYEFHK-00001",
  "subscription": {
    "id": "VDGsT23osdLb84KD"
  },
  "total": "8.00",
  "customer_balance_transactions": [
    {
      "id": "cgZa3SXcsPTVyC4Y",
      "created_at": "2022-05-01T07:01:31+00:00",
      "starting_balance": "33.00",
      "ending_balance": "22.00",
      "amount": "11.00",
      "description": "An optional description",
      "invoice": {
        "id": "gXcsPTVyC4YZa3Sc"
      }
    }
  ],
  "credit_notes": [
    {
      "voided_at": "2022-05-01T07:01:31+00:00"
    }
  ],
  "payment_attempts": [
    {
      "receipt_pdf": "https://assets.withorb.com/receipt/rUHdhmg45vY45DX/qEAeuYePaphGMdFb"
    }
  ],
  "invoice_date": "2022-05-01T07:00:00+00:00"
}