Visitar URL original
File Links | Stripe API Reference
Core Resources
Payment Methods
Products
Product Catalog
Commerce
Agentic Commerce
Checkout
Payment Links
Billing
Capital
Connect
Reserves
Fraud
Issuing
Terminal
Treasury for Platforms
Payment Records
Account Evaluation
Entitlements
Sigma
Reporting
Financial Connections
Tax
Identity
Crypto
Climate
Forwarding
Privacy
Webhooks

File Links v1

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.

Was this section helpful?YesNo
Create a file link
POST/v1/file_links
Update a file link
POST/v1/file_links/:id
Retrieve a file link
GET/v1/file_links/:id
List all file links
GET/v1/file_links

The File Link object v1

Attributes

  • idstring

    Unique identifier for the object.

  • expires_atnullable timestamp

    Time that the link expires.

  • filestringExpandable

    The file object this link points to.

  • metadatamap

    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

  • urlnullable string

    The publicly accessible URL to download the file.

More attributes

  • objectstring, value is "file_link"

  • createdtimestamp

  • expiredboolean

  • livemodeboolean

The File Link object
{
  "id": "",
  "object": "file_link",
  "created": 1680108075,
  "expired": false,
  "expires_at": null,
  "file": "",
  "livemode": false,
  "metadata": {},
  "url": "https://files.stripe.com/links/MDB8YWNjdF8xTTJKVGtMa2RJd0h1N2l4fGZsX3Rlc3RfaXVoY2hrUnJPMzlBR3dPb01XMmFkSTVq00yUPLFf3h"
}

Create a file link v1

POST /v1/file_links

Creates a new file link object.

Parameters

  • filestringRequired

    The ID of the file. The file’s purpose must be one of the following: business_icon, business_logo, customer_signature, dispute_evidence, finance_report_run, financial_account_statement, identity_document_downloadable, issuing_regulatory_reporting, pci_document, selfie, sigma_scheduled_query, tax_document_user_upload, terminal_android_apk, or terminal_reader_splashscreen.

  • expires_attimestamp

    The link isn’t usable after this future timestamp.

  • metadatamap

    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.

Returns

Returns the file link object if successful and raises an error otherwise.

curl https://api.stripe.com/v1/file_links \
  -u "sk_test_...sk_test_...:" \
  -d file=
Response
{
  "id": "",
  "object": "file_link",
  "created": 1680108075,
  "expired": false,
  "expires_at": null,
  "file": "",
  "livemode": false,
  "metadata": {},
  "url": "https://files.stripe.com/links/MDB8YWNjdF8xTTJKVGtMa2RJd0h1N2l4fGZsX3Rlc3RfaXVoY2hrUnJPMzlBR3dPb01XMmFkSTVq00yUPLFf3h"
}