Scheduled Tasks

Create scheduled task

Changed on

Use when setting up recurring data exports or other scheduled jobs. Ideal for report generation or syncing data on a schedule.

post/tasks/scheduled

Request

  • Base URL
    https://us.api.flexprice.io/v1
  • URL
    https://us.api.flexprice.io/v1/tasks/scheduled
  • Auth
    API key in header x-api-key

Request body

connection_idstring required
enabledboolean
entity_type'events' | 'invoice' | 'credit_topups' | 'wallet_debits' | 'credit_usage' | 'usage_analytics' | 'revenue_facts' required
interval'15MIN' | '30MIN' | 'custom' | 'hourly' | 'daily' required

Response

Created

connection_idstring
created_atstring date-time
enabledboolean
entity_type'events' | 'invoice' | 'credit_topups' | 'wallet_debits' | 'credit_usage' | 'usage_analytics' | 'revenue_facts'
environment_idstring
idstring
interval'15MIN' | '30MIN' | 'custom' | 'hourly' | 'daily'
statusstring
tenant_idstring
updated_atstring date-time

Changes

  • de915dc839feRevision changes
    • warning

      added the new wallet_debits enum value to the response property for the response status

    • info

      added the new wallet_debits enum value to the request property

  • b395e3f05ba2Revision changes
    • warning

      added the new revenue_facts enum value to the response property for the response status

    • info

      added the new revenue_facts enum value to the request property