Skip to content

Resource

Invoices

List, create, search, and manage invoices.

The invoice object

Attributes

  • invoiceobject
    Show 19 child attributesHide child attributes
    • idinteger
      Example: 48213
    • slugstring
      Example: k7xq2m9d4r
    • numberstring
      Example: INV-1042
    • invoice_typestring
      Example: invoice
    • total_pricestring
      Example: 100.94
    • currencystring
      Example: USD
    • financial_statusstring
      Example: paid
    • fulfillment_statusstring
      Example: fulfilled
    • order_namestring
      Example: #1042
    • order_numberinteger
      Example: 1042
    • processed_atstring
      Example: 2026-01-15T09:30:00Z
    • notestring
      Example: Please leave at the front desk.
    • created_atstring
      Example: 2026-01-15T09:31:12Z
    • updated_atstring
      Example: 2026-01-15T09:31:40Z
    • customerobject
      Show 4 child attributesHide child attributes
      • idinteger
        Example: 9177
      • emailstring
        Example: jane.doe@example.com
      • first_namestring
        Example: Jane
      • last_namestring
        Example: Doe
    • billing_addressobject
      Show 10 child attributesHide child attributes
      • first_namestring
        Example: Jane
      • last_namestring
        Example: Doe
      • companystring
        Example: Doe Studio
      • address1string
        Example: 12 Example Street
      • address2string
        Example: Suite 4
      • citystring
        Example: Springfield
      • provincestring
        Example: Illinois
      • countrystring
        Example: United States
      • zipstring
        Example: 62701
      • phonestring
        Example: +1 555 010 0199
    • shipping_addressobject
      Show 10 child attributesHide child attributes
      • first_namestring
        Example: Jane
      • last_namestring
        Example: Doe
      • companystring
      • address1string
        Example: 12 Example Street
      • address2string
      • citystring
        Example: Springfield
      • provincestring
        Example: Illinois
      • countrystring
        Example: United States
      • zipstring
        Example: 62701
      • phonestring
        Example: +1 555 010 0199
    • line_itemsarray of objects
      Show 5 child attributesHide child attributes
      • titlestring
        Example: Canvas tote bag
      • variant_titlestring
        Example: Natural / Large
      • quantityinteger
        Example: 2
      • pricestring
        Example: 45.00
      • skustring
        Example: TOTE-NAT-L
    • tax_linesarray of objects
      Show 3 child attributesHide child attributes
      • titlestring

        Tax name (e.g. VAT, GST).

      • ratenumber

        Decimal rate (e.g. 0.2 for 20%).

      • pricestring
        Example: 5.94
The invoice object
{
  "invoice": {
    "id": 48213,
    "slug": "k7xq2m9d4r",
    "number": "INV-1042",
    "invoice_type": "invoice",
    "total_price": "100.94",
    "currency": "USD",
    "financial_status": "paid",
    "fulfillment_status": "fulfilled",
    "order_name": "#1042",
    "order_number": 1042,
    "processed_at": "2026-01-15T09:30:00Z",
    "note": "Please leave at the front desk.",
    "created_at": "2026-01-15T09:31:12Z",
    "updated_at": "2026-01-15T09:31:40Z",
    "customer": {
      "id": 9177,
      "email": "jane.doe@example.com",
      "first_name": "Jane",
      "last_name": "Doe"
    },
    "billing_address": {
      "first_name": "Jane",
      "last_name": "Doe",
      "company": "Doe Studio",
      "address1": "12 Example Street",
      "address2": "Suite 4",
      "city": "Springfield",
      "province": "Illinois",
      "country": "United States",
      "zip": "62701",
      "phone": "+1 555 010 0199"
    },
    "shipping_address": {
      "first_name": "Jane",
      "last_name": "Doe",
      "company": null,
      "address1": "12 Example Street",
      "address2": null,
      "city": "Springfield",
      "province": "Illinois",
      "country": "United States",
      "zip": "62701",
      "phone": "+1 555 010 0199"
    },
    "line_items": [
      {
        "title": "Canvas tote bag",
        "variant_title": "Natural / Large",
        "quantity": 2,
        "price": "45.00",
        "sku": "TOTE-NAT-L"
      },
      {
        "title": "Gift wrapping",
        "variant_title": null,
        "quantity": 1,
        "price": "5.00",
        "sku": null
      }
    ],
    "tax_lines": [
      {
        "title": "State tax",
        "rate": 0.0625,
        "price": "5.94"
      }
    ]
  }
}