Module enums

Source

Expand description

This module contains enums used in the Paddle API.

Enums§

AdjustmentAction: How this adjustment impacts the related transaction.
AdjustmentItemType: Type of adjustment for this transaction item. tax adjustments are automatically created by Paddle. Include amount when creating a partial adjustment.
AdjustmentStatus: Status of this adjustment. Set automatically by Paddle.
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.
AdjustmentsReportFilterName: Field name to filter by.
AdjustmentsReportType: Type of report.
ApiKeyStatus
BalanceReportFilterName: Field name to filter by.
BalanceReportType: Type of report.
CardType: Type of credit or debit card used to pay.
CatalogType: Type of item. Standard items are considered part of your catalog and are shown on the Paddle dashboard.
CollectionMode: How payment is collected. automatic for checkout, manual for invoices.
CountryCodeSupported
CurrencyCode: Supported three-letter ISO 4217 currency code.
CurrencyCodeChargebacks: Three-letter ISO 4217 currency code for chargeback fees.
CurrencyCodePayouts: Supported three-letter ISO 4217 currency code for payouts from Paddle.
DiscountStatus: Whether this entity can be used in Paddle.
DiscountType: Type of discount. Determines how this discount impacts the checkout or transaction total.
DiscountsReportFilterName: Field name to filter by.
DiscountsReportType: Type of report.
Disposition: Determine whether the generated URL should download the PDF as an attachment saved locally, or open it inline in the browser.
EffectiveFrom: When this subscription change should take effect from. Defaults to next_billing_period, which creates a scheduled_change to apply the subscription change at the end of the billing period.
ErrorCode: Reason why a payment attempt failed. Returns null if payment captured successfully.
EventData: Type of event sent by Paddle along with it’s corresponding entity data
EventTypeName: Type of event sent by Paddle, in the format entity.event_type.
FilterOperator: Operator to use when filtering.
Interval: Unit of time.
NotificationOrigin: Describes how this notification was created.
NotificationSettingType: Where notifications should be sent for this destination.
NotificationStatus: Status of this notification.
PaymentAttemptStatus: Status of this payment attempt.
PaymentMethodOrigin: Describes how this payment method was saved.
PaymentMethodType: Type of payment method used for this payment attempt.
PayoutStatus
ProductPricesReportFilterName: Field name to filter by.
ProductsAndPricesReportType: Type of report.
ProrationBillingMode: How Paddle should handle proration calculation for changes made to a subscription or its items. Required when making changes that impact billing.
ReportStatus: Status of this report. Set automatically by Paddle.
SavedPaymentMethodType: Type of payment method saved.
ScheduledChangeAction: Kind of change that’s scheduled to be applied to this subscription.
SimulationEventStatus: Status of this simulation run log.
SimulationKind: Type of simulation.
SimulationRunStatus: Status of this simulation run.
SimulationScenarioType: Scenario for a simulation.
Status: Whether this entity can be used in Paddle.
SubscriptionItemStatus: Status of this subscription item. Set automatically by Paddle.
SubscriptionOnPaymentFailure: How Paddle should handle changes made to a subscription or its items if the payment fails during update. If omitted, defaults to prevent_change.
SubscriptionOnResume: How Paddle should set the billing period for the subscription when resuming. If omitted, defaults to start_new_billing_period.
SubscriptionStatus: Status of this subscription. Set automatically by Paddle. Use the pause subscription or cancel subscription operations to change.
TaxCategory: Tax category for this product. Used for charging the correct rate of tax. Selected tax category must be enabled on your Paddle account.
TaxMode: How tax is calculated for this price.
TrafficSource: Whether Paddle should deliver real platform events, simulation events or both to this notification destination.
TransactionOrigin
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.
TransactionsReportFilterName: Field name to filter by.
TransactionsReportType: Type of report.
Type: Type of error encountered.
UpdateSummaryResultAction: Whether the subscription change results in a prorated credit or a charge.

Module enumsCopy item path

Enums§

Module enums