Modulestripeapi-3.0.0.0Haskell2010

StripeAPI.Operations.GetSubscriptionSchedules

Contains the different functions to run the operation getSubscriptionSchedules

11 types
7 values

Packagestripeapi-3.0.0.0
Exports18
LanguageHaskell2010
LicenceMIT
SourceGetSubscriptionSchedules.hs

valuegetSubscriptionSchedules

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

GET /v1/subscription_schedules

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

datadata GetSubscriptionSchedulesParameters

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

Constructors

GetSubscriptionSchedulesParameters
- getSubscriptionSchedulesParametersQueryCanceledAt :: Maybe GetSubscriptionSchedulesParametersQueryCanceledAt'Variants
  queryCanceled_at: Represents the parameter named 'canceled_at'
  Only return subscription schedules that were created canceled the given date interval.
- getSubscriptionSchedulesParametersQueryCompletedAt :: Maybe GetSubscriptionSchedulesParametersQueryCompletedAt'Variants
  queryCompleted_at: Represents the parameter named 'completed_at'
  Only return subscription schedules that completed during the given date interval.
- getSubscriptionSchedulesParametersQueryCreated :: Maybe GetSubscriptionSchedulesParametersQueryCreated'Variants
  queryCreated: Represents the parameter named 'created'
  Only return subscription schedules that were created during the given date interval.
- getSubscriptionSchedulesParametersQueryCustomer :: Maybe Text
  queryCustomer: Represents the parameter named 'customer'
  Only return subscription schedules for the given customer.
  Constraints:
  - Maximum length of 5000
- getSubscriptionSchedulesParametersQueryEndingBefore :: 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
- getSubscriptionSchedulesParametersQueryExpand :: Maybe [Text]
  queryExpand: Represents the parameter named 'expand'
  Specifies which fields in the response should be expanded.
- getSubscriptionSchedulesParametersQueryLimit :: 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.
- getSubscriptionSchedulesParametersQueryReleasedAt :: Maybe GetSubscriptionSchedulesParametersQueryReleasedAt'Variants
  queryReleased_at: Represents the parameter named 'released_at'
  Only return subscription schedules that were released during the given date interval.
- getSubscriptionSchedulesParametersQueryScheduled :: Maybe Bool
  queryScheduled: Represents the parameter named 'scheduled'
  Only return subscription schedules that have not started yet.
- getSubscriptionSchedulesParametersQueryStartingAfter :: 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

Eq GetSubscriptionSchedulesParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetSubscriptionSchedules
Show GetSubscriptionSchedulesParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetSubscriptionSchedules
FromJSON GetSubscriptionSchedulesParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetSubscriptionSchedules
ToJSON GetSubscriptionSchedulesParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetSubscriptionSchedules

valuemkGetSubscriptionSchedulesParameters :: GetSubscriptionSchedulesParameters

Create a new GetSubscriptionSchedulesParameters with all required fields.

datadata GetSubscriptionSchedulesParametersQueryCanceledAt'OneOf1

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

Constructors

GetSubscriptionSchedulesParametersQueryCanceledAt'OneOf1

Instances4Eq, Show, FromJSON, ToJSON

Eq GetSubscriptionSchedulesParametersQueryCanceledAt'OneOf1Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetSubscriptionSchedules
Show GetSubscriptionSchedulesParametersQueryCanceledAt'OneOf1Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetSubscriptionSchedules
FromJSON GetSubscriptionSchedulesParametersQueryCanceledAt'OneOf1Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetSubscriptionSchedules
ToJSON GetSubscriptionSchedulesParametersQueryCanceledAt'OneOf1Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetSubscriptionSchedules

valuemkGetSubscriptionSchedulesParametersQueryCanceledAt'OneOf1 :: GetSubscriptionSchedulesParametersQueryCanceledAt'OneOf1

Create a new GetSubscriptionSchedulesParametersQueryCanceledAt'OneOf1 with all required fields.

datadata GetSubscriptionSchedulesParametersQueryCanceledAt'Variants

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

Represents the parameter named 'canceled_at'

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

Constructors

