Files
In Lemon Squeezy, a file represents a digital good that can be downloaded by a customer after the product has been purchased.
A file belongs to a Variant.
The file object
Attributes
variant_id
The ID of the variant this file belongs to.
identifier
The unique identifier (UUID) for this file.
name
The name of the file (e.g. example.pdf
).
extension
The file extension of the file (e.g. pdf
).
download_url
The unique URL to download the file. Note: for security reasons, download URLs are signed, expire after 1 hour and are rate-limited to 10 downloads per day per IP address.
size
A positive integer in bytes representing the size of the file.
size_formatted
The human-readable size of the file (e.g. 5.5 MB
).
version
The software version of this file (if one exists, e.g. 1.0.0
).
sort
An integer representing the order of this file when displayed.
status
The status of the file. Either draft
or published
.
created_at
An ISO-8601 formatted date-time string indicating when the object was created.
updated_at
An ISO-8601 formatted date-time string indicating when the object was last updated.
File object
Retrieve a file
Retrieves the file with the given ID.
GET /v1/files/:id
Returns
Returns a file object.
Response
List all files
Returns a paginated list of files.
Parameters
variant_id
Only return files belonging to the variant with this ID.
GET /v1/files
Returns
Returns a paginated list of file objects ordered by sort
.