SellApp
ResourcesInvoices

List all invoices

This endpoint allows you to retrieve a paginated list of all your invoices. By default, a maximum of fifteen invoices are shown per page.

This endpoint allows you to retrieve a paginated list of all your invoices. By default, a maximum of fifteen invoices are shown per page.

GET
/v2/invoices

Authorization

bearerAuth
AuthorizationBearer <token>

Provide your SellApp API key as a bearer token.

In: header

Query Parameters

limit?integer

Limit the number of blacklist rules returned.

Default15
Range1 <= value <= 100
page?integer

The page number you are attempting to access.

Default1
Range1 <= value
search?string

Free-text search term.

search_by?string

Which invoice field the search term should be matched against.

Value in"default" | "transaction_id" | "serial_code" | "additional_info" | "product_name" | "discord_data" | "crypto_txid" | "crypto_address" | "coupon_code"
id?string

Filter by invoice ID.

email?string

Filter by customer email.

transaction_id?string

Filter by payment transaction ID.

serial_code?string

Filter by delivered serial.

additional_info?string

Filter by customer-provided additional information.

product_name?string

Filter by product or variant title.

discord_data?string

Filter by attached Discord data.

crypto_txid?string

Filter by crypto TXID.

crypto_address?string

Filter by crypto payment address.

coupon_code?string

Filter by coupon code.

status?array<>

Filter by one or more invoice statuses.

payment_methods?array<>

Filter by one or more payment methods.

sort?string

Sort order for the result set.

Value in"created_at" | "-created_at"

Response Body

application/json

curl -X GET "https://sell.app/api/v2/invoices"
{
  "data": [
    {
      "id": 1,
      "payment": {
        "fee": {
          "base": "0",
          "currency": "USD",
          "units": 1,
          "vat": 0,
          "total": {
            "exclusive": "0",
            "inclusive": "0"
          }
        },
        "gateway": {
          "data": {
            "total": {
              "base": "1999",
              "currency": "USD",
              "units": 1,
              "vat": 0,
              "total": {
                "exclusive": "1999",
                "inclusive": "1999"
              }
            },
            "customer_email": "customer@example.com",
            "transaction_id": "CQEGF35V"
          },
          "type": "COINBASE"
        },
        "subtotal": {
          "base": "1999",
          "currency": "USD",
          "units": 1,
          "vat": 0,
          "total": {
            "exclusive": "1999",
            "inclusive": "1999"
          }
        },
        "expires_at": "2024-01-09T23:50:11.000000Z",
        "full_price": {
          "base": "1999",
          "currency": "USD",
          "units": 1,
          "vat": 0,
          "total": {
            "exclusive": "1999",
            "inclusive": "1999"
          }
        },
        "original_amount": {
          "base": "1999",
          "currency": "USD",
          "units": 1,
          "vat": 0,
          "total": {
            "exclusive": "1999",
            "inclusive": "1999"
          }
        }
      },
      "status": {
        "history": [
          {
            "setAt": "2024-01-09T14:50:11.000000Z",
            "status": "PENDING",
            "updatedAt": "2024-01-09T18:00:50.000000Z"
          }
        ],
        "status": {
          "setAt": "2024-01-09T18:00:50.000000Z",
          "status": "COMPLETED",
          "updatedAt": "2024-01-09T18:00:50.000000Z"
        }
      },
      "webhooks": [],
      "feedback": "",
      "created_at": "2024-01-09T14:50:11.000000Z",
      "updated_at": "2024-01-09T18:00:50.000000Z",
      "store_id": 1,
      "coupon_id": null,
      "subscription_id": null,
      "customer_information": {
        "id": 123,
        "email": "customer@example.com",
        "country": "Germany",
        "location": "Munich",
        "ip": "1.3.3.7",
        "proxied": false,
        "browser_agent": "Mozilla/4.9 (Windows 98; sl-SI; rv:1.9.1.20) Gecko/20110422 Firefox/21.0",
        "vat": {
          "amount": 0,
          "country": "DE"
        }
      }
    }
  ],
  "links": {},
  "meta": {}
}

Overview

On this page, we’ll dive into the different invoice endpoints you can use to manage invoices programmatically.

Search invoices POST

This endpoint is a backward-compatible search endpoint for invoice lookups. It accepts the same filters as the list endpoint, but in a JSON request body instead of query parameters.