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
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
- 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
Tasks
ScheduledTasks
Tax Associations
Tax Rates
Tenants
ScheduledTasks
Get a scheduled task
Get a scheduled task by ID
GET
/
tasks
/
scheduled
/
{id}
Get a scheduled task
Copy
curl --request GET \
--url https://api.cloud.flexprice.io/v1/tasks/scheduled/{id} \
--header 'x-api-key: <api-key>'Copy
{
"connection_id": "<string>",
"created_at": "<string>",
"enabled": true,
"entity_type": "events",
"environment_id": "<string>",
"id": "<string>",
"interval": "custom",
"job_config": {
"bucket": "<string>",
"compression": "none",
"encryption": "AES256",
"endpoint_url": "<string>",
"key_prefix": "<string>",
"region": "<string>",
"use_path_style": true
},
"status": "<string>",
"tenant_id": "<string>",
"updated_at": "<string>"
}Authorizations
Enter your API key in the format x-api-key <api-key>*
Path Parameters
Scheduled Task ID
Response
OK
Available options:
events, invoice, credit_topups Available options:
custom, hourly, daily Show child attributes
Show child attributes
S3 bucket name
Available options:
none, gzip Available options:
AES256, aws:kms, aws:kms:dsse Custom S3 endpoint URL (e.g., "http://minio:9000" for MinIO)
Optional prefix for S3 keys (e.g., "flexprice-exports/")
AWS region (e.g., "us-west-2")
Use path-style addressing instead of virtual-hosted-style (required for MinIO)
Previous
Update a scheduled taskUpdate a scheduled task by ID - Only enabled field can be changed (pause/resume)
Next
⌘I
Get a scheduled task
Copy
curl --request GET \
--url https://api.cloud.flexprice.io/v1/tasks/scheduled/{id} \
--header 'x-api-key: <api-key>'Copy
{
"connection_id": "<string>",
"created_at": "<string>",
"enabled": true,
"entity_type": "events",
"environment_id": "<string>",
"id": "<string>",
"interval": "custom",
"job_config": {
"bucket": "<string>",
"compression": "none",
"encryption": "AES256",
"endpoint_url": "<string>",
"key_prefix": "<string>",
"region": "<string>",
"use_path_style": true
},
"status": "<string>",
"tenant_id": "<string>",
"updated_at": "<string>"
}