SubscriptionSchedule class final
SubscriptionSchedule
A subscription schedule allows you to create and manage the lifecycle of a subscription by predefining expected changes. Related guide: [Subscription schedules](https://stripe.com/docs/billing/subscriptions/subscription-schedules)
- Implemented types
Constructors
-
SubscriptionSchedule({BillingPortalConfigurationApplicationOrId? application, DateTime? canceledAt, DateTime? completedAt, required DateTime created, SubscriptionScheduleCurrentPhase? currentPhase, required BankAccountCustomerOrId customer, required SubscriptionSchedulesResourceDefaultSettings defaultSettings, required SubscriptionScheduleEndBehavior endBehavior, required String id, required bool livemode, Map<
String, String> ? metadata, required List<SubscriptionSchedulePhaseConfiguration> phases, DateTime? releasedAt, String? releasedSubscription, required SubscriptionScheduleStatus status, SubscriptionOrId? subscription, TestHelpersTestClockOrId? testClock}) -
SubscriptionSchedule
const
- SubscriptionSchedule.fromJson(Object? json)
-
factory
Properties
- application → BillingPortalConfigurationApplicationOrId?
-
final
- canceledAt → DateTime?
-
final
- completedAt → DateTime?
-
final
- created → DateTime
-
final
- currentPhase → SubscriptionScheduleCurrentPhase?
-
Object representing the start and end dates for the current phase of the subscription schedule, if it is `active`.
final
- customer → BankAccountCustomerOrId
-
final
- defaultSettings → SubscriptionSchedulesResourceDefaultSettings
-
final
- endBehavior → SubscriptionScheduleEndBehavior
-
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- id → String
-
The ID of the SubscriptionSchedule.
final
- livemode → bool
-
final
-
metadata
→ Map<
String, String> ? -
final
- object → String
-
The resource's type.
final
-
phases
→ List<
SubscriptionSchedulePhaseConfiguration> -
final
- releasedAt → DateTime?
-
final
- releasedSubscription → String?
-
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- status → SubscriptionScheduleStatus
-
final
- subscription → SubscriptionOrId?
-
final
- testClock → TestHelpersTestClockOrId?
-
final
Methods
-
encodeWith<
V> (Encoder< V> encoder) → V -
override
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toJson(
) → Map< String, Object?> -
override
-
toString(
) → String -
A string representation of this object.
override
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Methods
-
encode<
V> (SubscriptionSchedule instance, Encoder< V> encoder) → V -
override