Stripe.Reporting.ReportRun (stripity_stripe v2.17.2) 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
Link to this section Types
Specs
status() :: String.t()
One of "pending"
, "succeeded"
, or "failed"
.
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
Specs
create(params, Stripe.options()) :: {:ok, t()} | {:error, Stripe.Error.t()} when params: %{:report_type => String.t(), optional(:parameters) => map()} | %{}
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() }
Specs
retrieve(Stripe.id() | t(), Stripe.options()) :: {:ok, t()} | {:error, Stripe.Error.t()}