StripeAPI.Types.SubscriptionSchedule

Contains the types generated from the schema SubscriptionSchedule

Documentation

data 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

Fields

• subscriptionScheduleCanceledAt :: Maybe Int

  canceled_at: Time at which the subscription schedule was canceled. Measured in seconds since the Unix epoch.

• subscriptionScheduleCompletedAt :: Maybe 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 SubscriptionScheduleCurrentPhase'

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

  released_at: Time at which the subscription schedule was released. Measured in seconds since the Unix epoch.

• subscriptionScheduleReleasedSubscription :: Maybe 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 SubscriptionScheduleSubscription'Variants

  subscription: ID of the subscription managed by the subscription schedule.

Instances

Eq SubscriptionSchedule

Defined in StripeAPI.Types.SubscriptionSchedule

Methods

(==) :: SubscriptionSchedule -> SubscriptionSchedule -> Bool

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

Show SubscriptionSchedule

Defined in StripeAPI.Types.SubscriptionSchedule

Methods

showsPrec :: Int -> SubscriptionSchedule -> ShowS

show :: SubscriptionSchedule -> String

showList :: [SubscriptionSchedule] -> ShowS

ToJSON SubscriptionSchedule

Defined in StripeAPI.Types.SubscriptionSchedule

Methods

toJSON :: SubscriptionSchedule -> Value

toEncoding :: SubscriptionSchedule -> Encoding

toJSONList :: [SubscriptionSchedule] -> Value

toEncodingList :: [SubscriptionSchedule] -> Encoding

FromJSON SubscriptionSchedule

Defined in StripeAPI.Types.SubscriptionSchedule

Methods

parseJSON :: Value -> Parser SubscriptionSchedule

parseJSONList :: Value -> Parser [SubscriptionSchedule]

mkSubscriptionSchedule

Arguments

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

data SubscriptionScheduleCurrentPhase'

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'

Fields

• subscriptionScheduleCurrentPhase'EndDate :: Maybe Int

  end_date: The end of this phase of the subscription schedule.

• subscriptionScheduleCurrentPhase'StartDate :: Maybe Int

  start_date: The start of this phase of the subscription schedule.

Instances

Eq SubscriptionScheduleCurrentPhase'

Defined in StripeAPI.Types.SubscriptionSchedule

Methods

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

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

Show SubscriptionScheduleCurrentPhase'

Defined in StripeAPI.Types.SubscriptionSchedule

Methods

showsPrec :: Int -> SubscriptionScheduleCurrentPhase' -> ShowS

show :: SubscriptionScheduleCurrentPhase' -> String

