Sign in
Invoices

Get Invoices

Retrieves the invoices.

get/v1/shops/{shopId}/invoices

Request body

pageinteger

Page number. Must be at least 1.

perPageinteger

Items per page, 1-100. Must be at least 1. Must not be greater than 100.

orderColumn'id' | 'price_usd' | 'paid_usd' | 'created_at' | 'completed_at'
orderDirection'asc' | 'desc'
idstring

Filter by invoice ID or unique ID.

statusesstring[]
emailstring

Filter by customer email.

gatewaysobject

Deprecated. Use payment_method_ids.

payment_method_idsobject

Filter by payment method IDs.

created_at_startstring

Must be a valid date.

created_at_endstring

Must be a valid date. Must be a date after <code>created_at_start</code>.

completed_at_startstring

Must be a valid date.

completed_at_endstring

Must be a valid date. Must be a date after <code>completed_at_start</code>.

product_namestring
variant_namestring
coupon_codestring
ipstring
discord_idstring
discord_usernamestring
deliverablestring

Filter by delivered content.

custom_fieldstring

Filter by custom field value.

archivedstring

Only archived invoices.

manualstring

Only manual invoices.

external_id_typestring
external_id_valuestring
cashapp_notestring
paypalff_notestring
venmo_notestring
customer_idstring

Filter by customer ID.

allboolean

Include full invoice details in the list.

Example request

{
  "page": 1
}

Response

current_pageinteger
first_page_urlstring
frominteger
last_pageinteger
last_page_urlstring
next_page_urlstring
pathstring
per_pageinteger
prev_page_urlstring
tointeger
totalinteger

Example response

{
  "current_page": 1,
  "data": [
    {
      "id": 2,
      "status": "completed",
      "price": "14.99",
      "currency": "USD",
      "paid": "0.00",
      "paid_usd": "0.00",
      "gateway": null,
      "payment_method_id": null,
      "email": "reseller@sellauth.test",
      "salt": "04fa0a37b47bd",
      "manual": false,
      "created_at": "2026-08-28T18:23:02.000000Z",
      "completed_at": "2026-08-28T18:23:02.000000Z",
      "archived_at": null,
      "shop_customer_id": 3,
      "tax_rate": "0.00",
      "ip": "127.0.0.1",
      "country_code": null,
      "user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64)",
      "asn": null,
      "unique_id": "04fa0a37b47bd-0000000000002",
      "product": null,
      "variant": null,
      "items": [
        {
          "id": 2,
          "invoice_id": 2,
          "product_id": 1,
          "variant_id": 1,
          "custom_name": null,
          "product": {
            "id": 1,
            "name": "License Keys",
            "stock_count": 0,
            "images": [
              {
                "id": 1,
                "cloudflare_image_id": null,
                "url": "http://static.mysellauth.test/storage/images/1.webp",
                "pivot": {
                  "product_id": 1,
                  "image_id": 1,
                  "order": 0
                }
              }
            ]
          },
          "variant": {
            "id": 1,
            "name": "Standard"
          }
        }
      ],
      "payment_method": null
    },
    {
      "id": 1,
      "status": "completed",
      "price": "14.99",
      "currency": "USD",
      "paid": "14.99",
      "paid_usd": "14.99",
      "gateway": "STRIPE",
      "payment_method_id": 1,
      "email": "customer@sellauth.test",
      "salt": "e1ba502e01286",
      "manual": false,
      "created_at": "2026-08-28T18:23:02.000000Z",
      "completed_at": "2026-08-28T18:23:02.000000Z",
      "archived_at": null,
      "shop_customer_id": 1,
      "tax_rate": "0.00",
      "ip": "127.0.0.1",
      "country_code": null,
      "user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64)",
      "asn": null,
      "unique_id": "e1ba502e01286-0000000000001",
      "product": null,
      "variant": null,
      "items": [
        {
          "id": 1,
          "invoice_id": 1,
          "product_id": 1,
          "variant_id": 1,
          "custom_name": null,
          "product": {
            "id": 1,
            "name": "License Keys",
            "stock_count": 0,
            "images": [
              {
                "id": 1,
                "cloudflare_image_id": null,
                "url": "http://static.mysellauth.test/storage/images/1.webp",
                "pivot": {
                  "product_id": 1,
                  "image_id": 1,
                  "order": 0
                }
              }
            ]
          },
          "variant": {
            "id": 1,
            "name": "Standard"
          }
        }
      ],
      "payment_method": {
        "id": 1,
        "name": "Stripe",
        "icon_image_id": null,
        "icon_image_url": null,
        "icon_image": null
      }
    }
  ],
  "first_page_url": "http://api.sellauth.test/v1/shops/1/invoices?page=1",
  "from": 1,
  "last_page": 1,
  "last_page_url": "http://api.sellauth.test/v1/shops/1/invoices?page=1",
  "links": [
    {
      "url": null,
      "label": "&laquo; Previous",
      "active": false
    },
    {
      "url": "http://api.sellauth.test/v1/shops/1/invoices?page=1",
      "label": "1",
      "active": true
    },
    {
      "url": null,
      "label": "Next &raquo;",
      "active": false
    }
  ],
  "next_page_url": null,
  "path": "http://api.sellauth.test/v1/shops/1/invoices",
  "per_page": 20,
  "prev_page_url": null,
  "to": 2,
  "total": 2
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.