Struct TransactionPreview

pub struct TransactionPreview {
    pub customer_id: CustomerID,
    pub address_id: AddressID,
    pub business_id: BusinessID,
    pub currency_code: CurrencyCode,
    pub discount_id: DiscountID,
    pub customer_ip_address: Option<String>,
    pub address: Address,
    pub ignore_trials: bool,
    pub items: Vec<HashMap<String, String>>,
    pub details: TransactionDetailsPreview,
    pub available_payment_methods: Vec<PaymentMethodType>,
}

Represents a transaction entity when previewing transactions.

Fields

customer_id: CustomerID

Paddle ID of the customer that this transaction preview is for, prefixed with ctm_.

address_id: AddressID

Paddle ID of the address that this transaction preview is for, prefixed with add_. Send one of address_id, customer_ip_address, or the address object when previewing.

business_id: BusinessID

Paddle ID of the business that this transaction preview is for, prefixed with biz_.

currency_code: CurrencyCode

Supported three-letter ISO 4217 currency code.

discount_id: DiscountID

Paddle ID of the discount applied to this transaction preview, prefixed with dsc_.

customer_ip_address: Option<String>

IP address for this transaction preview. Send one of address_id, customer_ip_address, or the address object when previewing.

address: Address

Address for this transaction preview. Send one of address_id, customer_ip_address, or the address object when previewing.

ignore_trials: bool

Whether trials should be ignored for transaction preview calculations.

By default, recurring items with trials are considered to have a zero charge when previewing. Set to true to disable this.

items: Vec<HashMap<String, String>>

List of items to preview transaction calculations for.

details: TransactionDetailsPreview

Calculated totals for a transaction preview, including discounts, tax, and currency conversion. Considered the source of truth for totals on a transaction preview.

available_payment_methods: Vec<PaymentMethodType>

Trait Implementations

impl Clone for TransactionPreview

fn clone(&self) -> TransactionPreview

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TransactionPreview

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for TransactionPreview

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for TransactionPreview

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

where __S: Serializer,

Serialize this value into the given Serde serializer.