API documentation

API documentation

Overview

Retrieve synchronized customers and invoices and download InvoiceXpress or Stripe documents from your systems. This is a read-only API, and every request is scoped to the Stripe account and mode associated with the access code.

What you can build
Use the API to embed billing data and documents into your own products and processes.
  • Display up-to-date fiscal and billing information for a customer.
  • Present invoice histories with search, filters and pagination.
  • Provide InvoiceXpress and Stripe PDFs in a portal or workflow.
  • Reconcile Stripe states, synchronization and InvoiceXpress documents.

Suggested path

Follow these steps to move from an access code to your first complete flow.

1

Configure access

Generate the code and make your first authenticated request.

2

Retrieve a customer

Validate the scope and understand the customer contract.

3

Read an invoice

Retrieve line items, totals, states and download paths.

Endpoints

Select an endpoint to view its parameters, scope rules and complete request and response examples.

GET

Retrieve a customer

/client/:customerId

Returns billing information for a Stripe customer.

GET

List customer invoices

/client/:customerId/invoices

Lists and filters a customer's synchronized invoices.

GET

Retrieve invoice details

/client/:customerId/invoice/:invoiceId

Returns the invoice, line items and available download links.

GET

Download InvoiceXpress PDF

/client/:customerId/invoice/:invoiceId/ix/download

Redirects to a temporary InvoiceXpress PDF URL.

GET

Download Stripe PDF

/client/:customerId/invoice/:invoiceId/stripe/download

Redirects to the PDF hosted by Stripe.