StripeAPI.Operations.GetCheckoutSessions

Contains the different functions to run the operation getCheckoutSessions

Documentation

getCheckoutSessions

Arguments

:: forall m. MonadHTTP m

=> GetCheckoutSessionsParameters

Contains all available parameters of this operation (query and path parameters)

-> StripeT m (Response GetCheckoutSessionsResponse)

Monadic computation which returns the result of the operation

GET /v1/checkout/sessions

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

data GetCheckoutSessionsParameters

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

Constructors

GetCheckoutSessionsParameters

Fields

• 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

Instances

Eq GetCheckoutSessionsParameters

Defined in StripeAPI.Operations.GetCheckoutSessions

Methods

(==) :: GetCheckoutSessionsParameters -> GetCheckoutSessionsParameters -> Bool

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

Show GetCheckoutSessionsParameters

Defined in StripeAPI.Operations.GetCheckoutSessions

Methods

showsPrec :: Int -> GetCheckoutSessionsParameters -> ShowS

show :: GetCheckoutSessionsParameters -> String

showList :: [GetCheckoutSessionsParameters] -> ShowS

ToJSON GetCheckoutSessionsParameters

Defined in StripeAPI.Operations.GetCheckoutSessions

Methods

toJSON :: GetCheckoutSessionsParameters -> Value

toEncoding :: GetCheckoutSessionsParameters -> Encoding

toJSONList :: [GetCheckoutSessionsParameters] -> Value

toEncodingList :: [GetCheckoutSessionsParameters] -> Encoding

FromJSON GetCheckoutSessionsParameters

Defined in StripeAPI.Operations.GetCheckoutSessions

Methods

parseJSON :: Value -> Parser GetCheckoutSessionsParameters

parseJSONList :: Value -> Parser [GetCheckoutSessionsParameters]

mkGetCheckoutSessionsParameters :: GetCheckoutSessionsParameters

Create a new GetCheckoutSessionsParameters with all required fields.

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 object schema located at paths./v1/checkout/sessions.GET.responses.200.content.application/json.schema in the specification.

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.

• 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]

mkGetCheckoutSessionsResponseBody200

Arguments

:: [Checkout'session]

getCheckoutSessionsResponseBody200Data

-> Bool

getCheckoutSessionsResponseBody200HasMore

-> Text

getCheckoutSessionsResponseBody200Url

-> GetCheckoutSessionsResponseBody200

Create a new GetCheckoutSessionsResponseBody200 with all required fields.