Safe Haskell	None
Language	Haskell2010

StripeAPI.Operations.GetSubscriptions

Description

Contains the different functions to run the operation getSubscriptions

Synopsis

getSubscriptions :: forall m. MonadHTTP m => GetSubscriptionsParameters -> ClientT m (Response GetSubscriptionsResponse)
data GetSubscriptionsParameters = GetSubscriptionsParameters {
}
mkGetSubscriptionsParameters :: GetSubscriptionsParameters
data GetSubscriptionsParametersQueryCollectionMethod'
data GetSubscriptionsParametersQueryCreated'OneOf1 = GetSubscriptionsParametersQueryCreated'OneOf1 {
}
mkGetSubscriptionsParametersQueryCreated'OneOf1 :: GetSubscriptionsParametersQueryCreated'OneOf1
data GetSubscriptionsParametersQueryCreated'Variants
- = GetSubscriptionsParametersQueryCreated'GetSubscriptionsParametersQueryCreated'OneOf1 GetSubscriptionsParametersQueryCreated'OneOf1
- | GetSubscriptionsParametersQueryCreated'Int Int
data GetSubscriptionsParametersQueryCurrentPeriodEnd'OneOf1 = GetSubscriptionsParametersQueryCurrentPeriodEnd'OneOf1 {
}
mkGetSubscriptionsParametersQueryCurrentPeriodEnd'OneOf1 :: GetSubscriptionsParametersQueryCurrentPeriodEnd'OneOf1
data GetSubscriptionsParametersQueryCurrentPeriodEnd'Variants
- = GetSubscriptionsParametersQueryCurrentPeriodEnd'GetSubscriptionsParametersQueryCurrentPeriodEnd'OneOf1 GetSubscriptionsParametersQueryCurrentPeriodEnd'OneOf1
- | GetSubscriptionsParametersQueryCurrentPeriodEnd'Int Int
data GetSubscriptionsParametersQueryCurrentPeriodStart'OneOf1 = GetSubscriptionsParametersQueryCurrentPeriodStart'OneOf1 {
}
mkGetSubscriptionsParametersQueryCurrentPeriodStart'OneOf1 :: GetSubscriptionsParametersQueryCurrentPeriodStart'OneOf1
data GetSubscriptionsParametersQueryCurrentPeriodStart'Variants
- = GetSubscriptionsParametersQueryCurrentPeriodStart'GetSubscriptionsParametersQueryCurrentPeriodStart'OneOf1 GetSubscriptionsParametersQueryCurrentPeriodStart'OneOf1
- | GetSubscriptionsParametersQueryCurrentPeriodStart'Int Int
data GetSubscriptionsParametersQueryStatus'
data GetSubscriptionsResponse
data GetSubscriptionsResponseBody200 = GetSubscriptionsResponseBody200 {
}
mkGetSubscriptionsResponseBody200 :: [Subscription] -> Bool -> Text -> GetSubscriptionsResponseBody200

Documentation

getSubscriptions Source #

Arguments

:: forall m. 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>

data GetSubscriptionsParameters Source #

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

Constructors

GetSubscriptionsParameters

Fields

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.

Instances

Instances details

Eq GetSubscriptionsParameters Source #
Instance details Defined in StripeAPI.Operations.GetSubscriptions Methods (==) :: GetSubscriptionsParameters -> GetSubscriptionsParameters -> Bool # (/=) :: GetSubscriptionsParameters -> GetSubscriptionsParameters -> Bool #
Show GetSubscriptionsParameters Source #
Instance details Defined in StripeAPI.Operations.GetSubscriptions Methods showsPrec :: Int -> GetSubscriptionsParameters -> ShowS # show :: GetSubscriptionsParameters -> String # showList :: [GetSubscriptionsParameters] -> ShowS #
ToJSON GetSubscriptionsParameters Source #
Instance details Defined in StripeAPI.Operations.GetSubscriptions Methods toJSON :: GetSubscriptionsParameters -> Value # toEncoding :: GetSubscriptionsParameters -> Encoding # toJSONList :: [GetSubscriptionsParameters] -> Value # toEncodingList :: [GetSubscriptionsParameters] -> Encoding #
FromJSON GetSubscriptionsParameters Source #
Instance details Defined in StripeAPI.Operations.GetSubscriptions Methods parseJSON :: Value -> Parser GetSubscriptionsParameters # parseJSONList :: Value -> Parser [GetSubscriptionsParameters] #

