Safe Haskell | None |
---|---|
Language | Haskell2010 |
Contains the types generated from the schema SubscriptionSchedule
Synopsis
- data SubscriptionSchedule = SubscriptionSchedule {
- subscriptionScheduleCanceledAt :: Maybe Int
- subscriptionScheduleCompletedAt :: Maybe Int
- subscriptionScheduleCreated :: Int
- subscriptionScheduleCurrentPhase :: Maybe SubscriptionScheduleCurrentPhase'
- subscriptionScheduleCustomer :: SubscriptionScheduleCustomer'Variants
- subscriptionScheduleDefaultSettings :: SubscriptionSchedulesResourceDefaultSettings
- subscriptionScheduleEndBehavior :: SubscriptionScheduleEndBehavior'
- subscriptionScheduleId :: Text
- subscriptionScheduleLivemode :: Bool
- subscriptionScheduleMetadata :: Maybe Object
- subscriptionSchedulePhases :: [SubscriptionSchedulePhaseConfiguration]
- subscriptionScheduleReleasedAt :: Maybe Int
- subscriptionScheduleReleasedSubscription :: Maybe Text
- subscriptionScheduleStatus :: SubscriptionScheduleStatus'
- subscriptionScheduleSubscription :: Maybe SubscriptionScheduleSubscription'Variants
- mkSubscriptionSchedule :: Int -> SubscriptionScheduleCustomer'Variants -> SubscriptionSchedulesResourceDefaultSettings -> SubscriptionScheduleEndBehavior' -> Text -> Bool -> [SubscriptionSchedulePhaseConfiguration] -> SubscriptionScheduleStatus' -> SubscriptionSchedule
- data SubscriptionScheduleCurrentPhase' = SubscriptionScheduleCurrentPhase' {}
- mkSubscriptionScheduleCurrentPhase' :: SubscriptionScheduleCurrentPhase'
- data SubscriptionScheduleCustomer'Variants
- data SubscriptionScheduleEndBehavior'
- data SubscriptionScheduleStatus'
- data SubscriptionScheduleSubscription'Variants
Documentation
data SubscriptionSchedule Source #
Defines the object schema located at components.schemas.subscription_schedule
in the specification.
A subscription schedule allows you to create and manage the lifecycle of a subscription by predefining expected changes.
Related guide: Subscription Schedules.
SubscriptionSchedule | |
|
Instances
Eq SubscriptionSchedule Source # | |
Defined in StripeAPI.Types.SubscriptionSchedule (==) :: SubscriptionSchedule -> SubscriptionSchedule -> Bool # (/=) :: SubscriptionSchedule -> SubscriptionSchedule -> Bool # | |
Show SubscriptionSchedule Source # | |
Defined in StripeAPI.Types.SubscriptionSchedule showsPrec :: Int -> SubscriptionSchedule -> ShowS # show :: SubscriptionSchedule -> String # showList :: [SubscriptionSchedule] -> ShowS # | |
ToJSON SubscriptionSchedule Source # | |
Defined in StripeAPI.Types.SubscriptionSchedule toJSON :: SubscriptionSchedule -> Value # toEncoding :: SubscriptionSchedule -> Encoding # toJSONList :: [SubscriptionSchedule] -> Value # toEncodingList :: [SubscriptionSchedule] -> Encoding # | |
FromJSON SubscriptionSchedule Source # | |
Defined in StripeAPI.Types.SubscriptionSchedule parseJSON :: Value -> Parser SubscriptionSchedule # parseJSONList :: Value -> Parser [SubscriptionSchedule] # |
mkSubscriptionSchedule Source #
Create a new SubscriptionSchedule
with all required fields.
data SubscriptionScheduleCurrentPhase' Source #
Defines the object schema located at components.schemas.subscription_schedule.properties.current_phase.anyOf
in the specification.
Object representing the start and end dates for the current phase of the subscription schedule, if it is \`active\`.
SubscriptionScheduleCurrentPhase' | |
|
mkSubscriptionScheduleCurrentPhase' :: SubscriptionScheduleCurrentPhase' Source #
Create a new SubscriptionScheduleCurrentPhase'
with all required fields.
data SubscriptionScheduleCustomer'Variants Source #
Defines the oneOf schema located at components.schemas.subscription_schedule.properties.customer.anyOf
in the specification.
ID of the customer who owns the subscription schedule.
SubscriptionScheduleCustomer'Text Text | |
SubscriptionScheduleCustomer'Customer Customer | |
SubscriptionScheduleCustomer'DeletedCustomer DeletedCustomer |
data SubscriptionScheduleEndBehavior' Source #
Defines the enum schema located at components.schemas.subscription_schedule.properties.end_behavior
in the specification.
Behavior of the subscription schedule and underlying subscription when it ends. Possible values are `release` and `cancel`.
SubscriptionScheduleEndBehavior'Other Value | This case is used if the value encountered during decoding does not match any of the provided cases in the specification. |
SubscriptionScheduleEndBehavior'Typed Text | This constructor can be used to send values to the server which are not present in the specification yet. |
SubscriptionScheduleEndBehavior'EnumCancel | Represents the JSON value |
SubscriptionScheduleEndBehavior'EnumNone | Represents the JSON value |
SubscriptionScheduleEndBehavior'EnumRelease | Represents the JSON value |
SubscriptionScheduleEndBehavior'EnumRenew | Represents the JSON value |
data SubscriptionScheduleStatus' Source #
Defines the enum schema located at components.schemas.subscription_schedule.properties.status
in the specification.
The present status of the subscription schedule. Possible values are `not_started`, `active`, `completed`, `released`, and `canceled`. You can read more about the different states in our behavior guide.
SubscriptionScheduleStatus'Other Value | This case is used if the value encountered during decoding does not match any of the provided cases in the specification. |
SubscriptionScheduleStatus'Typed Text | This constructor can be used to send values to the server which are not present in the specification yet. |
SubscriptionScheduleStatus'EnumActive | Represents the JSON value |
SubscriptionScheduleStatus'EnumCanceled | Represents the JSON value |
SubscriptionScheduleStatus'EnumCompleted | Represents the JSON value |
SubscriptionScheduleStatus'EnumNotStarted | Represents the JSON value |
SubscriptionScheduleStatus'EnumReleased | Represents the JSON value |
Instances
data SubscriptionScheduleSubscription'Variants Source #
Defines the oneOf schema located at components.schemas.subscription_schedule.properties.subscription.anyOf
in the specification.
ID of the subscription managed by the subscription schedule.
SubscriptionScheduleSubscription'Text Text | |
SubscriptionScheduleSubscription'Subscription Subscription |