Modulestripeapi-3.0.0.0Haskell2010

StripeAPI.Operations.GetSubscriptions

Contains the different functions to run the operation getSubscriptions

11 types
6 values

Packagestripeapi-3.0.0.0
Exports17
LanguageHaskell2010
LicenceMIT
SourceGetSubscriptions.hs

valuegetSubscriptions

:: MonadHTTP m
=> GetSubscriptionsParameters
Contains all available parameters of this operation (query and path parameters)
-> ClientT m (Response GetSubscriptionsResponse)
Monadic computation which returns the result of the operation

GET /v1/subscriptions

<p>By default, returns a list of subscriptions that have not been canceled. In order to list canceled subscriptions, specify <code>status=canceled</code>.</p>

datadata GetSubscriptionsParameters

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

Constructors

GetSubscriptionsParameters
- getSubscriptionsParametersQueryCollectionMethod :: Maybe GetSubscriptionsParametersQueryCollectionMethod'
  queryCollection_method: Represents the parameter named 'collection_method'
  The collection method of the subscriptions to retrieve. Either `charge_automatically` or `send_invoice`.
- getSubscriptionsParametersQueryCreated :: Maybe GetSubscriptionsParametersQueryCreated'Variants
  queryCreated: Represents the parameter named 'created'
- getSubscriptionsParametersQueryCurrentPeriodEnd :: Maybe GetSubscriptionsParametersQueryCurrentPeriodEnd'Variants
  queryCurrent_period_end: Represents the parameter named 'current_period_end'
- getSubscriptionsParametersQueryCurrentPeriodStart :: Maybe GetSubscriptionsParametersQueryCurrentPeriodStart'Variants
  queryCurrent_period_start: Represents the parameter named 'current_period_start'
- getSubscriptionsParametersQueryCustomer :: Maybe Text
  queryCustomer: Represents the parameter named 'customer'
  The ID of the customer whose subscriptions will be retrieved.
  Constraints:
  - Maximum length of 5000
- getSubscriptionsParametersQueryEndingBefore :: 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
- getSubscriptionsParametersQueryExpand :: Maybe [Text]
  queryExpand: Represents the parameter named 'expand'
  Specifies which fields in the response should be expanded.
- getSubscriptionsParametersQueryLimit :: 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.
- getSubscriptionsParametersQueryPrice :: Maybe Text
  queryPrice: Represents the parameter named 'price'
  Filter for subscriptions that contain this recurring price ID.
  Constraints:
  - Maximum length of 5000
- getSubscriptionsParametersQueryStartingAfter :: 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
- getSubscriptionsParametersQueryStatus :: Maybe GetSubscriptionsParametersQueryStatus'
  queryStatus: Represents the parameter named 'status'
  The status of the subscriptions to retrieve. Passing in a value of `canceled` will return all canceled subscriptions, including those belonging to deleted customers. Pass `ended` to find subscriptions that are canceled and subscriptions that are expired due to incomplete payment. Passing in a value of `all` will return subscriptions of all statuses. If no value is supplied, all subscriptions that have not been canceled are returned.
- getSubscriptionsParametersQueryTestClock :: Maybe Text
  queryTest_clock: Represents the parameter named 'test_clock'
  Filter for subscriptions that are associated with the specified test clock. The response will not include subscriptions with test clocks if this and the customer parameter is not set.
  Constraints:
  - Maximum length of 5000

Instances4Eq, Show, FromJSON, ToJSON

Eq GetSubscriptionsParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetSubscriptions
Show GetSubscriptionsParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetSubscriptions
FromJSON GetSubscriptionsParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetSubscriptions
ToJSON GetSubscriptionsParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetSubscriptions

valuemkGetSubscriptionsParameters :: GetSubscriptionsParameters

Create a new GetSubscriptionsParameters with all required fields.

datadata GetSubscriptionsParametersQueryCollectionMethod'

Defines the enum schema located at paths./v1/subscriptions.GET.parameters.properties.queryCollection_method in the specification.

Represents the parameter named 'collection_method'

The collection method of the subscriptions to retrieve. Either `charge_automatically` or `send_invoice`.

Constructors

GetSubscriptionsParametersQueryCollectionMethod'Other Value
This case is used if the value encountered during decoding does not match any of the provided cases in the specification.
GetSubscriptionsParametersQueryCollectionMethod'Typed Text
This constructor can be used to send values to the server which are not present in the specification yet.
GetSubscriptionsParametersQueryCollectionMethod'EnumChargeAutomatically
Represents the JSON value "charge_automatically"
GetSubscriptionsParametersQueryCollectionMethod'EnumSendInvoice
Represents the JSON value "send_invoice"

Instances4Eq, Show, FromJSON, ToJSON

Eq GetSubscriptionsParametersQueryCollectionMethod'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetSubscriptions
Show GetSubscriptionsParametersQueryCollectionMethod'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetSubscriptions
FromJSON GetSubscriptionsParametersQueryCollectionMethod'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetSubscriptions
ToJSON GetSubscriptionsParametersQueryCollectionMethod'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetSubscriptions

