stripeapi-0.1.0.0: Stripe-Library

Safe HaskellNone
LanguageHaskell2010

StripeAPI.Operations.GetCheckoutSessions

Description

Contains the different functions to run the operation getCheckoutSessions

Synopsis

Documentation

getCheckoutSessions Source #

Arguments

:: (MonadHTTP m, SecurityScheme s) 
=> Configuration s

The configuration to use in the request

-> Maybe String

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 String

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 String

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

-> Maybe String

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 String

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

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

data GetCheckoutSessionsResponse Source #

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.

data GetCheckoutSessionsResponseBody200 Source #

Defines the data type for the schema GetCheckoutSessionsResponseBody200

Constructors

GetCheckoutSessionsResponseBody200 

Fields

data GetCheckoutSessionsResponseBody200Object' Source #

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