mkGetSubscriptionsParameters :: GetSubscriptionsParameters Source #

Create a new GetSubscriptionsParameters with all required fields.

data GetSubscriptionsParametersQueryCollectionMethod' Source #

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

Instances

Instances details

Eq GetSubscriptionsParametersQueryCollectionMethod' Source #
Instance details Defined in StripeAPI.Operations.GetSubscriptions Methods (==) :: GetSubscriptionsParametersQueryCollectionMethod' -> GetSubscriptionsParametersQueryCollectionMethod' -> Bool # (/=) :: GetSubscriptionsParametersQueryCollectionMethod' -> GetSubscriptionsParametersQueryCollectionMethod' -> Bool #
Show GetSubscriptionsParametersQueryCollectionMethod' Source #
Instance details Defined in StripeAPI.Operations.GetSubscriptions Methods showsPrec :: Int -> GetSubscriptionsParametersQueryCollectionMethod' -> ShowS # show :: GetSubscriptionsParametersQueryCollectionMethod' -> String # showList :: [GetSubscriptionsParametersQueryCollectionMethod'] -> ShowS #
ToJSON GetSubscriptionsParametersQueryCollectionMethod' Source #
Instance details Defined in StripeAPI.Operations.GetSubscriptions Methods toJSON :: GetSubscriptionsParametersQueryCollectionMethod' -> Value # toEncoding :: GetSubscriptionsParametersQueryCollectionMethod' -> Encoding # toJSONList :: [GetSubscriptionsParametersQueryCollectionMethod'] -> Value # toEncodingList :: [GetSubscriptionsParametersQueryCollectionMethod'] -> Encoding #
FromJSON GetSubscriptionsParametersQueryCollectionMethod' Source #
Instance details Defined in StripeAPI.Operations.GetSubscriptions Methods parseJSON :: Value -> Parser GetSubscriptionsParametersQueryCollectionMethod' # parseJSONList :: Value -> Parser [GetSubscriptionsParametersQueryCollectionMethod'] #

data GetSubscriptionsParametersQueryCreated'OneOf1 Source #

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

Constructors

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

Instances

Instances details

Eq GetSubscriptionsParametersQueryCreated'OneOf1 Source #
Instance details Defined in StripeAPI.Operations.GetSubscriptions Methods (==) :: GetSubscriptionsParametersQueryCreated'OneOf1 -> GetSubscriptionsParametersQueryCreated'OneOf1 -> Bool # (/=) :: GetSubscriptionsParametersQueryCreated'OneOf1 -> GetSubscriptionsParametersQueryCreated'OneOf1 -> Bool #
Show GetSubscriptionsParametersQueryCreated'OneOf1 Source #
Instance details Defined in StripeAPI.Operations.GetSubscriptions Methods showsPrec :: Int -> GetSubscriptionsParametersQueryCreated'OneOf1 -> ShowS # show :: GetSubscriptionsParametersQueryCreated'OneOf1 -> String # showList :: [GetSubscriptionsParametersQueryCreated'OneOf1] -> ShowS #
ToJSON GetSubscriptionsParametersQueryCreated'OneOf1 Source #
Instance details Defined in StripeAPI.Operations.GetSubscriptions Methods toJSON :: GetSubscriptionsParametersQueryCreated'OneOf1 -> Value # toEncoding :: GetSubscriptionsParametersQueryCreated'OneOf1 -> Encoding # toJSONList :: [GetSubscriptionsParametersQueryCreated'OneOf1] -> Value # toEncodingList :: [GetSubscriptionsParametersQueryCreated'OneOf1] -> Encoding #
FromJSON GetSubscriptionsParametersQueryCreated'OneOf1 Source #
Instance details Defined in StripeAPI.Operations.GetSubscriptions Methods parseJSON :: Value -> Parser GetSubscriptionsParametersQueryCreated'OneOf1 # parseJSONList :: Value -> Parser [GetSubscriptionsParametersQueryCreated'OneOf1] #

