StripeAPI.Operations.GetSubscriptionSchedules

Contains the different functions to run the operation getSubscriptionSchedules

Documentation

getSubscriptionSchedules

Arguments

:: (MonadHTTP m, SecurityScheme s)

=> Configuration s

The configuration to use in the request

-> Maybe String

canceled_at: Only return subscription schedules that were created canceled the given date interval.

-> Maybe String

completed_at: Only return subscription schedules that completed during the given date interval.

-> Maybe String

created: Only return subscription schedules that were created during the given date interval.

-> Maybe String

customer: Only return subscription schedules for the given customer. | Constraints: Maximum length of 5000

-> Maybe String

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 String

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 String

released_at: Only return subscription schedules that were released during the given date interval.

-> Maybe Bool

scheduled: Only return subscription schedules that have not started yet.

-> Maybe String

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

-> GetSubscriptionSchedulesRequestBody

The request body to send

-> m (Either HttpException (Response GetSubscriptionSchedulesResponse))

Monad containing the result of the operation

GET /v1/subscription_schedules

<p>Retrieves the list of your subscription schedules.</p>

getSubscriptionSchedulesRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Maybe String -> Maybe String -> Maybe String -> Maybe String -> Maybe String -> Maybe String -> Maybe Integer -> Maybe String -> Maybe Bool -> Maybe String -> GetSubscriptionSchedulesRequestBody -> m (Either HttpException (Response ByteString))

GET /v1/subscription_schedules

The same as getSubscriptionSchedules but returns the raw ByteString

getSubscriptionSchedulesM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe String -> Maybe String -> Maybe String -> Maybe String -> Maybe String -> Maybe String -> Maybe Integer -> Maybe String -> Maybe Bool -> Maybe String -> GetSubscriptionSchedulesRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response GetSubscriptionSchedulesResponse))

GET /v1/subscription_schedules

Monadic version of getSubscriptionSchedules (use with runWithConfiguration)

getSubscriptionSchedulesRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe String -> Maybe String -> Maybe String -> Maybe String -> Maybe String -> Maybe String -> Maybe Integer -> Maybe String -> Maybe Bool -> Maybe String -> GetSubscriptionSchedulesRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString))

GET /v1/subscription_schedules

Monadic version of getSubscriptionSchedulesRaw (use with runWithConfiguration)

data GetSubscriptionSchedulesRequestBody

Defines the data type for the schema getSubscriptionSchedulesRequestBody

Constructors

GetSubscriptionSchedulesRequestBody

Instances

Eq GetSubscriptionSchedulesRequestBody

Defined in StripeAPI.Operations.GetSubscriptionSchedules

Methods

(==) :: GetSubscriptionSchedulesRequestBody -> GetSubscriptionSchedulesRequestBody -> Bool

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

Show GetSubscriptionSchedulesRequestBody

Defined in StripeAPI.Operations.GetSubscriptionSchedules

Methods

showsPrec :: Int -> GetSubscriptionSchedulesRequestBody -> ShowS

show :: GetSubscriptionSchedulesRequestBody -> String

showList :: [GetSubscriptionSchedulesRequestBody] -> ShowS

ToJSON GetSubscriptionSchedulesRequestBody

Defined in StripeAPI.Operations.GetSubscriptionSchedules

Methods

toJSON :: GetSubscriptionSchedulesRequestBody -> Value

toEncoding :: GetSubscriptionSchedulesRequestBody -> Encoding

toJSONList :: [GetSubscriptionSchedulesRequestBody] -> Value

toEncodingList :: [GetSubscriptionSchedulesRequestBody] -> Encoding

FromJSON GetSubscriptionSchedulesRequestBody

Defined in StripeAPI.Operations.GetSubscriptionSchedules

Methods

parseJSON :: Value -> Parser GetSubscriptionSchedulesRequestBody

parseJSONList :: Value -> Parser [GetSubscriptionSchedulesRequestBody]

data GetSubscriptionSchedulesResponse

Represents a response of the operation getSubscriptionSchedules.

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

Constructors

GetSubscriptionSchedulesResponseError String

Means either no matching case available or a parse error

GetSubscriptionSchedulesResponse200 GetSubscriptionSchedulesResponseBody200

Successful response.

GetSubscriptionSchedulesResponseDefault Error

Error response.

Instances

Eq GetSubscriptionSchedulesResponse

Defined in StripeAPI.Operations.GetSubscriptionSchedules

