StripeAPI.Operations.GetCheckoutSessions

Contains the different functions to run the operation getCheckoutSessions

Documentation

getCheckoutSessions

Arguments

:: (MonadHTTP m, SecurityScheme s)

=> Configuration s

The configuration to use in the request

-> Maybe Text

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

-> Maybe Text

expand: Specifies which fields in the response should be expanded.

-> Maybe Integer

limit: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

-> Maybe Text

payment_intent: Only return the Checkout Session for the PaymentIntent specified. | Constraints: Maximum length of 5000

-> Maybe Text

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

-> Maybe Text

subscription: Only return the Checkout Session for the subscription specified. | Constraints: Maximum length of 5000

-> Maybe GetCheckoutSessionsRequestBody

The request body to send

-> m (Either HttpException (Response GetCheckoutSessionsResponse))

Monad containing the result of the operation

GET /v1/checkout/sessions

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

getCheckoutSessionsRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Maybe Text -> Maybe Text -> Maybe Integer -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe GetCheckoutSessionsRequestBody -> m (Either HttpException (Response ByteString))

GET /v1/checkout/sessions

The same as getCheckoutSessions but returns the raw ByteString

getCheckoutSessionsM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe Text -> Maybe Text -> Maybe Integer -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe GetCheckoutSessionsRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response GetCheckoutSessionsResponse))

GET /v1/checkout/sessions

Monadic version of getCheckoutSessions (use with runWithConfiguration)

getCheckoutSessionsRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe Text -> Maybe Text -> Maybe Integer -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe GetCheckoutSessionsRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString))

GET /v1/checkout/sessions

Monadic version of getCheckoutSessionsRaw (use with runWithConfiguration)

data GetCheckoutSessionsRequestBody

Defines the data type for the schema getCheckoutSessionsRequestBody

Constructors

GetCheckoutSessionsRequestBody

Instances

Eq GetCheckoutSessionsRequestBody

Defined in StripeAPI.Operations.GetCheckoutSessions

Methods

(==) :: GetCheckoutSessionsRequestBody -> GetCheckoutSessionsRequestBody -> Bool

(/=) :: GetCheckoutSessionsRequestBody -> GetCheckoutSessionsRequestBody -> Bool

Show GetCheckoutSessionsRequestBody

Defined in StripeAPI.Operations.GetCheckoutSessions

Methods

showsPrec :: Int -> GetCheckoutSessionsRequestBody -> ShowS

show :: GetCheckoutSessionsRequestBody -> String

showList :: [GetCheckoutSessionsRequestBody] -> ShowS

ToJSON GetCheckoutSessionsRequestBody

Defined in StripeAPI.Operations.GetCheckoutSessions

Methods

toJSON :: GetCheckoutSessionsRequestBody -> Value

toEncoding :: GetCheckoutSessionsRequestBody -> Encoding

toJSONList :: [GetCheckoutSessionsRequestBody] -> Value

toEncodingList :: [GetCheckoutSessionsRequestBody] -> Encoding

FromJSON GetCheckoutSessionsRequestBody

Defined in StripeAPI.Operations.GetCheckoutSessions

Methods

parseJSON :: Value -> Parser GetCheckoutSessionsRequestBody

parseJSONList :: Value -> Parser [GetCheckoutSessionsRequestBody]

data 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.

Instances

Eq GetCheckoutSessionsResponse

Defined in StripeAPI.Operations.GetCheckoutSessions

Methods

(==) :: GetCheckoutSessionsResponse -> GetCheckoutSessionsResponse -> Bool

(/=) :: GetCheckoutSessionsResponse -> GetCheckoutSessionsResponse -> Bool

Show GetCheckoutSessionsResponse

Defined in StripeAPI.Operations.GetCheckoutSessions

Methods

showsPrec :: Int -> GetCheckoutSessionsResponse -> ShowS

show :: GetCheckoutSessionsResponse -> String

showList :: [GetCheckoutSessionsResponse] -> ShowS

data GetCheckoutSessionsResponseBody200

Defines the data type for the schema GetCheckoutSessionsResponseBody200

Constructors

