Authorizations
Enter your API key in the format x-api-key <api-key>*
Path Parameters
Scheduled Task ID
Addons
Connections
CostSheets
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
Entitlements
Entity Integration Mappings
Environments
Events
Features
Payments
Plans
Prices
Price Units
Integrations
Subscriptions
- GETList subscriptions
- POSTCreate subscription
- POSTAdd addon to subscription
- DELRemove addon from subscription
- PUTUpdate subscription line item
- POSTList subscriptions by filter
- POSTGet usage by subscription
- GETGet subscription
- POSTCancel subscription
- POSTExecute subscription plan change
- POSTPreview subscription plan change
- POSTPause a subscription
- GETList all pauses for a subscription
- POSTAdd new phase to subscription schedule
- POSTResume a paused subscription
Tasks
ScheduledTasks
Tax Associations
Tax Rates
Tenants
Users
Webhooks
ScheduledTasks
Trigger force run
Trigger a force run export immediately for a scheduled task with optional custom time range
POST
/
tasks
/
scheduled
/
{id}
/
run
Trigger force run
Copy
curl --request POST \
--url https://api.cloud.flexprice.io/v1/tasks/scheduled/{id}/run \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '{
"end_time": "<string>",
"start_time": "<string>"
}'Copy
{
"end_time": "<string>",
"message": "<string>",
"mode": "<string>",
"start_time": "<string>",
"workflow_id": "<string>"
}⌘I
Trigger force run
Copy
curl --request POST \
--url https://api.cloud.flexprice.io/v1/tasks/scheduled/{id}/run \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '{
"end_time": "<string>",
"start_time": "<string>"
}'Copy
{
"end_time": "<string>",
"message": "<string>",
"mode": "<string>",
"start_time": "<string>",
"workflow_id": "<string>"
}