Stripe: File links schemas
1 Stripe schema with complete fields and constraints.
← File links operations · All schemas
Create a file link — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | To share the contents of a `File` object with non-Stripe users, you can create a `FileLink`. `FileLink`s contain a URL that you can use to retrieve the contents of the file without authentication. |
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]+)?$ |
expired | boolean | Required within parent | Returns if the link is already expired. |
expires_at | JSON | Optional | |
expires_at (anyOf 1) | JSON | Alternative | |
expires_at (anyOf 1) (anyOf 1) | integer | Alternative | Time that the link expires. 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 | |
file | JSON | Required within parent | The file object this link points to. |
file (anyOf 1) | string | Alternative | Maximum length: 5000 |
file (anyOf 2) | Model | Alternative | Expand Create a file — response body |
id | string | Required within parent | Unique identifier for the object. Maximum length: 5000 |
livemode | boolean | Required within parent | If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`. |
metadata | object | Required within parent | Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Additional keys: see wildcard field |
metadata.* | string | Additional keys | Maximum length: 500 |
object | string | Required within parent | String representing the object's type. Objects of the same type share the same value. Known values: file_link |
url | JSON | Optional | |
url (anyOf 1) | string | Alternative | The publicly accessible URL to download the file. Maximum length: 5000 |
url (anyOf 2) | null | Alternative |
Referenced models: Create a file — response body