---
agentTools:
  projectIndex: https://copperx.readme.io/llms.txt
---

# Export checkout sessions

Returns a excel file of checkout sessions

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "paths": {
    "/api/v1/checkout/sessions/export": {
      "get": {
        "operationId": "SessionsController_exportCheckoutSessions",
        "summary": "Export checkout sessions",
        "description": "Returns a excel file of checkout sessions",
        "parameters": [
          {
            "name": "createdAt",
            "required": false,
            "in": "query",
            "description": "Filter by created date",
            "example": {
              "gt": "2020-01-01"
            },
            "style": "deepObject",
            "explode": true,
            "schema": {
              "$ref": "#/components/schemas/DateFilterDto"
            }
          },
          {
            "name": "ids",
            "required": false,
            "in": "query",
            "example": [
              "c3611c05-df51-4b47-b601-f2eac02f4ef0",
              "c3611c05-df51-4b47-b601-f2eac02f4ef2"
            ],
            "description": "Filter by id. Returns items with given ids",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "paymentLinkId",
            "required": false,
            "in": "query",
            "description": "To filter checkout sessions by payment link id",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "subscriptionId",
            "required": false,
            "in": "query",
            "description": "To filter checkout sessions by subscription id",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "invoiceId",
            "required": false,
            "in": "query",
            "description": "To filter checkout sessions by invoice ids",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "mode",
            "required": false,
            "in": "query",
            "description": "To filter checkout sessions by mode",
            "schema": {
              "$ref": "#/components/schemas/CheckoutSessionMode"
            }
          },
          {
            "name": "paymentMethodTypes",
            "required": false,
            "in": "query",
            "description": "To filter checkout sessions by payment method type",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/components/schemas/PaymentMethodType"
              }
            }
          },
          {
            "name": "status",
            "required": false,
            "in": "query",
            "description": "To filter checkout sessions by status",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "paymentStatus",
            "required": false,
            "in": "query",
            "description": "To filter checkout sessions by payment status",
            "schema": {
              "$ref": "#/components/schemas/PaymentStatus"
            }
          },
          {
            "name": "customerId",
            "required": false,
            "in": "query",
            "description": "To filter checkout sessions by customer id",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "couponId",
            "required": false,
            "in": "query",
            "description": "To filter checkout sessions by applied coupon id",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "from",
            "required": false,
            "in": "query",
            "description": "To filter checkout sessions by created date from",
            "schema": {
              "format": "date-time",
              "type": "string"
            }
          },
          {
            "name": "to",
            "required": false,
            "in": "query",
            "description": "To filter checkout sessions by created date to",
            "schema": {
              "format": "date-time",
              "type": "string"
            }
          }
        ],
        "responses": {
          "500": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorDto"
                }
              }
            }
          }
        },
        "tags": [
          "Checkout Sessions"
        ],
        "security": [
          {
            "bearer": []
          }
        ]
      }
    }
  },
  "info": {
    "title": "Copperx API",
    "description": "Copperx APIs allows you to access to manage payments, transactions and more in a simple way. Our APIs are easy to use and provide an intuitive APIs for developers to create powerful applications.",
    "version": "v0.0.0",
    "contact": {
      "name": "Copperx",
      "url": "https://t.me/+bVxXaalfhF8wMDFl",
      "email": "support@copperx.io"
    }
  },
  "servers": [
    {
      "url": "https://api.copperx.dev",
      "description": "Test"
    },
    {
      "url": "https://api.copperx.io",
      "description": "Production"
    }
  ],
  "components": {
    "securitySchemes": {
      "bearer": {
        "scheme": "bearer",
        "bearerFormat": "JWT",
        "type": "http"
      }
    },
    "schemas": {
      "ErrorDto": {
        "type": "object",
        "properties": {
          "message": {
            "type": "object"
          },
          "statusCode": {
            "type": "number"
          },
          "error": {
            "type": "string"
          }
        },
        "required": [
          "message",
          "statusCode",
          "error"
        ]
      },
      "PaymentMethodType": {
        "type": "string",
        "enum": [
          "superfluid",
          "wallet",
          "allowance_based_recurring",
          "stripe",
          "binance_pay"
        ]
      },
      "CheckoutSessionMode": {
        "type": "string",
        "enum": [
          "payment",
          "subscription"
        ]
      },
      "PaymentStatus": {
        "type": "string",
        "enum": [
          "unpaid",
          "paid"
        ]
      },
      "DateFilterDto": {
        "type": "object",
        "properties": {
          "isnull": {
            "type": "boolean",
            "description": "Returns null values"
          },
          "notnull": {
            "type": "boolean",
            "description": "Returns not null values"
          },
          "gt": {
            "format": "date-time",
            "type": "string",
            "description": "Returns values greater than the given date"
          },
          "gte": {
            "format": "date-time",
            "type": "string",
            "description": "Returns values greater than or equal to the given date"
          },
          "lt": {
            "format": "date-time",
            "type": "string",
            "description": "Returns values less than the given date"
          },
          "lte": {
            "format": "date-time",
            "type": "string",
            "description": "Returns values less than or equal to the given date"
          }
        }
      }
    }
  },
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "_id": {
    "buffer": {
      "0": 99,
      "1": 181,
      "2": 177,
      "3": 27,
      "4": 23,
      "5": 171,
      "6": 139,
      "7": 0,
      "8": 127,
      "9": 93,
      "10": 212,
      "11": 76
    }
  }
}
```