stripeapi-0.1.0.0: Stripe-Library

Safe HaskellNone
LanguageHaskell2010

StripeAPI.Operations.GetCoupons

Description

Contains the different functions to run the operation getCoupons

Synopsis

Documentation

getCoupons Source #

Arguments

:: (MonadHTTP m, SecurityScheme s) 
=> Configuration s

The configuration to use in the request

-> Maybe String

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.

-> Maybe String

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

-> Maybe String

expand: Specifies which fields in the response should be expanded.

-> Maybe Integer

limit: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

-> Maybe String

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

-> GetCouponsRequestBody

The request body to send

-> m (Either HttpException (Response GetCouponsResponse))

Monad containing the result of the operation

GET /v1/coupons

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

data GetCouponsResponse Source #

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.

data GetCouponsResponseBody200 Source #

Defines the data type for the schema GetCouponsResponseBody200

Constructors

GetCouponsResponseBody200 

Fields

data GetCouponsResponseBody200Object' Source #

Defines the enum schema GetCouponsResponseBody200Object'

String representing the object's type. Objects of the same type share the same value. Always has the value `list`.