GetSubscriptionSchedulesParametersQueryCanceledAt'GetSubscriptionSchedulesParametersQueryCanceledAt'OneOf1 GetSubscriptionSchedulesParametersQueryCanceledAt'OneOf1
GetSubscriptionSchedulesParametersQueryCanceledAt'Int Int

Instances4Eq, Show, FromJSON, ToJSON

Eq GetSubscriptionSchedulesParametersQueryCanceledAt'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetSubscriptionSchedules
Show GetSubscriptionSchedulesParametersQueryCanceledAt'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetSubscriptionSchedules
FromJSON GetSubscriptionSchedulesParametersQueryCanceledAt'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetSubscriptionSchedules
ToJSON GetSubscriptionSchedulesParametersQueryCanceledAt'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetSubscriptionSchedules

datadata GetSubscriptionSchedulesParametersQueryCompletedAt'OneOf1

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

Constructors

GetSubscriptionSchedulesParametersQueryCompletedAt'OneOf1

Instances4Eq, Show, FromJSON, ToJSON

Eq GetSubscriptionSchedulesParametersQueryCompletedAt'OneOf1Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetSubscriptionSchedules
Show GetSubscriptionSchedulesParametersQueryCompletedAt'OneOf1Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetSubscriptionSchedules
FromJSON GetSubscriptionSchedulesParametersQueryCompletedAt'OneOf1Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetSubscriptionSchedules
ToJSON GetSubscriptionSchedulesParametersQueryCompletedAt'OneOf1Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetSubscriptionSchedules

valuemkGetSubscriptionSchedulesParametersQueryCompletedAt'OneOf1 :: GetSubscriptionSchedulesParametersQueryCompletedAt'OneOf1

Create a new GetSubscriptionSchedulesParametersQueryCompletedAt'OneOf1 with all required fields.

datadata GetSubscriptionSchedulesParametersQueryCompletedAt'Variants

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

Represents the parameter named 'completed_at'

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

Constructors

GetSubscriptionSchedulesParametersQueryCompletedAt'GetSubscriptionSchedulesParametersQueryCompletedAt'OneOf1 GetSubscriptionSchedulesParametersQueryCompletedAt'OneOf1
GetSubscriptionSchedulesParametersQueryCompletedAt'Int Int

Instances4Eq, Show, FromJSON, ToJSON

Eq GetSubscriptionSchedulesParametersQueryCompletedAt'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetSubscriptionSchedules
Show GetSubscriptionSchedulesParametersQueryCompletedAt'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetSubscriptionSchedules
FromJSON GetSubscriptionSchedulesParametersQueryCompletedAt'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetSubscriptionSchedules
ToJSON GetSubscriptionSchedulesParametersQueryCompletedAt'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetSubscriptionSchedules

datadata GetSubscriptionSchedulesParametersQueryCreated'OneOf1

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

Constructors

GetSubscriptionSchedulesParametersQueryCreated'OneOf1
- getSubscriptionSchedulesParametersQueryCreated'OneOf1Gt :: Maybe Int
  gt
- getSubscriptionSchedulesParametersQueryCreated'OneOf1Gte :: Maybe Int
  gte
- getSubscriptionSchedulesParametersQueryCreated'OneOf1Lt :: Maybe Int
  lt
- getSubscriptionSchedulesParametersQueryCreated'OneOf1Lte :: Maybe Int
  lte

Instances4Eq, Show, FromJSON, ToJSON

Eq GetSubscriptionSchedulesParametersQueryCreated'OneOf1Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetSubscriptionSchedules
Show GetSubscriptionSchedulesParametersQueryCreated'OneOf1Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetSubscriptionSchedules
FromJSON GetSubscriptionSchedulesParametersQueryCreated'OneOf1Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetSubscriptionSchedules
ToJSON GetSubscriptionSchedulesParametersQueryCreated'OneOf1Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetSubscriptionSchedules

valuemkGetSubscriptionSchedulesParametersQueryCreated'OneOf1 :: GetSubscriptionSchedulesParametersQueryCreated'OneOf1

Create a new GetSubscriptionSchedulesParametersQueryCreated'OneOf1 with all required fields.

datadata GetSubscriptionSchedulesParametersQueryCreated'Variants

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

Represents the parameter named 'created'

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

Constructors

