downloadstripeinvoices - Bulk Download of Stripe PDF Invoices
Downloads all invoices for a restricted API secret key for a given period. Only the Invoices Stripe permission is required for this key. The maximum number of invoices per call is 300.
This function is charged by credits per item (invoice) or with 4 credits if the call fails. If not all invoices can be downloaded from Stripe, an error will occur and 4 credits will be charged. Use cases for this feature are:
- Monthly download of all your invoices for tax purposes
- Annual reports
- Import to accounting management system
This function covers also pagination requests of the Stripe API.
The maximum number of invoice pdfs is undefined
secretKeystring
Stripe restricted API secret key. Only for invoices. See https://stripe.com/docs/keys#create-restricted-api-secret-key for details
Example:
sk_yoursecretkeycustomerIdstring
The customer ID in Stripe of your customer for whom you want to retrieve the invoices. Otherwise, all invoices for all customers will be loaded.
Example:
cus_stripecustomeridfromDateDD.MM.YYYY
The date from which you would like to receive invoices.
Example:
01.06.2022untilDateDD.MM.YYYY
The date until you wish to receive invoice.
Example:
31.12.2022namingPatternstring
File naming pattern. Defaults to date_invoicenumber.
Possible values are: date_invoicenumber, customerId_date_invoicenumber, date_customerId_invoicenumber, invoice_invoicenumber
Example:
date_invoicenumberAvailable on
