/ 
Net-API-Stripe-v2.0.6
River stage one • 1 direct dependent • 1 total dependent
/ Net::API::Stripe::Reporting::ReportRun

NAME

Net::API::Stripe::Reporting::ReportRun - Stripe API Reporting Run Object

SYNOPSIS

my $report = $stripe->report_run({
    livemode => $stripe->false,
    report_type => 'balance.summary.1',
    result => $file_object,
    status => 'pending',
    succeeded_at => undef,
});

See documentation in Net::API::Stripe for example to make api calls to Stripe to create those objects.

VERSION

v0.101.0

DESCRIPTION

The Report Run object represents an instance of a report type generated with specific run parameters. Once the object is created, Stripe begins processing the report. When the report has finished running, it will give you a reference to a file where you can retrieve your results. For an overview, see API Access to Reports (https://stripe.com/docs/reporting/statements/api).

Note that reports can only be run based on your live-mode data (not test-mode data), and thus related requests must be made with a live-mode API key (https://stripe.com/docs/keys#test-live-modes).

CONSTRUCTOR

new( %arg )

Creates a new Net::API::Stripe::Reporting::ReportRun object. It may also take an hash like arguments, that also are method of the same name.

METHODS

id string

Unique identifier for the object.

object string, value is "reporting.report_run"

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

created timestamp

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

errorstring

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

livemode boolean

Always true: reports can only be run on live-mode data.

parameters hash

Parameters of this report run.

columns array containing strings

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

connected_account string

Connected account ID by which to filter the report run.

urrency currency

Currency of objects to be included in the report run.

interval_end timestamp

Ending timestamp of data to be included in the report run (exclusive).

interval_start timestamp

Starting timestamp of data to be included in the report run.

payout string

Payout ID by which to filter the report run.

reporting_category string

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

timezone 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_type string

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

result hash

The file object (Net::APi::Stripe::File) representing the result of the report run (populated when status=succeeded).

status string

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, Stripe may encounter an error, at which point this will be set to failed and the error field will be populated.

succeeded_at timestamp

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

API SAMPLE

{
  "id": "frr_fake123456789",
  "object": "reporting.report_run",
  "created": 1579440566,
  "error": null,
  "livemode": true,
  "parameters": {
    "interval_end": 1525132800,
    "interval_start": 1522540800
  },
  "report_type": "balance.summary.1",
  "result": {
    "id": "file_fake123456789",
    "object": "file",
    "created": 1535589144,
    "filename": "file_fake123456789",
    "links": {
      "object": "list",
      "data": [],
      "has_more": false,
      "url": "/v1/file_links?file=file_fake123456789"
    },
    "purpose": "finance_report_run",
    "size": 9863,
    "title": null,
    "type": "csv",
    "url": "https://files.stripe.com/v1/files/file_fake123456789/contents"
  },
  "status": "succeeded",
  "succeeded_at": 1525192811
}

HISTORY

v0.1

Initial version

AUTHOR

Jacques Deguest <jack@deguest.jp>

SEE ALSO

perl

COPYRIGHT & LICENSE

Copyright (c) 2020-2020 DEGUEST Pte. Ltd.

All rights reserved

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.