datadata GetSubscriptionsParametersQueryCreated'OneOf1

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

Constructors

GetSubscriptionsParametersQueryCreated'OneOf1
- getSubscriptionsParametersQueryCreated'OneOf1Gt :: Maybe Int
  gt
- getSubscriptionsParametersQueryCreated'OneOf1Gte :: Maybe Int
  gte
- getSubscriptionsParametersQueryCreated'OneOf1Lt :: Maybe Int
  lt
- getSubscriptionsParametersQueryCreated'OneOf1Lte :: Maybe Int
  lte

Instances4Eq, Show, FromJSON, ToJSON

Eq GetSubscriptionsParametersQueryCreated'OneOf1Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetSubscriptions
Show GetSubscriptionsParametersQueryCreated'OneOf1Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetSubscriptions
FromJSON GetSubscriptionsParametersQueryCreated'OneOf1Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetSubscriptions
ToJSON GetSubscriptionsParametersQueryCreated'OneOf1Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetSubscriptions

valuemkGetSubscriptionsParametersQueryCreated'OneOf1 :: GetSubscriptionsParametersQueryCreated'OneOf1

Create a new GetSubscriptionsParametersQueryCreated'OneOf1 with all required fields.

datadata GetSubscriptionsParametersQueryCreated'Variants

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

Represents the parameter named 'created'

Constructors

GetSubscriptionsParametersQueryCreated'GetSubscriptionsParametersQueryCreated'OneOf1 GetSubscriptionsParametersQueryCreated'OneOf1
GetSubscriptionsParametersQueryCreated'Int Int

Instances4Eq, Show, FromJSON, ToJSON

Eq GetSubscriptionsParametersQueryCreated'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetSubscriptions
Show GetSubscriptionsParametersQueryCreated'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetSubscriptions
FromJSON GetSubscriptionsParametersQueryCreated'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetSubscriptions
ToJSON GetSubscriptionsParametersQueryCreated'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetSubscriptions

datadata GetSubscriptionsParametersQueryCurrentPeriodEnd'OneOf1

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

Constructors

GetSubscriptionsParametersQueryCurrentPeriodEnd'OneOf1

Instances4Eq, Show, FromJSON, ToJSON

Eq GetSubscriptionsParametersQueryCurrentPeriodEnd'OneOf1Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetSubscriptions
Show GetSubscriptionsParametersQueryCurrentPeriodEnd'OneOf1Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetSubscriptions
FromJSON GetSubscriptionsParametersQueryCurrentPeriodEnd'OneOf1Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetSubscriptions
ToJSON GetSubscriptionsParametersQueryCurrentPeriodEnd'OneOf1Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetSubscriptions

valuemkGetSubscriptionsParametersQueryCurrentPeriodEnd'OneOf1 :: GetSubscriptionsParametersQueryCurrentPeriodEnd'OneOf1

Create a new GetSubscriptionsParametersQueryCurrentPeriodEnd'OneOf1 with all required fields.

datadata GetSubscriptionsParametersQueryCurrentPeriodEnd'Variants

Defines the oneOf schema located at paths./v1/subscriptions.GET.parameters.properties.queryCurrent_period_end.anyOf in the specification.

Represents the parameter named 'current_period_end'

Constructors

GetSubscriptionsParametersQueryCurrentPeriodEnd'GetSubscriptionsParametersQueryCurrentPeriodEnd'OneOf1 GetSubscriptionsParametersQueryCurrentPeriodEnd'OneOf1
GetSubscriptionsParametersQueryCurrentPeriodEnd'Int Int

Instances4Eq, Show, FromJSON, ToJSON

Eq GetSubscriptionsParametersQueryCurrentPeriodEnd'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetSubscriptions
Show GetSubscriptionsParametersQueryCurrentPeriodEnd'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetSubscriptions
FromJSON GetSubscriptionsParametersQueryCurrentPeriodEnd'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetSubscriptions
ToJSON GetSubscriptionsParametersQueryCurrentPeriodEnd'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetSubscriptions

datadata GetSubscriptionsParametersQueryCurrentPeriodStart'OneOf1

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

Constructors

GetSubscriptionsParametersQueryCurrentPeriodStart'OneOf1

Instances4Eq, Show, FromJSON, ToJSON

Eq GetSubscriptionsParametersQueryCurrentPeriodStart'OneOf1Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetSubscriptions
Show GetSubscriptionsParametersQueryCurrentPeriodStart'OneOf1Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetSubscriptions
FromJSON GetSubscriptionsParametersQueryCurrentPeriodStart'OneOf1Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetSubscriptions
ToJSON GetSubscriptionsParametersQueryCurrentPeriodStart'OneOf1Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetSubscriptions

valuemkGetSubscriptionsParametersQueryCurrentPeriodStart'OneOf1 :: GetSubscriptionsParametersQueryCurrentPeriodStart'OneOf1

