Struct UpdatePlan 

pub struct UpdatePlan { /* private fields */ }

Updates the specified plan by setting the values of the parameters passed. Any parameters not provided are left unchanged. By design, you cannot change a plan’s ID, amount, currency, or billing cycle.

Implementations

impl UpdatePlan

pub fn new(plan: impl Into<PlanId>) -> Self

Construct a new UpdatePlan.

pub fn active(self, active: impl Into<bool>) -> Self

Whether the plan is currently available for new subscriptions.

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 nickname(self, nickname: impl Into<String>) -> Self

A brief description of the plan, hidden from customers.

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

The product the plan belongs to. This cannot be changed once it has been used in a subscription or subscription schedule.

pub fn trial_period_days(self, trial_period_days: impl Into<u32>) -> Self

Default number of trial days when subscribing a customer to this plan using trial_from_plan=true.

impl UpdatePlan

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 UpdatePlan

fn clone(&self) -> UpdatePlan

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for UpdatePlan

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

Formats the value using the given formatter.

impl Serialize for UpdatePlan

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 UpdatePlan

type Output = Plan

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.