List Invoices

invoices.list() -> InvoiceListResponse

get/invoices

List Invoices

ParametersExpand Collapse

subject_id: str

The ID or external ID of the subject to list invoices for.

limit: Optional[int]

maximum100

minimum1

offset: Optional[int]

minimum0

ReturnsExpand Collapse

class InvoiceListResponse: …

has_more: bool

invoices: List[Invoice]

id: str

The ID of the invoice.

created_at: datetime

The date and time the invoice was created.

formatdate-time

hosted_url: Optional[str]

The URL of the hosted invoice.

line_items: List[InvoiceLineItem]

The line items of the invoice.

amount: AmountOutput

currency_code: str

The currency code of the amount.

value: str

The value of the amount in the smallest unit of the currency.

description: str

price_in_unit_amount: AmountOutput

currency_code: str

The currency code of the amount.

value: str

The value of the amount in the smallest unit of the currency.

quantity: int

status: Literal["draft", "open", "paid", 2 more]

The status of the invoice.

Accepts one of the following:

"draft"

"open"

"paid"

"uncollectible"

"void"

subject_id: str

The ID of the subject for the invoice.

total_amount: AmountOutput

The total amount of the invoice.

currency_code: str

The currency code of the amount.

value: str

The value of the amount in the smallest unit of the currency.

List Invoices

from lark import Lark

client = Lark(
    api_key="My API Key",
)
invoices = client.invoices.list(
    subject_id="user_1234567890",
)
print(invoices.has_more)

{
  "has_more": false,
  "invoices": [
    {
      "id": "in_1SS1tIDHrpDCEzdlVd8FH0V4",
      "created_at": "2021-01-01T00:00:00Z",
      "hosted_url": "https://invoice.stripe.com/i/acct_6Q96h5avMho8OKe/test_9USnMMVPQmtUHVUYXV2M...",
      "line_items": [
        {
          "amount": {
            "currency_code": "USD",
            "value": "100"
          },
          "description": "Test Invoice",
          "price_in_unit_amount": {
            "currency_code": "USD",
            "value": "100"
          },
          "quantity": 1
        }
      ],
      "status": "draft",
      "subject_id": "subj_VyX6Q96h5avMho8O7QWlKeXE",
      "total_amount": {
        "currency_code": "USD",
        "value": "100"
      }
    }
  ]
}

Returns Examples

{
  "has_more": false,
  "invoices": [
    {
      "id": "in_1SS1tIDHrpDCEzdlVd8FH0V4",
      "created_at": "2021-01-01T00:00:00Z",
      "hosted_url": "https://invoice.stripe.com/i/acct_6Q96h5avMho8OKe/test_9USnMMVPQmtUHVUYXV2M...",
      "line_items": [
        {
          "amount": {
            "currency_code": "USD",
            "value": "100"
          },
          "description": "Test Invoice",
          "price_in_unit_amount": {
            "currency_code": "USD",
            "value": "100"
          },
          "quantity": 1
        }
      ],
      "status": "draft",
      "subject_id": "subj_VyX6Q96h5avMho8O7QWlKeXE",
      "total_amount": {
        "currency_code": "USD",
        "value": "100"
      }
    }
  ]
}