mkGetSubscriptionsParametersQueryCreated'OneOf1 :: GetSubscriptionsParametersQueryCreated'OneOf1 Source #

Create a new GetSubscriptionsParametersQueryCreated'OneOf1 with all required fields.

data GetSubscriptionsParametersQueryCreated'Variants Source #

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

Instances

Instances details

Eq GetSubscriptionsParametersQueryCreated'Variants Source #
Instance details Defined in StripeAPI.Operations.GetSubscriptions Methods (==) :: GetSubscriptionsParametersQueryCreated'Variants -> GetSubscriptionsParametersQueryCreated'Variants -> Bool # (/=) :: GetSubscriptionsParametersQueryCreated'Variants -> GetSubscriptionsParametersQueryCreated'Variants -> Bool #
Show GetSubscriptionsParametersQueryCreated'Variants Source #
Instance details Defined in StripeAPI.Operations.GetSubscriptions Methods showsPrec :: Int -> GetSubscriptionsParametersQueryCreated'Variants -> ShowS # show :: GetSubscriptionsParametersQueryCreated'Variants -> String # showList :: [GetSubscriptionsParametersQueryCreated'Variants] -> ShowS #
ToJSON GetSubscriptionsParametersQueryCreated'Variants Source #
Instance details Defined in StripeAPI.Operations.GetSubscriptions Methods toJSON :: GetSubscriptionsParametersQueryCreated'Variants -> Value # toEncoding :: GetSubscriptionsParametersQueryCreated'Variants -> Encoding # toJSONList :: [GetSubscriptionsParametersQueryCreated'Variants] -> Value # toEncodingList :: [GetSubscriptionsParametersQueryCreated'Variants] -> Encoding #
FromJSON GetSubscriptionsParametersQueryCreated'Variants Source #
Instance details Defined in StripeAPI.Operations.GetSubscriptions Methods parseJSON :: Value -> Parser GetSubscriptionsParametersQueryCreated'Variants # parseJSONList :: Value -> Parser [GetSubscriptionsParametersQueryCreated'Variants] #

data GetSubscriptionsParametersQueryCurrentPeriodEnd'OneOf1 Source #

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

Constructors

GetSubscriptionsParametersQueryCurrentPeriodEnd'OneOf1
Fields getSubscriptionsParametersQueryCurrentPeriodEnd'OneOf1Gt :: Maybe Int gt getSubscriptionsParametersQueryCurrentPeriodEnd'OneOf1Gte :: Maybe Int gte getSubscriptionsParametersQueryCurrentPeriodEnd'OneOf1Lt :: Maybe Int lt getSubscriptionsParametersQueryCurrentPeriodEnd'OneOf1Lte :: Maybe Int lte

Instances

Instances details

Eq GetSubscriptionsParametersQueryCurrentPeriodEnd'OneOf1 Source #
Instance details Defined in StripeAPI.Operations.GetSubscriptions Methods (==) :: GetSubscriptionsParametersQueryCurrentPeriodEnd'OneOf1 -> GetSubscriptionsParametersQueryCurrentPeriodEnd'OneOf1 -> Bool # (/=) :: GetSubscriptionsParametersQueryCurrentPeriodEnd'OneOf1 -> GetSubscriptionsParametersQueryCurrentPeriodEnd'OneOf1 -> Bool #
Show GetSubscriptionsParametersQueryCurrentPeriodEnd'OneOf1 Source #
Instance details Defined in StripeAPI.Operations.GetSubscriptions Methods showsPrec :: Int -> GetSubscriptionsParametersQueryCurrentPeriodEnd'OneOf1 -> ShowS # show :: GetSubscriptionsParametersQueryCurrentPeriodEnd'OneOf1 -> String # showList :: [GetSubscriptionsParametersQueryCurrentPeriodEnd'OneOf1] -> ShowS #
ToJSON GetSubscriptionsParametersQueryCurrentPeriodEnd'OneOf1 Source #
Instance details Defined in StripeAPI.Operations.GetSubscriptions Methods toJSON :: GetSubscriptionsParametersQueryCurrentPeriodEnd'OneOf1 -> Value # toEncoding :: GetSubscriptionsParametersQueryCurrentPeriodEnd'OneOf1 -> Encoding # toJSONList :: [GetSubscriptionsParametersQueryCurrentPeriodEnd'OneOf1] -> Value # toEncodingList :: [GetSubscriptionsParametersQueryCurrentPeriodEnd'OneOf1] -> Encoding #
FromJSON GetSubscriptionsParametersQueryCurrentPeriodEnd'OneOf1 Source #
Instance details Defined in StripeAPI.Operations.GetSubscriptions Methods parseJSON :: Value -> Parser GetSubscriptionsParametersQueryCurrentPeriodEnd'OneOf1 # parseJSONList :: Value -> Parser [GetSubscriptionsParametersQueryCurrentPeriodEnd'OneOf1] #

