Struct stripe::SubscriptionSchedule

pub struct SubscriptionSchedule {
    pub id: SubscriptionScheduleId,
    pub billing: Option<CollectionMethod>,
    pub billing_thresholds: Option<SubscriptionBillingThresholds>,
    pub canceled_at: Option<Timestamp>,
    pub collection_method: Option<CollectionMethod>,
    pub completed_at: Option<Timestamp>,
    pub created: Timestamp,
    pub current_phase: Option<SubscriptionScheduleCurrentPhase>,
    pub customer: Expandable<Customer>,
    pub default_payment_method: Option<Expandable<PaymentMethod>>,
    pub end_behavior: Option<SubscriptionScheduleEndBehavior>,
    pub invoice_settings: Option<SubscriptionScheduleInvoiceSettings>,
    pub livemode: bool,
    pub metadata: Metadata,
    pub phases: Vec<SubscriptionSchedulePhaseConfiguration>,
    pub released_at: Option<Timestamp>,
    pub released_subscription: Option<String>,
    pub renewal_behavior: Option<SubscriptionScheduleRenewalBehavior>,
    pub renewal_interval: Option<SubscriptionScheduleRenewalInterval>,
    pub status: SubscriptionScheduleStatus,
    pub subscription: Option<Expandable<Subscription>>,
}

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.

billing: Option<CollectionMethod>

This field has been renamed to collection_method and will be removed in a future API version.

billing_thresholds: Option<SubscriptionBillingThresholds>

Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period.

canceled_at: Option<Timestamp>

Time at which the subscription schedule was canceled.

Measured in seconds since the Unix epoch.

collection_method: Option<CollectionMethod>

Either charge_automatically, or send_invoice.

When charging automatically, Stripe will attempt to pay the underlying subscription at the end of each billing cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions.

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_payment_method: Option<Expandable<PaymentMethod>>

ID of the default payment method for the subscription schedule.

It must belong to the customer associated with the subscription schedule. If not set, invoices will use the default payment method in the customer's invoice settings.

end_behavior: Option<SubscriptionScheduleEndBehavior>

Behavior of the subscription schedule and underlying subscription when it ends.

invoice_settings: Option<SubscriptionScheduleInvoiceSettings>

The subscription schedule's default invoice settings.

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

renewal_behavior: Option<SubscriptionScheduleRenewalBehavior>

Behavior of the subscription schedule and underlying subscription when it ends.

renewal_interval: Option<SubscriptionScheduleRenewalInterval>

Interval and duration at which the subscription schedule renews for when it ends if renewal_behavior is renew.

status: SubscriptionScheduleStatus

Possible values are not_started, active, completed, released, and canceled.

subscription: Option<Expandable<Subscription>>

ID of the subscription managed by the subscription schedule.

Methods

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

Creates a new subscription schedule object.

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>

Updates an existing subscription schedule.

Trait Implementations

impl Clone for SubscriptionSchedule

fn clone(&self) -> SubscriptionSchedule

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SubscriptionSchedule

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SubscriptionSchedule

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Object for SubscriptionSchedule

type Id = SubscriptionScheduleId

The canonical id type for this object.

fn id(&self) -> Self::Id

The id of the object.

fn object(&self) -> &'static str

The object's type, typically represented in wire format as the object property.

impl Serialize for SubscriptionSchedule

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.