API Documentation
Addons
Entitlements
Alert Logs
Connections
Costs
Coupons
CreditGrants
Credit Notes
Customers
Wallets
Invoices
- GETGet a customer invoice summary
- GETList invoices
- POSTCreate a new one off invoice
- POSTGet a preview invoice
- POSTList invoices by filter
- GETGet an invoice by ID
- PUTUpdate an invoice
- POSTTrigger communication webhook for an invoice
- POSTFinalize an invoice
- PUTUpdate invoice payment status
- POSTAttempt payment for an invoice
- GETGet PDF for an invoice
- POSTRecalculate invoice totals and line items
- POSTVoid an invoice
Entity Integration Mappings
Environments
Events
Features
Payments
Plans
CustomerPortal
Prices
Price Units
Integrations
Subscriptions
- GETList subscriptions
- POSTCreate subscription
- POSTAdd addon to subscription
- DELRemove addon from subscription
- PUTUpdate subscription line item
- DELDelete subscription line item
- POSTList subscriptions by filter
- POSTGet usage by subscription
- GETGet 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
- 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
ScheduledTasks
Tax Associations
Tax Rates
Tenants
Trigger communication webhook for an invoice
Copy
curl --request POST \
--url https://us.api.flexprice.io/v1/invoices/{id}/comms/trigger \
--header 'x-api-key: <api-key>'Copy
{
"message": "<string>"
}Invoices
Trigger communication webhook for an invoice
Triggers a communication webhook event containing all information about the invoice
POST
/
invoices
/
{id}
/
comms
/
trigger
Trigger communication webhook for an invoice
Copy
curl --request POST \
--url https://us.api.flexprice.io/v1/invoices/{id}/comms/trigger \
--header 'x-api-key: <api-key>'Copy
{
"message": "<string>"
}⌘I