mkGetSubscriptionsParametersQueryCurrentPeriodEnd'OneOf1 :: GetSubscriptionsParametersQueryCurrentPeriodEnd'OneOf1 Source #

Create a new GetSubscriptionsParametersQueryCurrentPeriodEnd'OneOf1 with all required fields.

data GetSubscriptionsParametersQueryCurrentPeriodEnd'Variants Source #

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

Instances

Instances details

Eq GetSubscriptionsParametersQueryCurrentPeriodEnd'Variants Source #
Instance details Defined in StripeAPI.Operations.GetSubscriptions Methods (==) :: GetSubscriptionsParametersQueryCurrentPeriodEnd'Variants -> GetSubscriptionsParametersQueryCurrentPeriodEnd'Variants -> Bool # (/=) :: GetSubscriptionsParametersQueryCurrentPeriodEnd'Variants -> GetSubscriptionsParametersQueryCurrentPeriodEnd'Variants -> Bool #
Show GetSubscriptionsParametersQueryCurrentPeriodEnd'Variants Source #
Instance details Defined in StripeAPI.Operations.GetSubscriptions Methods showsPrec :: Int -> GetSubscriptionsParametersQueryCurrentPeriodEnd'Variants -> ShowS # show :: GetSubscriptionsParametersQueryCurrentPeriodEnd'Variants -> String # showList :: [GetSubscriptionsParametersQueryCurrentPeriodEnd'Variants] -> ShowS #
ToJSON GetSubscriptionsParametersQueryCurrentPeriodEnd'Variants Source #
Instance details Defined in StripeAPI.Operations.GetSubscriptions Methods toJSON :: GetSubscriptionsParametersQueryCurrentPeriodEnd'Variants -> Value # toEncoding :: GetSubscriptionsParametersQueryCurrentPeriodEnd'Variants -> Encoding # toJSONList :: [GetSubscriptionsParametersQueryCurrentPeriodEnd'Variants] -> Value # toEncodingList :: [GetSubscriptionsParametersQueryCurrentPeriodEnd'Variants] -> Encoding #
FromJSON GetSubscriptionsParametersQueryCurrentPeriodEnd'Variants Source #
Instance details Defined in StripeAPI.Operations.GetSubscriptions Methods parseJSON :: Value -> Parser GetSubscriptionsParametersQueryCurrentPeriodEnd'Variants # parseJSONList :: Value -> Parser [GetSubscriptionsParametersQueryCurrentPeriodEnd'Variants] #

data GetSubscriptionsParametersQueryCurrentPeriodStart'OneOf1 Source #

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

Constructors

GetSubscriptionsParametersQueryCurrentPeriodStart'OneOf1
Fields getSubscriptionsParametersQueryCurrentPeriodStart'OneOf1Gt :: Maybe Int gt getSubscriptionsParametersQueryCurrentPeriodStart'OneOf1Gte :: Maybe Int gte getSubscriptionsParametersQueryCurrentPeriodStart'OneOf1Lt :: Maybe Int lt getSubscriptionsParametersQueryCurrentPeriodStart'OneOf1Lte :: Maybe Int lte

Instances

Instances details

