View Source Stripe.Reporting.ReportType (stripity_stripe v3.2.0)

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 for those Report Type IDs, along with required and optional parameters.

Note that certain report types can only be run based on your live-mode data (not test-mode data), and will error when queried without a live-mode API key.

Summary

Types

t()

The reporting.report_type type.

Functions

list(params \\ %{}, opts \\ [])

Returns a full list of Report Types.

retrieve(report_type, params \\ %{}, opts \\ [])

Retrieves the details of a Report Type. (Certain report types require a live-mode API key.)

Types

t()

@type t() :: %Stripe.Reporting.ReportType{
  data_available_end: integer(),
  data_available_start: integer(),
  default_columns: term() | nil,
  id: binary(),
  livemode: boolean(),
  name: binary(),
  object: binary(),
  updated: integer(),
  version: integer()
}

The reporting.report_type type.

data_available_end Most recent time for which this Report Type is available. Measured in seconds since the Unix epoch.
data_available_start Earliest time for which this Report Type is available. Measured in seconds since the Unix epoch.
default_columns 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.)
id The ID of the Report Type, such as balance.summary.1.
livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
name Human-readable name of the Report Type
object String representing the object's type. Objects of the same type share the same value.
updated When this Report Type was latest updated. Measured in seconds since the Unix epoch.
version 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.

Functions

list(params \\ %{}, opts \\ [])

@spec list(params :: %{optional(:expand) => [binary()]}, opts :: Keyword.t()) ::
  {:ok, Stripe.List.t(t())} | {:error, Stripe.ApiErrors.t()} | {:error, term()}

Returns a full list of Report Types.

Details

Method: get
Path: /v1/reporting/report_types

retrieve(report_type, params \\ %{}, opts \\ [])

@spec retrieve(
  report_type :: binary(),
  params :: %{optional(:expand) => [binary()]},
  opts :: Keyword.t()
) :: {:ok, t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()}

Retrieves the details of a Report Type. (Certain report types require a live-mode API key.)

Details

Method: get
Path: /v1/reporting/report_types/{report_type}