Basics
Paddle Permissions
Paddle recently introduced more granular API permissions. In this document we'll go through the necessary permission set.
If you just want to get going (you can always change the permissions later), simply select Read permissions for all objects and write permissions to:
- Addresses
- Businesses
- Customers
- Notification settings
- Subscriptions
- Transactions
If you want to use our Import and Export features (e.g. when you move from sandbox to production) you will need to also provide write access to:
- Products
- Prices
Our "Clear Sandbox" feature requires write permissions to all entities as this feature deletes all entries from your sandbox to give you a fresh start.
Future features may require additional permissions
We may introduce features in future that require additional permissions which will require you to change the API permission set. But as of right now this is the minimum set of permissions necessary to run Boathouse.
Details
Let's go through each use case that requires one of the above rights:
Biling Invoice Editing
This features requires access to the customer, business and address entity that together make up the business address visible on the customer's invoice. Boathouse will create a new business entity if required and link it to the customer, or simply edit the existing address.
Additional Billing Email Address
If you activate the feature in Boathouse allowing customers to add an additinal billing email address in the portal (which sends a copy of any invoice generated by Paddle to that email address) then the email address provided by the customer is written to the custom data field of the customer entity.
Webhook Check
In order to check if we are receiving the right notifications from Paddle we regularly check if all checkboxes in the notification types are correct and add any notifications if Boathouse adds features based on new events.
Subscription management
In order to change the subscription we need write access to that entity and also write access to the transaction to create the preview screen for any changes your customers make.
We ensure integrating Boathouse is a simple as possible. There is one API call that you will make to get all the information you need to implement a "pricing" and "manage subscription" page in your software.