Active
This application does not need additional settings. So you can make connection only by using your login credentials or by following the instructions below .

ProfitWell

With ProfitWell modules in Boost.space Integrator, 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 Boost.space Integrator

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.

    profitwell-1.png
  3. Log in to your Boost.space Integrator account, insert a ProfitWell module scenario and click the Add button next to the Connection field.

    profitwell-2.gif
  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.

Connection

Establish a connection to your ProfitWell account.

User ID or Alias

Select or map the User ID whose subscriptions you want to list.

Limit

Set the maximum number of subscriptions Boost.space Integrator 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.

Connection

Establish a connection to your ProfitWell account.

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.

Connection

Establish a connection to your ProfitWell account.

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.

Connection

Establish a connection to your ProfitWell account.

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.

Connection

Establish a connection to your ProfitWell account.

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.

Connection

Establish a connection to your ProfitWell account.

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.

Connection

Establish a connection to your ProfitWell account.

Limit

Set the maximum number of plans Boost.space Integrator will return during one execution cycle. The default value is 10.

Get a Plan

Gets a plan.

Connection

Establish a connection to your ProfitWell account.

Plan ID

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

Create a New Plan

Creates a new plan.

Connection

Establish a connection to your ProfitWell account.

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.

Connection

Establish a connection to your ProfitWell account.

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.

Connection

Establish a connection to your ProfitWell account.

Limit

Set the maximum number of customers Boost.space Integrator 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.

Connection

Establish a connection to your ProfitWell account.

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] Note

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

Connection

Establish a connection to your ProfitWell account.

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

profitwell-4.png

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

In our example, 10 customers returned:

profitwell-3.png