Struct CreateSubscriptionItem 

pub struct CreateSubscriptionItem { /* private fields */ }

Adds a new item to an existing subscription. No existing items will be changed or replaced.

Implementations

impl CreateSubscriptionItem

pub fn new(subscription: impl Into<String>) -> Self

Construct a new CreateSubscriptionItem.

pub fn billing_thresholds( self, billing_thresholds: impl Into<ItemBillingThresholdsParam>, ) -> Self

Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds.

pub fn discounts(self, discounts: impl Into<Vec<DiscountsDataParam>>) -> Self

The coupons to redeem into discounts for the subscription item.

pub fn expand(self, expand: impl Into<Vec<String>>) -> Self

Specifies which fields in the response should be expanded.

pub fn metadata(self, metadata: impl Into<HashMap<String, String>>) -> Self

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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.

pub fn payment_behavior( self, payment_behavior: impl Into<CreateSubscriptionItemPaymentBehavior>, ) -> Self

Use allow_incomplete to transition the subscription to status=past_due if a payment is required but cannot be paid. This allows you to manage scenarios where additional user actions are needed to pay a subscription’s invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the SCA Migration Guide for Billing to learn more. This is the default behavior.

Use default_incomplete to transition the subscription to status=past_due when payment is required and await explicit confirmation of the invoice’s payment intent. This allows simpler management of scenarios where additional user actions are needed to pay a subscription’s invoice. Such as failed payments, SCA regulation, or collecting a mandate for a bank debit payment method.

Use pending_if_incomplete to update the subscription using pending updates. When you use pending_if_incomplete you can only pass the parameters supported by pending updates.

Use error_if_incomplete if you want Stripe to return an HTTP 402 status code if a subscription’s invoice cannot be paid. For example, if a payment method requires 3DS authentication due to SCA regulation and further user action is needed, this parameter does not update the subscription and returns an error instead. This was the default behavior for API versions prior to 2019-03-14. See the changelog to learn more.

pub fn plan(self, plan: impl Into<String>) -> Self

The identifier of the plan to add to the subscription.

pub fn price(self, price: impl Into<String>) -> Self

The ID of the price object.

pub fn price_data( self, price_data: impl Into<CreateSubscriptionItemPriceData>, ) -> Self

Data used to generate a new Price object inline.

pub fn proration_behavior( self, proration_behavior: impl Into<CreateSubscriptionItemProrationBehavior>, ) -> Self

Determines how to handle prorations when the billing cycle changes (e.g., when switching plans, resetting billing_cycle_anchor=now, or starting a trial), or if an item’s quantity changes. The default value is create_prorations.

pub fn proration_date(self, proration_date: impl Into<Timestamp>) -> Self

If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply the same proration that was previewed with the upcoming invoice endpoint.

pub fn quantity(self, quantity: impl Into<u64>) -> Self

The quantity you’d like to apply to the subscription item you’re creating.

pub fn tax_rates(self, tax_rates: impl Into<Vec<String>>) -> Self

A list of Tax Rate ids. These Tax Rates will override the default_tax_rates on the Subscription. When updating, pass an empty string to remove previously-defined tax rates.

impl CreateSubscriptionItem

pub async fn send<C: StripeClient>( &self, client: &C, ) -> Result<<Self as StripeRequest>::Output, C::Err>

Send the request and return the deserialized response.

pub fn send_blocking<C: StripeBlockingClient>( &self, client: &C, ) -> Result<<Self as StripeRequest>::Output, C::Err>

Send the request and return the deserialized response, blocking until completion.

Trait Implementations

impl Clone for CreateSubscriptionItem

fn clone(&self) -> CreateSubscriptionItem

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CreateSubscriptionItem

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

Formats the value using the given formatter.

impl Serialize for CreateSubscriptionItem

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StripeRequest for CreateSubscriptionItem

type Output = SubscriptionItem

The data returned from the eventual API call.

fn build(&self) -> RequestBuilder

Convert the struct into library-agnostic data that can be used by compatible clients to make API calls.

fn customize(&self) -> CustomizableStripeRequest<Self::Output>

Convert to a builder allowing per-request customization.