Invoices

Get Invoices

Changed on Nov 2, 2026

Retrieves the invoices.

get/v1/shops/{shopId}/invoices

Request

Base URL
https://api.sellauth.com
Auth
HTTP bearer
TypeScript
https://skmtc.dev/sellauth/apis/sellauth-api/docs/v1/shops/:shopId/invoices/get.ts
A function with typed inputs. Its response is checked against the schema.

Request body

pageinteger nullable

Page number. Must be at least 1.

perPageinteger nullable

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' nullable

orderDirection'asc' | 'desc' nullable

idstring nullable

Filter by invoice ID or unique ID.

statusesstring[]

underpaidboolean nullable

Only pending invoices that received part of the payment.

disputedboolean nullable

Only invoices with an open payment dispute. Requires the Scale plan.

late_paymentboolean nullable

Only invoices with a late payment waiting to be delivered, refunded or dismissed.

fulfillment_statusesstring[]

emailstring nullable

Filter by customer email.

gatewaysobject nullable

Deprecated. Use payment_method_ids.

payment_method_idsobject nullable

Filter by payment method IDs.

created_at_startstring nullable

Must be a valid date.

created_at_endstring nullable

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

completed_at_startstring nullable

Must be a valid date.

completed_at_endstring nullable

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

product_namestring nullable

variant_namestring nullable

coupon_codestring nullable

ipstring nullable

utm_sourcestring nullable

Filter by exact utm_source.

utm_mediumstring nullable

Filter by exact utm_medium.

utm_campaignstring nullable

Filter by exact utm_campaign.

utm_termstring nullable

Filter by exact utm_term.

utm_contentstring nullable

Filter by exact utm_content.

referrer_hoststring nullable

Filter by exact referrer host.

discord_idstring nullable

discord_usernamestring nullable

deliverablestring nullable

Filter by delivered content.

custom_fieldstring nullable

Filter by custom field value.

archivedstring nullable

Only archived invoices.

manualstring nullable

Only manual invoices.

external_id_typestring nullable

external_id_valuestring nullable

cashapp_notestring nullable

paypalff_notestring nullable

venmo_notestring nullable

zelle_notestring nullable

skrillp2p_notestring nullable

customer_idstring nullable

Filter by customer ID.

allboolean nullable

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 nullable

pathstring

per_pageinteger

prev_page_urlstring nullable

tointeger

totalinteger

Example response

