StripeElixir.Params.PayoutListParams (stripe_elixir v0.1.0)

Copy Markdown View Source

Parameters for payout list.

Summary

Types

t()

Types

t()

@type t() :: %StripeElixir.Params.PayoutListParams{
  arrival_date: map() | nil,
  created: map() | nil,
  destination: String.t() | nil,
  ending_before: String.t() | nil,
  expand: [String.t()] | nil,
  limit: integer() | nil,
  starting_after: String.t() | nil,
  status: String.t() | nil
}
  • arrival_date - Only return payouts that are expected to arrive during the given date interval.
  • created - Only return payouts that were created during the given date interval.
  • destination - The ID of an external account - only return payouts sent to this external account.
  • ending_before - A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list. Max length: 5000.
  • expand - Specifies which fields in the response should be expanded.
  • limit - A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
  • starting_after - A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list. Max length: 5000.
  • status - Only return payouts that have the given status: pending, paid, failed, or canceled. Max length: 5000.