Struct TransactionPreview

pub struct TransactionPreview<'a> { /* private fields */ }

Request builder for generating a transaction preview without creating a transaction entity.

Implementations

impl<'a> TransactionPreview<'a>

pub fn new(client: &'a Paddle) -> Self

pub fn append_catalog_item( &mut self, price_id: impl Into<PriceID>, quantity: u32, ) -> &mut Self

Append to the list of items to charge for.

You can charge for items that you’ve added to your catalog by passing the Paddle ID of an existing price entity,

To charge for non-catalog items see append_non_catalog_item.

pub fn append_non_catalog_item( &mut self, price: TransactionItemNonCatalogPrice, quantity: u32, ) -> &mut Self

Append to the list of items to charge for.

You can charge for non-catalog items by passing a TransactionItemNonCatalogPrice object.

pub fn address(&mut self, address: AddressPreview) -> &mut Self

Address to charge tax for.

pub fn customer_ip_address(&mut self, ip: String) -> &mut Self

IP address of the customer. Paddle fetches location using this IP address to calculate totals.

pub fn address_id(&mut self, address_id: impl Into<AddressID>) -> &mut Self

Paddle ID of the address that this transaction preview is for.

pub fn business_id(&mut self, business_id: impl Into<BusinessID>) -> &mut Self

Paddle ID of the business that this transaction is for.

pub fn customer_id(&mut self, customer_id: impl Into<CustomerID>) -> &mut Self

Paddle ID of the customer that this transaction is for.

pub fn currency_code(&mut self, currency_code: CurrencyCode) -> &mut Self

Supported three-letter currency code.

pub fn discount_id(&mut self, discount_id: impl Into<DiscountID>) -> &mut Self

Paddle ID of the discount applied to this transaction.

pub fn ignore_trials(&mut self, ignore_trials: bool) -> &mut Self

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.

pub async fn send(&self) -> Result<SuccessResponse<TransactionPreview>, Error>

Send the request to Paddle and return the response.

Trait Implementations

impl<'a> Serialize for TransactionPreview<'a>

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

where __S: Serializer,

Serialize this value into the given Serde serializer.