v1

latestOpenAPI 3.0.32026-07-248519153.1 KB

Retrieve a list of all client invoices

Fetch all invoices for a client based on the payment system. Supports Stripe, Paddle, PayPal, and Primer payment systems.

get/subscription/invoices

pay_system_idstring required

ID of the subscription in external Stripe/Paddle/PayPal/Primer, e.g. sub_1PzNJzCsRq5tBi2bbfNsAf86or I-H7HC902MYM49

limitinteger

Number of records to retrieve (default: 100, max: 1000).

offsetstring

Pagination offset using the ID of the last invoice on the page. For Stripe: starting_after parameter, for Paddle: after parameter.

List of invoices retrieved successfully.

successinteger

errorinteger

dataobject[]

Array of invoice objects. Structure varies by payment system.

{
  "success": 1
}