API Documentation
Addons
Entitlements
Alerts
Costs
Credit Grants
Customers
Wallets
Invoices
- GETGet customer invoice summary
- POSTCreate one-off invoice
- 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
- POSTVoid invoice
Entity Integration Mappings
Environments
Events
Payments
Plans
Prices
Price Units
Integrations
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
- 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
Webhooks
Workflows
Trigger invoice communication webhook
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 invoice communication webhook
Use when sending an invoice to the customer (e.g. trigger email or Slack). Payload includes full invoice details for your integration.
POST
/
invoices
/
{id}
/
comms
/
trigger
Trigger invoice communication webhook
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