Stripe: Files schemas
1 Stripe schema with complete fields and constraints.
← Files operations · All schemas
Create a file — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | This object represents files hosted on Stripe's servers. You can upload files with the [create file](https://docs.stripe.com/api#create_file) request (for example, when uploading dispute evidence). Stripe also creates files independently (for example, the results of a [Sigma scheduled query](#scheduled_queries)). Related guide: [File upload guide](https://docs.stripe.com/file-upload) |
created | JSON | Required within parent | |
created (anyOf 1) | integer | Alternative | Time at which the object was created. Measured in seconds since the Unix epoch. Format: unix-time |
created (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
expires_at | JSON | Optional | |
expires_at (anyOf 1) | JSON | Alternative | |
expires_at (anyOf 1) (anyOf 1) | integer | Alternative | The file expires and isn't available at this time in epoch seconds. Format: unix-time |
expires_at (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
expires_at (anyOf 2) | null | Alternative | |
filename | JSON | Optional | |
filename (anyOf 1) | string | Alternative | The suitable name for saving the file to a filesystem. Maximum length: 5000 |
filename (anyOf 2) | null | Alternative | |
id | string | Required within parent | Unique identifier for the object. Maximum length: 5000 |
links | JSON | Optional | |
links (anyOf 1) | object | Alternative | A list of [file links](https://docs.stripe.com/api#file_links) that point at this file. |
links (anyOf 1).data | array | Required within parent | Details about each object. |
links (anyOf 1).data[] | Model | Each item | Expand Create a file link — response body |
links (anyOf 1).has_more | boolean | Required within parent | True if this list has another page of items after this one that can be fetched. |
links (anyOf 1).object | string | Required within parent | String representing the object's type. Objects of the same type share the same value. Always has the value `list`. Known values: list |
links (anyOf 1).url | string | Required within parent | The URL where this list can be accessed. Maximum length: 5000 Pattern: ^/v1/file_links |
links (anyOf 2) | null | Alternative | |
object | string | Required within parent | String representing the object's type. Objects of the same type share the same value. Known values: file |
purpose | string | Required within parent | The [purpose](https://docs.stripe.com/file-upload#uploading-a-file) of the uploaded file. Known values: account_requirement, additional_verification, business_icon, business_logo, customer_signature, dispute_evidence, document_provider_identity_document, finance_report_run, financial_account_statement, identity_document, identity_document_downloadable, issuing_regulatory_reporting, pci_document, platform_terms_of_service, selfie, sigma_scheduled_query, tax_document_user_upload, terminal_android_apk, terminal_reader_splashscreen, terminal_wifi_certificate, terminal_wifi_private_key |
size | JSON | Required within parent | |
size (anyOf 1) | integer | Alternative | The size of the file object in bytes. |
size (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
title | JSON | Optional | |
title (anyOf 1) | string | Alternative | A suitable title for the document. Maximum length: 5000 |
title (anyOf 2) | null | Alternative | |
type | JSON | Optional | |
type (anyOf 1) | string | Alternative | The returned file type (for example, `csv`, `pdf`, `jpg`, or `png`). Maximum length: 5000 |
type (anyOf 2) | null | Alternative | |
url | JSON | Optional | |
url (anyOf 1) | string | Alternative | Use your live secret API key to download the file from this URL. Maximum length: 5000 |
url (anyOf 2) | null | Alternative |
Referenced models: Create a file link — response body