StripeAPI.Operations.GetSubscriptions

Contains the different functions to run the operation getSubscriptions

Documentation

getSubscriptions

Arguments

:: (MonadHTTP m, SecurityScheme s)

=> Configuration s

The configuration to use in the request

-> Maybe Text

collection_method: The collection method of the subscriptions to retrieve. Either `charge_automatically` or `send_invoice`. | Constraints: Maximum length of 5000

-> Maybe Text

created

-> Maybe Text

current_period_end

-> Maybe Text

current_period_start

-> Maybe Text

customer: The ID of the customer whose subscriptions will be retrieved. | Constraints: Maximum length of 5000

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

plan: The ID of the plan whose subscriptions will be retrieved. | 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 Text

status: The status of the subscriptions to retrieve. One of: `incomplete`, `incomplete_expired`, `trialing`, `active`, `past_due`, `unpaid`, `canceled`, or `all`. Passing in a value of `canceled` will return all canceled subscriptions, including those belonging to deleted customers. Passing in a value of `all` will return subscriptions of all statuses. | Constraints: Maximum length of 5000

-> Maybe GetSubscriptionsRequestBody

The request body to send

-> m (Either HttpException (Response GetSubscriptionsResponse))

Monad containing 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>

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

GET /v1/subscriptions

The same as getSubscriptions but returns the raw ByteString

getSubscriptionsM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe Text -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe Integer -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe GetSubscriptionsRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response GetSubscriptionsResponse))

GET /v1/subscriptions

Monadic version of getSubscriptions (use with runWithConfiguration)

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

GET /v1/subscriptions

Monadic version of getSubscriptionsRaw (use with runWithConfiguration)

data GetSubscriptionsRequestBody

Defines the data type for the schema getSubscriptionsRequestBody

Constructors

GetSubscriptionsRequestBody

Instances

Eq GetSubscriptionsRequestBody

Defined in StripeAPI.Operations.GetSubscriptions

Methods

(==) :: GetSubscriptionsRequestBody -> GetSubscriptionsRequestBody -> Bool

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

Show GetSubscriptionsRequestBody

Defined in StripeAPI.Operations.GetSubscriptions

Methods

showsPrec :: Int -> GetSubscriptionsRequestBody -> ShowS

show :: GetSubscriptionsRequestBody -> String

showList :: [GetSubscriptionsRequestBody] -> ShowS

ToJSON GetSubscriptionsRequestBody

Defined in StripeAPI.Operations.GetSubscriptions

Methods

toJSON :: GetSubscriptionsRequestBody -> Value

toEncoding :: GetSubscriptionsRequestBody -> Encoding

toJSONList :: [GetSubscriptionsRequestBody] -> Value

toEncodingList :: [GetSubscriptionsRequestBody] -> Encoding

FromJSON GetSubscriptionsRequestBody

Defined in StripeAPI.Operations.GetSubscriptions

Methods

parseJSON :: Value -> Parser GetSubscriptionsRequestBody

parseJSONList :: Value -> Parser [GetSubscriptionsRequestBody]

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

Instances

Eq GetSubscriptionsResponse

Defined in StripeAPI.Operations.GetSubscriptions

Methods

(==) :: GetSubscriptionsResponse -> GetSubscriptionsResponse -> Bool

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

Show GetSubscriptionsResponse

Defined in StripeAPI.Operations.GetSubscriptions

Methods

showsPrec :: Int -> GetSubscriptionsResponse -> ShowS

show :: GetSubscriptionsResponse -> String

showList :: [GetSubscriptionsResponse] -> ShowS

data GetSubscriptionsResponseBody200

Defines the data type for the schema GetSubscriptionsResponseBody200

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.

• getSubscriptionsResponseBody200Object :: GetSubscriptionsResponseBody200Object'

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

• getSubscriptionsResponseBody200Url :: Text

  url: The URL where this list can be accessed.

  Constraints:

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

Instances

Eq GetSubscriptionsResponseBody200

Defined in StripeAPI.Operations.GetSubscriptions

Methods

(==) :: GetSubscriptionsResponseBody200 -> GetSubscriptionsResponseBody200 -> Bool

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

Show GetSubscriptionsResponseBody200

Defined in StripeAPI.Operations.GetSubscriptions

Methods

showsPrec :: Int -> GetSubscriptionsResponseBody200 -> ShowS

show :: GetSubscriptionsResponseBody200 -> String

showList :: [GetSubscriptionsResponseBody200] -> ShowS

ToJSON GetSubscriptionsResponseBody200

Defined in StripeAPI.Operations.GetSubscriptions

Methods

toJSON :: GetSubscriptionsResponseBody200 -> Value

toEncoding :: GetSubscriptionsResponseBody200 -> Encoding

toJSONList :: [GetSubscriptionsResponseBody200] -> Value

toEncodingList :: [GetSubscriptionsResponseBody200] -> Encoding

FromJSON GetSubscriptionsResponseBody200

Defined in StripeAPI.Operations.GetSubscriptions

Methods

parseJSON :: Value -> Parser GetSubscriptionsResponseBody200

parseJSONList :: Value -> Parser [GetSubscriptionsResponseBody200]

data GetSubscriptionsResponseBody200Object'

Defines the enum schema GetSubscriptionsResponseBody200Object'

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

Constructors

GetSubscriptionsResponseBody200Object'EnumOther Value

GetSubscriptionsResponseBody200Object'EnumTyped Text

GetSubscriptionsResponseBody200Object'EnumStringList

Instances

Eq GetSubscriptionsResponseBody200Object'

Defined in StripeAPI.Operations.GetSubscriptions

Methods

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

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

Show GetSubscriptionsResponseBody200Object'

Defined in StripeAPI.Operations.GetSubscriptions

Methods

showsPrec :: Int -> GetSubscriptionsResponseBody200Object' -> ShowS

show :: GetSubscriptionsResponseBody200Object' -> String

showList :: [GetSubscriptionsResponseBody200Object'] -> ShowS

ToJSON GetSubscriptionsResponseBody200Object'

Defined in StripeAPI.Operations.GetSubscriptions

Methods

toJSON :: GetSubscriptionsResponseBody200Object' -> Value

toEncoding :: GetSubscriptionsResponseBody200Object' -> Encoding

toJSONList :: [GetSubscriptionsResponseBody200Object'] -> Value

toEncodingList :: [GetSubscriptionsResponseBody200Object'] -> Encoding

FromJSON GetSubscriptionsResponseBody200Object'

Defined in StripeAPI.Operations.GetSubscriptions

Methods

parseJSON :: Value -> Parser GetSubscriptionsResponseBody200Object'

parseJSONList :: Value -> Parser [GetSubscriptionsResponseBody200Object']