Modulestripeapi-3.0.0.0Haskell2010

StripeAPI.Operations.GetPaymentLinks

Contains the different functions to run the operation getPaymentLinks

3 types
3 values

Packagestripeapi-3.0.0.0
Exports6
LanguageHaskell2010
LicenceMIT
SourceGetPaymentLinks.hs

valuegetPaymentLinks

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

GET /v1/payment_links

<p>Returns a list of your payment links.</p>

datadata GetPaymentLinksParameters

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

Constructors

GetPaymentLinksParameters
- getPaymentLinksParametersQueryActive :: Maybe Bool
  queryActive: Represents the parameter named 'active'
  Only return payment links that are active or inactive (e.g., pass `false` to list all inactive payment links).
- getPaymentLinksParametersQueryEndingBefore :: 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
- getPaymentLinksParametersQueryExpand :: Maybe [Text]
  queryExpand: Represents the parameter named 'expand'
  Specifies which fields in the response should be expanded.
- getPaymentLinksParametersQueryLimit :: 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.
- getPaymentLinksParametersQueryStartingAfter :: 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 GetPaymentLinksParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetPaymentLinks
Show GetPaymentLinksParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetPaymentLinks
FromJSON GetPaymentLinksParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetPaymentLinks
ToJSON GetPaymentLinksParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetPaymentLinks

valuemkGetPaymentLinksParameters :: GetPaymentLinksParameters

Create a new GetPaymentLinksParameters with all required fields.

datadata GetPaymentLinksResponse

Represents a response of the operation getPaymentLinks.

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

Constructors

GetPaymentLinksResponseError String
Means either no matching case available or a parse error
GetPaymentLinksResponse200 GetPaymentLinksResponseBody200
Successful response.
GetPaymentLinksResponseDefault Error
Error response.

Instances2Eq, Show

Eq GetPaymentLinksResponseDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetPaymentLinks
Show GetPaymentLinksResponseDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetPaymentLinks

datadata GetPaymentLinksResponseBody200

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

Constructors

GetPaymentLinksResponseBody200
- getPaymentLinksResponseBody200Data :: [PaymentLink]
  data
- getPaymentLinksResponseBody200HasMore :: Bool
  has_more: True if this list has another page of items after this one that can be fetched.
- getPaymentLinksResponseBody200Url :: Text
  url: The URL where this list can be accessed.
  Constraints:
  - Maximum length of 5000
  - Must match pattern '^/v1/payment_links'

Instances4Eq, Show, FromJSON, ToJSON

Eq GetPaymentLinksResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetPaymentLinks
Show GetPaymentLinksResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetPaymentLinks
FromJSON GetPaymentLinksResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetPaymentLinks
ToJSON GetPaymentLinksResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetPaymentLinks

valuemkGetPaymentLinksResponseBody200

:: [PaymentLink]
getPaymentLinksResponseBody200Data
-> Bool
getPaymentLinksResponseBody200HasMore
-> Text
getPaymentLinksResponseBody200Url
-> GetPaymentLinksResponseBody200

Create a new GetPaymentLinksResponseBody200 with all required fields.