Mayson Monorepo Documentation
    Preparing search index...

    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

    interface File {
        id: string;
        object: "file";
        created: number;
        expires_at: number;
        filename: string;
        links?: ApiList<FileLink>;
        purpose: Stripe.File.Purpose;
        size: number;
        title: string;
        type: string;
        url: string;
    }
    Index

    Properties

    id: string

    Unique identifier for the object.

    object: "file"

    String representing the object's type. Objects of the same type share the same value.

    created: number

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

    expires_at: number

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

    filename: string

    The suitable name for saving the file to a filesystem.

    links?: ApiList<FileLink>

    A list of file links that point at this file.

    The purpose of the uploaded file.

    size: number

    The size of the file object in bytes.

    title: string

    A suitable title for the document.

    type: string

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

    url: string

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