showList :: [SubscriptionScheduleCurrentPhase'] -> ShowS

ToJSON SubscriptionScheduleCurrentPhase'

Defined in StripeAPI.Types.SubscriptionSchedule

Methods

toJSON :: SubscriptionScheduleCurrentPhase' -> Value

toEncoding :: SubscriptionScheduleCurrentPhase' -> Encoding

toJSONList :: [SubscriptionScheduleCurrentPhase'] -> Value

toEncodingList :: [SubscriptionScheduleCurrentPhase'] -> Encoding

FromJSON SubscriptionScheduleCurrentPhase'

Defined in StripeAPI.Types.SubscriptionSchedule

Methods

parseJSON :: Value -> Parser SubscriptionScheduleCurrentPhase'

parseJSONList :: Value -> Parser [SubscriptionScheduleCurrentPhase']

mkSubscriptionScheduleCurrentPhase' :: SubscriptionScheduleCurrentPhase'

Create a new SubscriptionScheduleCurrentPhase' with all required fields.

data 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

Instances

Eq SubscriptionScheduleCustomer'Variants

Defined in StripeAPI.Types.SubscriptionSchedule

Methods

(==) :: SubscriptionScheduleCustomer'Variants -> SubscriptionScheduleCustomer'Variants -> Bool

(/=) :: SubscriptionScheduleCustomer'Variants -> SubscriptionScheduleCustomer'Variants -> Bool

Show SubscriptionScheduleCustomer'Variants

Defined in StripeAPI.Types.SubscriptionSchedule

Methods

showsPrec :: Int -> SubscriptionScheduleCustomer'Variants -> ShowS

show :: SubscriptionScheduleCustomer'Variants -> String

showList :: [SubscriptionScheduleCustomer'Variants] -> ShowS

ToJSON SubscriptionScheduleCustomer'Variants

Defined in StripeAPI.Types.SubscriptionSchedule

Methods

toJSON :: SubscriptionScheduleCustomer'Variants -> Value

toEncoding :: SubscriptionScheduleCustomer'Variants -> Encoding

toJSONList :: [SubscriptionScheduleCustomer'Variants] -> Value

toEncodingList :: [SubscriptionScheduleCustomer'Variants] -> Encoding

FromJSON SubscriptionScheduleCustomer'Variants

Defined in StripeAPI.Types.SubscriptionSchedule

Methods

parseJSON :: Value -> Parser SubscriptionScheduleCustomer'Variants

parseJSONList :: Value -> Parser [SubscriptionScheduleCustomer'Variants]

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

Instances

Eq SubscriptionScheduleEndBehavior'

Defined in StripeAPI.Types.SubscriptionSchedule

Methods

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

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

Show SubscriptionScheduleEndBehavior'

Defined in StripeAPI.Types.SubscriptionSchedule

Methods

showsPrec :: Int -> SubscriptionScheduleEndBehavior' -> ShowS

show :: SubscriptionScheduleEndBehavior' -> String

showList :: [SubscriptionScheduleEndBehavior'] -> ShowS

ToJSON SubscriptionScheduleEndBehavior'

Defined in StripeAPI.Types.SubscriptionSchedule

Methods

toJSON :: SubscriptionScheduleEndBehavior' -> Value

toEncoding :: SubscriptionScheduleEndBehavior' -> Encoding

toJSONList :: [SubscriptionScheduleEndBehavior'] -> Value

toEncodingList :: [SubscriptionScheduleEndBehavior'] -> Encoding

FromJSON SubscriptionScheduleEndBehavior'

Defined in StripeAPI.Types.SubscriptionSchedule

Methods

parseJSON :: Value -> Parser SubscriptionScheduleEndBehavior'

parseJSONList :: Value -> Parser [SubscriptionScheduleEndBehavior']

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

Instances

Eq SubscriptionScheduleStatus'

Defined in StripeAPI.Types.SubscriptionSchedule

Methods

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

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

Show SubscriptionScheduleStatus'

Defined in StripeAPI.Types.SubscriptionSchedule

Methods

showsPrec :: Int -> SubscriptionScheduleStatus' -> ShowS

show :: SubscriptionScheduleStatus' -> String

showList :: [SubscriptionScheduleStatus'] -> ShowS

ToJSON SubscriptionScheduleStatus'

Defined in StripeAPI.Types.SubscriptionSchedule

Methods

toJSON :: SubscriptionScheduleStatus' -> Value

toEncoding :: SubscriptionScheduleStatus' -> Encoding

toJSONList :: [SubscriptionScheduleStatus'] -> Value

toEncodingList :: [SubscriptionScheduleStatus'] -> Encoding

FromJSON SubscriptionScheduleStatus'

Defined in StripeAPI.Types.SubscriptionSchedule

Methods

parseJSON :: Value -> Parser SubscriptionScheduleStatus'

parseJSONList :: Value -> Parser [SubscriptionScheduleStatus']

data SubscriptionScheduleSubscription'Variants

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

SubscriptionScheduleSubscription'Subscription Subscription

Instances

Eq SubscriptionScheduleSubscription'Variants

Defined in StripeAPI.Types.SubscriptionSchedule

Methods

(==) :: SubscriptionScheduleSubscription'Variants -> SubscriptionScheduleSubscription'Variants -> Bool

(/=) :: SubscriptionScheduleSubscription'Variants -> SubscriptionScheduleSubscription'Variants -> Bool

Show SubscriptionScheduleSubscription'Variants

Defined in StripeAPI.Types.SubscriptionSchedule

Methods

showsPrec :: Int -> SubscriptionScheduleSubscription'Variants -> ShowS

show :: SubscriptionScheduleSubscription'Variants -> String

showList :: [SubscriptionScheduleSubscription'Variants] -> ShowS

ToJSON SubscriptionScheduleSubscription'Variants

Defined in StripeAPI.Types.SubscriptionSchedule

Methods

toJSON :: SubscriptionScheduleSubscription'Variants -> Value

toEncoding :: SubscriptionScheduleSubscription'Variants -> Encoding

toJSONList :: [SubscriptionScheduleSubscription'Variants] -> Value

toEncodingList :: [SubscriptionScheduleSubscription'Variants] -> Encoding

FromJSON SubscriptionScheduleSubscription'Variants

Defined in StripeAPI.Types.SubscriptionSchedule

Methods

parseJSON :: Value -> Parser SubscriptionScheduleSubscription'Variants

parseJSONList :: Value -> Parser [SubscriptionScheduleSubscription'Variants]