Skip to main content
GET
/
api
/
v1
/
invoices
List Invoices
curl --request GET \
  --url https://app.flowglad.com/api/v1/invoices \
  --header 'Authorization: <api-key>'
{
  "data": [
    {
      "id": "<string>",
      "createdAt": 0,
      "updatedAt": 0,
      "livemode": true,
      "purchaseId": "<string>",
      "invoiceNumber": "<string>",
      "invoiceDate": 0,
      "customerId": "<string>",
      "organizationId": "<string>",
      "status": "draft",
      "billingRunId": "<string>",
      "ownerMembershipId": "<string>",
      "memo": "<string>",
      "bankPaymentOnly": true,
      "type": "<string>",
      "currency": "USD",
      "taxAmount": -1,
      "subtotal": -1,
      "taxState": "<string>",
      "taxRatePercentage": "<string>",
      "applicationFee": -1,
      "pricingModelId": "<string>",
      "billingPeriodId": "<unknown>",
      "dueDate": 0,
      "subscriptionId": "<unknown>",
      "billingPeriodStartDate": "<unknown>",
      "billingPeriodEndDate": "<unknown>",
      "pdfURL": "<string>",
      "receiptPdfURL": "<string>",
      "taxType": "amusement_tax",
      "taxCountry": "AD"
    }
  ],
  "hasMore": true,
  "total": 123,
  "currentCursor": "<string>",
  "nextCursor": "<string>"
}

Authorizations

​
Authorization
string
header
required

Query Parameters

​
cursor
string
​
limit
string

Response

Successful response

​
data
object[]
required

An invoice record, which describes a bill that can be associated with a purchase, subscription, or stand alone. Each invoice has a specific type that determines its behavior and required fields.

​
hasMore
boolean
required
​
total
number
required
​
currentCursor
string
​
nextCursor
string