Struct stripe::SubscriptionSchedule [−][src]
pub struct SubscriptionSchedule {Show 15 fields
pub id: SubscriptionScheduleId,
pub canceled_at: Option<Box<Timestamp>>,
pub completed_at: Option<Box<Timestamp>>,
pub created: Timestamp,
pub current_phase: Option<Box<SubscriptionScheduleCurrentPhase>>,
pub customer: Expandable<Customer>,
pub default_settings: SubscriptionScheduleDefaultSettings,
pub end_behavior: SubscriptionScheduleEndBehavior,
pub livemode: bool,
pub metadata: Metadata,
pub phases: Vec<SubscriptionSchedulePhaseConfiguration>,
pub released_at: Option<Box<Timestamp>>,
pub released_subscription: Option<Box<String>>,
pub status: SubscriptionScheduleStatus,
pub subscription: Option<Box<Expandable<Subscription>>>,
}
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.
canceled_at: Option<Box<Timestamp>>
Time at which the subscription schedule was canceled.
Measured in seconds since the Unix epoch.
completed_at: Option<Box<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<Box<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
and cancel
.
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: 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<Box<Timestamp>>
Time at which the subscription schedule was released.
Measured in seconds since the Unix epoch.
released_subscription: Option<Box<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<Box<Expandable<Subscription>>>
ID of the subscription managed by the subscription schedule.
Implementations
pub 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.
pub 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.
pub 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.
pub 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
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
Auto Trait Implementations
impl RefUnwindSafe for SubscriptionSchedule
impl Send for SubscriptionSchedule
impl Sync for SubscriptionSchedule
impl Unpin for SubscriptionSchedule
impl UnwindSafe for SubscriptionSchedule
Blanket Implementations
Mutably borrows from an owned value. Read more
Instruments this type with the provided Span
, returning an
Instrumented
wrapper. Read more
pub fn vzip(self) -> V
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more