Eq GetSubscriptionsParametersQueryCurrentPeriodStart'OneOf1 Source #
Instance details Defined in StripeAPI.Operations.GetSubscriptions Methods (==) :: GetSubscriptionsParametersQueryCurrentPeriodStart'OneOf1 -> GetSubscriptionsParametersQueryCurrentPeriodStart'OneOf1 -> Bool # (/=) :: GetSubscriptionsParametersQueryCurrentPeriodStart'OneOf1 -> GetSubscriptionsParametersQueryCurrentPeriodStart'OneOf1 -> Bool #
Show GetSubscriptionsParametersQueryCurrentPeriodStart'OneOf1 Source #
Instance details Defined in StripeAPI.Operations.GetSubscriptions Methods showsPrec :: Int -> GetSubscriptionsParametersQueryCurrentPeriodStart'OneOf1 -> ShowS # show :: GetSubscriptionsParametersQueryCurrentPeriodStart'OneOf1 -> String # showList :: [GetSubscriptionsParametersQueryCurrentPeriodStart'OneOf1] -> ShowS #
ToJSON GetSubscriptionsParametersQueryCurrentPeriodStart'OneOf1 Source #
Instance details Defined in StripeAPI.Operations.GetSubscriptions Methods toJSON :: GetSubscriptionsParametersQueryCurrentPeriodStart'OneOf1 -> Value # toEncoding :: GetSubscriptionsParametersQueryCurrentPeriodStart'OneOf1 -> Encoding # toJSONList :: [GetSubscriptionsParametersQueryCurrentPeriodStart'OneOf1] -> Value # toEncodingList :: [GetSubscriptionsParametersQueryCurrentPeriodStart'OneOf1] -> Encoding #
FromJSON GetSubscriptionsParametersQueryCurrentPeriodStart'OneOf1 Source #
Instance details Defined in StripeAPI.Operations.GetSubscriptions Methods parseJSON :: Value -> Parser GetSubscriptionsParametersQueryCurrentPeriodStart'OneOf1 # parseJSONList :: Value -> Parser [GetSubscriptionsParametersQueryCurrentPeriodStart'OneOf1] #

mkGetSubscriptionsParametersQueryCurrentPeriodStart'OneOf1 :: GetSubscriptionsParametersQueryCurrentPeriodStart'OneOf1 Source #

Create a new GetSubscriptionsParametersQueryCurrentPeriodStart'OneOf1 with all required fields.

data GetSubscriptionsParametersQueryCurrentPeriodStart'Variants Source #

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

Instances

Instances details

Eq GetSubscriptionsParametersQueryCurrentPeriodStart'Variants Source #
Instance details Defined in StripeAPI.Operations.GetSubscriptions Methods (==) :: GetSubscriptionsParametersQueryCurrentPeriodStart'Variants -> GetSubscriptionsParametersQueryCurrentPeriodStart'Variants -> Bool # (/=) :: GetSubscriptionsParametersQueryCurrentPeriodStart'Variants -> GetSubscriptionsParametersQueryCurrentPeriodStart'Variants -> Bool #
Show GetSubscriptionsParametersQueryCurrentPeriodStart'Variants Source #
Instance details Defined in StripeAPI.Operations.GetSubscriptions Methods showsPrec :: Int -> GetSubscriptionsParametersQueryCurrentPeriodStart'Variants -> ShowS # show :: GetSubscriptionsParametersQueryCurrentPeriodStart'Variants -> String # showList :: [GetSubscriptionsParametersQueryCurrentPeriodStart'Variants] -> ShowS #
ToJSON GetSubscriptionsParametersQueryCurrentPeriodStart'Variants Source #
Instance details Defined in StripeAPI.Operations.GetSubscriptions Methods toJSON :: GetSubscriptionsParametersQueryCurrentPeriodStart'Variants -> Value # toEncoding :: GetSubscriptionsParametersQueryCurrentPeriodStart'Variants -> Encoding # toJSONList :: [GetSubscriptionsParametersQueryCurrentPeriodStart'Variants] -> Value # toEncodingList :: [GetSubscriptionsParametersQueryCurrentPeriodStart'Variants] -> Encoding #
FromJSON GetSubscriptionsParametersQueryCurrentPeriodStart'Variants Source #
Instance details Defined in StripeAPI.Operations.GetSubscriptions Methods parseJSON :: Value -> Parser GetSubscriptionsParametersQueryCurrentPeriodStart'Variants # parseJSONList :: Value -> Parser [GetSubscriptionsParametersQueryCurrentPeriodStart'Variants] #