GetSubscriptionSchedulesParametersQueryCreated'GetSubscriptionSchedulesParametersQueryCreated'OneOf1 GetSubscriptionSchedulesParametersQueryCreated'OneOf1
GetSubscriptionSchedulesParametersQueryCreated'Int Int

Instances4Eq, Show, FromJSON, ToJSON

Eq GetSubscriptionSchedulesParametersQueryCreated'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetSubscriptionSchedules
Show GetSubscriptionSchedulesParametersQueryCreated'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetSubscriptionSchedules
FromJSON GetSubscriptionSchedulesParametersQueryCreated'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetSubscriptionSchedules
ToJSON GetSubscriptionSchedulesParametersQueryCreated'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetSubscriptionSchedules

datadata GetSubscriptionSchedulesParametersQueryReleasedAt'OneOf1

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

Constructors

GetSubscriptionSchedulesParametersQueryReleasedAt'OneOf1

Instances4Eq, Show, FromJSON, ToJSON

Eq GetSubscriptionSchedulesParametersQueryReleasedAt'OneOf1Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetSubscriptionSchedules
Show GetSubscriptionSchedulesParametersQueryReleasedAt'OneOf1Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetSubscriptionSchedules
FromJSON GetSubscriptionSchedulesParametersQueryReleasedAt'OneOf1Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetSubscriptionSchedules
ToJSON GetSubscriptionSchedulesParametersQueryReleasedAt'OneOf1Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetSubscriptionSchedules

valuemkGetSubscriptionSchedulesParametersQueryReleasedAt'OneOf1 :: GetSubscriptionSchedulesParametersQueryReleasedAt'OneOf1

Create a new GetSubscriptionSchedulesParametersQueryReleasedAt'OneOf1 with all required fields.

datadata GetSubscriptionSchedulesParametersQueryReleasedAt'Variants

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

Represents the parameter named 'released_at'

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

Constructors

GetSubscriptionSchedulesParametersQueryReleasedAt'GetSubscriptionSchedulesParametersQueryReleasedAt'OneOf1 GetSubscriptionSchedulesParametersQueryReleasedAt'OneOf1
GetSubscriptionSchedulesParametersQueryReleasedAt'Int Int

Instances4Eq, Show, FromJSON, ToJSON

Eq GetSubscriptionSchedulesParametersQueryReleasedAt'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetSubscriptionSchedules
Show GetSubscriptionSchedulesParametersQueryReleasedAt'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetSubscriptionSchedules
FromJSON GetSubscriptionSchedulesParametersQueryReleasedAt'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetSubscriptionSchedules
ToJSON GetSubscriptionSchedulesParametersQueryReleasedAt'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetSubscriptionSchedules

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

Instances2Eq, Show

Eq GetSubscriptionSchedulesResponseDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetSubscriptionSchedules
Show GetSubscriptionSchedulesResponseDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetSubscriptionSchedules

datadata GetSubscriptionSchedulesResponseBody200

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

Constructors

GetSubscriptionSchedulesResponseBody200
- getSubscriptionSchedulesResponseBody200Data :: [SubscriptionSchedule]
  data
- getSubscriptionSchedulesResponseBody200HasMore :: Bool
  has_more: True if this list has another page of items after this one that can be fetched.
- getSubscriptionSchedulesResponseBody200Url :: Text
  url: The URL where this list can be accessed.
  Constraints:
  - Maximum length of 5000
  - Must match pattern '^/v1/subscription_schedules'

Instances4Eq, Show, FromJSON, ToJSON

Eq GetSubscriptionSchedulesResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetSubscriptionSchedules
Show GetSubscriptionSchedulesResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetSubscriptionSchedules
FromJSON GetSubscriptionSchedulesResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetSubscriptionSchedules
ToJSON GetSubscriptionSchedulesResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetSubscriptionSchedules

valuemkGetSubscriptionSchedulesResponseBody200

:: [SubscriptionSchedule]
getSubscriptionSchedulesResponseBody200Data
-> Bool
getSubscriptionSchedulesResponseBody200HasMore
-> Text
getSubscriptionSchedulesResponseBody200Url
-> GetSubscriptionSchedulesResponseBody200

Create a new GetSubscriptionSchedulesResponseBody200 with all required fields.