Skip to main content
GET
/
api
/
invoices
/
{invoice_id}
/
pdf_url
/
cURL
curl --request GET \
  --url https://api.uselotus.io/api/invoices/{invoice_id}/pdf_url/ \
  --header 'Authorization: <api-key>'
{
  "invoice_id": "<string>",
  "invoice_number": "<string>",
  "cost_due": 5000000000,
  "amount": 0,
  "currency": {
    "code": "<string>",
    "name": "<string>",
    "symbol": "<string>"
  },
  "issue_date": "2023-11-07T05:31:56Z",
  "payment_status": "draft",
  "external_payment_obj_id": "<string>",
  "external_payment_obj_type": "stripe",
  "external_payment_obj_status": "<string>",
  "line_items": [
    {
      "name": "<string>",
      "start_date": "2023-11-07T05:31:56Z",
      "end_date": "2023-11-07T05:31:56Z",
      "quantity": 5000000000,
      "billing_type": "in_arrears",
      "metadata": {},
      "plan": {
        "plan_name": "<string>",
        "plan_id": "<string>",
        "version_id": "<string>",
        "version": 123
      },
      "subscription_filters": [
        {
          "value": "<string>",
          "property_name": "<string>"
        }
      ],
      "base": 0,
      "adjustments": [
        {
          "amount": "<string>",
          "account": "<string>",
          "adjustment_type": "sales_tax"
        }
      ],
      "amount": 0,
      "subtotal": 0
    }
  ],
  "customer": {
    "customer_name": "<string>",
    "email": "jsmith@example.com",
    "customer_id": "<string>",
    "address": {
      "city": "<string>",
      "country": "AW",
      "line1": "<string>",
      "line2": "<string>",
      "postal_code": "<string>",
      "state": "<string>"
    }
  },
  "due_date": "2023-11-07T05:31:56Z",
  "start_date": "2023-12-25",
  "end_date": "2023-12-25",
  "seller": {
    "name": "<string>",
    "address": {
      "city": "<string>",
      "country": "AW",
      "line1": "<string>",
      "line2": "<string>",
      "postal_code": "<string>",
      "state": "<string>"
    },
    "phone": "<string>",
    "email": "jsmith@example.com"
  },
  "invoice_pdf": "<string>"
}
Retrieves a link to an invoice’s pdf, generated by Lotus.

Authorizations

​
Authorization
string
header
required

Token-based authentication with required prefix "Token"

Path Parameters

​
invoice_id
string
required

Either an invoice ID (in the format invoice_<uuid>) or an invoice number (in the format YYMMDD-000001)

Response

200 - application/json
​
invoice_id
string
required
​
invoice_number
string
required
​
cost_due
number
required
deprecated
Required range: 0 <= x < 10000000000
​
amount
number
required
Required range: -10000000000 < x < 10000000000
​
currency
object
required
​
issue_date
string<date-time>
required
​
payment_status
enum<string>
required
  • draft - draft
  • voided - voided
  • paid - paid
  • unpaid - unpaid
Available options:
draft,
voided,
paid,
unpaid
​
external_payment_obj_id
string | null
required
​
external_payment_obj_type
enum<string> | null
required
  • stripe - Stripe
  • braintree - Braintree
Available options:
stripe,
braintree
​
line_items
object[]
required
​
customer
object
required
​
due_date
string<date-time> | null
required
​
start_date
string<date>
required
​
end_date
string<date>
required
​
seller
object
required
​
invoice_pdf
string<uri> | null
required
​
external_payment_obj_status
string | null