Struct PricePreview

pub struct PricePreview {

    pub id: Option<PriceID>,
    pub product_id: Option<ProductID>,
    pub description: String,
    pub type: CatalogType,
    pub name: Option<String>,
    pub billing_cycle: Option<Duration>,
    pub trial_period: Option<Duration>,
    pub tax_mode: TaxMode,
    pub unit_price: Money,
    pub unit_price_overrides: Vec<UnitPriceOverride>,
    pub quantity: PriceQuantity,
    pub status: Status,
    pub custom_data: Option<HashMap<String, String>>,
    pub import_meta: ImportMeta,
    pub created_at: String,
    pub updated_at: String,
}

Represents a price preview entity.

Fields

id: Option<PriceID>

Unique Paddle ID for this price, prefixed with pri_. The value is null for custom prices being previewed.

product_id: Option<ProductID>

Paddle ID for the product that this price is for, prefixed with pro_. The value is null for custom products being previewed.

description: String

Internal description for this price, not shown to customers. Typically notes for your team.

type: CatalogType

Type of item. Standard items are considered part of your catalog and are shown on the Paddle dashboard.

name: Option<String>

Name of this price, shown to customers at checkout and on invoices. Typically describes how often the related product bills.

billing_cycle: Option<Duration>

How often this price should be charged. null if price is non-recurring (one-time).

trial_period: Option<Duration>

Trial period for the product related to this price. The billing cycle begins once the trial period is over. null for no trial period. Requires billing_cycle.

tax_mode: TaxMode

How tax is calculated for this price.

unit_price: Money

A base representation of monetary value unformatted in the lowest denomination with currency code.

unit_price_overrides: Vec<UnitPriceOverride>

List of unit price overrides. Use to override the base price with a custom price and currency for a country or group of countries.

quantity: PriceQuantity

status: Status

Whether this entity can be used in Paddle.

custom_data: Option<HashMap<String, String>>

Your own structured key-value data.

import_meta: ImportMeta

Import information for this entity. null if this entity is not imported.

created_at: String

RFC 3339 datetime string of when this entity was created. Set automatically by Paddle.

updated_at: String

RFC 3339 datetime string of when this entity was updated. Set automatically by Paddle.

Trait Implementations

impl Clone for PricePreview

fn clone(&self) -> PricePreview

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PricePreview

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PricePreview

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for PricePreview

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

where __S: Serializer,

Serialize this value into the given Serde serializer.