PayWhirl

Manage subscription customers and billing with PayWhirl.

Finance and paymentsAPI key6 actionsAll integrations

On this page

Connect
Call it from a workflow
Actions (6)
createCustomer
cancelSubscription
custom_api_call
getCustomer
searchCustomersSubscription
subscribeCustomer
Details

Connect

Auth type: API key (secret_text). Paste the API key (or token) from the provider's settings into the connect dialog. It is encrypted at rest and only decrypted on the server when an action runs.

In the editor: Backend panel, Integrations tab, then Connect. This connects it for the project.
For every project in a workspace: Workspace settings, Integrations.
Owners and admins choose which integrations members may connect in the admin panel (Integrations tab), and can attach their own OAuth app there.

Call it from a workflow

Pass the action name and its input. The call resolves with { success, output, error? }; a missing connection resolves with success false and the reason. See ctx.integrations.invoke and ctx.integrations.call.

Native workflow

// .workflow.js (native ctx)
export async function run(ctx) {
  const res = await ctx.integrations.invoke("paywhirl", "createCustomer", {
    "first_name": "<first name>",
    "last_name": "<last name>",
    "email": "<email>",
    "currency": "<currency>"
  });
  if (!res.success) throw new Error(res.error);
  ctx.log.info("PayWhirl answered", { output: res.output });
}

defineWorkflow module

// defineWorkflow module (@app/sdk ctx)
import { defineWorkflow } from "@app/sdk";

export default defineWorkflow({
  id: "paywhirl-createcustomer",
  name: "PayWhirl: Create Customer",
  description: "Calls PayWhirl when a row is created.",
  trigger: { type: "entity_event", entity: "tickets", event: "created" },
  async run(ctx, event) {
    const res = await ctx.integrations.call("paywhirl", {
      "action": "createCustomer",
      "first_name": "<first name>",
      "last_name": "<last name>",
      "email": "<email>",
      "currency": "<currency>"
    }) as { success: boolean; error?: string };
    if (!res.success) throw new Error(res.error);
  },
});

From an app (connector proxy)

curl -X POST "$APP_ORIGIN/__appbricx/connector-proxy/paywhirl/createCustomer" \
  -H "Authorization: Bearer $APP_KEY" \
  -H "content-type: application/json" \
  -d '{"props":{"first_name":"<first name>","last_name":"<last name>","email":"<email>","currency":"<currency>"}}'

Actions

createCustomerin catalog

Create Customer. Create a new customer. This is required before binding a customer to a plan via a subscription.

Also accepted as create_customer.

Input	Type	Description
`first_name`required	text	First name
`last_name`required	text	Last name
`email`required	text	Email address
`currency`required	text	Currency code (ex. USD, GBP, AUD, CAD, EUR, etc)
`password`optional	text	Password (leave blank to let customer assign via secure link in welcome email)
`phone`optional	number	Phone number
`address`optional	long text	Street address
`city`optional	text	City
`state`optional	text	State / Region
`zip`optional	text	Zip / Postal Code
`country`optional	text	Country Code (ex. US, GB, CA, AU, etc)
`gateway_id`optional	text	PayWhirl ID of payment gateway to attach to customer. If left blank, first loaded gateway will be used.
`utm_source`optional	text	Acquisition source (ex. google, bing, email, fall_campaign, etc)
`utm_medium`optional	text	Acquisition medium (ex. CPC, banner, text_ad, etc)
`utm_term`optional	text	Acquisition keyword
`utm_content`optional	text	Acquisition Ad Content
`utm_campaign`optional	text	Acquisition Ad Campaign
`utm_group`optional	text	Acquisition Ad Group

cancelSubscription

Cancel Subscription. Cancel a customer's existing subscription. This will prevent the subscription from making any additional charges and unbind the customer from the plan.

Input	Type	Description
`subscription_id`optional	number	Subscription ID
`customer_id`optional	text	Customer ID (can be used instead of subscription_id)

custom_api_call

Custom API Call. Make a custom API call to a specific endpoint

Input	Type	Description
`url`required	object (depends on other props)	url
`method`required	one of "GET" \| "POST" \| "PATCH" \| "PUT" \| "DELETE" \| "HEAD"	Method
`headers`required	object	Authorization headers are injected automatically from your connection.
`queryParams`required	object	Query Parameters
`body_type`optional	one of "none" \| "json" \| "form_data" \| "raw"	Body Type
`body`optional	object (depends on other props)	Body
`response_is_binary`optional	boolean	Enable for files like PDFs, images, etc.
`failsafe`optional	boolean	No Error on Failure
`timeout`optional	number	Timeout (in seconds)
`followRedirects`optional	boolean	Follow redirects

getCustomer

Get Customers. Retrieve a selection of customers. Useful for keeping track of customers in a local database.

Input	Type	Description
`limit`optional	number	Number of entries to return. Limit 100.
`order_key`optional	text	Field to sort by. Default: id
`order_direction`optional	one of "asc" \| "desc"	Direction to order results
`before_id`optional	number	All customers returned will have an ID less than this value
`after_id`optional	number	All customers returned will have an ID greater than this value
`keyword`optional	text	Filter by keyword

searchCustomersSubscription

Get Customer Subscriptions. Get a list of subscriptions associated with a given customer. Useful for determining which services a customer is currently expecting.

Input	Type	Description
`customer_id`required	number	Customer ID
`status`optional	one of "active" \| "canceled" \| "all"	Filter by subscription status. Active (default) excludes canceled; Canceled shows only canceled; All shows all subscriptions.

subscribeCustomer

Subscribe Customer. Enroll a customer in an existing plan. The customer must have a valid payment method on file.

Input	Type	Description
`customer_id`required	number	Customer ID
`plan_id`required	number	Plan ID
`trial_end`optional	number	UNIX timestamp in the future (UTC timezone)
`promo_id`optional	number	ID of promo code to apply
`quantity`optional	number	Quantity (Default: 1)

Details

Id: paywhirl
Category: Finance and payments
Tags: subscriptions, billing, recurring, payments
Package: @activepieces/piece-paywhirl@0.0.5
Tier: Community