Modulestripeapi-3.0.0.0Haskell2010

StripeAPI.Operations.GetCheckoutSessionsSessionLineItems

Contains the different functions to run the operation getCheckoutSessionsSessionLineItems

Synopsis

value getCheckoutSessionsSessionLineItems
data GetCheckoutSessionsSessionLineItemsParameters
value mkGetCheckoutSessionsSessionLineItemsParameters
data GetCheckoutSessionsSessionLineItemsResponse
data GetCheckoutSessionsSessionLineItemsResponseBody200
value mkGetCheckoutSessionsSessionLineItemsResponseBody200

Packagestripeapi-3.0.0.0
Exports6
LanguageHaskell2010
LicenceMIT
SourceGetCheckoutSessionsSessionLineItems.hs

valuegetCheckoutSessionsSessionLineItems

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

GET /v1/checkout/sessions/{session}/line_items

<p>When retrieving a Checkout Session, there is an includable <strong>line_items</strong> property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.</p>

datadata GetCheckoutSessionsSessionLineItemsParameters

Source#

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

Constructors

GetCheckoutSessionsSessionLineItemsParameters
- getCheckoutSessionsSessionLineItemsParametersPathSession :: Text
  pathSession: Represents the parameter named 'session'
  Constraints:
  - Maximum length of 5000
- getCheckoutSessionsSessionLineItemsParametersQueryEndingBefore :: 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
- getCheckoutSessionsSessionLineItemsParametersQueryExpand :: Maybe [Text]
  queryExpand: Represents the parameter named 'expand'
  Specifies which fields in the response should be expanded.
- getCheckoutSessionsSessionLineItemsParametersQueryLimit :: 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.
- getCheckoutSessionsSessionLineItemsParametersQueryStartingAfter :: 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

Instances4Eq, Show, FromJSON, ToJSON

Eq GetCheckoutSessionsSessionLineItemsParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetCheckoutSessionsSessionLineItems
Show GetCheckoutSessionsSessionLineItemsParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetCheckoutSessionsSessionLineItems
FromJSON GetCheckoutSessionsSessionLineItemsParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetCheckoutSessionsSessionLineItems
ToJSON GetCheckoutSessionsSessionLineItemsParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetCheckoutSessionsSessionLineItems

valuemkGetCheckoutSessionsSessionLineItemsParameters

:: Text
getCheckoutSessionsSessionLineItemsParametersPathSession
-> GetCheckoutSessionsSessionLineItemsParameters

Source#

Create a new GetCheckoutSessionsSessionLineItemsParameters with all required fields.

datadata GetCheckoutSessionsSessionLineItemsResponse

Source#

Represents a response of the operation getCheckoutSessionsSessionLineItems.

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), GetCheckoutSessionsSessionLineItemsResponseError is used.

Constructors

GetCheckoutSessionsSessionLineItemsResponseError String
Means either no matching case available or a parse error
GetCheckoutSessionsSessionLineItemsResponse200 GetCheckoutSessionsSessionLineItemsResponseBody200
Successful response.
GetCheckoutSessionsSessionLineItemsResponseDefault Error
Error response.

Instances2Eq, Show

Eq GetCheckoutSessionsSessionLineItemsResponseDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetCheckoutSessionsSessionLineItems
Show GetCheckoutSessionsSessionLineItemsResponseDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetCheckoutSessionsSessionLineItems

datadata GetCheckoutSessionsSessionLineItemsResponseBody200

Source#

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

Constructors

GetCheckoutSessionsSessionLineItemsResponseBody200
- getCheckoutSessionsSessionLineItemsResponseBody200Data :: [Item]
  data: Details about each object.
- getCheckoutSessionsSessionLineItemsResponseBody200HasMore :: Bool
  has_more: True if this list has another page of items after this one that can be fetched.
- getCheckoutSessionsSessionLineItemsResponseBody200Url :: Text
  url: The URL where this list can be accessed.
  Constraints:
  - Maximum length of 5000

Instances4Eq, Show, FromJSON, ToJSON

Eq GetCheckoutSessionsSessionLineItemsResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetCheckoutSessionsSessionLineItems
Show GetCheckoutSessionsSessionLineItemsResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetCheckoutSessionsSessionLineItems
FromJSON GetCheckoutSessionsSessionLineItemsResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetCheckoutSessionsSessionLineItems
ToJSON GetCheckoutSessionsSessionLineItemsResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetCheckoutSessionsSessionLineItems

valuemkGetCheckoutSessionsSessionLineItemsResponseBody200

:: [Item]
getCheckoutSessionsSessionLineItemsResponseBody200Data
-> Bool
getCheckoutSessionsSessionLineItemsResponseBody200HasMore
-> Text
getCheckoutSessionsSessionLineItemsResponseBody200Url
-> GetCheckoutSessionsSessionLineItemsResponseBody200

Source#

Create a new GetCheckoutSessionsSessionLineItemsResponseBody200 with all required fields.