WIwithflex
Exports

List Exports

Changed on

Returns a list of your exports, sorted with the most recently created exports first.

get/v1/exports

Request

  • Base URL
    https://api.withflex.com
  • URL
    https://api.withflex.com/v1/exports
  • Auth
    HTTP bearer

Query parameters

starting_afterstring nullable

A cursor for use in pagination. starting_after is an export ID that defines your place in the list.

Example:fxprt_01J9XR8M3K7VZ8N2YB4WJ6T0RA
ending_beforestring nullable

A cursor for use in pagination. ending_before is an export ID that defines your place in the list.

Example:fxprt_01J9XR8M3K7VZ8N2YB4WJ6T0RA
limitinteger nullable

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

Example:10
offsetinteger nullable

Number of objects to skip before returning results.

Example:3

Response

An envelope wrapping a list of export objects.

Example response

{
  "export": [
    {
      "export_id": "fxprt_01J9XR8M3K7VZ8N2YB4WJ6T0RA",
      "description": "Premium SPF 50 mineral sunscreen",
      "type": "product",
      "status": "created",
      "created_at": "2026-06-15T14:30:00Z",
      "started_at": "2026-06-15T14:30:00Z",
      "completed_at": "2026-06-15T14:30:00Z",
      "metadata": {
        "order_id": "8842",
        "channel": "shopify"
      },
      "filters": {
        "payment": {
          "limit": 0,
          "status": "canceled",
          "starting_after": "string",
          "ending_before": "string",
          "customer": "fcus_01J9XR8M3K7VZ8N2YB4WJ6T0RA"
        },
        "checkout_session": {
          "limit": 0,
          "offset": 0,
          "payment_intent": "fpi_01J9XR8M3K7VZ8N2YB4WJ6T0RA",
          "client_reference_id": "string",
          "start_date": "string",
          "end_date": "string"
        },
        "subscription": {
          "limit": 0,
          "offset": 0,
          "start_date": "string",
          "end_date": "string"
        },
        "customer": {
          "limit": 0,
          "offset": 0,
          "starting_after": "string",
          "ending_before": "string"
        },
        "product": {
          "limit": 0,
          "offset": 0,
          "starting_after": "string",
          "ending_before": "string"
        },
        "charge_reconciliation": {
          "start_date": "string",
          "end_date": "string"
        },
        "payout": {
          "start_date": "string",
          "end_date": "string"
        },
        "dispute": {
          "start_date": "string",
          "end_date": "string"
        },
        "line_item": {
          "start_date": "string",
          "end_date": "string"
        },
        "line_item_revenue": {
          "start_date": "string",
          "end_date": "string"
        },
        "balance_activity": {
          "start_date": "string",
          "end_date": "string"
        }
      },
      "test_mode": false
    }
  ]
}

Changes

  • eec642897a22Revision changes
    • warning

      for the query request parameter limit, the max was set to 2147483647.00

    • warning

      for the query request parameter offset, the max was set to 2147483647.00

    • warning

      for the query request parameter limit, the min was set to -2147483648.00

    • warning

      for the query request parameter offset, the min was set to -2147483648.00

    • warning

      removed the optional property //////// from the response with the status

    • warning

      removed the optional property //////// from the response with the status

    • warning

      added the new balance_activity enum value to the // response property for the response status

    • info

      added the optional property /////// to the response with the status