Struct SubscriptionUpdate

pub struct SubscriptionUpdate {

    pub customer_id: CustomerID,
    pub address_id: AddressID,
    pub business_id: BusinessID,
    pub currency_code: CurrencyCode,
    pub next_billed_at: DateTime<FixedOffset>,
    pub discount: SubscriptionDiscountEffectiveFrom,
    pub collection_mode: CollectionMode,
    pub billing_details: BillingDetails,
    pub scheduled_change: Option<()>,
    pub items: Vec<SubscriptionChargeItem>,
    pub custom_data: Option<Value>,
    pub proration_billing_mode: ProrationBillingMode,
    pub on_payment_failure: SubscriptionOnPaymentFailure,
}

Represents a subscription entity when updating subscriptions.

Fields

customer_id: CustomerID

Unique Paddle ID for this customer entity, prefixed with ctm_.

address_id: AddressID

Unique Paddle ID for this address entity, prefixed with add_.

business_id: BusinessID

Paddle ID of the business that this subscription is for, prefixed with biz_. Include to change the business for a subscription.

currency_code: CurrencyCode

Supported three-letter ISO 4217 currency code.

next_billed_at: DateTime<FixedOffset>

RFC 3339 datetime string.

discount: SubscriptionDiscountEffectiveFrom

Details of the discount applied to this subscription. Include to add a discount to a subscription. null to remove a discount.

collection_mode: CollectionMode

How payment is collected. automatic for checkout, manual for invoices.

billing_details: BillingDetails

Details for invoicing. Required if collection_mode is manual. null if changing collection_mode to automatic.

scheduled_change: Option<()>

Change that’s scheduled to be applied to a subscription. When updating, you may only set to null to remove a scheduled change. Use the pause subscription, cancel subscription, and resume subscription operations to create scheduled changes.

items: Vec<SubscriptionChargeItem>

List of items on this subscription. Only recurring items may be added. Send the complete list of items that should be on this subscription, including existing items to retain.

custom_data: Option<Value>

Your own structured key-value data.

proration_billing_mode: ProrationBillingMode

How Paddle should handle proration calculation for changes made to a subscription or its items. Required when making changes that impact billing.

For automatically-collected subscriptions, responses may take longer than usual if a proration billing mode that collects for payment immediately is used.

on_payment_failure: SubscriptionOnPaymentFailure

How Paddle should handle changes made to a subscription or its items if the payment fails during update. If omitted, defaults to prevent_change.

Trait Implementations

impl Clone for SubscriptionUpdate

fn clone(&self) -> SubscriptionUpdate

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SubscriptionUpdate

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SubscriptionUpdate

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for SubscriptionUpdate

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

where __S: Serializer,

Serialize this value into the given Serde serializer.