HORIZON HASKELLDocslts/ghc-9.10.xc74966e2026-09-27Search names, modules, packages, or :: a typeCtrl K

GHC 9.10.3 · lts/ghc-9.10.x · c74966e · 2026-09-27

Modulestripeapi-3.0.0.0Haskell2010

StripeAPI.Operations.GetPlans

Contains the different functions to run the operation getPlans

  • 5 types
  • 4 values
datadata GetPlansParameters
#

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

Constructors

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

Instances4Eq, Show, FromJSON, ToJSON
datadata GetPlansParametersQueryCreated'OneOf1
#

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

Constructors

Instances4Eq, Show, FromJSON, ToJSON
datadata 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

Instances4Eq, Show, FromJSON, ToJSON
datadata 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

Instances2Eq, Show
datadata GetPlansResponseBody200
#

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

Constructors

Instances4Eq, Show, FromJSON, ToJSON