Struct stripe::SubscriptionItem

pub struct SubscriptionItem {
    pub id: SubscriptionItemId,
    pub billing_thresholds: Option<SubscriptionItemBillingThresholds>,
    pub created: Option<Timestamp>,
    pub deleted: bool,
    pub metadata: Metadata,
    pub plan: Option<Plan>,
    pub quantity: Option<u64>,
    pub subscription: Option<String>,
    pub tax_rates: Option<Vec<TaxRate>>,
}

The resource representing a Stripe "SubscriptionItem".

For more details see https://stripe.com/docs/api/subscription_items/object.

Fields

id: SubscriptionItemId

Unique identifier for the object.

billing_thresholds: Option<SubscriptionItemBillingThresholds>

Define thresholds at which an invoice will be sent, and the related subscription advanced to a new billing period.

created: Option<Timestamp>

Time at which the object was created.

Measured in seconds since the Unix epoch.

deleted: bool

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.

plan: Option<Plan>

quantity: Option<u64>

The quantity of the plan to which the customer should be subscribed.

subscription: Option<String>

The subscription this subscription_item belongs to.

tax_rates: Option<Vec<TaxRate>>

The tax rates which apply to this subscription_item.

When set, the default_tax_rates on the subscription do not apply to this subscription_item.

Methods

impl SubscriptionItem

pub fn list(
    client: &Client,
    params: ListSubscriptionItems
) -> Response<List<SubscriptionItem>>

Returns a list of your subscription items for a given subscription.

pub fn retrieve(
    client: &Client,
    id: &SubscriptionItemId,
    expand: &[&str]
) -> Response<SubscriptionItem>

Retrieves the invoice item with the given ID.

pub fn update(
    client: &Client,
    id: &SubscriptionItemId,
    params: UpdateSubscriptionItem
) -> Response<SubscriptionItem>

Updates the plan or quantity of an item on a current subscription.

pub fn delete(
    client: &Client,
    id: &SubscriptionItemId
) -> Response<Deleted<SubscriptionItemId>>

Deletes an item from the subscription.

Removing a subscription item from a subscription will not cancel the subscription.

Trait Implementations

impl Object for SubscriptionItem

type Id = SubscriptionItemId

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 Clone for SubscriptionItem

fn clone(&self) -> SubscriptionItem

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SubscriptionItem

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

Formats the value using the given formatter.

impl Serialize for SubscriptionItem

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

Serialize this value into the given Serde serializer.

impl<'de> Deserialize<'de> for SubscriptionItem

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.