data GetSubscriptionsParametersQueryStatus' Source #

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

Instances

Instances details

Eq GetSubscriptionsParametersQueryStatus' Source #
Instance details Defined in StripeAPI.Operations.GetSubscriptions Methods (==) :: GetSubscriptionsParametersQueryStatus' -> GetSubscriptionsParametersQueryStatus' -> Bool # (/=) :: GetSubscriptionsParametersQueryStatus' -> GetSubscriptionsParametersQueryStatus' -> Bool #
Show GetSubscriptionsParametersQueryStatus' Source #
Instance details Defined in StripeAPI.Operations.GetSubscriptions Methods showsPrec :: Int -> GetSubscriptionsParametersQueryStatus' -> ShowS # show :: GetSubscriptionsParametersQueryStatus' -> String # showList :: [GetSubscriptionsParametersQueryStatus'] -> ShowS #
ToJSON GetSubscriptionsParametersQueryStatus' Source #
Instance details Defined in StripeAPI.Operations.GetSubscriptions Methods toJSON :: GetSubscriptionsParametersQueryStatus' -> Value # toEncoding :: GetSubscriptionsParametersQueryStatus' -> Encoding # toJSONList :: [GetSubscriptionsParametersQueryStatus'] -> Value # toEncodingList :: [GetSubscriptionsParametersQueryStatus'] -> Encoding #
FromJSON GetSubscriptionsParametersQueryStatus' Source #
Instance details Defined in StripeAPI.Operations.GetSubscriptions Methods parseJSON :: Value -> Parser GetSubscriptionsParametersQueryStatus' # parseJSONList :: Value -> Parser [GetSubscriptionsParametersQueryStatus'] #

data GetSubscriptionsResponse Source #

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.

Instances

Instances details

Eq GetSubscriptionsResponse Source #
Instance details Defined in StripeAPI.Operations.GetSubscriptions Methods (==) :: GetSubscriptionsResponse -> GetSubscriptionsResponse -> Bool # (/=) :: GetSubscriptionsResponse -> GetSubscriptionsResponse -> Bool #
Show GetSubscriptionsResponse Source #
Instance details Defined in StripeAPI.Operations.GetSubscriptions Methods showsPrec :: Int -> GetSubscriptionsResponse -> ShowS # show :: GetSubscriptionsResponse -> String # showList :: [GetSubscriptionsResponse] -> ShowS #

data GetSubscriptionsResponseBody200 Source #

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

Constructors

GetSubscriptionsResponseBody200
Fields 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'

Instances

Instances details

Eq GetSubscriptionsResponseBody200 Source #
Instance details Defined in StripeAPI.Operations.GetSubscriptions Methods (==) :: GetSubscriptionsResponseBody200 -> GetSubscriptionsResponseBody200 -> Bool # (/=) :: GetSubscriptionsResponseBody200 -> GetSubscriptionsResponseBody200 -> Bool #
Show GetSubscriptionsResponseBody200 Source #
Instance details Defined in StripeAPI.Operations.GetSubscriptions Methods showsPrec :: Int -> GetSubscriptionsResponseBody200 -> ShowS # show :: GetSubscriptionsResponseBody200 -> String # showList :: [GetSubscriptionsResponseBody200] -> ShowS #
ToJSON GetSubscriptionsResponseBody200 Source #
Instance details Defined in StripeAPI.Operations.GetSubscriptions Methods toJSON :: GetSubscriptionsResponseBody200 -> Value # toEncoding :: GetSubscriptionsResponseBody200 -> Encoding # toJSONList :: [GetSubscriptionsResponseBody200] -> Value # toEncodingList :: [GetSubscriptionsResponseBody200] -> Encoding #
FromJSON GetSubscriptionsResponseBody200 Source #
Instance details Defined in StripeAPI.Operations.GetSubscriptions Methods parseJSON :: Value -> Parser GetSubscriptionsResponseBody200 # parseJSONList :: Value -> Parser [GetSubscriptionsResponseBody200] #

mkGetSubscriptionsResponseBody200 Source #

Arguments

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

Create a new GetSubscriptionsResponseBody200 with all required fields.