All notable changes to this project will be documented in this file.
The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.
Check our main developer changelog for information about changes to the Paddle Billing platform, the Paddle API, and other developer tools.
- Limited bytes that can be read via the webhook verification middleware
- Handle nullable
SubscriptionDiscountTimePeriod
propertyStartsAt
making it a pointer
- Support for new API errors
- Vietnamese Dong (VND) currency support, see related changelog
- Simpler creation of full adjustments and a new
AdjustmentType
property, see related changelog - Support for controlling how Paddle bills when resuming subscriptions with
SubscriptionOnResume
, see related chagnelog - Support for non catalog items on Transaction Previews with pointer ID properties
- Removed write only property
items
from PricePreview entity - Removed unused DiscountStatus values
expired
andused
- Corrected URL acronym casing for
SubscriptionManagementURLs
- Corrected internal package version number
- Added missing changelog updates
- An example for webhook unmarshalling was added to the package.
- Create v2 module for the latest major version
- Support for the Simulation API - see related changelog entry
- Filtering of customer credit balances by
currency_code
inAdjustmentsClient.ListCreditBalances
- New API error mappings
- Subscription resume union funcs now accept the required path param
NewResumeSubscriptionRequestResumeOnASpecificDate
NewResumeSubscriptionRequestResumeImmediately
- Response unmarshal for GetNotifications to the Notification struct
PricePreview
has moved toPreviewPrices
to match API documentation- Refactored non catalog item types for consistency through the SDK, see UPGRADING for details
- Support for new Paddle API errors
- Adjustment credit notes (
GetAdjustmentCreditNote
) disposition
query parameter forGetTransactionInvoice
andGetAdjustmentCreditNote
active
query parameter filter support for NotificationSettings- Subscription update and preview update support non catalog items
Type
for Product and Price notifications are nullable*CatalogType
PaymentMethodID
on Transaction payments is nullable*PaymentMethodID
for both notifications and API calls
No documented changes.
- Consistency to naming where some occurrences of pluralised prefixes where the pattern is to be singular see UPGRADING for details
- Post consistency fixes to some type names that conflicted, see UPGRADING for details
- Reports architecture has changed to a oneOf design
- Report filter values incorrectly typed as a
string
when it requires eitherstring
or[]string
depending on the filter name.
- Paddle API enum types are now correctly enforced where applicable
- Notifications and Events
EventType
property now useEventTypeName
instead ofstring
type Totals
is now a unified type from the previous 4 typesTotals
,TotalsFormatted
,UnitTotals
andUnitTotalsFormatted
- Various types have been renamed to be less generic and lower the risk of a future breaking change, see UPGRADING for details
Product
has been added as a property ofSubscriptionItem
TaxRatesUsed
has been added as a property ofAdjustments
andAdjustmentNotification
Notification
propertyType
narrows toEventTypeName
fromstring
- All notifications and events now have
EventType
narrowed toEventTypeName
fromstring
- Handling collections for API endpoints without pagination
UnitPriceOverride
propertyCountryCodes
is now typed as a sliceTransaction
propertyAvailablePaymentMethods
is now typed as a slicePricePreview
propertyAvailablePaymentMethods
is now typed as a sliceCreateNotificationSettingRequest
propertySubscribedEvents
is now correctly typedUpdateNotificationSettingRequest
propertySubscribedEvents
is now correctly typed
- Shared types
TransactionSubscriptionPriceCreateWithProduct
andTransactionSubscriptionPriceCreateWithProductID
have diverged into 2 new types for Transactions and Subscriptions - Include entity types are unified with their non-include variant, e.g.
ProductWithIncludes
andProduct
are now justProduct
AUD
andCAD
chargeback currencies are available
- Subscription resume properly accepts the subscription id as a path parameter on
ResumeSubscriptionRequest
- Correctly make a
PATCH
call forPreviewSubscription
instead ofPOST
and usePatchField
types in thePreviewSubscriptionRequest
request
Event
andNotificationsEvent
are now an interfaces.NotificationsEvent
has moved package topaddlenotification
.
- New
paddlenotification
package. - Support for
/events
and/notifications
endpoints.
- Initial early access release. Added support for the most frequently used Paddle Billing entities and API operations. Check the README for more information.