Enum SubscriptionStatus 

#[non_exhaustive]
pub enum SubscriptionStatus {
    Trialing,
    Active,
    PastDue,
    Canceled,
    Unpaid,
    Incomplete,
    IncompleteExpired,
    Paused,
    Other(String),
}

Where a recurring subscription stands (issue #589), in the provider’s own vocabulary — Stripe’s subscription statuses today, plus Other for one this version does not know. This is the provider’s word, not an entitlement: a billing module reads it and decides what access it grants (ADR 0025).

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Trialing

In a free trial; the first invoice has not been raised yet.

Active

Paid and current.

PastDue

A renewal payment failed; the provider is still retrying.

Canceled

Ended, by the customer or after collection gave up.

Unpaid

The final invoice went unpaid, after the retries ran out.

Incomplete

Created, but the first payment has not completed yet.

IncompleteExpired

The first payment was never completed in time; the subscription is dead and cannot be revived.

Paused

Paused: billing is suspended and no invoices are raised.

Other(String)

A status this version does not know; the raw value is kept.

Implementations

impl SubscriptionStatus

pub fn from_provider(status: &str) -> Self

Maps a provider status string (Stripe’s spellings) to a status; anything unknown is kept as SubscriptionStatus::Other.

pub fn as_str(&self) -> &str

The provider’s status string, the inverse of from_provider, so a status read from a provider and written back keeps its spelling.

Trait Implementations

impl Clone for SubscriptionStatus

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SubscriptionStatus

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

Formats the value using the given formatter.

impl Eq for SubscriptionStatus

impl PartialEq for SubscriptionStatus

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for SubscriptionStatus