Issue an invoice

POST/v1/invoices/{id}/issueRun

Requires invoices:write permission.

Headers

Idempotency-Keystringrequired

Example: order-1001-attempt-1

Required. A unique string for this request. See Idempotency.

Path parameters

idstringrequired

The id of the invoice (inv_…).

Example: inv_01k7q3m8x2v5t9n4b6c1d0e7fa

Prefixed with inv_.

Response (200)

dataobjectrequired

The returned object, or an array of objects for a list.

Example: string

metaobjectrequired

Request details such as its id and pagination cursor.

request_idstringrequired

The id of this request. Quote it when you ask support about it.

Example: req_Hy3k9QzT2LmN8vXa

A failed request answers with the common error shape; see Errors.

Request

curl -X POST "https://api.baiyar.com/v1/invoices/{id}/issue" \
  -H "Authorization: Bearer $BAIYAR_KEY" \
  -H "Idempotency-Key: order-1001-attempt-1"

Response

{
  "data": "string",
  "meta": {
    "request_id": "req_Hy3k9QzT2LmN8vXa"
  }
}