Struct Subscription 

pub struct Subscription {
    pub id: String,
    pub customer_ref: String,
    pub status: SubscriptionStatus,
    pub price_ref: Option<String>,
    pub quantity: u32,
    pub current_period_end: Option<OffsetDateTime>,
    pub cancel_at_period_end: bool,
    pub metadata: BTreeMap<String, String>,
}

A recurring subscription as the provider reports it (issue #589). customer_ref names the customer the way the adapter is configured to name customers (a provider id, or the venture’s own id where the adapter maps it); the fields mirror what a billing module reconciles against, never an entitlement.

Fields

id: String

customer_ref: String

status: SubscriptionStatus

price_ref: Option<String>

The price the subscription is on (a Stripe Price id), when the provider reports one.

quantity: u32

The number of units subscribed. 1 when the provider reports none — a metered price, for example, has no fixed quantity.

current_period_end: Option<OffsetDateTime>

When the current period ends; None when the provider does not say.

cancel_at_period_end: bool

Whether the subscription is set to end when the current period does.

metadata: BTreeMap<String, String>

The metadata the provider holds on the subscription.

Trait Implementations

impl Clone for Subscription

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 Subscription

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

Formats the value using the given formatter.

impl Eq for Subscription

impl PartialEq for Subscription

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Subscription