Struct stripe::generated::core::file::File

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

The resource representing a Stripe “File”.

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

Fields

id: FileId

Unique identifier for the object.

created: Timestamp

Time at which the object was created.

Measured in seconds since the Unix epoch.

expires_at: Option<Timestamp>

The time at which the file expires and is no longer available in epoch seconds.

filename: Option<String>

A filename for the file, suitable for saving to a filesystem.

links: List<FileLink>

A list of file links that point at this file.

purpose: FilePurpose

The purpose of the uploaded file.

size: u64

The size in bytes of the file object.

title: Option<String>

A user friendly title for the document.

type_: Option<String>

The type of the file returned (e.g., csv, pdf, jpg, or png).

url: Option<String>

The URL from which the file can be downloaded using your live secret API key.

Implementations

impl File

pub fn list(client: &Client, params: &ListFiles<'_>) -> Response<List<File>>

Returns a list of the files that your account has access to.

The files are returned sorted by creation date, with the most recently created files appearing first.

pub fn retrieve(client: &Client, id: &FileId, expand: &[&str]) -> Response<File>

Retrieves the details of an existing file object.

Supply the unique file ID from a file, and Stripe will return the corresponding file object. To access file contents, see the File Upload Guide.

Trait Implementations

impl Clone for File

fn clone(&self) -> File

Returns a copy 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

Formats the value using the given formatter.

impl Default for File

fn default() -> File

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for File

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Object for File

type Id = FileId

The canonical id type for this object.

fn id(&self) -> Self::Id

The id of the object.

fn object(&self) -> &'static str

The object’s type, typically represented in wire format as the object property.

impl Serialize for File

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>where __S: Serializer,

Serialize this value into the given Serde serializer.