Skip to content
Documentation
Contact
← Back to documentation
Technical Reference

Paywhirl

PayWhirls intuitive tools make recurring billing easy. Sell subscriptions, pre-orders, payment plans, or whatever billing arrangements you can dream up.

CategoryAccounting
Authenticationcustom
Version0.1.0
Published scopes0 published scopes
Last updatedSeptember 21, 2026

Overview

Connect Paywhirl with Flows360

PayWhirls intuitive tools make recurring billing easy. Sell subscriptions, pre-orders, payment plans, or whatever billing arrangements you can dream up.

Use the Paywhirl connector to include its declared actions and events in Flows360 workflows without duplicating the integration logic inside each consuming system. This pinned connector version currently exposes 6 actions and no declared triggers.

Available actions

  • Cancel Subscription
  • Create Customer
  • Get Customers
  • Get Customer Subscriptions
  • Subscribe Customer
  • Custom API Call

Available triggers

  • No triggers are declared in this pinned package.

The capability list above is generated from the exact reviewed connector package so the public description stays aligned with the version Flows360 operates.

Technical guide

Technical reference

Package identity

  • Connector: Paywhirl
  • Package: @activepieces/piece-paywhirl@0.1.0
  • Exact artifact digest: sha256:bda02df6d4c9bfc18efb2b1ead183fa7a59e7e36c1f24cd4684b6d317502d783
  • Runtime: Activepieces-compatible deterministic worker
  • Source: the exact reviewed Activepieces source

Authentication

CUSTOM AUTH. Connection values are tenant-specific and remain in the consuming Studio instance; CDK stores definitions and field metadata, not customer credential values.

Action contracts

  • Cancel Subscription (cancelSubscription), Cancel a customer's existing subscription. This will prevent the subscription from making any additional charges and unbind the customer from the plan. Classification: read.
  • Create Customer (createCustomer), Create a new customer. This is required before binding a customer to a plan via a subscription. Classification: read.
  • Get Customers (getCustomer), Retrieve a selection of customers. Useful for keeping track of customers in a local database. Classification: read.
  • Get Customer Subscriptions (searchCustomersSubscription), Get a list of subscriptions associated with a given customer. Useful for determining which services a customer is currently expecting. Classification: read.
  • Subscribe Customer (subscribeCustomer), Enroll a customer in an existing plan. The customer must have a valid payment method on file. Classification: read.
  • Custom API Call (custom_api_call), Make a custom API call to a specific endpoint Classification: read.

Trigger contracts

  • No trigger delivery contracts are declared.

Verification

Deterministic execution evidence is recorded for the pinned artifact, including 1 exercised action entrypoint and 0 exercised trigger entrypoints.

Capability summary

Authenticationcustom
Supported objects6
Supported actions6
TriggersNone published

Authentication

Authentication method: custom

Authentication profiles

connection · custom
  • API Key Required · protected credential
  • API Secret Required · protected credential

Supported objects

ObjectReadWriteNotes
Cancel Subscription Yes No Cancel a customer's existing subscription. This will prevent the subscription from making any additional charges and unbind the customer from the plan.
Create Customer Yes No Create a new customer. This is required before binding a customer to a plan via a subscription.
Get Customers Yes No Retrieve a selection of customers. Useful for keeping track of customers in a local database.
Get Customer Subscriptions Yes No Get a list of subscriptions associated with a given customer. Useful for determining which services a customer is currently expecting.
Subscribe Customer Yes No Enroll a customer in an existing plan. The customer must have a valid payment method on file.
Custom API Call Yes No Make a custom API call to a specific endpoint

Supported actions

Cancel Subscription · Read

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

cancel_subscription · Risk: low · Retry: safe

Inputs

  • subscription_id · number · Optional, Subscription ID
  • customer_id · string · Optional, Customer ID (can be used instead of subscription_id)
Create Customer · Read

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

create_customer · Risk: low · Retry: safe

Inputs

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

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

get_customer · Risk: low · Retry: safe

Inputs

  • limit · number · Optional, Number of entries to return. Limit 100.
  • order_key · string · Optional, Field to sort by. Default: id
  • order_direction · string · Optional, Direction to order results
  • before_id · number · Optional, All customers returned will have an ID less than this value
  • after_id · number · Optional, All customers returned will have an ID greater than this value
  • keyword · string · Optional, Filter by keyword
Get Customer Subscriptions · Read

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

search_customers_subscription · Risk: low · Retry: safe

Inputs

  • customer_id · number · Required, Customer ID
  • status · string · Optional, Filter by subscription status. Active (default) excludes canceled; Canceled shows only canceled; All shows all subscriptions.
Subscribe Customer · Read

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

subscribe_customer · Risk: low · Retry: safe

Inputs

  • customer_id · number · Required, Customer ID
  • plan_id · number · Required, Plan ID
  • trial_end · number · Optional, UNIX timestamp in the future (UTC timezone)
  • promo_id · number · Optional, ID of promo code to apply
  • quantity · number · Optional, Quantity (Default: 1)
Custom API Call · Read

Make a custom API call to a specific endpoint

custom_api_call · Risk: low · Retry: safe

Inputs

  • url · object · Required
  • method · string · Required
  • headers · object · Optional, Authorization headers are injected automatically from your connection.
  • queryParams · object · Optional, Appended to the URL as ?key=value.
  • body_type · string · Optional
  • body · object · Optional
  • response_is_binary · boolean · Optional, Enable for files like PDFs, images, etc.
  • failsafe · boolean · Optional, On a failed request, output the error instead of failing the step.
  • timeout · number · Optional, Seconds to wait for a response. Empty: up to the flow limit (10 min).
  • followRedirects · boolean · Optional, Follow 3xx redirects instead of returning them as the response.

Setup

Setup

  1. Add the Paywhirl connector to the workflow in the target Flows360 Studio instance.
  2. Create or select the tenant-specific connection required by the connector. Connection secrets remain in the Studio connection boundary and are not copied into CDK documentation.
  3. Provide the connection fields declared by the pinned package:
  • API Key (api_key), required; stored as a sensitive connection value.
  • API Secret (api_secret), required; stored as a sensitive connection value.
  1. Select the required action or trigger and complete its declared input fields. Required and optional inputs are defined by the exact package schema.
  2. Test the workflow in the appropriate environment before enabling production scheduling or event delivery.

Limitations

Limitations and operational notes

  • This content describes @activepieces/piece-paywhirl@0.1.0; provider behaviour can change independently and should be revalidated when the provider or connector version changes.
  • Only the 6 actions and 0 triggers declared by this pinned package are represented here.
  • Tenant credentials and connection values are not stored in the public connector record.
  • Provider-side permissions, account entitlements, quotas and rate limits remain subject to the connected provider account and are not inferred when the package does not declare them.
  • Deterministic execution evidence is recorded for the pinned artifact, including 1 exercised action entrypoint and 0 exercised trigger entrypoints.

Troubleshooting

Why canu2019t the connector authenticate?

Check the tenant connection in Studio and confirm every required Paywhirl connection field is present. Re-authorise OAuth-based connections if the provider token or consent has expired. Do not place credential values in CDK content or logs.

Why is an action or trigger unavailable?

Confirm that the workflow is using @activepieces/piece-paywhirl@0.1.0 and compare the requested capability with the declared action and trigger list for this version. A capability that is not declared by the pinned package should not be presented as supported.

What should I check after a provider-side change?

Revalidate authentication, required fields, action/trigger behaviour and provider documentation before publishing refreshed connector content or moving a new package version into production.

github.com