Struct Subscription 

pub struct Subscription<C = Customer> {

    pub id: String,
    pub customer: C,
    pub plan: Plan,
    pub start_date: OffsetDateTime,
    pub end_date: Option<OffsetDateTime>,
    pub status: Option<SubscriptionStatus>,
    pub current_billing_period_start_date: Option<OffsetDateTime>,
    pub current_billing_period_end_date: Option<OffsetDateTime>,
    pub active_plan_phase_order: Option<i64>,
    pub fixed_fee_quantity_schedule: Vec<SubscriptionFixedFee>,
    pub net_terms: i64,
    pub auto_collection: bool,
    pub default_invoice_memo: String,
    pub created_at: OffsetDateTime,
}

An Orb subscription.

Fields

id: String

The Orb-assigned unique identifier for the subscription.

customer: C

The customer associated with this subscription.

plan: Plan

The plan associated with this subscription.

start_date: OffsetDateTime

The date at which Orb starts billing for this subscription.

end_date: Option<OffsetDateTime>

The date at which Orb stops billing for this subscription.

status: Option<SubscriptionStatus>

The status of the subscription.

current_billing_period_start_date: Option<OffsetDateTime>

The start of the current billing period if the subscription is currently active.

current_billing_period_end_date: Option<OffsetDateTime>

The end of the current billing period if the subscription is currently active.

active_plan_phase_order: Option<i64>

The current plan phase that is active, if the subscription’s plan has phases.

fixed_fee_quantity_schedule: Vec<SubscriptionFixedFee>

List of all fixed fee quantities associated with this subscription.

net_terms: i64

Determines the difference between the invoice issue date and the date that they are due.

A value of zero indicates that the invoice is due on issue, whereas a value of 30 represents that the customer has a month to pay the invoice.

auto_collection: bool

Determines whether issued invoices for this subscription will automatically be charged with the saved payment method on the due date.

If None, the value is determined by the plan configuration.

default_invoice_memo: String

Determines the default memo on this subscription’s invoices.

If None, the value is determined by the plan configuration.

created_at: OffsetDateTime

The time at which the subscription was created.

Trait Implementations

impl<C: Clone> Clone for Subscription<C>

fn clone(&self) -> Subscription<C>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<C: Debug> Debug for Subscription<C>

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

Formats the value using the given formatter.

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

where C: Deserialize<'de>,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<C: Hash> Hash for Subscription<C>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<C: PartialEq> PartialEq for Subscription<C>

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl<C> Serialize for Subscription<C>

where C: Serialize,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<C: Eq> Eq for Subscription<C>

impl<C> StructuralPartialEq for Subscription<C>