Struct ory_client::models::subscription::Subscription

pub struct Subscription {

    pub created_at: String,
    pub currency: CurrencyEnum,
    pub current_interval: CurrentIntervalEnum,
    pub current_plan: String,
    pub customer_id: String,
    pub id: String,
    pub interval_changes_to: Option<String>,
    pub ongoing_stripe_checkout_id: Option<String>,
    pub payed_until: String,
    pub plan_changes_at: Option<String>,
    pub plan_changes_to: Option<String>,
    pub status: String,
    pub updated_at: String,
}

Fields

created_at: String

currency: CurrencyEnum

The currency of the subscription. To change this, a new subscription must be created. usd USD eur Euro

current_interval: CurrentIntervalEnum

The currently active interval of the subscription monthly Monthly yearly Yearly

current_plan: String

The currently active plan of the subscription

customer_id: String

The ID of the stripe customer

id: String

The ID of the subscription

interval_changes_to: Option<String>

ongoing_stripe_checkout_id: Option<String>

payed_until: String

Until when the subscription is payed

plan_changes_at: Option<String>

plan_changes_to: Option<String>

status: String

For collection_method=charge_automatically a subscription moves into incomplete if the initial payment attempt fails. A subscription in this state can only have metadata and default_source updated. Once the first invoice is paid, the subscription moves into an active state. If the first invoice is not paid within 23 hours, the subscription transitions to incomplete_expired. This is a terminal state, the open invoice will be voided and no further invoices will be generated. A subscription that is currently in a trial period is trialing and moves to active when the trial period is over. If subscription collection_method=charge_automatically, it becomes past_due when payment is required but cannot be paid (due to failed payment or awaiting additional user actions). Once Stripe has exhausted all payment retry attempts, the subscription will become canceled or unpaid (depending on your subscriptions settings). If subscription collection_method=send_invoice it becomes past_due when its invoice is not paid by the due date, and canceled or unpaid if it is still not paid by an additional deadline after that. Note that when a subscription has a status of unpaid, no subsequent invoices will be attempted (invoices will be created, but then immediately automatically closed). After receiving updated payment information from a customer, you may choose to reopen and pay their closed invoices.

updated_at: String

Implementations

impl Subscription

pub fn new( created_at: String, currency: CurrencyEnum, current_interval: CurrentIntervalEnum, current_plan: String, customer_id: String, id: String, interval_changes_to: Option<String>, payed_until: String, plan_changes_to: Option<String>, status: String, updated_at: String ) -> Subscription

Trait Implementations

impl Clone for Subscription

fn clone(&self) -> Subscription

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Subscription

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Subscription

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Subscription

fn eq(&self, other: &Subscription) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Subscription

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Subscription