StripeAPI.Operations.GetPlans

Contains the different functions to run the operation getPlans

Documentation

getPlans

Arguments

:: forall m. MonadHTTP m

=> GetPlansParameters

Contains all available parameters of this operation (query and path parameters)

-> ClientT m (Response GetPlansResponse)

Monadic computation which returns the result of the operation

GET /v1/plans

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

data GetPlansParameters

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

Constructors

GetPlansParameters

Fields

• getPlansParametersQueryActive :: Maybe Bool

  queryActive: Represents the parameter named 'active'

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

• getPlansParametersQueryCreated :: Maybe GetPlansParametersQueryCreated'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.

• getPlansParametersQueryEndingBefore :: 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
• getPlansParametersQueryExpand :: Maybe [Text]

  queryExpand: Represents the parameter named 'expand'

  Specifies which fields in the response should be expanded.

• getPlansParametersQueryLimit :: 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.

• getPlansParametersQueryProduct :: Maybe Text

  queryProduct: Represents the parameter named 'product'

  Only return plans for the given product.

  Constraints:

  • Maximum length of 5000
• getPlansParametersQueryStartingAfter :: 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 GetPlansParameters

Defined in StripeAPI.Operations.GetPlans

Methods

(==) :: GetPlansParameters -> GetPlansParameters -> Bool

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

Show GetPlansParameters

Defined in StripeAPI.Operations.GetPlans

Methods

showsPrec :: Int -> GetPlansParameters -> ShowS

show :: GetPlansParameters -> String

showList :: [GetPlansParameters] -> ShowS

ToJSON GetPlansParameters

Defined in StripeAPI.Operations.GetPlans

Methods

toJSON :: GetPlansParameters -> Value

toEncoding :: GetPlansParameters -> Encoding

toJSONList :: [GetPlansParameters] -> Value

toEncodingList :: [GetPlansParameters] -> Encoding

FromJSON GetPlansParameters

Defined in StripeAPI.Operations.GetPlans

Methods

parseJSON :: Value -> Parser GetPlansParameters

parseJSONList :: Value -> Parser [GetPlansParameters]

mkGetPlansParameters :: GetPlansParameters

Create a new GetPlansParameters with all required fields.

data GetPlansParametersQueryCreated'OneOf1

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

Constructors

GetPlansParametersQueryCreated'OneOf1

Fields

• getPlansParametersQueryCreated'OneOf1Gt :: Maybe Int

  gt

• getPlansParametersQueryCreated'OneOf1Gte :: Maybe Int

  gte

• getPlansParametersQueryCreated'OneOf1Lt :: Maybe Int

  lt

• getPlansParametersQueryCreated'OneOf1Lte :: Maybe Int

  lte

Instances

Eq GetPlansParametersQueryCreated'OneOf1

Defined in StripeAPI.Operations.GetPlans

Methods

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

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

Show GetPlansParametersQueryCreated'OneOf1

Defined in StripeAPI.Operations.GetPlans

Methods

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

show :: GetPlansParametersQueryCreated'OneOf1 -> String

showList :: [GetPlansParametersQueryCreated'OneOf1] -> ShowS

ToJSON GetPlansParametersQueryCreated'OneOf1

Defined in StripeAPI.Operations.GetPlans

Methods

toJSON :: GetPlansParametersQueryCreated'OneOf1 -> Value

toEncoding :: GetPlansParametersQueryCreated'OneOf1 -> Encoding

toJSONList :: [GetPlansParametersQueryCreated'OneOf1] -> Value

toEncodingList :: [GetPlansParametersQueryCreated'OneOf1] -> Encoding

FromJSON GetPlansParametersQueryCreated'OneOf1

Defined in StripeAPI.Operations.GetPlans

Methods

parseJSON :: Value -> Parser GetPlansParametersQueryCreated'OneOf1

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

mkGetPlansParametersQueryCreated'OneOf1 :: GetPlansParametersQueryCreated'OneOf1

Create a new GetPlansParametersQueryCreated'OneOf1 with all required fields.

data GetPlansParametersQueryCreated'Variants

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

GetPlansParametersQueryCreated'GetPlansParametersQueryCreated'OneOf1 GetPlansParametersQueryCreated'OneOf1

GetPlansParametersQueryCreated'Int Int

Instances

Eq GetPlansParametersQueryCreated'Variants

Defined in StripeAPI.Operations.GetPlans

Methods

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

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

Show GetPlansParametersQueryCreated'Variants

Defined in StripeAPI.Operations.GetPlans

Methods

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

show :: GetPlansParametersQueryCreated'Variants -> String

showList :: [GetPlansParametersQueryCreated'Variants] -> ShowS

ToJSON GetPlansParametersQueryCreated'Variants

Defined in StripeAPI.Operations.GetPlans

Methods

toJSON :: GetPlansParametersQueryCreated'Variants -> Value

toEncoding :: GetPlansParametersQueryCreated'Variants -> Encoding

toJSONList :: [GetPlansParametersQueryCreated'Variants] -> Value

toEncodingList :: [GetPlansParametersQueryCreated'Variants] -> Encoding

FromJSON GetPlansParametersQueryCreated'Variants

Defined in StripeAPI.Operations.GetPlans

Methods

parseJSON :: Value -> Parser GetPlansParametersQueryCreated'Variants

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

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 object schema located at paths./v1/plans.GET.responses.200.content.application/json.schema in the specification.

Constructors

GetPlansResponseBody200

Fields

• getPlansResponseBody200Data :: [Plan]

  data: Details about each object.

• getPlansResponseBody200HasMore :: Bool

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

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

mkGetPlansResponseBody200

Arguments

:: [Plan]

getPlansResponseBody200Data

-> Bool

getPlansResponseBody200HasMore

-> Text

getPlansResponseBody200Url

-> GetPlansResponseBody200

Create a new GetPlansResponseBody200 with all required fields.