Stripe.Reporting.ReportRun (stripity_stripe v2.17.3) View Source

Work with Stripe Report Run objects.

You can:

Create a report run
Retrieve a report run
List all report runs

Stripe API reference: https://stripe.com/docs/api/reporting/report_run

Link to this section Summary

Types

status()

One of "pending", "succeeded", or "failed".

t()

Functions

create(params, opts \\ [])

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

retrieve(id, opts \\ [])

Link to this section Types

status()

Specs

status() :: String.t()

One of "pending", "succeeded", or "failed".

t()

Specs

t() :: %Stripe.Reporting.ReportRun{
  created: Stripe.timestamp(),
  error: String.t(),
  id: Stripe.id(),
  livemode: boolean(),
  object: String.t(),
  parameters: map(),
  report_type: String.t(),
  result: map(),
  status: status(),
  succeeded_at: Stripe.timestamp()
}

Link to this section Functions

create(params, opts \\ [])

Specs

create(params, Stripe.options()) :: {:ok, t()} | {:error, Stripe.Error.t()}
when params: %{:report_type => String.t(), optional(:parameters) => map()} | %{}

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

Specs

list(params, Stripe.options()) ::
  {:ok, Stripe.List.t(t())} | {:error, Stripe.Error.t()}
when params: %{
       optional(:created) => Stripe.date_query(),
       optional(:ending_before) => t() | Stripe.id(),
       optional(:limit) => 1..100,
       optional(:starting_after) => t() | Stripe.id()
     }

retrieve(id, opts \\ [])

Specs

retrieve(Stripe.id() | t(), Stripe.options()) ::
  {:ok, t()} | {:error, Stripe.Error.t()}