{
  "current_page": 1,
  "data": [
    {
      "id": 4,
      "status": "completed",
      "price": "14.99",
      "currency": "USD",
      "paid": "0.00",
      "paid_usd": "0.00",
      "gateway": null,
      "payment_method_id": null,
      "email": "customer@sellauth.test",
      "salt": "caedc9891db67",
      "manual": false,
      "created_at": "2026-11-01T20:00:51.000000Z",
      "completed_at": "2026-11-01T20:00:51.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,
      "utm_source": null,
      "utm_medium": null,
      "utm_campaign": null,
      "utm_term": null,
      "utm_content": null,
      "referrer_host": null,
      "has_open_dispute": false,
      "has_open_late_payment": false,
      "unique_id": "caedc9891db67-0000000000004",
      "product": null,
      "variant": null,
      "items": [
        {
          "id": 3,
          "invoice_id": 4,
          "product_id": 1,
          "variant_id": 1,
          "custom_name": null,
          "quantity": 1,
          "product": {
            "id": 1,
            "name": "License Keys",
            "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": 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": "7a40790c24db2",
      "manual": false,
      "created_at": "2026-11-01T20:00:51.000000Z",
      "completed_at": "2026-11-01T20:00:51.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,
      "utm_source": null,
      "utm_medium": null,
      "utm_campaign": null,
      "utm_term": null,
      "utm_content": null,
      "referrer_host": null,
      "has_open_dispute": false,
      "has_open_late_payment": false,
      "unique_id": "7a40790c24db2-0000000000002",
      "product": null,
      "variant": null,
      "items": [
        {
          "id": 2,
          "invoice_id": 2,
          "product_id": 1,
          "variant_id": 1,
          "custom_name": null,
          "quantity": 1,
          "product": {
            "id": 1,
            "name": "License Keys",
            "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": "667e99ffee7e5",
      "manual": false,
      "created_at": "2026-11-01T20:00:51.000000Z",
      "completed_at": "2026-11-01T20:00:51.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,
      "utm_source": "newsletter",
      "utm_medium": "email",
      "utm_campaign": "spring_sale",
      "utm_term": null,
      "utm_content": null,
      "referrer_host": "example.com",
      "has_open_dispute": true,
      "has_open_late_payment": false,
      "unique_id": "667e99ffee7e5-0000000000001",
      "product": null,
      "variant": null,
      "items": [
        {
          "id": 1,
          "invoice_id": 1,
          "product_id": 1,
          "variant_id": 1,
          "custom_name": null,
          "quantity": 1,
          "product": {
            "id": 1,
            "name": "License Keys",
            "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",
      "page": null,
      "active": false
    },
    {
      "url": "http://api.sellauth.test/v1/shops/1/invoices?page=1",
      "label": "1",
      "page": 1,
      "active": true
    },
    {
      "url": null,
      "label": "Next &raquo;",
      "page": null,
      "active": false
    }
  ],
  "next_page_url": null,
  "path": "http://api.sellauth.test/v1/shops/1/invoices",
  "per_page": 20,
  "prev_page_url": null,
  "to": 3,
  "total": 3
}

Changes

Nov 2, 2026ff0d59c98d7a Revision changes
- breaking
  request property / was restricted to a list of enum values
- breaking
  request property / was restricted to a list of enum values
- breaking
  the response property // became nullable for the status
- breaking
  the response property // became nullable for the status
- breaking
  the response property // became nullable for the status
- breaking
  the response property // became nullable for the status
- breaking
  the response property //// became nullable for the status
- breaking
  the response property /////// became nullable for the status
- breaking
  the response property // became nullable for the status
- breaking
  the response property // became nullable for the status
- breaking
  the response property // became nullable for the status
- breaking
  the response property // became nullable for the status
- breaking
  the response property // became nullable for the status
- breaking
  the response property // became nullable for the status
- breaking
  the response property // became nullable for the status
- breaking
  the response property // became nullable for the status
- breaking
  the response property // became nullable for the status
- breaking
  the response property // became nullable for the status
- breaking
  the response property // became nullable for the status
- breaking
  the response property became nullable for the status
- breaking
  the response property became nullable for the status
- info
  the request property became nullable
- info
  the request property became nullable
- info
  the request property became nullable
- info
  the request property became nullable
- info
  the request property became nullable
- info
  the request property became nullable
- info
  the request property became nullable
- info
  the request property became nullable
- info
  the request property became nullable
- info
  the request property became nullable
- info
  the request property became nullable
- info
  the request property became nullable
- info
  the request property became nullable
- info
  the request property became nullable
- info
  the request property became nullable
- info
  the request property became nullable
- info
  the request property became nullable
- info
  the request property became nullable
- info
  the request property became nullable
- info
  the request property became nullable
- info
  the request property became nullable
- info
  the request property became nullable
- info
  the request property became nullable
- info
  the request property became nullable
- info
  the request property became nullable
- info
  the request property became nullable
- info
  the request property became nullable
- info
  the request property became nullable
- info
  the request property became nullable
- info
  the request property became nullable
- info
  the request property became nullable
- info
  the request property became nullable
- info
  the request property became nullable
- info
  the request property became nullable
- info
  the request property became nullable
- info
  the request property became nullable
- info
  the request property became nullable
- info
  the request property became nullable
- info
  the request property became nullable
- info
  the request property became nullable
- info
  added the new cancelled enum value to the request property /
- info
  added the new charged_back enum value to the request property /
- info
  added the new completed enum value to the request property /
- info
  added the new confirming enum value to the request property /
- info
  added the new delivered enum value to the request property /
- info
  added the new expired enum value to the request property /
- info
  added the new failed enum value to the request property /
- info
  added the new partially_completed enum value to the request property /
- info
  added the new pending enum value to the request property /
- info
  added the new processing enum value to the request property /
- info
  added the new refunded enum value to the request property /
- info
  added the new shipped enum value to the request property /
- info
  added the new unfulfilled enum value to the request property /
- info
  added the optional property // to the response with the status
Oct 25, 20267c30a806e130 Revision changes
- info
  added the new optional request property
- info
  added the optional property // to the response with the status

Operation history (6 revisions)