Methods

(==) :: GetSubscriptionSchedulesResponse -> GetSubscriptionSchedulesResponse -> Bool

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

Show GetSubscriptionSchedulesResponse

Defined in StripeAPI.Operations.GetSubscriptionSchedules

Methods

showsPrec :: Int -> GetSubscriptionSchedulesResponse -> ShowS

show :: GetSubscriptionSchedulesResponse -> String

showList :: [GetSubscriptionSchedulesResponse] -> ShowS

data GetSubscriptionSchedulesResponseBody200

Defines the data type for the schema GetSubscriptionSchedulesResponseBody200

Constructors

GetSubscriptionSchedulesResponseBody200

Fields

• getSubscriptionSchedulesResponseBody200Data :: [] SubscriptionSchedule

  data

• getSubscriptionSchedulesResponseBody200HasMore :: Bool

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

• getSubscriptionSchedulesResponseBody200Object :: GetSubscriptionSchedulesResponseBody200Object'

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

• getSubscriptionSchedulesResponseBody200Url :: String

  url: The URL where this list can be accessed.

  Constraints:

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

Instances

Eq GetSubscriptionSchedulesResponseBody200

Defined in StripeAPI.Operations.GetSubscriptionSchedules

Methods

(==) :: GetSubscriptionSchedulesResponseBody200 -> GetSubscriptionSchedulesResponseBody200 -> Bool

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

Show GetSubscriptionSchedulesResponseBody200

Defined in StripeAPI.Operations.GetSubscriptionSchedules

Methods

showsPrec :: Int -> GetSubscriptionSchedulesResponseBody200 -> ShowS

show :: GetSubscriptionSchedulesResponseBody200 -> String

showList :: [GetSubscriptionSchedulesResponseBody200] -> ShowS

ToJSON GetSubscriptionSchedulesResponseBody200

Defined in StripeAPI.Operations.GetSubscriptionSchedules

Methods

toJSON :: GetSubscriptionSchedulesResponseBody200 -> Value

toEncoding :: GetSubscriptionSchedulesResponseBody200 -> Encoding

toJSONList :: [GetSubscriptionSchedulesResponseBody200] -> Value

toEncodingList :: [GetSubscriptionSchedulesResponseBody200] -> Encoding

FromJSON GetSubscriptionSchedulesResponseBody200

Defined in StripeAPI.Operations.GetSubscriptionSchedules

Methods

parseJSON :: Value -> Parser GetSubscriptionSchedulesResponseBody200

parseJSONList :: Value -> Parser [GetSubscriptionSchedulesResponseBody200]

data GetSubscriptionSchedulesResponseBody200Object'

Defines the enum schema GetSubscriptionSchedulesResponseBody200Object'

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

Constructors

GetSubscriptionSchedulesResponseBody200Object'EnumOther Value

GetSubscriptionSchedulesResponseBody200Object'EnumTyped String

GetSubscriptionSchedulesResponseBody200Object'EnumStringList

Instances

Eq GetSubscriptionSchedulesResponseBody200Object'

Defined in StripeAPI.Operations.GetSubscriptionSchedules

Methods

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

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

Show GetSubscriptionSchedulesResponseBody200Object'

Defined in StripeAPI.Operations.GetSubscriptionSchedules

Methods

showsPrec :: Int -> GetSubscriptionSchedulesResponseBody200Object' -> ShowS

show :: GetSubscriptionSchedulesResponseBody200Object' -> String

showList :: [GetSubscriptionSchedulesResponseBody200Object'] -> ShowS

ToJSON GetSubscriptionSchedulesResponseBody200Object'

Defined in StripeAPI.Operations.GetSubscriptionSchedules

Methods

toJSON :: GetSubscriptionSchedulesResponseBody200Object' -> Value

toEncoding :: GetSubscriptionSchedulesResponseBody200Object' -> Encoding

toJSONList :: [GetSubscriptionSchedulesResponseBody200Object'] -> Value

toEncodingList :: [GetSubscriptionSchedulesResponseBody200Object'] -> Encoding

FromJSON GetSubscriptionSchedulesResponseBody200Object'

Defined in StripeAPI.Operations.GetSubscriptionSchedules

Methods

parseJSON :: Value -> Parser GetSubscriptionSchedulesResponseBody200Object'

parseJSONList :: Value -> Parser [GetSubscriptionSchedulesResponseBody200Object']