Create a new GetSubscriptionsParametersQueryCurrentPeriodStart'OneOf1 with all required fields.

datadata GetSubscriptionsParametersQueryCurrentPeriodStart'Variants

Defines the oneOf schema located at paths./v1/subscriptions.GET.parameters.properties.queryCurrent_period_start.anyOf in the specification.

Represents the parameter named 'current_period_start'

Constructors

GetSubscriptionsParametersQueryCurrentPeriodStart'GetSubscriptionsParametersQueryCurrentPeriodStart'OneOf1 GetSubscriptionsParametersQueryCurrentPeriodStart'OneOf1
GetSubscriptionsParametersQueryCurrentPeriodStart'Int Int

Instances4Eq, Show, FromJSON, ToJSON

Eq GetSubscriptionsParametersQueryCurrentPeriodStart'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetSubscriptions
Show GetSubscriptionsParametersQueryCurrentPeriodStart'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetSubscriptions
FromJSON GetSubscriptionsParametersQueryCurrentPeriodStart'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetSubscriptions
ToJSON GetSubscriptionsParametersQueryCurrentPeriodStart'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetSubscriptions

datadata GetSubscriptionsParametersQueryStatus'

Defines the enum schema located at paths./v1/subscriptions.GET.parameters.properties.queryStatus in the specification.

Represents the parameter named 'status'

The status of the subscriptions to retrieve. Passing in a value of `canceled` will return all canceled subscriptions, including those belonging to deleted customers. Pass `ended` to find subscriptions that are canceled and subscriptions that are expired due to incomplete payment. Passing in a value of `all` will return subscriptions of all statuses. If no value is supplied, all subscriptions that have not been canceled are returned.

Constructors

GetSubscriptionsParametersQueryStatus'Other Value
This case is used if the value encountered during decoding does not match any of the provided cases in the specification.
GetSubscriptionsParametersQueryStatus'Typed Text
This constructor can be used to send values to the server which are not present in the specification yet.
GetSubscriptionsParametersQueryStatus'EnumActive
Represents the JSON value "active"
GetSubscriptionsParametersQueryStatus'EnumAll
Represents the JSON value "all"
GetSubscriptionsParametersQueryStatus'EnumCanceled
Represents the JSON value "canceled"
GetSubscriptionsParametersQueryStatus'EnumEnded
Represents the JSON value "ended"
GetSubscriptionsParametersQueryStatus'EnumIncomplete
Represents the JSON value "incomplete"
GetSubscriptionsParametersQueryStatus'EnumIncompleteExpired
Represents the JSON value "incomplete_expired"
GetSubscriptionsParametersQueryStatus'EnumPastDue
Represents the JSON value "past_due"
GetSubscriptionsParametersQueryStatus'EnumTrialing
Represents the JSON value "trialing"
GetSubscriptionsParametersQueryStatus'EnumUnpaid
Represents the JSON value "unpaid"

Instances4Eq, Show, FromJSON, ToJSON

Eq GetSubscriptionsParametersQueryStatus'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetSubscriptions
Show GetSubscriptionsParametersQueryStatus'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetSubscriptions
FromJSON GetSubscriptionsParametersQueryStatus'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetSubscriptions
ToJSON GetSubscriptionsParametersQueryStatus'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetSubscriptions

datadata GetSubscriptionsResponse

Represents a response of the operation getSubscriptions.

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

Constructors

GetSubscriptionsResponseError String
Means either no matching case available or a parse error
GetSubscriptionsResponse200 GetSubscriptionsResponseBody200
Successful response.
GetSubscriptionsResponseDefault Error
Error response.

Instances2Eq, Show

Eq GetSubscriptionsResponseDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetSubscriptions
Show GetSubscriptionsResponseDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetSubscriptions

datadata GetSubscriptionsResponseBody200

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

Constructors

GetSubscriptionsResponseBody200
- getSubscriptionsResponseBody200Data :: [Subscription]
  data
- getSubscriptionsResponseBody200HasMore :: Bool
  has_more: True if this list has another page of items after this one that can be fetched.
- getSubscriptionsResponseBody200Url :: Text
  url: The URL where this list can be accessed.
  Constraints:
  - Maximum length of 5000
  - Must match pattern '^/v1/subscriptions'

Instances4Eq, Show, FromJSON, ToJSON

Eq GetSubscriptionsResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetSubscriptions
Show GetSubscriptionsResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetSubscriptions
FromJSON GetSubscriptionsResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetSubscriptions
ToJSON GetSubscriptionsResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetSubscriptions

valuemkGetSubscriptionsResponseBody200

:: [Subscription]
getSubscriptionsResponseBody200Data
-> Bool
getSubscriptionsResponseBody200HasMore
-> Text
getSubscriptionsResponseBody200Url
-> GetSubscriptionsResponseBody200

Create a new GetSubscriptionsResponseBody200 with all required fields.