About the Memberships Service Plugin

The Wix eCommerce Memberships Service Plugin allows you to integrate with Wix as a membership provider. This means you can enable customers to purchase various goods using memberships issued by your service. By integrating your service with Wix, you can facilitate key membership operations such as membership retrieval, charging, and voiding membership transactions. These operations are seamlessly integrated into the site's checkout page, enhancing the overall customer experience.

With the Memberships SPI, you can:

  • Provide the memberships that can be used to pay for a given list of items
  • Charge memberships
  • Void a previous membership use

Before you begin

  • It's important to ensure that your implementation of the memberships provider service plugin endpoints adheres to the provided specifications.
  • This SPI is focused on memberships as a payment method. It does not cover how a customer subscribes to a membership.
  • For these APIs to function, a gift card provider must be integrated with the site. This integration can be achieved by any of the following:
    • Marking your app as dependent on Wix Stores, Wix Bookings, or Wix Restaurants, which blocks the installation of your app and prompts users to install the required app first.
    • Making your app dependent on a third-party app that implements the Service Plugin. There is currently no way to block installation on sites that don't have the third-party app installed, or to check that a site has installed the required app.
  • Implementation of this Service Plugin is dependent on configuration of the eCommerce Memberships Provider extension in the app dashboard:
NameTypeDescription
deploymentUristringRequired. Base URI where the endpoints are called. Wix eCommerce appends the endpoint path to the base URI. For example, to call the List Eligible Memberships endpoint at https://my-memberships.com/v1/list-eligible-memberships, the base URI you provide here is https://my-emberships.com/.

  • Configuration setup: When a site owner installs and authorizes your app to provide gift card operations, Wix will send a JSON Web Token (JWT) with an instance ID to your deployment URI + endpoint path. The app should collect the JWT, decode it, and store the resulting instance ID.
    For example, the token in this request:

    Copy

    Decodes into:

    Copy
Was this helpful?
Yes
No