Modulestripeapi-3.0.0.0Haskell2010

StripeAPI.Types.SubscriptionSchedule

Contains the types generated from the schema SubscriptionSchedule

8 types
2 values

Packagestripeapi-3.0.0.0
Exports10
LanguageHaskell2010
LicenceMIT
SourceSubscriptionSchedule.hs

datadata SubscriptionSchedule

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.

Constructors

SubscriptionSchedule
- subscriptionScheduleApplication :: Maybe (Nullable SubscriptionScheduleApplication'NonNullableVariants)
  application: ID of the Connect Application that created the schedule.
- subscriptionScheduleCanceledAt :: Maybe (Nullable Int)
  canceled_at: Time at which the subscription schedule was canceled. Measured in seconds since the Unix epoch.
- subscriptionScheduleCompletedAt :: Maybe (Nullable Int)
  completed_at: Time at which the subscription schedule was completed. Measured in seconds since the Unix epoch.
- subscriptionScheduleCreated :: Int
  created: Time at which the object was created. Measured in seconds since the Unix epoch.
- subscriptionScheduleCurrentPhase :: Maybe (Nullable SubscriptionScheduleCurrentPhase'NonNullable)
  current_phase: Object representing the start and end dates for the current phase of the subscription schedule, if it is `active`.
- subscriptionScheduleCustomer :: SubscriptionScheduleCustomer'Variants
  customer: ID of the customer who owns the subscription schedule.
- subscriptionScheduleDefaultSettings :: SubscriptionSchedulesResourceDefaultSettings
  default_settings:
- subscriptionScheduleEndBehavior :: SubscriptionScheduleEndBehavior'
  end_behavior: Behavior of the subscription schedule and underlying subscription when it ends. Possible values are `release` and `cancel`.
- subscriptionScheduleId :: Text
  id: Unique identifier for the object.
  Constraints:
  - Maximum length of 5000
- subscriptionScheduleLivemode :: Bool
  livemode: Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
- subscriptionScheduleMetadata :: Maybe (Nullable Object)
  metadata: Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
- subscriptionSchedulePhases :: [SubscriptionSchedulePhaseConfiguration]
  phases: Configuration for the subscription schedule's phases.
- subscriptionScheduleReleasedAt :: Maybe (Nullable Int)
  released_at: Time at which the subscription schedule was released. Measured in seconds since the Unix epoch.
- subscriptionScheduleReleasedSubscription :: Maybe (Nullable Text)
  released_subscription: ID of the subscription once managed by the subscription schedule (if it is released).
  Constraints:
  - Maximum length of 5000
- subscriptionScheduleStatus :: SubscriptionScheduleStatus'
  status: 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.
- subscriptionScheduleSubscription :: Maybe (Nullable SubscriptionScheduleSubscription'NonNullableVariants)
  subscription: ID of the subscription managed by the subscription schedule.
- subscriptionScheduleTestClock :: Maybe (Nullable SubscriptionScheduleTestClock'NonNullableVariants)
  test_clock: ID of the test clock this subscription schedule belongs to.

Instances4Eq, Show, FromJSON, ToJSON

Eq SubscriptionScheduleDefined in stripeapi-3.0.0.0 · StripeAPI.Types.SubscriptionSchedule
Show SubscriptionScheduleDefined in stripeapi-3.0.0.0 · StripeAPI.Types.SubscriptionSchedule
FromJSON SubscriptionScheduleDefined in stripeapi-3.0.0.0 · StripeAPI.Types.SubscriptionSchedule
ToJSON SubscriptionScheduleDefined in stripeapi-3.0.0.0 · StripeAPI.Types.SubscriptionSchedule

valuemkSubscriptionSchedule

:: Int
subscriptionScheduleCreated
-> SubscriptionScheduleCustomer'Variants
subscriptionScheduleCustomer
-> SubscriptionSchedulesResourceDefaultSettings
subscriptionScheduleDefaultSettings
-> SubscriptionScheduleEndBehavior'
subscriptionScheduleEndBehavior
-> Text
subscriptionScheduleId
-> Bool
subscriptionScheduleLivemode
-> [SubscriptionSchedulePhaseConfiguration]
subscriptionSchedulePhases
-> SubscriptionScheduleStatus'
subscriptionScheduleStatus
-> SubscriptionSchedule

Create a new SubscriptionSchedule with all required fields.

datadata SubscriptionScheduleApplication'NonNullableVariants

Defines the oneOf schema located at components.schemas.subscription_schedule.properties.application.anyOf in the specification.

ID of the Connect Application that created the schedule.

Constructors

SubscriptionScheduleApplication'NonNullableText Text
SubscriptionScheduleApplication'NonNullableApplication Application
SubscriptionScheduleApplication'NonNullableDeletedApplication DeletedApplication

Instances4Eq, Show, FromJSON, ToJSON

Eq SubscriptionScheduleApplication'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.SubscriptionSchedule
Show SubscriptionScheduleApplication'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.SubscriptionSchedule
FromJSON SubscriptionScheduleApplication'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.SubscriptionSchedule
ToJSON SubscriptionScheduleApplication'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.SubscriptionSchedule

datadata SubscriptionScheduleCurrentPhase'NonNullable

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\`.

Constructors

SubscriptionScheduleCurrentPhase'NonNullable
- subscriptionScheduleCurrentPhase'NonNullableEndDate :: Maybe Int
  end_date: The end of this phase of the subscription schedule.
- subscriptionScheduleCurrentPhase'NonNullableStartDate :: Maybe Int
  start_date: The start of this phase of the subscription schedule.

Instances4Eq, Show, FromJSON, ToJSON

Eq SubscriptionScheduleCurrentPhase'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.SubscriptionSchedule
Show SubscriptionScheduleCurrentPhase'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.SubscriptionSchedule
FromJSON SubscriptionScheduleCurrentPhase'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.SubscriptionSchedule
ToJSON SubscriptionScheduleCurrentPhase'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.SubscriptionSchedule

valuemkSubscriptionScheduleCurrentPhase'NonNullable :: SubscriptionScheduleCurrentPhase'NonNullable

Create a new SubscriptionScheduleCurrentPhase'NonNullable with all required fields.

datadata SubscriptionScheduleCustomer'Variants

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.

Constructors

SubscriptionScheduleCustomer'Text Text
SubscriptionScheduleCustomer'Customer Customer
SubscriptionScheduleCustomer'DeletedCustomer DeletedCustomer

Instances4Eq, Show, FromJSON, ToJSON

Eq SubscriptionScheduleCustomer'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.SubscriptionSchedule
Show SubscriptionScheduleCustomer'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.SubscriptionSchedule
FromJSON SubscriptionScheduleCustomer'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.SubscriptionSchedule
ToJSON SubscriptionScheduleCustomer'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.SubscriptionSchedule

datadata SubscriptionScheduleEndBehavior'

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

Constructors

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 "cancel"
SubscriptionScheduleEndBehavior'EnumNone
Represents the JSON value "none"
SubscriptionScheduleEndBehavior'EnumRelease
Represents the JSON value "release"
SubscriptionScheduleEndBehavior'EnumRenew
Represents the JSON value "renew"

Instances4Eq, Show, FromJSON, ToJSON

Eq SubscriptionScheduleEndBehavior'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.SubscriptionSchedule
Show SubscriptionScheduleEndBehavior'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.SubscriptionSchedule
FromJSON SubscriptionScheduleEndBehavior'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.SubscriptionSchedule
ToJSON SubscriptionScheduleEndBehavior'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.SubscriptionSchedule

datadata SubscriptionScheduleStatus'

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.

Constructors

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 "active"
SubscriptionScheduleStatus'EnumCanceled
Represents the JSON value "canceled"
SubscriptionScheduleStatus'EnumCompleted
Represents the JSON value "completed"
SubscriptionScheduleStatus'EnumNotStarted
Represents the JSON value "not_started"
SubscriptionScheduleStatus'EnumReleased
Represents the JSON value "released"

Instances4Eq, Show, FromJSON, ToJSON

Eq SubscriptionScheduleStatus'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.SubscriptionSchedule
Show SubscriptionScheduleStatus'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.SubscriptionSchedule
FromJSON SubscriptionScheduleStatus'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.SubscriptionSchedule
ToJSON SubscriptionScheduleStatus'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.SubscriptionSchedule

datadata SubscriptionScheduleSubscription'NonNullableVariants

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.

Constructors

SubscriptionScheduleSubscription'NonNullableText Text
SubscriptionScheduleSubscription'NonNullableSubscription Subscription

Instances4Eq, Show, FromJSON, ToJSON

Eq SubscriptionScheduleSubscription'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.SubscriptionSchedule
Show SubscriptionScheduleSubscription'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.SubscriptionSchedule
FromJSON SubscriptionScheduleSubscription'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.SubscriptionSchedule
ToJSON SubscriptionScheduleSubscription'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.SubscriptionSchedule

datadata SubscriptionScheduleTestClock'NonNullableVariants

Defines the oneOf schema located at components.schemas.subscription_schedule.properties.test_clock.anyOf in the specification.

ID of the test clock this subscription schedule belongs to.

Constructors

SubscriptionScheduleTestClock'NonNullableText Text
SubscriptionScheduleTestClock'NonNullableTestHelpers'testClock TestHelpers'testClock

Instances4Eq, Show, FromJSON, ToJSON

Eq SubscriptionScheduleTestClock'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.SubscriptionSchedule
Show SubscriptionScheduleTestClock'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.SubscriptionSchedule
FromJSON SubscriptionScheduleTestClock'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.SubscriptionSchedule
ToJSON SubscriptionScheduleTestClock'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.SubscriptionSchedule