Report Revenue
Per the Weebly App Developer Agreement, as a partner developing an app, you are entitled to 70% of collected revenue and Weebly is entitled to the remaining 30%. You are responsible for reporting that revenue to Weebly as they occur, using the Payment Notifications API.
Tip: Weebly doesn't handle payment processing from your customers. You'll need to implement that in your app. Typically, the flow looks like this:
- The site owner downloads and installs your app.
- You use your OAuth redirect to send the user to a page on your site where they can pay for the app.
- You process payment with a service of your choice.
- You report revenue from each transaction to us via our Payment API.
In this topic:
Report Revenue
You use the Weebly Payment Notifications API to report every app transaction that results in receiving a payment or giving a refund/credit. This includes things like sales, refunds, renewals, upgrades, recurring charges, credits, etc. You must report these transactions using the API as they happen.
Note: Before you submit your app, you need to test that your transaction reports are successfully received. See below for more info.
Use the API to report the method (purchase or refund), the kind (single, setup, recurring, trial, cancel, upgrade, or downgrade), the gross amount, and the payable amount of the transaction. You also give each type of transaction a name.
Note: Revenue is a success metric that will be used for app placement within the App Center, as well as other promotions and marketing programs Weebly will run from time to time.
Test Your Reporting
Testing that your payment notification has been received is part of the requirements for having your app approved. You must use the testpurchase and testrefund method field values to test the payment notification API. All successful posts will return a Status 200 message.
Note: If you use purchase or refund method fields to post your test transactions (instead of the test methods), those amounts will count towards your revenue share!
For example, to test an install fee, you might post this:
Once you've reported revenue using the Payment Notification API, use the Payment Log in the Developer Admin to review and verify your notifications.
Review Your Payment Notifications
The Payment Log tab on an app's detail page of the Developer Admin displays every record you've reported for that app. The table lists the date of the payment, the user and site that purchased the app, the name of the payment, the method, the gross amount paid by the customer and the net you keep, and the payable amount you owe to Weebly, all as received via the API. You can browse through the entries or search for a specific entry by User or Site ID. You can also sort by column.
This information can also be be emailed to you as a CSV file by clicking the Export All button. The file is sent to the account's email.
This information can also be be emailed to you as a CSV file by clicking the Export All button. The file is sent to the account's email.
Correct a Revenue Entry
If you find an entry that needs to be changed, click that entry, and in the modal, click Make Correction. Change the data as needed. You can change anything except the IDs and timestamp. Don't forget to save your changes!
Tip: Original records are preserved, so you cannot delete an entry. Instead of deleting, change all the dollar amounts to zero.