List Invoices
Built with APIMatic
Advanced Billing Developer Portalv1.0Advanced Billing Developer Portalv1.0Lists invoices for a site. By default, invoices returned on the index will only include totals, not detailed breakdowns for line_items, discounts, taxes, credits, payments, custom_fields, or refunds. To include breakdowns, pass the specific field as a key in the query with a value set to true.
The username is a Maxio Chargify API key and the password is x. Basic authentication works only with the US and EU environments, which connect to chargify.com directly. The Maxio API Gateway environment does not accept Basic authentication.
In: header
The start date (format YYYY-MM-DD) with which to filter the date_field. Returns invoices with a timestamp at or after midnight (12:00:00 AM) in your site’s time zone on the date specified.
The end date (format YYYY-MM-DD) with which to filter the date_field. Returns invoices with a timestamp up to and including 11:59:59PM in your site’s time zone on the date specified.
The current status of the invoice. Allowed Values: draft, open, paid, pending, voided
Value in
The subscription's ID.
The UID of the subscription group you want to fetch consolidated invoices for. This will return a paginated list of consolidated invoices for the specified group.
The consolidation level of the invoice. Allowed Values: none, parent, child or comma-separated lists of thereof, e.g. none,parent.
Result records are organized in pages. By default, the first page of results is displayed. The page parameter specifies a page number of results to fetch. You can start navigating through the pages to consume the results. You do this by passing in a page parameter. Retrieve the next page by adding ?page=2 to the query string. If there are no results to return, then an empty result set will be returned.
Use in query page=1.
1 <= value1This parameter indicates how many records to fetch in each request. Default value is 20. The maximum allowed values is 200; any per_page value over 200 will be changed to 200.
Use in query per_page=200.
value <= 20020The sort direction of the returned invoices.
"desc"Value in
Include line items data.
falseInclude discounts data.
falseInclude taxes data.
falseInclude credits data.
falseInclude payments data.
falseInclude custom fields data.
falseInclude refunds data.
falseThe type of filter you would like to apply to your search. Use in query date_field=issue_date.
"due_date"Value in
The start date and time (format YYYY-MM-DD HH:MM:SS) with which to filter the date_field. Returns invoices with a timestamp at or after exact time provided in query. You can specify timezone in query - otherwise your site's time zone will be used. If provided, this parameter will be used instead of start_date. Allowed to be used only along with date_field set to created_at or updated_at.
The end date and time (format YYYY-MM-DD HH:MM:SS) with which to filter the date_field. Returns invoices with a timestamp at or before exact time provided in query. You can specify timezone in query - otherwise your site's time zone will be used. If provided, this parameter will be used instead of end_date. Allowed to be used only along with date_field set to created_at or updated_at.
Allows fetching invoices with matching customer id based on provided values. Use in query customer_ids=1,2,3.
Allows fetching invoices with matching invoice number based on provided values. Use in query number=1234,1235.
Allows fetching invoices with matching line items product ids based on provided values. Use in query product_ids=23,34.
Allows specification of the order of the returned list. Use in query sort=total_amount.
"number"Value in
application/json
curl -X GET -G \ --url 'https://subdomain.chargify.com/invoices.json' \ -H 'Accept: application/json' \ -H 'Authorization: Bearer ACCESS_TOKEN'