The Report Run object 

Attributes

• idstring

  Unique identifier for the object.

• parametersobject

  Parameters of this report run.

  Hide child attributes

  • parameters.columnsnullable array of strings

    The set of output columns requested for inclusion in the report run.

  • parameters.connected_accountnullable string

    Connected account ID by which to filter the report run.

  • parameters.currencynullable enum

    Currency of objects to be included in the report run.

  • parameters.interval_endnullable timestamp

    Ending timestamp of data to be included in the report run. Can be any UTC timestamp between 1 second after the user specified interval_start and 1 second before this report’s last data_available_end value.

  • parameters.interval_startnullable timestamp

    Starting timestamp of data to be included in the report run. Can be any UTC timestamp between 1 second after this report’s data_available_start and 1 second before the user specified interval_end value.

  • parameters.payoutnullable string

    Payout ID by which to filter the report run.

  • parameters.reporting_categorynullable string

    Category of balance transactions to be included in the report run.

  • parameters.timezonenullable string

    Defaults to Etc/UTC. The output timezone for all timestamps in the report. A list of possible time zone values is maintained at the IANA Time Zone Database. Has no effect on interval_start or interval_end.

• report_typestring

  The ID of the report type to run, such as "balance.summary.1".

• resultnullable object

  The file object representing the result of the report run (populated when status=succeeded).

  Hide child attributes

  • result.idstring

    Unique identifier for the object.

  • result.objectstring

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

  • result.createdtimestamp

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

  • result.expires_atnullable timestamp

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

  • result.filenamenullable string

    The suitable name for saving the file to a filesystem.

  • result.linksnullable object

    A list of file links that point at this file.

    Hide child attributes

    • result.links.objectstring

      String representing the object’s type. Objects of the same type share the same value. Always has the value list.

    • result.links.dataarray of objects

      Details about each object.

      Hide child attributes

      • result.links.data.idstring

        Unique identifier for the object.

      • result.links.data.objectstring

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

      • result.links.data.createdtimestamp

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

      • result.links.data.expiredboolean

        Returns if the link is already expired.

      • result.links.data.expires_atnullable timestamp

        Time that the link expires.

      • result.links.data.filestringExpandable

        The file object this link points to.

      • result.links.data.livemodeboolean

        Has the value true if the object exists in live mode or the value false if the object exists in test mode.

      • result.links.data.metadataobject

        Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

      • result.links.data.urlnullable string

        The publicly accessible URL to download the file.

    • result.links.has_moreboolean

      True if this list has another page of items after this one that can be fetched.

    • result.links.urlstring

      The URL where this list can be accessed.

  • result.purposeenum

    The purpose of the uploaded file.

    Possible enum values

    account_requirement Additional documentation requirements that can be requested for an account.

    additional_verification Additional verification for custom accounts.

    business_icon A business icon.

    business_logo A business logo.

    customer_signature Customer signature image.

    dispute_evidence Evidence to submit with a dispute response.

    finance_report_run User-accessible copies of query results from the Reporting dataset.

    financial_account_statement Financial account statements.

    identity_document A document to verify the identity of an account owner during account provisioning.

    identity_document_downloadable Image of a document collected by Stripe Identity.

    Show 7 more

  • result.sizeinteger

    The size of the file object in bytes.

  • result.titlenullable string

    A suitable title for the document.

  • result.typenullable string

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

  • result.urlnullable string

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

• statusstring

  Status of this report run. This will be pending when the run is initially created. When the run finishes, this will be set to succeeded and the result field will be populated. Rarely, we may encounter an error, at which point this will be set to failed and the error field will be populated.

More attributes

Collapse all

• objectstring

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

• createdtimestamp

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

• errornullable string

  If something should go wrong during the run, a message about the failure (populated when status=failed).

• livemodeboolean

  true if the report is run on live mode data and false if it is run on test mode data.

• succeeded_atnullable timestamp

  Timestamp at which this run successfully finished (populated when status=succeeded). Measured in seconds since the Unix epoch.