POST
/
v1
/
exports
Create Export
curl --request POST \
  --url https://api.withflex.com/v1/exports \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "export": {
    "description": "<string>",
    "filters": {
      "payment": {
        "limit": 123,
        "status": "canceled",
        "starting_after": "<string>",
        "ending_before": "<string>",
        "customer": "<string>"
      }
    },
    "metadata": {},
    "type": "product"
  }
}'
{
  "export": {
    "export_id": "<string>",
    "description": "<string>",
    "type": "product",
    "status": "created",
    "created_at": "<string>",
    "started_at": "<string>",
    "completed_at": "<string>",
    "metadata": {},
    "filters": {
      "payment": {
        "limit": 123,
        "status": "canceled",
        "starting_after": "<string>",
        "ending_before": "<string>",
        "customer": "<string>"
      }
    },
    "test_mode": true
  }
}

Authorizations

​
Authorization
string
header
required

Use a Bearer token to access this API.

Body

application/json
​
export
object
required

Response

​
export
object
required

Export defines the export_type and filters needed to export a file Export types are supported for Payments, Subscriptions, Customers, CheckoutSession