Modulestripeapi-3.0.0.0Haskell2010

StripeAPI.Operations.GetPromotionCodes

Contains the different functions to run the operation getPromotionCodes

5 types
4 values

Packagestripeapi-3.0.0.0
Exports9
LanguageHaskell2010
LicenceMIT
SourceGetPromotionCodes.hs

valuegetPromotionCodes

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

GET /v1/promotion_codes

<p>Returns a list of your promotion codes.</p>

datadata GetPromotionCodesParameters

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

Constructors

GetPromotionCodesParameters
- getPromotionCodesParametersQueryActive :: Maybe Bool
  queryActive: Represents the parameter named 'active'
  Filter promotion codes by whether they are active.
- getPromotionCodesParametersQueryCode :: Maybe Text
  queryCode: Represents the parameter named 'code'
  Only return promotion codes that have this case-insensitive code.
  Constraints:
  - Maximum length of 5000
- getPromotionCodesParametersQueryCoupon :: Maybe Text
  queryCoupon: Represents the parameter named 'coupon'
  Only return promotion codes for this coupon.
  Constraints:
  - Maximum length of 5000
- getPromotionCodesParametersQueryCreated :: Maybe GetPromotionCodesParametersQueryCreated'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.
- getPromotionCodesParametersQueryCustomer :: Maybe Text
  queryCustomer: Represents the parameter named 'customer'
  Only return promotion codes that are restricted to this customer.
  Constraints:
  - Maximum length of 5000
- getPromotionCodesParametersQueryEndingBefore :: 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
- getPromotionCodesParametersQueryExpand :: Maybe [Text]
  queryExpand: Represents the parameter named 'expand'
  Specifies which fields in the response should be expanded.
- getPromotionCodesParametersQueryLimit :: 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.
- getPromotionCodesParametersQueryStartingAfter :: 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 GetPromotionCodesParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetPromotionCodes
Show GetPromotionCodesParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetPromotionCodes
FromJSON GetPromotionCodesParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetPromotionCodes
ToJSON GetPromotionCodesParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetPromotionCodes

valuemkGetPromotionCodesParameters :: GetPromotionCodesParameters

Create a new GetPromotionCodesParameters with all required fields.

datadata GetPromotionCodesParametersQueryCreated'OneOf1

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

Constructors

GetPromotionCodesParametersQueryCreated'OneOf1
- getPromotionCodesParametersQueryCreated'OneOf1Gt :: Maybe Int
  gt
- getPromotionCodesParametersQueryCreated'OneOf1Gte :: Maybe Int
  gte
- getPromotionCodesParametersQueryCreated'OneOf1Lt :: Maybe Int
  lt
- getPromotionCodesParametersQueryCreated'OneOf1Lte :: Maybe Int
  lte

Instances4Eq, Show, FromJSON, ToJSON

Eq GetPromotionCodesParametersQueryCreated'OneOf1Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetPromotionCodes
Show GetPromotionCodesParametersQueryCreated'OneOf1Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetPromotionCodes
FromJSON GetPromotionCodesParametersQueryCreated'OneOf1Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetPromotionCodes
ToJSON GetPromotionCodesParametersQueryCreated'OneOf1Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetPromotionCodes

valuemkGetPromotionCodesParametersQueryCreated'OneOf1 :: GetPromotionCodesParametersQueryCreated'OneOf1

Create a new GetPromotionCodesParametersQueryCreated'OneOf1 with all required fields.

datadata GetPromotionCodesParametersQueryCreated'Variants

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

GetPromotionCodesParametersQueryCreated'GetPromotionCodesParametersQueryCreated'OneOf1 GetPromotionCodesParametersQueryCreated'OneOf1
GetPromotionCodesParametersQueryCreated'Int Int

Instances4Eq, Show, FromJSON, ToJSON

Eq GetPromotionCodesParametersQueryCreated'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetPromotionCodes
Show GetPromotionCodesParametersQueryCreated'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetPromotionCodes
FromJSON GetPromotionCodesParametersQueryCreated'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetPromotionCodes
ToJSON GetPromotionCodesParametersQueryCreated'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetPromotionCodes

datadata GetPromotionCodesResponse

Represents a response of the operation getPromotionCodes.

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

Constructors

GetPromotionCodesResponseError String
Means either no matching case available or a parse error
GetPromotionCodesResponse200 GetPromotionCodesResponseBody200
Successful response.
GetPromotionCodesResponseDefault Error
Error response.

Instances2Eq, Show

Eq GetPromotionCodesResponseDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetPromotionCodes
Show GetPromotionCodesResponseDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetPromotionCodes

datadata GetPromotionCodesResponseBody200

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

Constructors

GetPromotionCodesResponseBody200
- getPromotionCodesResponseBody200Data :: [PromotionCode]
  data
- getPromotionCodesResponseBody200HasMore :: Bool
  has_more: True if this list has another page of items after this one that can be fetched.
- getPromotionCodesResponseBody200Url :: Text
  url: The URL where this list can be accessed.
  Constraints:
  - Maximum length of 5000
  - Must match pattern '^/v1/promotion_codes'

Instances4Eq, Show, FromJSON, ToJSON

Eq GetPromotionCodesResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetPromotionCodes
Show GetPromotionCodesResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetPromotionCodes
FromJSON GetPromotionCodesResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetPromotionCodes
ToJSON GetPromotionCodesResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetPromotionCodes

valuemkGetPromotionCodesResponseBody200

:: [PromotionCode]
getPromotionCodesResponseBody200Data
-> Bool
getPromotionCodesResponseBody200HasMore
-> Text
getPromotionCodesResponseBody200Url
-> GetPromotionCodesResponseBody200

Create a new GetPromotionCodesResponseBody200 with all required fields.