Retrieve a file

Retrieves the details of an existing file object. After you supply a unique file ID, Stripe returns the corresponding file object. Learn how to access file contents.

Parameters

No parameters.

Returns

If the identifier you provide is valid, a file object returns. If not, Stripe raises an error.

GET /v1/files/:id

Server-side language

curl https://api.stripe.com/v1/files/file_1Mr4LDLkdIwHu7ixFCz0dZiH \
  -u "sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2:"

Response

{
  "id": "file_1Mr4LDLkdIwHu7ixFCz0dZiH",
  "object": "file",
  "created": 1680116847,
  "expires_at": 1703444847,
  "filename": "file.png",
  "links": {
    "object": "list",
    "data": [],
    "has_more": false,
    "url": "/v1/file_links?file=file_1Mr4LDLkdIwHu7ixFCz0dZiH"
  },
  "purpose": "dispute_evidence",
  "size": 8429,
  "title": null,
  "type": "png",
  "url": "https://files.stripe.com/v1/files/file_1Mr4LDLkdIwHu7ixFCz0dZiH/contents"
}

List all files

Returns a list of the files that your account has access to. Stripe sorts and returns the files by their creation dates, placing the most recently created files at the top.

Parameters

purposestring
Filter queries by the file purpose. If you don’t provide a purpose, the queries return unfiltered files.

More parameters

createdobject

ending_beforestring

limitinteger

starting_afterstring

Returns

A dictionary with a data property that contains an array of up to limit files, starting after the starting_after file. Each entry in the array is a separate file object. If there aren’t additional available files, the resulting array is empty.

GET /v1/files

Server-side language

curl -G https://api.stripe.com/v1/files \
  -u "sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2:" \
  -d limit=3

Response

{
  "object": "list",
  "url": "/v1/files",
  "has_more": false,
  "data": [
    {
      "id": "file_1Mr4LDLkdIwHu7ixFCz0dZiH",
      "object": "file",
      "created": 1680116847,
      "expires_at": 1703444847,
      "filename": "file.png",
      "links": {
        "object": "list",
        "data": [],
        "has_more": false,
        "url": "/v1/file_links?file=file_1Mr4LDLkdIwHu7ixFCz0dZiH"
      },
      "purpose": "dispute_evidence",
      "size": 8429,
      "title": null,
      "type": "png",
      "url": "https://files.stripe.com/v1/files/file_1Mr4LDLkdIwHu7ixFCz0dZiH/contents"
    }
  ]
}

File Links

To share the contents of a File object with non-Stripe users, you can create a FileLink. FileLinks contain a URL that you can use to retrieve the contents of the file without authentication.

Endpoints

POST/v1/file_links

POST/v1/file_links/:id

GET/v1/file_links/:id

GET/v1/file_links

FX Quotes

The FX Quotes API provides three functions:

View Stripe’s current exchange rate for any given currency pair.
Extend quoted rates for a 1-hour period or a 24-hour period, minimzing uncertainty from FX fluctuations.
Preview the FX fees Stripe will charge on your FX transaction, allowing you to anticipate specific settlement amounts before payment costs.

Endpoints