Struct TransactionUpdate

pub struct TransactionUpdate {

    pub id: TransactionID,
    pub status: TransactionStatus,
    pub customer_id: CustomerID,
    pub address_id: AddressID,
    pub business_id: BusinessID,
    pub custom_data: Option<Value>,
    pub currency_code: CurrencyCode,
    pub origin: TransactionOrigin,
    pub subscription_id: SubscriptionID,
    pub invoice_id: InvoiceId,
    pub invoice_number: Option<String>,
    pub collection_mode: CollectionMode,
    pub discount_id: DiscountID,
    pub billing_details: BillingDetails,
    pub billing_period: Option<TimePeriod>,
    pub items: Vec<SubscriptionChargeItem>,
    pub details: TransactionDetails,
    pub payments: Vec<TransactionPaymentAttempt>,
    pub checkout: TransactionCheckout,
    pub created_at: DateTime<FixedOffset>,
    pub updated_at: DateTime<FixedOffset>,
    pub billed_at: Option<DateTime<FixedOffset>>,
}

Represents a transaction entity when updating transactions.

Fields

id: TransactionID

Unique Paddle ID for this transaction entity, prefixed with txn_.

status: TransactionStatus

Status of this transaction. You may set a transaction to billed or canceled, other statuses are set automatically by Paddle. Automatically-collected transactions may return completed if payment is captured successfully, or past_due if payment failed.

customer_id: CustomerID

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

address_id: AddressID

Paddle ID of the address that this transaction is for, prefixed with add_.

business_id: BusinessID

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

custom_data: Option<Value>

Your own structured key-value data.

currency_code: CurrencyCode

Supported three-letter ISO 4217 currency code. Must be USD, EUR, or GBP if collection_mode is manual.

origin: TransactionOrigin

Describes how this transaction was created.

subscription_id: SubscriptionID

Paddle ID of the subscription that this transaction is for, prefixed with sub_.

invoice_id: InvoiceId

Paddle ID of the invoice that this transaction is related to, prefixed with inv_. Used for compatibility with the Paddle Invoice API, which is now deprecated. This field is scheduled to be removed in the next version of the Paddle API.

invoice_number: Option<String>

Invoice number for this transaction. Automatically generated by Paddle when you mark a transaction as billed where collection_mode is manual.

collection_mode: CollectionMode

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

discount_id: DiscountID

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

billing_details: BillingDetails

Details for invoicing. Required if collection_mode is manual.

billing_period: Option<TimePeriod>

Time period that this transaction is for. Set automatically by Paddle for subscription renewals to describe the period that charges are for.

items: Vec<SubscriptionChargeItem>

List of items on this transaction.

When making a request, each object must contain either a price_id or a price object, and a quantity.

Include a price_id to charge for an existing catalog item, or a price object to charge for a non-catalog item.

details: TransactionDetails

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

payments: Vec<TransactionPaymentAttempt>

List of payment attempts for this transaction, including successful payments. Sorted by created_at in descending order, so most recent attempts are returned first.

checkout: TransactionCheckout

Paddle Checkout details for this transaction. You may pass a URL when creating or updating an automatically-collected transaction, or when creating or updating a manually-collected transaction where billing_details.enable_checkout is true.

created_at: DateTime<FixedOffset>

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

updated_at: DateTime<FixedOffset>

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

billed_at: Option<DateTime<FixedOffset>>

RFC 3339 datetime string of when this transaction was marked as billed. null for transactions that aren’t billed or completed. Set automatically by Paddle.

Trait Implementations

impl Clone for TransactionUpdate

fn clone(&self) -> TransactionUpdate

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TransactionUpdate

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for TransactionUpdate

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for TransactionUpdate

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

where __S: Serializer,

Serialize this value into the given Serde serializer.