Struct stripe::SubscriptionSchedule

pub struct SubscriptionSchedule {

    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: 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>>,
}

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

test_clock: Option<Expandable<TestHelpersTestClock>>

ID of the test clock this subscription schedule belongs to.

Implementations

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.

Each customer can have up to 500 active or scheduled subscriptions.

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 Default for SubscriptionSchedule

fn default() -> SubscriptionSchedule

Returns the “default value” for a type.

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.