pub struct SubscriptionSchedule {Show 17 fields
pub id: SubscriptionScheduleId,
pub application: Option<Expandable<Application>>,
pub canceled_at: Option<Timestamp>,
pub completed_at: Option<Timestamp>,
pub created: Timestamp,
pub current_phase: Option<SubscriptionScheduleCurrentPhase>,
pub customer: Expandable<Customer>,
pub default_settings: SubscriptionScheduleDefaultSettings,
pub end_behavior: SubscriptionScheduleEndBehavior,
pub livemode: bool,
pub metadata: Option<Metadata>,
pub phases: Vec<SubscriptionSchedulePhaseConfiguration>,
pub released_at: Option<Timestamp>,
pub released_subscription: Option<String>,
pub status: SubscriptionScheduleStatus,
pub subscription: Option<Expandable<Subscription>>,
pub test_clock: Option<Expandable<TestHelpersTestClock>>,
}
Expand description
The resource representing a Stripe “SubscriptionSchedule”.
For more details see https://stripe.com/docs/api/subscription_schedules/object
Fields§
§id: SubscriptionScheduleId
Unique identifier for the object.
application: Option<Expandable<Application>>
ID of the Connect Application that created the schedule.
canceled_at: Option<Timestamp>
Time at which the subscription schedule was canceled.
Measured in seconds since the Unix epoch.
completed_at: Option<Timestamp>
Time at which the subscription schedule was completed.
Measured in seconds since the Unix epoch.
created: Timestamp
Time at which the object was created.
Measured in seconds since the Unix epoch.
current_phase: Option<SubscriptionScheduleCurrentPhase>
Object representing the start and end dates for the current phase of the subscription schedule, if it is active
.
customer: Expandable<Customer>
ID of the customer who owns the subscription schedule.
default_settings: SubscriptionScheduleDefaultSettings
§end_behavior: SubscriptionScheduleEndBehavior
Behavior of the subscription schedule and underlying subscription when it ends.
Possible values are release
or cancel
with the default being release
.
release
will end the subscription schedule and keep the underlying subscription running.
cancel
will end the subscription schedule and cancel the underlying subscription.
livemode: bool
Has the value true
if the object exists in live mode or the value false
if the object exists in test mode.
metadata: Option<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.
phases: Vec<SubscriptionSchedulePhaseConfiguration>
Configuration for the subscription schedule’s phases.
released_at: Option<Timestamp>
Time at which the subscription schedule was released.
Measured in seconds since the Unix epoch.
released_subscription: Option<String>
ID of the subscription once managed by the subscription schedule (if it is released).
status: SubscriptionScheduleStatus
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.
subscription: Option<Expandable<Subscription>>
ID of the subscription managed by the subscription schedule.
test_clock: Option<Expandable<TestHelpersTestClock>>
ID of the test clock this subscription schedule belongs to.
Implementations§
source§impl SubscriptionSchedule
impl SubscriptionSchedule
sourcepub fn list(
client: &Client,
params: &ListSubscriptionSchedules<'_>
) -> Response<List<SubscriptionSchedule>>
pub fn list( client: &Client, params: &ListSubscriptionSchedules<'_> ) -> Response<List<SubscriptionSchedule>>
Retrieves the list of your subscription schedules.
sourcepub fn create(
client: &Client,
params: CreateSubscriptionSchedule<'_>
) -> Response<SubscriptionSchedule>
pub fn create( client: &Client, params: CreateSubscriptionSchedule<'_> ) -> Response<SubscriptionSchedule>
Creates a new subscription schedule object.
Each customer can have up to 500 active or scheduled subscriptions.
sourcepub fn retrieve(
client: &Client,
id: &SubscriptionScheduleId,
expand: &[&str]
) -> Response<SubscriptionSchedule>
pub fn retrieve( client: &Client, id: &SubscriptionScheduleId, expand: &[&str] ) -> Response<SubscriptionSchedule>
Retrieves the details of an existing subscription schedule.
You only need to supply the unique subscription schedule identifier that was returned upon subscription schedule creation.
sourcepub fn update(
client: &Client,
id: &SubscriptionScheduleId,
params: UpdateSubscriptionSchedule<'_>
) -> Response<SubscriptionSchedule>
pub fn update( client: &Client, id: &SubscriptionScheduleId, params: UpdateSubscriptionSchedule<'_> ) -> Response<SubscriptionSchedule>
Updates an existing subscription schedule.
Trait Implementations§
source§impl Clone for SubscriptionSchedule
impl Clone for SubscriptionSchedule
source§fn clone(&self) -> SubscriptionSchedule
fn clone(&self) -> SubscriptionSchedule
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read more