Struct SubscriptionParams 

pub struct SubscriptionParams {
    pub product_id: Option<Uuid>,
    pub proration_behavior: Option<ProrationBehavior>,
    pub discount_id: Option<Uuid>,
    pub cancel_at_period_end: Option<bool>,
    pub customer_cancellation_reason: Option<CustomerCancellationReason>,
    pub customer_cancellation_comment: Option<String>,
    pub revoke: Option<bool>,
}

Fields

product_id: Option<Uuid>

Update subscription to another product.

proration_behavior: Option<ProrationBehavior>

Determine how to handle the proration billing. If not provided, will use the default organization setting.

discount_id: Option<Uuid>

Update the subscription to apply a new discount. If set to None, the discount will be removed. The change will be applied on the next billing cycle.

cancel_at_period_end: Option<bool>

Cancel an active subscription once the current period ends.

Or uncancel a subscription currently set to be revoked at period end.

customer_cancellation_reason: Option<CustomerCancellationReason>

Customer reason for cancellation. Helpful to monitor reasons behind churn for future improvements.

Only set this in case your own service is requesting the reason from the customer. Or you know based on direct conversations, i.e support, with the customer.

customer_cancellation_comment: Option<String>

Customer feedback and why they decided to cancel.

revoke: Option<bool>

Cancel and revoke an active subscription immediately

Trait Implementations

impl Default for SubscriptionParams

fn default() -> SubscriptionParams

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SubscriptionParams

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for SubscriptionParams

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

where __S: Serializer,

Serialize this value into the given Serde serializer.