Modulestripeapi-3.0.0.0Haskell2010

StripeAPI.Operations.GetCheckoutSessions

Contains the different functions to run the operation getCheckoutSessions

3 types
3 values

Packagestripeapi-3.0.0.0
Exports6
LanguageHaskell2010
LicenceMIT
SourceGetCheckoutSessions.hs

valuegetCheckoutSessions

:: MonadHTTP m
=> GetCheckoutSessionsParameters
Contains all available parameters of this operation (query and path parameters)
-> ClientT m (Response GetCheckoutSessionsResponse)
Monadic computation which returns the result of the operation

GET /v1/checkout/sessions

<p>Returns a list of Checkout Sessions.</p>

datadata GetCheckoutSessionsParameters

Defines the object schema located at paths./v1/checkout/sessions.GET.parameters in the specification.

Constructors

GetCheckoutSessionsParameters
- getCheckoutSessionsParametersQueryEndingBefore :: Maybe Text
  queryEnding_before: Represents the parameter named '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.
  Constraints:
  - Maximum length of 5000
- getCheckoutSessionsParametersQueryExpand :: Maybe [Text]
  queryExpand: Represents the parameter named 'expand'
  Specifies which fields in the response should be expanded.
- getCheckoutSessionsParametersQueryLimit :: Maybe Int
  queryLimit: Represents the parameter named 'limit'
  A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- getCheckoutSessionsParametersQueryPaymentIntent :: Maybe Text
  queryPayment_intent: Represents the parameter named 'payment_intent'
  Only return the Checkout Session for the PaymentIntent specified.
  Constraints:
  - Maximum length of 5000
- getCheckoutSessionsParametersQueryStartingAfter :: Maybe Text
  queryStarting_after: Represents the parameter named '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.
  Constraints:
  - Maximum length of 5000
- getCheckoutSessionsParametersQuerySubscription :: Maybe Text
  querySubscription: Represents the parameter named 'subscription'
  Only return the Checkout Session for the subscription specified.
  Constraints:
  - Maximum length of 5000

Instances4Eq, Show, FromJSON, ToJSON

Eq GetCheckoutSessionsParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetCheckoutSessions
Show GetCheckoutSessionsParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetCheckoutSessions
FromJSON GetCheckoutSessionsParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetCheckoutSessions
ToJSON GetCheckoutSessionsParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetCheckoutSessions

valuemkGetCheckoutSessionsParameters :: GetCheckoutSessionsParameters

Create a new GetCheckoutSessionsParameters with all required fields.

datadata GetCheckoutSessionsResponse

Represents a response of the operation getCheckoutSessions.

The response constructor is chosen by the status code of the response. If no case matches (no specific case for the response code, no range case, no default case), GetCheckoutSessionsResponseError is used.

Constructors

GetCheckoutSessionsResponseError String
Means either no matching case available or a parse error
GetCheckoutSessionsResponse200 GetCheckoutSessionsResponseBody200
Successful response.
GetCheckoutSessionsResponseDefault Error
Error response.

Instances2Eq, Show

Eq GetCheckoutSessionsResponseDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetCheckoutSessions
Show GetCheckoutSessionsResponseDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetCheckoutSessions

datadata GetCheckoutSessionsResponseBody200

Defines the object schema located at paths./v1/checkout/sessions.GET.responses.200.content.application/json.schema in the specification.

Constructors

GetCheckoutSessionsResponseBody200
- getCheckoutSessionsResponseBody200Data :: [Checkout'session]
  data
- getCheckoutSessionsResponseBody200HasMore :: Bool
  has_more: True if this list has another page of items after this one that can be fetched.
- getCheckoutSessionsResponseBody200Url :: Text
  url: The URL where this list can be accessed.
  Constraints:
  - Maximum length of 5000

Instances4Eq, Show, FromJSON, ToJSON

Eq GetCheckoutSessionsResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetCheckoutSessions
Show GetCheckoutSessionsResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetCheckoutSessions
FromJSON GetCheckoutSessionsResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetCheckoutSessions
ToJSON GetCheckoutSessionsResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetCheckoutSessions

valuemkGetCheckoutSessionsResponseBody200

:: [Checkout'session]
getCheckoutSessionsResponseBody200Data
-> Bool
getCheckoutSessionsResponseBody200HasMore
-> Text
getCheckoutSessionsResponseBody200Url
-> GetCheckoutSessionsResponseBody200

Create a new GetCheckoutSessionsResponseBody200 with all required fields.