Invoices

Invoices represent billing documents generated for your workspace subscription. Each invoice contains payment details and can be downloaded as a PDF.

The Invoice Object

Name
id
Type
uuid
Description
Unique identifier for the invoice.
Name
workspace_id
Type
uuid
Description
The workspace this invoice belongs to.
Name
date
Type
date
Description
Invoice date in YYYY-MM-DD format.
Name
status
Type
string
Description
Invoice status (e.g., paid, open, void, uncollectible).
Name
currency
Type
string
Description
Three-letter ISO currency code (e.g., USD, EUR, BRL).
Name
total
Type
integer
Description
Total amount in cents (e.g., 5000 = $50.00).
Name
total_formatted
Type
string
Description
Formatted total amount with currency symbol (e.g., $50.00, €45.00).
Name
created_at
Type
datetime
Description
Timestamp when the invoice record was created.
Name
updated_at
Type
datetime
Description
Timestamp when the invoice record was last updated.

GET/app/invoices

List Invoices

Retrieve a list of all invoices for your workspace, ordered by date (most recent first).

Request

GET

/app/invoices

curl https://api.pipeback.com/app/invoices \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "x-workspace-id: YOUR_WORKSPACE_ID"

Response

{
  "data": [
    {
      "id": "9d5f3d04-5e92-7g4d-1d6h-4e5f6g7h8i9a",
      "workspace_id": "9d5f3cf9-fa6f-498b-b5be-bd078b7d5339",
      "date": "2025-10-01",
      "status": "paid",
      "currency": "USD",
      "total": 9900,
      "total_formatted": "$99.00",
      "created_at": "2025-10-01T00:00:00.000000Z",
      "updated_at": "2025-10-01T00:00:00.000000Z"
    },
    {
      "id": "9d5f3d04-5e92-7g4d-1d6h-4e5f6g7h8i9b",
      "workspace_id": "9d5f3cf9-fa6f-498b-b5be-bd078b7d5339",
      "date": "2025-09-01",
      "status": "paid",
      "currency": "USD",
      "total": 9900,
      "total_formatted": "$99.00",
      "created_at": "2025-09-01T00:00:00.000000Z",
      "updated_at": "2025-09-01T00:00:00.000000Z"
    },
    {
      "id": "9d5f3d04-5e92-7g4d-1d6h-4e5f6g7h8i9c",
      "workspace_id": "9d5f3cf9-fa6f-498b-b5be-bd078b7d5339",
      "date": "2025-08-01",
      "status": "paid",
      "currency": "USD",
      "total": 9900,
      "total_formatted": "$99.00",
      "created_at": "2025-08-01T00:00:00.000000Z",
      "updated_at": "2025-08-01T00:00:00.000000Z"
    }
  ]
}

GET/app/invoices/{id}

Retrieve Invoice PDF

Get the PDF download URL for a specific invoice. The URL is generated from Stripe and provides direct access to the invoice PDF.

The returned URL is temporary and expires after a certain period. It should be used immediately or stored temporarily for download purposes.

Request

GET

/app/invoices/{id}

curl https://api.pipeback.com/app/invoices/9d5f3d04-5e92-7g4d-1d6h-4e5f6g7h8i9a \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "x-workspace-id: YOUR_WORKSPACE_ID"

Response

{
  "url": "https://pay.stripe.com/invoice/acct_xxxxx/invst_xxxxx/pdf?s=ap"
}

Invoice Statuses

Invoices can have the following statuses:

Name
paid
Description
The invoice has been paid successfully.
Name
open
Description
The invoice is awaiting payment.
Name
void
Description
The invoice has been voided and is no longer payable.
Name
uncollectible
Description
The invoice is marked as uncollectible after payment attempts have failed.

Currency Format

Invoice amounts are stored in the smallest currency unit (cents):

USD: 5000 = $50.00
EUR: 4500 = €45.00
BRL: 25000 = R$250.00
GBP: 3999 = £39.99

The total_formatted field provides a human-readable version with the appropriate currency symbol and decimal places.