stripeapi-2.0.0.1: Stripe-Library
Safe HaskellNone
LanguageHaskell2010

StripeAPI.Operations.GetSetupIntents

Description

Contains the different functions to run the operation getSetupIntents

Synopsis

Documentation

getSetupIntents Source #

Arguments

:: forall m. MonadHTTP m 
=> GetSetupIntentsParameters

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

-> ClientT m (Response GetSetupIntentsResponse)

Monadic computation which returns the result of the operation

GET /v1/setup_intents

<p>Returns a list of SetupIntents.</p>

data GetSetupIntentsParameters Source #

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

Constructors

GetSetupIntentsParameters 

Fields

  • getSetupIntentsParametersQueryCreated :: Maybe GetSetupIntentsParametersQueryCreated'Variants

    queryCreated: Represents the parameter named 'created'

    A filter on the list, based on the object `created` field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with a number of different query options.

  • getSetupIntentsParametersQueryCustomer :: Maybe Text

    queryCustomer: Represents the parameter named 'customer'

    Only return SetupIntents for the customer specified by this customer ID.

    Constraints:

    • Maximum length of 5000
  • getSetupIntentsParametersQueryEndingBefore :: 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
  • getSetupIntentsParametersQueryExpand :: Maybe [Text]

    queryExpand: Represents the parameter named 'expand'

    Specifies which fields in the response should be expanded.

  • getSetupIntentsParametersQueryLimit :: 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.

  • getSetupIntentsParametersQueryPaymentMethod :: Maybe Text

    queryPayment_method: Represents the parameter named 'payment_method'

    Only return SetupIntents associated with the specified payment method.

    Constraints:

    • Maximum length of 5000
  • getSetupIntentsParametersQueryStartingAfter :: 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

data GetSetupIntentsParametersQueryCreated'OneOf1 Source #

Defines the object schema located at paths./v1/setup_intents.GET.parameters.properties.queryCreated.anyOf in the specification.

data GetSetupIntentsParametersQueryCreated'Variants Source #

Defines the oneOf schema located at paths./v1/setup_intents.GET.parameters.properties.queryCreated.anyOf in the specification.

Represents the parameter named 'created'

A filter on the list, based on the object `created` field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with a number of different query options.

data GetSetupIntentsResponse Source #

Represents a response of the operation getSetupIntents.

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

Constructors

GetSetupIntentsResponseError String

Means either no matching case available or a parse error

GetSetupIntentsResponse200 GetSetupIntentsResponseBody200

Successful response.

GetSetupIntentsResponseDefault Error

Error response.

data GetSetupIntentsResponseBody200 Source #

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

Constructors

GetSetupIntentsResponseBody200 

Fields