Struct File

pub struct File {
    pub created: i64,
    pub expires_at: Option<i64>,
    pub filename: Option<String>,
    pub id: FileId,
    pub links: Option<List<FileLink>>,
    pub purpose: FilePurpose,
    pub size: u64,
    pub title: Option<String>,
    pub type_: Option<String>,
    pub url: Option<String>,
}

This object represents files hosted on Stripe’s servers. You can upload files with the create file request (for example, when uploading dispute evidence). Stripe also creates files independently (for example, the results of a Sigma scheduled query).

Related guide: File upload guide

For more details see <https://stripe.com/docs/api/files/object>.

Fields

created: i64

Time at which the object was created. Measured in seconds since the Unix epoch.

expires_at: Option<i64>

The file expires and isn’t available at this time in epoch seconds.

filename: Option<String>

The suitable name for saving the file to a filesystem.

id: FileId

Unique identifier for the object.

links: Option<List<FileLink>>

A list of file links that point at this file.

purpose: FilePurpose

The purpose of the uploaded file.

size: u64

The size of the file object in bytes.

title: Option<String>

A suitable title for the document.

type_: Option<String>

The returned file type (for example, csv, pdf, jpg, or png).

url: Option<String>

Use your live secret API key to download the file from this URL.

Trait Implementations

impl Clone for File

fn clone(&self) -> File

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for File

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Deserialize for File

fn begin(out: &mut Option<File>) -> &mut dyn Visitor

The only correct implementation of this method is:

impl Object for File

type Id = FileId

The canonical id type for this object.

fn id(&self) -> &<File as Object>::Id

The id of the object.

fn into_id(self) -> <File as Object>::Id

The owned id of the object.

impl ObjectDeser for File

type Builder = FileBuilder