NAME

Net::API::Stripe::Reporting::ReportType - The Report Type object

SYNOPSIS

my $type = $stripe->report_type({
    data_available_end => '2020-11-17T12:15:20',
    data_available_start => '2020-03-01T07:30:20',
    default_columns => $some_array,
    name => 'type name',
    updated => 'now',
    version => 1,
});

VERSION

v0.2.0

DESCRIPTION

The Report Type resource corresponds to a particular type of report, such as the "Activity summary" or "Itemized payouts" reports. These objects are identified by an ID belonging to a set of enumerated values. See [API Access to Reports documentation](/docs/reporting/statements/api) for those Report Type IDs, along with required and optional parameters. 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](/docs/keys#test-live-modes).

METHODS

id string

The [ID of the Report Type](/docs/reporting/statements/api#available-report-types), such as `balance.summary.1`.

object string

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

data_available_end timestamp

Most recent time for which this Report Type is available. Measured in seconds since the Unix epoch.

data_available_start timestamp

Earliest time for which this Report Type is available. Measured in seconds since the Unix epoch.

default_columns string_array

List of column names that are included by default when this Report Type gets run. (If the Report Type doesn't support the `columns` parameter, this will be null.)

livemode boolean

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

name string

Human-readable name of the Report Type

updated timestamp

When this Report Type was latest updated. Measured in seconds since the Unix epoch.

version integer

Version of the Report Type. Different versions report with the same ID will have the same purpose, but may take different run parameters or have different result schemas.

API SAMPLE

{
  "id": "balance.summary.1",
  "object": "reporting.report_type",
  "data_available_end": 1604966400,
  "data_available_start": 1385769600,
  "default_columns": [
    "category",
    "description",
    "net_amount",
    "currency"
  ],
  "name": "Balance summary",
  "updated": 1605009363,
  "version": 1
}

HISTORY

v0.1.0

Initial version

AUTHOR

Jacques Deguest <jack@deguest.jp>

SEE ALSO

Stripe API documentation:

https://stripe.com/docs/api#reporting_report_type_object

COPYRIGHT & LICENSE

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

You can use, copy, modify and redistribute this package and associated files under the same terms as Perl itself.

cpanm Net::API::Stripe

perl -MCPAN -e shell
install Net::API::Stripe