About the External Billing Events API

Note: This API is only for Partner Billed Apps, which charge users using their own payment provider.

The External Billing Events API allows you to report charges and refunds to Wix for revenue tracking when you handle payment processing yourself, such as through Stripe or PayPal.

To get your Partner Billed App approved, you need to:

  1. Get approval from Wix.
  2. Implement this API.
  3. Submit Partner Billed App reports.

Note: Hosting your own external pricing page doesn't automatically make you a Partner Billed App. External pricing pages that process payments through Wix should use the Billing API, whereas external pricing pages that process payments independently should use this External Billing Events API.

The API has 1 method, Report External Billing Event, that lets you send the details of a billing event. In each method call, you report 1 external billing event associated with a single instance of your app.

Before you begin

It’s important to note the following point before starting to code:

Since you report a billing event for a specific app instance, you need at least 1 of the following:

  • An access token set up for the app instance. This is the recommended option.
  • The app instance ID.
  • An API key with the account-level Manage Custom Apps permission, from the account that owns your app.

Use cases

Terminology

  • Partner Billed App: An app that processes payments yourself using your own payment provider such as Stripe or PayPal instead of using Wix checkout. Requires Wix approval and regular reporting of billing events using this API.
  • External billing event: A charge or refund that occurs outside the Wix Billing system.
  • External pricing page: A custom pricing page that you host on your own servers.
  • App instance: Specific occurrence of your app on a particular Wix site.
Did this help?