Create Export
Copy
Ask AI
curl --request POST \
--url https://api.withflex.com/v1/exports \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"export": {
"type": "product",
"description": "<string>",
"filters": {
"payment": {
"limit": 123,
"status": "canceled",
"starting_after": "<string>",
"ending_before": "<string>",
"customer": "<string>"
}
},
"metadata": {}
}
}
'Copy
Ask AI
{
"export": {
"export_id": "<string>",
"type": "product",
"status": "created",
"created_at": "<string>",
"test_mode": true,
"description": "<string>",
"started_at": "<string>",
"completed_at": "<string>",
"metadata": {},
"filters": {
"payment": {
"limit": 123,
"status": "canceled",
"starting_after": "<string>",
"ending_before": "<string>",
"customer": "<string>"
}
}
}
}Create Export
Creates a new export function
POST
/
v1
/
exports
Create Export
Copy
Ask AI
curl --request POST \
--url https://api.withflex.com/v1/exports \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"export": {
"type": "product",
"description": "<string>",
"filters": {
"payment": {
"limit": 123,
"status": "canceled",
"starting_after": "<string>",
"ending_before": "<string>",
"customer": "<string>"
}
},
"metadata": {}
}
}
'Copy
Ask AI
{
"export": {
"export_id": "<string>",
"type": "product",
"status": "created",
"created_at": "<string>",
"test_mode": true,
"description": "<string>",
"started_at": "<string>",
"completed_at": "<string>",
"metadata": {},
"filters": {
"payment": {
"limit": 123,
"status": "canceled",
"starting_after": "<string>",
"ending_before": "<string>",
"customer": "<string>"
}
}
}
}Authorizations
Use a Bearer token to access this API.
Body
application/json
Show child attributes
Show child attributes
Available options:
product, payment, subscription, customer, checkout_session, charge_reconciliation, payout - Option 1
- Option 2
- Option 3
- Option 4
- Option 5
- Option 6
- Option 7
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Available options:
canceled, processing, requires_action, requires_capture, requires_confirmation, requires_payment_method, succeeded Response
Export defines the export_type and filters needed to export a file Export types are supported for Payments, Subscriptions, Customers, CheckoutSession
Show child attributes
Show child attributes
The unique identifier for the export.
The export type for the export.
Available options:
product, payment, subscription, customer, checkout_session, charge_reconciliation, payout The export status for the export.
Available options:
created, started, cancelled, failed, processing, completed The date the export object was created.
Whether the export is in test mode
The description of the export.
The date the export functionality was started.
The date the export functionality was completed.
Metadata information for the export object
Filter information for the export object
- Option 1
- Option 2
- Option 3
- Option 4
- Option 5
- Option 6
- Option 7
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Available options:
canceled, processing, requires_action, requires_capture, requires_confirmation, requires_payment_method, succeeded ⌘I