• Documentation >
• Apps >
• Commerce >
• ProfitWell

ProfitWell

With ProfitWell modules in Ibexa Connect, you can:

• create, update, churn, un-churn, and list subscriptions

• update and delete users

• create, update, retrieve, and list plans

• list and retrieve customers

To get started with ProfitWell, create an account at profitwell.com.

Connect ProfitWell to Ibexa Connect

To connect ProfitWell app, you need to obtain the Private Token from your ProfitWell account and insert them in the ProfitWell module scenario.

1. Log in to your ProfitWell account.

2. Click Settings > Integrations > API Keys/ DEV KIT. Copy the Private Token to a safe place.

   

3. Log in to your Ibexa Connect account, insert a ProfitWell module scenario and click the Add button next to the Connection field.

   

4. In the Connection name field, enter a name for the connection.

5. In the Private Token field, enter the details copied in step 2 and click Save.

You have successfully established the connection. You can now begin editing your scenario and adding more ProfitWell modules. If your connection needs reauthorization at any point, follow the connection renewal steps here.

Subscriptions

You can create, update, churn, un-churn, and list subscriptions using the following modules.

List Subscriptions

Lists all subscriptions.

User ID or Alias	Select or map the User ID whose subscriptions you want to list.
Limit	Set the maximum number of subscriptions Ibexa Connect will return during one execution cycle. The default value is 10.

Create a Subscription

Creates a subscription.

For field descriptions, see the ProfitWell Subscriptions API reference.

Update a Subscription

Updates a subscription.

Customer ID	Select or map the Customer ID whose subscriptions you want to update.

For field descriptions, see the ProfitWell Subscriptions API reference.

Churn a Subscription

Removes a subscription.

Subscription ID or Alias	Select or map the Subscription ID you want to churn.

For field descriptions, see the ProfitWell Subscriptions API reference.

Un-churn Subscription

Un-churns a subscription.

Subscription ID or Alias	Select or map the Subscription ID you want to un-churn.

Users

You can update and delete users using the following modules.

Update a User

Updates a user.

User ID or Alias	Select or map the User ID whose details you want to update.
Email address	Enter a new email address.

Delete a User

Deletes a user.

User ID or Alias	Select or map the User ID you want to delete.

Plans

You can create, update, retrieve, and list plans using the following modules.

List Plans

Lists all plans.

Limit	Set the maximum number of plans Ibexa Connect will return during one execution cycle. The default value is 10.

Get a Plan

Gets a plan.

Plan ID	Select or map the Plan ID whose details you want to retrieve.

Create a New Plan

Creates a new plan.

Plan ID	Enter a Plan ID without conflicting with other manually added plan or a plan that comes from the connected data provider. For example, new_plan.
Name	Enter a name for the plan.

Update a Plan

Updates a plan.

Plan ID	Select or map the Plan ID whose details you want to update.
Name	Enter a new name for the plan.

Customers

You can list and retrieve customers using the following modules.

List Customers

Lists all customers.

Limit	Set the maximum number of customers Ibexa Connect will return during one execution cycle. The default value is 10.

For field descriptions, see the ProfitWell Customers API reference.

Get a Customer

Gets a customer.

Customer ID	Select or map the Customer ID whose details you want to retrieve.

Other

You can call APIs using the following module.

Make an API Call

Performs an arbitrary authorized API call.

Note

For the list of available endpoints, refer to the ProfitWell API documentation.

URL	Enter a path relative to https://api.profitwell.com. For example, /v2/plans/.
Method	GET to retrieve information for an entry. POST to create a new entry. PUT to update/replace an existing entry. PATCH to make a partial entry update. DELETE to delete an entry.
Headers	Enter the desired request headers. You don't have to add authorization headers; we already did that for you.
Query String	Enter the request query string.
Body	Enter the body content for your API call.

Example of use - Search Customers

The following API call returns all customers from your account.

URL: /v2/customers

Method: GET

The search matches can be found in the module's Output under Bundle > Body.

In our example, 10 customers returned: