StripeAPI.Operations.GetPlans

Contains the different functions to run the operation getPlans

Documentation

getPlans

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 Text

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 Text

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 Text

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 Text

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

-> Maybe Text

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

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

getPlansRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Maybe Bool -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe Integer -> Maybe Text -> Maybe Text -> Maybe GetPlansRequestBody -> m (Either HttpException (Response ByteString))

GET /v1/plans

The same as getPlans but returns the raw ByteString

getPlansM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe Bool -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe Integer -> Maybe Text -> Maybe Text -> Maybe GetPlansRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response GetPlansResponse))

GET /v1/plans

Monadic version of getPlans (use with runWithConfiguration)

getPlansRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe Bool -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe Integer -> Maybe Text -> Maybe Text -> Maybe GetPlansRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString))

GET /v1/plans

Monadic version of getPlansRaw (use with runWithConfiguration)

data GetPlansRequestBody

Defines the data type for the schema getPlansRequestBody

Constructors

GetPlansRequestBody

Instances

Eq GetPlansRequestBody

Defined in StripeAPI.Operations.GetPlans

Methods

(==) :: GetPlansRequestBody -> GetPlansRequestBody -> Bool

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

Show GetPlansRequestBody

Defined in StripeAPI.Operations.GetPlans

Methods

showsPrec :: Int -> GetPlansRequestBody -> ShowS

show :: GetPlansRequestBody -> String

showList :: [GetPlansRequestBody] -> ShowS

ToJSON GetPlansRequestBody

Defined in StripeAPI.Operations.GetPlans

Methods

toJSON :: GetPlansRequestBody -> Value

toEncoding :: GetPlansRequestBody -> Encoding

toJSONList :: [GetPlansRequestBody] -> Value

toEncodingList :: [GetPlansRequestBody] -> Encoding

FromJSON GetPlansRequestBody

Defined in StripeAPI.Operations.GetPlans

Methods

parseJSON :: Value -> Parser GetPlansRequestBody

parseJSONList :: Value -> Parser [GetPlansRequestBody]

data GetPlansResponse

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.

Instances

Eq GetPlansResponse

Defined in StripeAPI.Operations.GetPlans

Methods

(==) :: GetPlansResponse -> GetPlansResponse -> Bool

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

Show GetPlansResponse

Defined in StripeAPI.Operations.GetPlans

Methods

showsPrec :: Int -> GetPlansResponse -> ShowS

show :: GetPlansResponse -> String

showList :: [GetPlansResponse] -> ShowS

data GetPlansResponseBody200

Defines the data type for the schema GetPlansResponseBody200

Constructors

GetPlansResponseBody200

Fields

• getPlansResponseBody200Data :: [] Plan

  data

• getPlansResponseBody200HasMore :: Bool

  has_more: True if this list has another page of items after this one that can be fetched.

• getPlansResponseBody200Object :: GetPlansResponseBody200Object'

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

• getPlansResponseBody200Url :: Text

  url: The URL where this list can be accessed.

  Constraints:

  • Maximum length of 5000
  • Must match pattern '^/v1/plans'

Instances

Eq GetPlansResponseBody200

Defined in StripeAPI.Operations.GetPlans

Methods

(==) :: GetPlansResponseBody200 -> GetPlansResponseBody200 -> Bool

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

Show GetPlansResponseBody200

Defined in StripeAPI.Operations.GetPlans

Methods

showsPrec :: Int -> GetPlansResponseBody200 -> ShowS

show :: GetPlansResponseBody200 -> String

showList :: [GetPlansResponseBody200] -> ShowS

ToJSON GetPlansResponseBody200

Defined in StripeAPI.Operations.GetPlans

Methods

toJSON :: GetPlansResponseBody200 -> Value

toEncoding :: GetPlansResponseBody200 -> Encoding

toJSONList :: [GetPlansResponseBody200] -> Value

toEncodingList :: [GetPlansResponseBody200] -> Encoding

FromJSON GetPlansResponseBody200

Defined in StripeAPI.Operations.GetPlans

Methods

parseJSON :: Value -> Parser GetPlansResponseBody200

parseJSONList :: Value -> Parser [GetPlansResponseBody200]

data GetPlansResponseBody200Object'

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

Constructors

GetPlansResponseBody200Object'EnumOther Value

GetPlansResponseBody200Object'EnumTyped Text

GetPlansResponseBody200Object'EnumStringList

Instances

Eq GetPlansResponseBody200Object'

Defined in StripeAPI.Operations.GetPlans

Methods

(==) :: GetPlansResponseBody200Object' -> GetPlansResponseBody200Object' -> Bool

(/=) :: GetPlansResponseBody200Object' -> GetPlansResponseBody200Object' -> Bool

Show GetPlansResponseBody200Object'

Defined in StripeAPI.Operations.GetPlans

Methods

showsPrec :: Int -> GetPlansResponseBody200Object' -> ShowS

show :: GetPlansResponseBody200Object' -> String

showList :: [GetPlansResponseBody200Object'] -> ShowS

ToJSON GetPlansResponseBody200Object'

Defined in StripeAPI.Operations.GetPlans

Methods

toJSON :: GetPlansResponseBody200Object' -> Value

toEncoding :: GetPlansResponseBody200Object' -> Encoding

toJSONList :: [GetPlansResponseBody200Object'] -> Value

toEncodingList :: [GetPlansResponseBody200Object'] -> Encoding

FromJSON GetPlansResponseBody200Object'

Defined in StripeAPI.Operations.GetPlans

Methods

parseJSON :: Value -> Parser GetPlansResponseBody200Object'

parseJSONList :: Value -> Parser [GetPlansResponseBody200Object']