Struct stripe::SubscriptionSchedule [−][src]
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<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
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<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.
Implementations
impl SubscriptionSchedule
[src]
pub fn list(
client: &Client,
params: ListSubscriptionSchedules<'_>
) -> Response<List<SubscriptionSchedule>>
[src]
client: &Client,
params: ListSubscriptionSchedules<'_>
) -> Response<List<SubscriptionSchedule>>
Retrieves the list of your subscription schedules.
pub fn create(
client: &Client,
params: CreateSubscriptionSchedule<'_>
) -> Response<SubscriptionSchedule>
[src]
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>
[src]
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>
[src]
client: &Client,
id: &SubscriptionScheduleId,
params: UpdateSubscriptionSchedule<'_>
) -> Response<SubscriptionSchedule>
Updates an existing subscription schedule.
Trait Implementations
impl Clone for SubscriptionSchedule
[src]
fn clone(&self) -> SubscriptionSchedule
[src]
pub fn clone_from(&mut self, source: &Self)
1.0.0[src]
impl Debug for SubscriptionSchedule
[src]
impl<'de> Deserialize<'de> for SubscriptionSchedule
[src]
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
[src]
__D: Deserializer<'de>,
impl Object for SubscriptionSchedule
[src]
type Id = SubscriptionScheduleId
The canonical id type for this object.
fn id(&self) -> Self::Id
[src]
fn object(&self) -> &'static str
[src]
impl Serialize for SubscriptionSchedule
[src]
Auto Trait Implementations
impl RefUnwindSafe for SubscriptionSchedule
[src]
impl Send for SubscriptionSchedule
[src]
impl Sync for SubscriptionSchedule
[src]
impl Unpin for SubscriptionSchedule
[src]
impl UnwindSafe for SubscriptionSchedule
[src]
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
pub fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> DeserializeOwned for T where
T: for<'de> Deserialize<'de>,
[src]
T: for<'de> Deserialize<'de>,
impl<T> From<T> for T
[src]
impl<T> Instrument for T
[src]
pub fn instrument(self, span: Span) -> Instrumented<Self>
[src]
pub fn in_current_span(self) -> Instrumented<Self>
[src]
impl<T> Instrument for T
[src]
pub fn instrument(self, span: Span) -> Instrumented<Self>
[src]
pub fn in_current_span(self) -> Instrumented<Self>
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> Same<T> for T
type Output = T
Should always be Self
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
pub fn to_owned(&self) -> T
[src]
pub fn clone_into(&self, target: &mut T)
[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
V: MultiLane<T>,
pub fn vzip(self) -> V
impl<T> WithSubscriber for T
[src]
pub fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
[src]
S: Into<Dispatch>,