stripeapi-0.1.0.0: Stripe-Library

Safe HaskellNone
LanguageHaskell2010

StripeAPI.Operations.GetPlans

Description

Contains the different functions to run the operation getPlans

Synopsis

Documentation

getPlans Source #

Arguments

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

The configuration to use in the request

-> Maybe Bool

active: Only return plans that are active or inactive (e.g., pass `false` to list all inactive plans).

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

product: Only return plans for the given product. | Constraints: Maximum length of 5000

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

-> GetPlansRequestBody

The request body to send

-> m (Either HttpException (Response GetPlansResponse))

Monad containing the result of the operation

GET /v1/plans

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

data GetPlansResponse Source #

Represents a response of the operation getPlans.

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

Constructors

GetPlansResponseError String

Means either no matching case available or a parse error

GetPlansResponse200 GetPlansResponseBody200

Successful response.

GetPlansResponseDefault Error

Error response.

data GetPlansResponseBody200 Source #

Defines the data type for the schema GetPlansResponseBody200

Constructors

GetPlansResponseBody200 

Fields

data GetPlansResponseBody200Object' Source #

Defines the enum schema GetPlansResponseBody200Object'

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