List Subscription Proforma Invoices
Built with APIMatic
Advanced Billing Developer Portalv1.0Advanced Billing Developer Portalv1.0Lists proforma invoices for a subscription. By default, results only include totals, not detailed breakdowns for line_items, discounts, taxes, credits, payments, or custom_fields. 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 Chargify id of the subscription.
The beginning date range for the invoice's Due Date, in the YYYY-MM-DD format.
The ending date range for the invoice's Due Date, in the YYYY-MM-DD format.
The current status of the invoice. Allowed Values: draft, open, paid, pending, voided
Value in
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.
falseapplication/json
curl -X GET -G \ --url 'https://subdomain.chargify.com/subscriptions/1/proforma_invoices.json' \ -H 'Accept: application/json' \ -H 'Authorization: Bearer ACCESS_TOKEN'