Modulestripeapi-3.0.0.0Haskell2010

StripeAPI.Operations.GetCoupons

Contains the different functions to run the operation getCoupons

5 types
4 values

Packagestripeapi-3.0.0.0
Exports9
LanguageHaskell2010
LicenceMIT
SourceGetCoupons.hs

valuegetCoupons

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

GET /v1/coupons

<p>Returns a list of your coupons.</p>

datadata GetCouponsParameters

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

Constructors

GetCouponsParameters
- getCouponsParametersQueryCreated :: Maybe GetCouponsParametersQueryCreated'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.
- getCouponsParametersQueryEndingBefore :: 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
- getCouponsParametersQueryExpand :: Maybe [Text]
  queryExpand: Represents the parameter named 'expand'
  Specifies which fields in the response should be expanded.
- getCouponsParametersQueryLimit :: 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.
- getCouponsParametersQueryStartingAfter :: 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 GetCouponsParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetCoupons
Show GetCouponsParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetCoupons
FromJSON GetCouponsParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetCoupons
ToJSON GetCouponsParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetCoupons

valuemkGetCouponsParameters :: GetCouponsParameters

Create a new GetCouponsParameters with all required fields.

datadata GetCouponsParametersQueryCreated'OneOf1

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

Constructors

GetCouponsParametersQueryCreated'OneOf1
- getCouponsParametersQueryCreated'OneOf1Gt :: Maybe Int
  gt
- getCouponsParametersQueryCreated'OneOf1Gte :: Maybe Int
  gte
- getCouponsParametersQueryCreated'OneOf1Lt :: Maybe Int
  lt
- getCouponsParametersQueryCreated'OneOf1Lte :: Maybe Int
  lte

Instances4Eq, Show, FromJSON, ToJSON

Eq GetCouponsParametersQueryCreated'OneOf1Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetCoupons
Show GetCouponsParametersQueryCreated'OneOf1Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetCoupons
FromJSON GetCouponsParametersQueryCreated'OneOf1Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetCoupons
ToJSON GetCouponsParametersQueryCreated'OneOf1Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetCoupons

valuemkGetCouponsParametersQueryCreated'OneOf1 :: GetCouponsParametersQueryCreated'OneOf1

Create a new GetCouponsParametersQueryCreated'OneOf1 with all required fields.

datadata GetCouponsParametersQueryCreated'Variants

Defines the oneOf schema located at paths./v1/coupons.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.

Constructors

GetCouponsParametersQueryCreated'GetCouponsParametersQueryCreated'OneOf1 GetCouponsParametersQueryCreated'OneOf1
GetCouponsParametersQueryCreated'Int Int

Instances4Eq, Show, FromJSON, ToJSON

Eq GetCouponsParametersQueryCreated'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetCoupons
Show GetCouponsParametersQueryCreated'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetCoupons
FromJSON GetCouponsParametersQueryCreated'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetCoupons
ToJSON GetCouponsParametersQueryCreated'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetCoupons

datadata GetCouponsResponse

Represents a response of the operation getCoupons.

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

Constructors

GetCouponsResponseError String
Means either no matching case available or a parse error
GetCouponsResponse200 GetCouponsResponseBody200
Successful response.
GetCouponsResponseDefault Error
Error response.

Instances2Eq, Show

Eq GetCouponsResponseDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetCoupons
Show GetCouponsResponseDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetCoupons

datadata GetCouponsResponseBody200

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

Constructors

GetCouponsResponseBody200
- getCouponsResponseBody200Data :: [Coupon]
  data
- getCouponsResponseBody200HasMore :: Bool
  has_more: True if this list has another page of items after this one that can be fetched.
- getCouponsResponseBody200Url :: Text
  url: The URL where this list can be accessed.
  Constraints:
  - Maximum length of 5000
  - Must match pattern '^/v1/coupons'

Instances4Eq, Show, FromJSON, ToJSON

Eq GetCouponsResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetCoupons
Show GetCouponsResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetCoupons
FromJSON GetCouponsResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetCoupons
ToJSON GetCouponsResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetCoupons

valuemkGetCouponsResponseBody200

:: [Coupon]
getCouponsResponseBody200Data
-> Bool
getCouponsResponseBody200HasMore
-> Text
getCouponsResponseBody200Url
-> GetCouponsResponseBody200

Create a new GetCouponsResponseBody200 with all required fields.