GetCheckoutSessionsResponseBody200

Fields

• getCheckoutSessionsResponseBody200Data :: [] Checkout'session

  data

• getCheckoutSessionsResponseBody200HasMore :: Bool

  has_more: True if this list has another page of items after this one that can be fetched.

• getCheckoutSessionsResponseBody200Object :: GetCheckoutSessionsResponseBody200Object'

  object: String representing the object's type. Objects of the same type share the same value. Always has the value `list`.

• getCheckoutSessionsResponseBody200Url :: Text

  url: The URL where this list can be accessed.

  Constraints:

  • Maximum length of 5000

Instances

Eq GetCheckoutSessionsResponseBody200

Defined in StripeAPI.Operations.GetCheckoutSessions

Methods

(==) :: GetCheckoutSessionsResponseBody200 -> GetCheckoutSessionsResponseBody200 -> Bool

(/=) :: GetCheckoutSessionsResponseBody200 -> GetCheckoutSessionsResponseBody200 -> Bool

Show GetCheckoutSessionsResponseBody200

Defined in StripeAPI.Operations.GetCheckoutSessions

Methods

showsPrec :: Int -> GetCheckoutSessionsResponseBody200 -> ShowS

show :: GetCheckoutSessionsResponseBody200 -> String

showList :: [GetCheckoutSessionsResponseBody200] -> ShowS

ToJSON GetCheckoutSessionsResponseBody200

Defined in StripeAPI.Operations.GetCheckoutSessions

Methods

toJSON :: GetCheckoutSessionsResponseBody200 -> Value

toEncoding :: GetCheckoutSessionsResponseBody200 -> Encoding

toJSONList :: [GetCheckoutSessionsResponseBody200] -> Value

toEncodingList :: [GetCheckoutSessionsResponseBody200] -> Encoding

FromJSON GetCheckoutSessionsResponseBody200

Defined in StripeAPI.Operations.GetCheckoutSessions

Methods

parseJSON :: Value -> Parser GetCheckoutSessionsResponseBody200

parseJSONList :: Value -> Parser [GetCheckoutSessionsResponseBody200]

data GetCheckoutSessionsResponseBody200Object'

Defines the enum schema GetCheckoutSessionsResponseBody200Object'

String representing the object's type. Objects of the same type share the same value. Always has the value `list`.

Constructors

GetCheckoutSessionsResponseBody200Object'EnumOther Value

GetCheckoutSessionsResponseBody200Object'EnumTyped Text

GetCheckoutSessionsResponseBody200Object'EnumStringList

Instances

Eq GetCheckoutSessionsResponseBody200Object'

Defined in StripeAPI.Operations.GetCheckoutSessions

Methods

(==) :: GetCheckoutSessionsResponseBody200Object' -> GetCheckoutSessionsResponseBody200Object' -> Bool

(/=) :: GetCheckoutSessionsResponseBody200Object' -> GetCheckoutSessionsResponseBody200Object' -> Bool

Show GetCheckoutSessionsResponseBody200Object'

Defined in StripeAPI.Operations.GetCheckoutSessions

Methods

showsPrec :: Int -> GetCheckoutSessionsResponseBody200Object' -> ShowS

show :: GetCheckoutSessionsResponseBody200Object' -> String

showList :: [GetCheckoutSessionsResponseBody200Object'] -> ShowS

ToJSON GetCheckoutSessionsResponseBody200Object'

Defined in StripeAPI.Operations.GetCheckoutSessions

Methods

toJSON :: GetCheckoutSessionsResponseBody200Object' -> Value

toEncoding :: GetCheckoutSessionsResponseBody200Object' -> Encoding

toJSONList :: [GetCheckoutSessionsResponseBody200Object'] -> Value

toEncodingList :: [GetCheckoutSessionsResponseBody200Object'] -> Encoding

FromJSON GetCheckoutSessionsResponseBody200Object'

Defined in StripeAPI.Operations.GetCheckoutSessions

Methods

parseJSON :: Value -> Parser GetCheckoutSessionsResponseBody200Object'

parseJSONList :: Value -> Parser [GetCheckoutSessionsResponseBody200Object']