Packages

Complete Stripe SDK for Elixir with parity to the official Ruby SDK. V1+V2 coverage (193 services, 320 resource structs, 525 documented params). Per-event modules, Finch HTTP/2, RustyJSON, automatic retries, OAuth, webhooks, telemetry, per-client config, streaming pagination.

Current section

Files

Jump to
tiger_stripe lib stripe params checkout session_list_params.ex
Raw

lib/stripe/params/checkout/session_list_params.ex

# File generated from our OpenAPI spec
defmodule Stripe.Params.Checkout.SessionListParams do
@moduledoc "Parameters for session list."
@typedoc """
* `created` - Only return Checkout Sessions that were created during the given date interval.
* `customer` - Only return the Checkout Sessions for the Customer specified. Max length: 5000.
* `customer_account` - Only return the Checkout Sessions for the Account specified. Max length: 5000.
* `customer_details` - Only return the Checkout Sessions for the Customer details specified.
* `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.
* `payment_intent` - Only return the Checkout Session for the PaymentIntent specified. Max length: 5000.
* `payment_link` - Only return the Checkout Sessions for the Payment Link specified. Max length: 5000.
* `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 the Checkout Sessions matching the given status. Possible values: `complete`, `expired`, `open`.
* `subscription` - Only return the Checkout Session for the subscription specified. Max length: 5000.
"""
@type t :: %__MODULE__{
created: map() | nil,
customer: String.t() | nil,
customer_account: String.t() | nil,
customer_details: customer_details() | nil,
ending_before: String.t() | nil,
expand: [String.t()] | nil,
limit: integer() | nil,
payment_intent: String.t() | nil,
payment_link: String.t() | nil,
starting_after: String.t() | nil,
status: String.t() | nil,
subscription: String.t() | nil
}
defstruct [
:created,
:customer,
:customer_account,
:customer_details,
:ending_before,
:expand,
:limit,
:payment_intent,
:payment_link,
:starting_after,
:status,
:subscription
]
@typedoc """
* `email` - Customer's email address.
"""
@type customer_details :: %{
optional(:email) => String.t() | nil,
optional(String.t()) => term()
}
end