Expand description
Contains all Paddle entity types.
Structs§
- Address
- Represents an address entity.
- Address
Preview - Represents an address entity when previewing addresses.
- Adjustment
- Represents an adjustment entity.
- Adjustment
Create - Represents an adjustment entity when creating adjustments.
- Adjustment
Item - Adjustment
Item Input - Adjustment
Item Totals - Breakdown of the total for an adjustment item.
- Adjustment
Payout Totals - Breakdown of how this adjustment affects your payout balance.
- Adjustment
Preview - Represents an adjustment entity when previewing adjustments.
- Adjustment
TaxRate Used - Adjustment
TaxRate Used Totals - Calculated totals for the tax applied to this adjustment.
- Adjustment
Totals - Breakdown of the total for an adjustment.
- ApiKey
- ApiKey entity
- Billing
Details - Details for invoicing. Required if
collection_modeismanual. - Billing
Details Update - Details for invoicing. Required if
collection_modeismanual. - Business
- Represents a business entity.
- Card
- Card metadata
- Chargeback
Fee - Chargeback fees incurred for this adjustment. Only returned when the adjustment
actionischargebackorchargeback_warning. - Contact
- Credit
Balance - Represents a credit balance for a customer.
- Customer
- Represents a customer entity.
- Customer
Authentication Token - Represents a customer authentication token.
- Customer
Balance - Customer
Portal Session - Represents a customer portal session.
- Customer
Portal Session General Urls - Authenticated customer portal deep links that aren’t associated with a specific entity.
- Customer
Portal Session Subscription Urls - Customer
Portal Session Urls - Authenticated customer portal deep links. For security, the
tokenappended to each link is temporary. You shouldn’t store these links. - Discount
- Represents a discount entity.
- Duration
- Error
- Represents an error.
- Errors
- Event
- Represents an event entity.
- Event
Type - Represents an event type.
- Import
Meta - Import information for this entity.
nullif this entity is not imported. - Meta
- Information about this response.
- Meta
Paginated - Information about this response.
- Method
Details - Information about the payment method used for a payment attempt.
- Money
- A base representation of monetary value unformatted in the lowest denomination with currency code.
- Next
Transaction - Preview of the next transaction for this subscription. May include prorated charges that aren’t yet billed and one-time charges.
nullif the subscription is scheduled to cancel or pause. - Notification
- Represents a notification entity.
- Notification
Log - Represents a notification log entity.
- Notification
Payload - Notification payload. Includes the new or changed event.
- Notification
Setting - Represents a notification destination.
- Notification
Setting Create - Represents a notification destination when creating notification destinations.
- Notification
Setting Update - Represents a notification destination when updating notification destinations.
- Original
- Chargeback fee before conversion to the payout currency.
nullwhen the chargeback fee is the same as the payout currency. - Pagination
- Keys used for working with paginated results.
- PayPal
- PayPal metadata
- Payment
Method - Represents a customer payment method entity.
- Payout
- Payout entity received from a payout event
- Price
- Represents a price entity.
- Price
Preview - Represents a price preview entity.
- Price
Preview Base - Price
Preview Details - Calculated totals for a price preview, including discounts, tax, and currency conversion.
- Price
Preview Discounts - Array of discounts applied to this preview line item. Empty if no discounts applied.
- Price
Preview Item - Price
Preview Line Item - Information about line items for this preview. Includes totals calculated by Paddle. Considered the source of truth for line item totals.
- Price
Quantity - Pricing
Preview - Represents an entity for previewing prices.
- Product
- Represents a product entity.
- Product
Preview - Represents a product (preview) entity.
- Proration
- How proration was calculated for this item. Populated when a transaction is created from a subscription change, where
proration_billing_modewasprorated_immediatelyorprorated_next_billing_period. Set automatically by Paddle. - Report
Base - Represents a report entity.
- Report
Filter - Simulation
Event - Represents a simulation event.
- Simulation
Event Request - Information about the request. Sent by Paddle as part of the simulation.
- Simulation
Event Response - Information about the response. Sent by the responding server for the notification setting.
- Simulation
RunScenario - Represents a simulation run entity for a scenario.
- Simulation
RunSingle Event - Represents a simulation run entity for a single event.
- Simulation
Scenario - Represents a simulation entity for a scenario.
- Simulation
Scenario Create - Represents a simulation entity for a scenario when creating.
- Simulation
Scenario Update - Represents a simulation entity for a scenario when updating.
- Simulation
Single Event Create - Represents a simulation entity for a single event when creating.
- Simulation
Single Event Update - Represents a simulation entity for a single event when updating.
- Simulation
Type - Represents a simulation type.
- Subscription
- Represents a subscription entity.
- Subscription
Charge - Represents a one-time charge for a subscription.
- Subscription
Charge Create With Price - Subscription
Charge Create With Price AndProduct - Price object for a non-catalog item to charge for. Include a
productobject to create a non-catalog product for this non-catalog price. - Subscription
Charge Create With Price Price - Price object for a non-catalog item to bill for. Include a
product_idto relate this non-catalog price to an existing catalog price. - Subscription
Discount Effective From - Details of the discount applied to this subscription. Include to add a discount to a subscription.
nullto remove a discount. - Subscription
Discount Time Period - Details of the discount applied to this subscription.
- Subscription
Item - Represents a subscription item.
- Subscription
Item Create With Price - Subscription
Item Create With Price Id - Subscription
Management Urls - Authenticated customer portal deep links for this subscription. For security, the
tokenappended to each link is temporary. You shouldn’t store these links. - Subscription
Preview - Represents a subscription preview when previewing a subscription.
- Subscription
Preview Update Summary - Impact of this subscription change. Includes whether the change results in a charge or credit, and totals for prorated amounts.
- Subscription
Scheduled Change - Change that’s scheduled to be applied to a subscription. Use the pause subscription, cancel subscription, and resume subscription operations to create scheduled changes.
nullif no scheduled changes. - Subscription
Transaction Details Preview - Calculated totals for a transaction preview, including discounts, tax, and currency conversion. Considered the source of truth for totals on a transaction preview.
- Subscription
Transaction Details Preview Item - SubscriptionTransactionDetailsPreview requires same fields as TransactionLineItemPreview but proration is optional
- Subscription
Update - Represents a subscription entity when updating subscriptions.
- Subscription
Update Item - TaxRates
Used - Time
Period - Totals
- Breakdown of a charge in the lowest denomination of a currency (e.g. cents for USD).
- Totals
Without Discount - Breakdown of a charge in the lowest denomination of a currency (e.g. cents for USD).
- Transaction
- Represents a transaction entity.
- Transaction
Checkout - Paddle Checkout details for this transaction. Returned for automatically-collected transactions and where
billing_details.enable_checkoutistruefor manually-collected transactions;nullotherwise. - Transaction
Create - Represents a transaction entity when creating transactions.
- Transaction
Details - Calculated totals for a transaction, including proration, discounts, tax, and currency conversion. Considered the source of truth for totals on a transaction.
- Transaction
Details Preview - Calculated totals for a transaction preview, including discounts, tax, and currency conversion. Considered the source of truth for totals on a transaction preview.
- Transaction
Invoice - Contains an invoice PDF url for a transaction.
- Transaction
Item - Transaction
Item Create Base - Transaction
Item NonCatalog Price - Price object for a non-catalog item to charge for.
- Transaction
Item Preview Base - Transaction
Line Item - Information about line items for this transaction. Different from transaction
itemsas they include totals calculated by Paddle. Considered the source of truth for line item totals. - Transaction
Line Item Preview - Information about line items for this transaction preview. Different from transaction preview
itemsas they include totals calculated by Paddle. Considered the source of truth for line item totals. - Transaction
Line Item With Id - Information about line items for this transaction. Different from transaction
itemsas they include totals calculated by Paddle. Considered the source of truth for line item totals. - Transaction
Payment Attempt - Transaction
Payout Totals - Breakdown of the payout total for a transaction.
nulluntil the transaction iscompleted. Returned in your payout currency. - Transaction
Payout Totals Adjusted - Breakdown of the payout total for a transaction after adjustments.
nulluntil the transaction iscompleted. - Transaction
Preview - Represents a transaction entity when previewing transactions.
- Transaction
Preview Create - Represents a transaction entity when previewing.
- Transaction
Price Create Base - Represents a price entity.
- Transaction
Price Create With Product Id - Transaction
Revise - Represents a customer information revision for a transaction.
- Transaction
Subscription Product Create - Transaction
Totals - Breakdown of the total for a transaction. These numbers can be negative when dealing with subscription updates that result in credit.
- Transaction
Totals Adjusted - Breakdown of the totals for a transaction after adjustments.
- Transaction
Update - Represents a transaction entity when updating transactions.
- Unit
Price Override - Update
Summary Result - Details of the result of credits and charges. Where the total of any credit adjustments is greater than the total charge, the result is a prorated credit; otherwise, the result is a prorated charge.
- Validation
Error