API Documentation
Addons
Entitlements
Alerts
Costs
Credit Grants
Customers
Wallets
Invoices
- GETGet customer invoice summary
- POSTCreate one-off invoice
- POSTGet invoice preview using meter_usage data
- POSTGet invoice preview
- POSTQuery invoices
- GETGet invoice
- PUTUpdate invoice
- POSTTrigger invoice communication webhook
- POSTFinalize invoice
- PUTUpdate invoice payment status
- POSTAttempt invoice payment
- GETGet invoice PDF
- POSTRecalculate invoice (voided invoice)
- POSTRecalculate draft invoice (v2)
- POSTVoid invoice
Environments
Events
Integrations
Payments
Plans
Prices
Price Units
Subscriptions
- POSTCreate subscription
- POSTAdd addon to subscription
- DELRemove addon from subscription
- PUTUpdate subscription line item
- DELDelete subscription line item
- POSTQuery subscriptions
- POSTGet usage by subscription
- GETGet subscription
- PUTUpdate subscription
- POSTActivate draft subscription
- GETGet active addon associations
- POSTCancel subscription
- POSTExecute subscription plan change
- POSTPreview subscription plan change
- GETGet subscription entitlements
- GETGet upcoming credit grant applications
- POSTCreate subscription line item
- POSTExecute subscription modification
- POSTPreview subscription modification
- POSTPause a subscription
- GETList all pauses for a subscription
- POSTResume a paused subscription
- GETGet subscription (V2)
- GETList all subscription schedules
- GETGet subscription schedule
- POSTCancel subscription schedule
- GETList subscription schedules
Tasks
Scheduled Tasks
Tax Associations
Tax Rates
Webhook Events
- POSTcredit_note.created
- POSTcredit_note.updated
- POSTcustomer.created
- POSTcustomer.deleted
- POSTcustomer.updated
- POSTentitlement.created
- POSTentitlement.deleted
- POSTentitlement.updated
- POSTfeature.created
- POSTfeature.deleted
- POSTfeature.updated
- POSTfeature.wallet_balance.alert
- POSTinvoice.communication.triggered
- POSTinvoice.payment.overdue
- POSTinvoice.update
- POSTinvoice.update.finalized
- POSTinvoice.update.payment
- POSTinvoice.update.voided
- POSTpayment.created
- POSTpayment.failed
- POSTpayment.pending
- POSTpayment.success
- POSTpayment.updated
- POSTsubscription.activated
- POSTsubscription.cancelled
- POSTsubscription.created
- POSTsubscription.draft.created
- POSTsubscription.paused
- POSTsubscription.phase.created
- POSTsubscription.phase.deleted
- POSTsubscription.phase.updated
- POSTsubscription.renewal.due
- POSTsubscription.resumed
- POSTsubscription.updated
- POSTwallet.created
- POSTwallet.credit_balance.dropped
- POSTwallet.credit_balance.recovered
- POSTwallet.ongoing_balance.dropped
- POSTwallet.ongoing_balance.recovered
- POSTwallet.terminated
- POSTwallet.transaction.created
- POSTwallet.updated
Workflows
Get invoice PDF
curl --request GET \
--url https://us.api.flexprice.io/v1/invoices/{id}/pdf \
--header 'x-api-key: <api-key>'"<string>"Invoices
Get invoice PDF
Use when delivering an invoice PDF to the customer (e.g. email attachment or download). Use url=true for a presigned URL instead of binary. Use force_generate=true to regenerate and re-upload the PDF even if one already exists in S3.
GET
/
invoices
/
{id}
/
pdf
Get invoice PDF
curl --request GET \
--url https://us.api.flexprice.io/v1/invoices/{id}/pdf \
--header 'x-api-key: <api-key>'"<string>"Authorizations
Enter your API key in the format x-api-key <api-key>*
Path Parameters
Invoice ID
Query Parameters
Return presigned URL from s3 instead of PDF
Force regeneration of the PDF even if one already exists in S3 (default: false). Note: force_generate has no effect if invoice_pdf_url is already set on the invoice.
Response
OK
The response is of type file.
⌘I