Struct Adjustment

pub struct Adjustment {

    pub id: AdjustmentID,
    pub action: AdjustmentAction,
    pub type: AdjustmentType,
    pub transaction_id: TransactionID,
    pub subscription_id: Option<SubscriptionID>,
    pub customer_id: CustomerID,
    pub reason: String,
    pub credit_applied_to_balance: Option<bool>,
    pub currency_code: CurrencyCode,
    pub status: AdjustmentStatus,
    pub items: Vec<AdjustmentItem>,
    pub totals: AdjustmentTotals,
    pub payout_totals: Option<AdjustmentPayoutTotals>,
    pub tax_rates_used: Vec<AdjustmentTaxRateUsed>,
    pub created_at: DateTime<Utc>,
    pub updated_at: DateTime<Utc>,
}

Represents an adjustment entity.

Fields

id: AdjustmentID

Unique Paddle ID for this adjustment entity, prefixed with adj_.

action: AdjustmentAction

How this adjustment impacts the related transaction.

type: AdjustmentType

Type of adjustment. Use full to adjust the grand total for the related transaction. Include an items array when creating a partial adjustment. If omitted, defaults to partial.

transaction_id: TransactionID

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

subscription_id: Option<SubscriptionID>

Paddle ID for the subscription related to this adjustment, prefixed with sub_. Set automatically by Paddle based on the subscription_id of the related transaction.

customer_id: CustomerID

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

reason: String

Why this adjustment was created. Appears in the Paddle dashboard. Retained for record-keeping purposes.

credit_applied_to_balance: Option<bool>

Whether this adjustment was applied to the related customer’s credit balance. Only returned for credit adjustments.

currency_code: CurrencyCode

Supported three-letter ISO 4217 currency code.

status: AdjustmentStatus

Status of this adjustment. Set automatically by Paddle.

Most refunds for live accounts are created with the status of pending_approval until reviewed by Paddle, but some are automatically approved. For sandbox accounts, Paddle automatically approves refunds every ten minutes.

Credit adjustments don’t require approval from Paddle, so they’re created as approved.

items: Vec<AdjustmentItem>

List of items on this adjustment. Required if type is not populated or set to partial.

totals: AdjustmentTotals

Breakdown of the total for an adjustment.

payout_totals: Option<AdjustmentPayoutTotals>

Breakdown of how this adjustment affects your payout balance.

tax_rates_used: Vec<AdjustmentTaxRateUsed>

List of tax rates applied for this adjustment.

created_at: DateTime<Utc>

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

updated_at: DateTime<Utc>

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

Trait Implementations

impl Clone for Adjustment

fn clone(&self) -> Adjustment

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Adjustment

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Adjustment

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Adjustment

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

where __S: Serializer,

Serialize this value into the given Serde serializer.