StripeAPI.Operations.GetCoupons

Contains the different functions to run the operation getCoupons

Documentation

getCoupons

Arguments

:: forall m. 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>

data GetCouponsParameters

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

Constructors

GetCouponsParameters

Fields

• 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

Instances

Eq GetCouponsParameters

Defined in StripeAPI.Operations.GetCoupons

Methods

(==) :: GetCouponsParameters -> GetCouponsParameters -> Bool

(/=) :: GetCouponsParameters -> GetCouponsParameters -> Bool

Show GetCouponsParameters

Defined in StripeAPI.Operations.GetCoupons

Methods

showsPrec :: Int -> GetCouponsParameters -> ShowS

show :: GetCouponsParameters -> String

showList :: [GetCouponsParameters] -> ShowS

ToJSON GetCouponsParameters

Defined in StripeAPI.Operations.GetCoupons

Methods

toJSON :: GetCouponsParameters -> Value

toEncoding :: GetCouponsParameters -> Encoding

toJSONList :: [GetCouponsParameters] -> Value

toEncodingList :: [GetCouponsParameters] -> Encoding

FromJSON GetCouponsParameters

Defined in StripeAPI.Operations.GetCoupons

Methods

parseJSON :: Value -> Parser GetCouponsParameters

parseJSONList :: Value -> Parser [GetCouponsParameters]

mkGetCouponsParameters :: GetCouponsParameters

Create a new GetCouponsParameters with all required fields.

data GetCouponsParametersQueryCreated'OneOf1

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

Constructors

GetCouponsParametersQueryCreated'OneOf1

Fields

• getCouponsParametersQueryCreated'OneOf1Gt :: Maybe Int

  gt

• getCouponsParametersQueryCreated'OneOf1Gte :: Maybe Int

  gte

• getCouponsParametersQueryCreated'OneOf1Lt :: Maybe Int

  lt

• getCouponsParametersQueryCreated'OneOf1Lte :: Maybe Int

  lte

Instances

Eq GetCouponsParametersQueryCreated'OneOf1

Defined in StripeAPI.Operations.GetCoupons

Methods

(==) :: GetCouponsParametersQueryCreated'OneOf1 -> GetCouponsParametersQueryCreated'OneOf1 -> Bool

(/=) :: GetCouponsParametersQueryCreated'OneOf1 -> GetCouponsParametersQueryCreated'OneOf1 -> Bool

Show GetCouponsParametersQueryCreated'OneOf1

Defined in StripeAPI.Operations.GetCoupons

Methods

showsPrec :: Int -> GetCouponsParametersQueryCreated'OneOf1 -> ShowS

show :: GetCouponsParametersQueryCreated'OneOf1 -> String

showList :: [GetCouponsParametersQueryCreated'OneOf1] -> ShowS

ToJSON GetCouponsParametersQueryCreated'OneOf1

Defined in StripeAPI.Operations.GetCoupons

Methods

toJSON :: GetCouponsParametersQueryCreated'OneOf1 -> Value

toEncoding :: GetCouponsParametersQueryCreated'OneOf1 -> Encoding

toJSONList :: [GetCouponsParametersQueryCreated'OneOf1] -> Value

toEncodingList :: [GetCouponsParametersQueryCreated'OneOf1] -> Encoding

FromJSON GetCouponsParametersQueryCreated'OneOf1

Defined in StripeAPI.Operations.GetCoupons

Methods

parseJSON :: Value -> Parser GetCouponsParametersQueryCreated'OneOf1

parseJSONList :: Value -> Parser [GetCouponsParametersQueryCreated'OneOf1]

mkGetCouponsParametersQueryCreated'OneOf1 :: GetCouponsParametersQueryCreated'OneOf1

Create a new GetCouponsParametersQueryCreated'OneOf1 with all required fields.

data 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

Instances

Eq GetCouponsParametersQueryCreated'Variants

Defined in StripeAPI.Operations.GetCoupons

Methods

(==) :: GetCouponsParametersQueryCreated'Variants -> GetCouponsParametersQueryCreated'Variants -> Bool

(/=) :: GetCouponsParametersQueryCreated'Variants -> GetCouponsParametersQueryCreated'Variants -> Bool

Show GetCouponsParametersQueryCreated'Variants

Defined in StripeAPI.Operations.GetCoupons

Methods

showsPrec :: Int -> GetCouponsParametersQueryCreated'Variants -> ShowS

show :: GetCouponsParametersQueryCreated'Variants -> String

showList :: [GetCouponsParametersQueryCreated'Variants] -> ShowS

ToJSON GetCouponsParametersQueryCreated'Variants

Defined in StripeAPI.Operations.GetCoupons

Methods

toJSON :: GetCouponsParametersQueryCreated'Variants -> Value

toEncoding :: GetCouponsParametersQueryCreated'Variants -> Encoding

toJSONList :: [GetCouponsParametersQueryCreated'Variants] -> Value

toEncodingList :: [GetCouponsParametersQueryCreated'Variants] -> Encoding

FromJSON GetCouponsParametersQueryCreated'Variants

Defined in StripeAPI.Operations.GetCoupons

Methods

parseJSON :: Value -> Parser GetCouponsParametersQueryCreated'Variants

parseJSONList :: Value -> Parser [GetCouponsParametersQueryCreated'Variants]

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

Instances

Eq GetCouponsResponse

Defined in StripeAPI.Operations.GetCoupons

Methods

(==) :: GetCouponsResponse -> GetCouponsResponse -> Bool

(/=) :: GetCouponsResponse -> GetCouponsResponse -> Bool

Show GetCouponsResponse

Defined in StripeAPI.Operations.GetCoupons

Methods

showsPrec :: Int -> GetCouponsResponse -> ShowS

show :: GetCouponsResponse -> String

showList :: [GetCouponsResponse] -> ShowS

data GetCouponsResponseBody200

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

Constructors

GetCouponsResponseBody200

Fields

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

Instances

Eq GetCouponsResponseBody200

Defined in StripeAPI.Operations.GetCoupons

Methods

(==) :: GetCouponsResponseBody200 -> GetCouponsResponseBody200 -> Bool

(/=) :: GetCouponsResponseBody200 -> GetCouponsResponseBody200 -> Bool

Show GetCouponsResponseBody200

Defined in StripeAPI.Operations.GetCoupons

Methods

showsPrec :: Int -> GetCouponsResponseBody200 -> ShowS

show :: GetCouponsResponseBody200 -> String

showList :: [GetCouponsResponseBody200] -> ShowS

ToJSON GetCouponsResponseBody200

Defined in StripeAPI.Operations.GetCoupons

Methods

toJSON :: GetCouponsResponseBody200 -> Value

toEncoding :: GetCouponsResponseBody200 -> Encoding

toJSONList :: [GetCouponsResponseBody200] -> Value

toEncodingList :: [GetCouponsResponseBody200] -> Encoding

FromJSON GetCouponsResponseBody200

Defined in StripeAPI.Operations.GetCoupons

Methods

parseJSON :: Value -> Parser GetCouponsResponseBody200

parseJSONList :: Value -> Parser [GetCouponsResponseBody200]

mkGetCouponsResponseBody200

Arguments

:: [Coupon]

getCouponsResponseBody200Data

-> Bool

getCouponsResponseBody200HasMore

-> Text

getCouponsResponseBody200Url

-> GetCouponsResponseBody200

Create a new GetCouponsResponseBody200 with all required fields.