Chargebee - Apps Documentation

Requirements

To use Chargebee on WEXTL you need an active account and an API access token from your account settings.[3]

Get your Chargebee credentials

SitetextRequired
Chargebee site name only — not the full hostname. Example: acme-test.
[1]
API KeypasswordRequired
Settings → Configure Chargebee → API Keys. Use a full-access key.
[1]
Use test siteboolean
Connect to {site}-test.chargebee.com instead of the live site.
[1]
Business Entity IDtext
Only for multi-entity sites — sent as the chargebee-business-entity-id header.
[1]

Connect Chargebee in WEXTL

Log in to your WEXTL account, add the Chargebee node module to your workflow, and click Create new credential.
Instant triggers use webhooks — click Create a webhook first when adding one, then create the credential.
Optional: In the Credential name field, enter a name for the credential.
Enter the authentication credentials you copied from your Chargebee account, or follow the on-screen instructions to create the credential.
If prompted, authenticate your account and confirm access.
If you want to make changes to your credential in the future, follow the steps in Manage credentials →

Notes

Credentials are org-scoped; share them with teammates from the Credentials picker on any of its nodes.For detailed information on connecting an application, see Connect an application →

Chargebee node modules

The list below is a reference of every Chargebee node module the integration supports. You will be able to pick any of them on the workflow canvas while building automations.

Open any Chargebee node module below to inspect its input parameters, outputs, and connection requirements.

Watch EventsTrigger

Output fields[3]

Field	Type
Event	object
Event ID	text
Occurred At	date
Source	text
User	text
Origin User	text
Object	text
API Version	text
Event Type	text
Webhook Status	text
Content	text

Watch Events (Polling)Trigger

Output fields[3]

Field	Type
Event	object
Event ID	text
Occurred At	date
Source	text
User	text
Origin User	text
API Version	text
Event Type	text
Content	text
Webhooks	array

Get a CustomerSearch

Input fields[3]

Field	Type
Customer IDRequired	choice

Output fields[3]

Field	Type
Customer	object
ID	text
First Name	text
Last Name	text
Email	text
Phone	text
Company	text
Auto Collection	text
Net Term Days	number
Allow Direct Debit	boolean
VAT Number	text

Get a SubscriptionSearch

Input fields[3]

Field	Type
Subscription IDRequired	choice

Output fields[3]

Field	Type
Subscription	object
ID	text
Customer ID	text
Status	text
Currency Code	text
Billing Period	number
Billing Period Unit	text
Current Term Start	date
Current Term End	date
Next Billing At	date
Created At	date

Get Account Hierarchy for a CustomerSearch

Input fields[3]

Field	Type
Customer IDRequired	choice

Output fields[3]

Field	Type
Customer ID	text
Parent ID	text
Payment Owner ID	text
Invoice Owner ID	text
Has Children	boolean
Children IDs	array

List Attached ItemsSearch

Input fields[3]

Field	Type
Item IDRequired	choice
Max results	number

Output fields[3]

Field	Type
Attached Item	object
ID	text
Parent Item ID	text
Item ID	text
Type	text
Status	text
Quantity	number
Quantity (Decimal)	text
Billing Cycles	number
Charge On Event	text
Charge Once	boolean

List Contract Terms for a SubscriptionSearch

Input fields[3]

Field	Type
Subscription IDRequired	choice
Max results	number

Output fields[3]

Field	Type
Contract Term	object
ID	text
Status	text
Contract Start	date
Contract End	date
Billing Cycle	number
Total Contract Value	number
Action At Term End	text
Remaining Billing Cycles	number

List Coupon CodesSearch

Input fields[3]

Field	Type
Coupon ID	choice
Status	choice
Max results	number

Output fields[3]

Field	Type
Coupon Code	object
Code	text
Status	text
Coupon ID	text
Coupon Set ID	text
Coupon Set Name	text

List CouponsSearch

Input fields[3]

Field	Type
Status	choice
Discount Type	choice
Max results	number

Output fields[3]

Field	Type
Coupon	object
ID	text
Name	text
Invoice Name	text
Discount Type	text
Discount Percentage	number
Discount Amount	number
Discount Quantity	number
Currency Code	text
Duration Type	text
Valid From	date

List Credit NotesSearch

Input fields[3]

Field	Type
Customer ID	choice
Subscription ID	choice
Type	choice
Status	choice
Max results	number

Output fields[3]

Field	Type
Credit Note	object
ID	text
Customer ID	text
Subscription ID	text
Reference Invoice ID	text
Type	text
Reason Code	text
Status	text
Date	date
Currency Code	text
Total	number

List CustomersSearch

Input fields[3]

Field	Type
Email	text
Max results	number

Output fields[3]

Field	Type
Customer	object
ID	text
First Name	text
Last Name	text
Email	text
Phone	text
Company	text
Auto Collection	text
Net Term Days	number
Allow Direct Debit	boolean
VAT Number	text

List Discounts for a SubscriptionSearch

Input fields[3]

Field	Type
Subscription IDRequired	choice
Max results	number

Output fields[3]

Field	Type
Discount	object
ID	text
Invoice Name	text
Type	text
Apply On	text
Duration Type	text
Percentage	number
Amount	number
Period	number
Period Unit	text
Included In MRR	boolean

List EventsSearch

Input fields[3]

Field	Type
Event Type	choice
Webhook Status	choice
Source	choice
Occurred After	date
Occurred Before	date
Max results	number

Output fields[3]

Field	Type
Event	object
Event ID	text
Occurred At	date
Source	text
User	text
Origin User	text
API Version	text
Event Type	text
Content	text
Webhooks	array

List FeaturesSearch

Input fields[3]

Field	Type
Type	choice
Status	choice
Max results	number

Output fields[3]

Field	Type
Feature	object
ID	text
Name	text
Description	text
Status	text
Type	text
Unit	text
Metered	boolean
Created At	date
Updated At	date
Levels	array

List Hosted PagesSearch

Input fields[3]

Field	Type
Type	choice
State	choice
Max results	number

Output fields[3]

Field	Type
Hosted Page	object
ID	text
Type	text
URL	text
State	text
Pass Thru Content	text
Layout	text
Business Entity ID	text
Created At	date
Expires At	date
Updated At	date

List InvoicesSearch

Input fields[3]

Field	Type
Customer ID	choice
Subscription ID	choice
Status	choice
Max results	number

Output fields[3]

Field	Type
Invoice	object
ID	text
Customer ID	text
Subscription ID	text
Status	text
Date	date
Due Date	date
Currency Code	text
Total	number
Sub Total	number
Amount Paid	number

List Item FamiliesSearch

Input fields[3]

Field	Type
Name	text
Status	choice
Max results	number

Output fields[3]

Field	Type
Item Family	object
ID	text
Name	text
Description	text
Status	text
Channel	text
Business Entity ID	text
Updated At	date
Deleted	boolean

List Item PricesSearch

Input fields[3]

Field	Type
Item ID	choice
Item Family ID	choice
Status	choice
Max results	number

Output fields[3]

Field	Type
Item Price	object
ID	text
Name	text
Item ID	text
Item Family ID	text
Description	text
Status	text
External Name	text
Price Variant ID	text
Proration Type	text
Pricing Model	text

List ItemsSearch

Input fields[3]

Field	Type
Item Family ID	choice
Type	choice
Status	choice
Max results	number

Output fields[3]

Field	Type
Item	object
ID	text
Name	text
External Name	text
Description	text
Status	text
Type	text
Item Family ID	text
Is Shippable	boolean
Is Giftable	boolean
Redirect URL	text

List of Contacts for a CustomerSearch

Input fields[3]

Field	Type
Customer IDRequired	choice
Max results	number

Output fields[3]

Field	Type
Contact	object
ID	text
First Name	text
Last Name	text
Email	text
Phone	text
Label	text
Enabled	boolean
Send Billing Email	boolean
Send Account Email	boolean

List OrdersSearch

Input fields[3]

Field	Type
Subscription ID	choice
Invoice ID	choice
Status	choice
Max results	number

Output fields[3]

Field	Type
Order	object
ID	text
Customer ID	text
Subscription ID	text
Invoice ID	text
Status	text
Fulfillment Status	text
Order Type	text
Order Date	date
Currency Code	text
Total	number

List Payment SourcesSearch

Input fields[3]

Field	Type
Customer ID	choice
Subscription ID	choice
Type	choice
Status	choice
Include Deleted	boolean
Max results	number

Output fields[3]

Field	Type
Payment Source	object
ID	text
Resource Version	number
Customer ID	text
Type	text
Reference ID	text
Status	text
Gateway	text
Gateway Account ID	text
IP Address	text
Issuing Country	text

List Payments for an InvoiceSearch

Input fields[3]

Field	Type
Invoice IDRequired	choice
Max results	number

Output fields[3]

Field	Type
Transaction	object
ID	text
Status	text
Amount	number
Payment Method	text
Date	date
Reference Number	text
Currency Code	text
Customer ID	text
Gateway	text

List ProductsSearch

Input fields[3]

Field	Type
Status	choice
Shippable	boolean
Max results	number

Output fields[3]

Field	Type
Product	object
ID	text
Name	text
External Name	text
Description	text
Has Variant	boolean
Status	text
Shippable	boolean
SKU	text
Created At	date
Updated At	date

List QuotesSearch

Input fields[3]

Field	Type
Customer ID	choice
Subscription ID	choice
Status	choice
Max results	number

Output fields[3]

Field	Type
Quote	object
ID	text
Customer ID	text
Subscription ID	text
Invoice ID	text
Name	text
Status	text
Operation Type	text
Date	date
Valid Till	date
Currency Code	text

List Subscription EntitlementsSearch

Input fields[3]

Field	Type
Subscription IDRequired	choice
Max results	number

Output fields[3]

Field	Type
Subscription Entitlement	object
Feature ID	text
Feature Name	text
Value	text
Is Enabled	boolean
Is Overridden	boolean

List SubscriptionsSearch

Input fields[3]

Field	Type
Customer ID	choice
Status	choice
Max results	number

Output fields[3]

Field	Type
Subscription	object
ID	text
Customer ID	text
Status	text
Currency Code	text
Billing Period	number
Billing Period Unit	text
Current Term Start	date
Current Term End	date
Next Billing At	date
Created At	date

List TransactionsSearch

Input fields[3]

Field	Type
Customer ID	choice
Subscription ID	choice
Payment Source ID	text
Type	choice
Status	choice
Payment Method	choice
Max results	number

Output fields[3]

Field	Type
Transaction	object
ID	text
Customer ID	text
Subscription ID	text
Payment Source ID	text
Payment Method	text
Reference Number	text
Gateway	text
Gateway Account ID	text
Type	text
Date	date

List Unbilled ChargesSearch

Input fields[3]

Field	Type
Subscription ID	choice
Customer ID	choice
Max results	number

Output fields[3]

Field	Type
Unbilled Charge	object
ID	text
Customer ID	text
Subscription ID	text
Entity ID	text
Entity Type	text
Description	text
Date From	date
Date To	date
Unit Amount	number
Quantity	number

List Webhook EndpointsSearch

Input fields[3]

Field	Type
Max results	number

Output fields[3]

Field	Type
Webhook Endpoint	object
ID	text
Name	text
URL	text
Send Card Resource	boolean
Disabled	boolean
Primary URL	boolean
API Version	text
Chargebee Response Schema Type	text
Enabled Events	array

Retrieve a CouponSearch

Input fields[3]

Field	Type
Coupon IDRequired	choice

Output fields[3]

Field	Type
Coupon	object
ID	text
Name	text
Invoice Name	text
Discount Type	text
Discount Percentage	number
Discount Amount	number
Discount Quantity	number
Currency Code	text
Duration Type	text
Valid From	date

Retrieve a Coupon CodeSearch

Input fields[3]

Field	Type
Coupon CodeRequired	choice

Output fields[3]

Field	Type
Coupon Code	object
Code	text
Status	text
Coupon ID	text
Coupon Set ID	text
Coupon Set Name	text

Retrieve a Credit NoteSearch

Input fields[3]

Field	Type
Credit Note IDRequired	choice

Output fields[3]

Field	Type
Credit Note	object
ID	text
Customer ID	text
Subscription ID	text
Reference Invoice ID	text
Type	text
Reason Code	text
Status	text
Date	date
Currency Code	text
Total	number

Retrieve a FeatureSearch

Input fields[3]

Field	Type
Feature IDRequired	choice

Output fields[3]

Field	Type
Feature	object
ID	text
Name	text
Description	text
Status	text
Type	text
Unit	text
Metered	boolean
Created At	date
Updated At	date
Levels	array

Retrieve a Hosted PageSearch

Input fields[3]

Field	Type
Hosted Page IDRequired	choice

Output fields[3]

Field	Type
Hosted Page	object
ID	text
Type	text
URL	text
State	text
Pass Thru Content	text
Layout	text
Business Entity ID	text
Created At	date
Expires At	date
Updated At	date

Retrieve a Payment SourceSearch

Input fields[3]

Field	Type
Customer IDRequired	choice
Payment Source IDRequired	choice

Output fields[3]

Field	Type
Payment Source	object
ID	text
Resource Version	number
Customer ID	text
Type	text
Reference ID	text
Status	text
Gateway	text
Gateway Account ID	text
IP Address	text
Issuing Country	text

Retrieve A Portal SessionSearch

Input fields[3]

Field	Type
Portal Session IDRequired	text

Output fields[3]

Field	Type
Portal Session	object
ID	text
Token	text
Access URL	text
Redirect URL	text
Status	text
Created At	date
Expires At	date
Customer ID	text
Login At	date
Logout At	date

Retrieve a ProductSearch

Input fields[3]

Field	Type
Product IDRequired	choice

Output fields[3]

Field	Type
Product	object
ID	text
Name	text
External Name	text
Description	text
Has Variant	boolean
Status	text
Shippable	boolean
SKU	text
Created At	date
Updated At	date

Retrieve a QuoteSearch

Input fields[3]

Field	Type
Quote IDRequired	choice

Output fields[3]

Field	Type
Quote	object
ID	text
Customer ID	text
Subscription ID	text
Invoice ID	text
Name	text
Status	text
Operation Type	text
Date	date
Valid Till	date
Currency Code	text

Retrieve a TransactionSearch

Input fields[3]

Field	Type
Transaction IDRequired	choice

Output fields[3]

Field	Type
Transaction	object
ID	text
Customer ID	text
Subscription ID	text
Payment Source ID	text
Payment Method	text
Reference Number	text
Gateway	text
Gateway Account ID	text
Type	text
Date	date

Retrieve a UsageSearch

Input fields[3]

Field	Type
Subscription IDRequired	choice
Usage IDRequired	text

Output fields[3]

Field	Type
Usage	object
ID	text
Subscription ID	text
Item Price ID	text
Quantity	text
Usage Date	date
Note	text
Created At	date

Retrieve a Webhook EndpointSearch

Input fields[3]

Field	Type
Webhook Endpoint IDRequired	choice

Output fields[3]

Field	Type
Webhook Endpoint	object
ID	text
Name	text
URL	text
Send Card Resource	boolean
Disabled	boolean
Primary URL	boolean
API Version	text
Chargebee Response Schema Type	text
Enabled Events	array

Retrieve Advance Invoice ScheduleSearch

Input fields[3]

Field	Type
Subscription IDRequired	choice

Output fields[3]

Field	Type
ID	text
Schedule Type	text

Retrieve an EventSearch

Input fields[3]

Field	Type
Event IDRequired	choice

Output fields[3]

Field	Type
Event	object
Event ID	text
Occurred At	date
Source	text
User	text
Origin User	text
API Version	text
Event Type	text
Content	text
Webhooks	array

Retrieve an InvoiceSearch

Input fields[3]

Field	Type
Invoice IDRequired	choice

Output fields[3]

Field	Type
Invoice	object
ID	text
Customer ID	text
Subscription ID	text
Status	text
Date	date
Due Date	date
Currency Code	text
Total	number
Sub Total	number
Amount Paid	number

Retrieve an ItemSearch

Input fields[3]

Field	Type
Item IDRequired	choice

Output fields[3]

Field	Type
Item	object
ID	text
Name	text
External Name	text
Description	text
Status	text
Type	text
Item Family ID	text
Is Shippable	boolean
Is Giftable	boolean
Redirect URL	text

Retrieve an Item FamilySearch

Input fields[3]

Field	Type
Item Family IDRequired	choice

Output fields[3]

Field	Type
Item Family	object
ID	text
Name	text
Description	text
Status	text
Channel	text
Business Entity ID	text
Updated At	date
Deleted	boolean

Retrieve an Item PriceSearch

Input fields[3]

Field	Type
Item Price IDRequired	choice

Output fields[3]

Field	Type
Item Price	object
ID	text
Name	text
Item ID	text
Item Family ID	text
Description	text
Status	text
External Name	text
Price Variant ID	text
Proration Type	text
Pricing Model	text

Retrieve an OrderSearch

Input fields[3]

Field	Type
Order IDRequired	choice

Output fields[3]

Field	Type
Order	object
ID	text
Customer ID	text
Subscription ID	text
Invoice ID	text
Status	text
Fulfillment Status	text
Order Type	text
Order Date	date
Currency Code	text
Total	number

Retrieve Payment Schedules for an InvoiceSearch

Input fields[3]

Field	Type
Invoice IDRequired	choice
Max results	number

Output fields[3]

Field	Type
ID	text
Amount	number
Currency Code	text
Entity ID	text
Entity Type	text
Scheme ID	text
Created At	date
Updated At	date

Subscription Renewal EstimateSearch

Input fields[3]

Field	Type
Subscription IDRequired	choice

Output fields[3]

Field	Type
Created At	date
Invoice Estimate	object
Amount Due	number
Sub Total	number
Total	number
Currency Code	text

Accept A QuoteAction

Input fields[3]

Field	Type
Redirect URL	text
Layout	choice
Quote IDRequired	choice

Output fields[3]

Field	Type
Hosted Page	object
ID	text
Type	text
URL	text
State	text
Pass Thru Content	text
Layout	text
Business Entity ID	text
Created At	date
Expires At	date
Updated At	date

Acknowledge A Hosted PageAction

Input fields[3]

Field	Type
Hosted Page IDRequired	choice

Output fields[3]

Field	Type
Hosted Page	object
ID	text
Type	text
URL	text
State	text
Pass Thru Content	text
Layout	text
Business Entity ID	text
Created At	date
Expires At	date
Updated At	date

Activate A Portal SessionAction

Input fields[3]

Field	Type
Portal Session IDRequired	text
TokenRequired	text

Output fields[3]

Field	Type
Portal Session	object
ID	text
Token	text
Access URL	text
Redirect URL	text
Status	text
Created At	date
Expires At	date
Customer ID	text
Login At	date
Logout At	date

Add a Charge-Item to a Pending InvoiceAction

Input fields[3]

Field	Type
Invoice IDRequired	choice
Item Price IDRequired	choice
Quantity	number
Unit Price	number
Subscription ID	choice
Comment	text
Additional Fields	array
Field NameRequired	text
ValueRequired	text

Output fields[3]

Field	Type
Invoice	object
ID	text
Customer ID	text
Subscription ID	text
Status	text
Date	date
Due Date	date
Currency Code	text
Total	number
Sub Total	number
Amount Paid	number

Add Contacts to a CustomerAction

Input fields[3]

Field	Type
Customer IDRequired	choice
Contact Reference ID	text
First Name	text
Last Name	text
EmailRequired	text
Phone	text
Label	text
Enabled	boolean

2other input fields

Output fields[3]

Field	Type
Customer	object
ID	text
First Name	text
Last Name	text
Email	text
Phone	text
Company	text
Auto Collection	text
Net Term Days	number
Allow Direct Debit	boolean
VAT Number	text

Add One-Time Charge to a Pending InvoiceAction

Input fields[3]

Field	Type
Invoice IDRequired	choice
AmountRequired	number
DescriptionRequired	text
Subscription ID	choice
Comment	text
Additional Fields	array
Field NameRequired	text
ValueRequired	text

Output fields[3]

Field	Type
Invoice	object
ID	text
Customer ID	text
Subscription ID	text
Status	text
Date	date
Due Date	date
Currency Code	text
Total	number
Sub Total	number
Amount Paid	number

Apply Credits for an InvoiceAction

Input fields[3]

Field	Type
Invoice IDRequired	choice
Credit Note ID	choice
Comment	text
Additional Fields	array
Field NameRequired	text
ValueRequired	text

Output fields[3]

Field	Type
Invoice	object
ID	text
Customer ID	text
Subscription ID	text
Status	text
Date	date
Due Date	date
Currency Code	text
Total	number
Sub Total	number
Amount Paid	number

Apply Payments for an InvoiceAction

Input fields[3]

Field	Type
Invoice IDRequired	choice
Transaction ID	choice
Amount	number
Comment	text
Additional Fields	array
Field NameRequired	text
ValueRequired	text

Output fields[3]

Field	Type
Invoice	object
ID	text
Customer ID	text
Subscription ID	text
Status	text
Date	date
Due Date	date
Currency Code	text
Total	number
Sub Total	number
Amount Paid	number

Cancel a SubscriptionAction

Input fields[3]

Field	Type
Subscription IDRequired	choice
Cancel Option	choice
Cancel At	date
Apply At End Of Term	boolean
Unbilled Charges	choice
Credit Option (Current Term Charges)	choice
Account Receivables Handling	choice
Invoice Date	date

2other input fields

Output fields[3]

Field	Type
Subscription	object
ID	text
Customer ID	text
Status	text
Currency Code	text
Billing Period	number
Billing Period Unit	text
Current Term Start	date
Current Term End	date
Next Billing At	date
Created At	date

Cancel an OrderAction

Input fields[3]

Field	Type
Order IDRequired	choice
Cancellation ReasonRequired	choice
Customer Notes	text
Comment	text
Credit Note Total	number
Additional Fields	array
Field NameRequired	text
ValueRequired	text

Output fields[3]

Field	Type
Order	object
ID	text
Customer ID	text
Subscription ID	text
Invoice ID	text
Status	text
Fulfillment Status	text
Order Type	text
Order Date	date
Currency Code	text
Total	number

Change Term EndAction

Input fields[3]

Field	Type
Subscription IDRequired	choice
Term Ends AtRequired	date
Prorate	boolean
Invoice Immediately	boolean

Output fields[3]

Field	Type
Subscription	object
ID	text
Customer ID	text
Status	text
Currency Code	text
Billing Period	number
Billing Period Unit	text
Current Term Start	date
Current Term End	date
Next Billing At	date
Created At	date

Charge Future RenewalsAction

Input fields[3]

Field	Type
Subscription IDRequired	choice
Terms To Charge	number
Invoice Immediately	boolean
Schedule Type	choice
Additional Fields	array
Field NameRequired	text
ValueRequired	text

Output fields[3]

Field	Type
Subscription	object
ID	text
Customer ID	text
Status	text
Currency Code	text
Billing Period	number
Billing Period Unit	text
Current Term Start	date
Current Term End	date
Next Billing At	date
Created At	date

Checkout Charge-Items And One-Time ChargesAction

Input fields[3]

Field	Type
Redirect URL	text
Cancel URL	text
Currency Code	text
Invoice Note	text
Customer ID	choice
New Customer Email	text
Item Price ID	choice
Quantity	number

3other input fields

Output fields[3]

Field	Type
Hosted Page	object
ID	text
Type	text
URL	text
State	text
Pass Thru Content	text
Layout	text
Business Entity ID	text
Created At	date
Expires At	date
Updated At	date

Checkout Gift Subscription For ItemsAction

Input fields[3]

Field	Type
Redirect URL	text
Business Entity ID	text
Coupon	choice
Gifter Customer IDRequired	choice
Item Price IDRequired	choice
Quantity	number
Additional Fields	array
Field NameRequired	text
ValueRequired	text

Output fields[3]

Field	Type
Hosted Page	object
ID	text
Type	text
URL	text
State	text
Pass Thru Content	text
Layout	text
Business Entity ID	text
Created At	date
Expires At	date
Updated At	date

Close a Pending InvoiceAction

Input fields[3]

Field	Type
Invoice IDRequired	choice
Comment	text
Invoice Note	text
Remove General Note	boolean
Invoice Date	date
Additional Fields	array
Field NameRequired	text
ValueRequired	text

Output fields[3]

Field	Type
Invoice	object
ID	text
Customer ID	text
Subscription ID	text
Status	text
Date	date
Due Date	date
Currency Code	text
Total	number
Sub Total	number
Amount Paid	number

Collect NowAction

Input fields[3]

Field	Type
Redirect URL	text
Currency Code	text
Payment Method Save Policy	choice
Customer IDRequired	choice
Card Gateway Account ID	text

Output fields[3]

Field	Type
Hosted Page	object
ID	text
Type	text
URL	text
State	text
Pass Thru Content	text
Layout	text
Business Entity ID	text
Created At	date
Expires At	date
Updated At	date

Collect Payment for an InvoiceAction

Input fields[3]

Field	Type
Invoice IDRequired	choice
Customer ID	choice
Amount	number
Payment Source ID	choice
Authorization Transaction ID	text
Payment Initiator	choice
Comment	text
Additional Fields	array
Field NameRequired	text
ValueRequired	text

Output fields[3]

Field	Type
Invoice	object
ID	text
Customer ID	text
Subscription ID	text
Status	text
Date	date
Due Date	date
Currency Code	text
Total	number
Sub Total	number
Amount Paid	number
Transaction	object
ID	text
Status	text
Amount	number
Payment Method	text
Date	date
Reference Number	text
Currency Code	text
Customer ID	text
Gateway	text

Collect Payment for CustomerAction

Input fields[3]

Field	Type
Customer IDRequired	choice
Amount	number
Payment Source ID	choice
Token ID	text
Replace Primary Payment Source	boolean
Retain Payment Source	boolean
Payment Initiator	choice
Additional Fields	array
Field NameRequired	text
ValueRequired	text

Output fields[3]

Field	Type
Customer	object
ID	text
First Name	text
Last Name	text
Email	text
Phone	text
Company	text
Auto Collection	text
Net Term Days	number
Allow Direct Debit	boolean
VAT Number	text
Transaction	object
ID	text
Amount	number
Currency Code	text
Date	date
Payment Method	text
Reference Number	text
Status	text

Convert a QuoteAction

Input fields[3]

Field	Type
Quote IDRequired	choice
Invoice Date	date
Invoice Immediately	boolean
Create Pending Invoices	boolean
First Invoice Pending	boolean
Subscription Auto Collection	choice
Subscription PO Number	text
Additional Fields	array
Field NameRequired	text
ValueRequired	text

Output fields[3]

Field	Type
Quote	object
ID	text
Customer ID	text
Subscription ID	text
Invoice ID	text
Name	text
Status	text
Operation Type	text
Date	date
Valid Till	date
Currency Code	text
Invoice	object
ID	text
Customer ID	text
Subscription ID	text
Status	text
Date	date
Due Date	date
Currency Code	text
Total	number
Sub Total	number
Amount Paid	number

Copy CardAction

Input fields[3]

Field	Type
Customer IDRequired	choice
Gateway Account IDRequired	text

Output fields[3]

Field	Type
Third Party Payment Method	object
ID	text
Status	text

Create a Bank Account Payment SourceAction

Input fields[3]

Field	Type
Customer IDRequired	choice
Issuing Country	text
Replace Primary Payment Source	boolean
IBAN	text
Account Holder First Name	text
Account Holder Last Name	text
Bank Name	text
Account Number	secret

4other input fields

Output fields[3]

Field	Type
Customer	object
ID	text
First Name	text
Last Name	text
Email	text
Payment Source	object
ID	text
Resource Version	number
Customer ID	text
Type	text
Reference ID	text
Status	text
Gateway	text
Gateway Account ID	text
IP Address	text
Issuing Country	text

Create a Card Payment SourceAction

Input fields[3]

Field	Type
Customer IDRequired	choice
Replace Primary Payment Source	boolean
Gateway Account ID	text
Cardholder First Name	text
Cardholder Last Name	text
Card NumberRequired	secret
Expiry MonthRequired	number
Expiry YearRequired	number

6other input fields

Output fields[3]

Field	Type
Customer	object
ID	text
First Name	text
Last Name	text
Email	text
Payment Source	object
ID	text
Resource Version	number
Customer ID	text
Type	text
Reference ID	text
Status	text
Gateway	text
Gateway Account ID	text
IP Address	text
Issuing Country	text

Create a Coupon for ItemsAction

Input fields[3]

Field	Type
IDRequired	text
NameRequired	text
Apply OnRequired	choice
Invoice Name	text
Discount Type	choice
Discount Amount	number
Discount Percentage	number
Discount Quantity	number

11other input fields

Output fields[3]

Field	Type
Coupon	object
ID	text
Name	text
Invoice Name	text
Discount Type	text
Discount Percentage	number
Discount Amount	number
Discount Quantity	number
Currency Code	text
Duration Type	text
Valid From	date

Create a CustomerAction

Input fields[3]

Field	Type
Customer ID	text
First Name	text
Last Name	text
Email	text
Phone	text
Company	text
Auto Collection	choice
Net Term Days	number

6other input fields

Output fields[3]

Field	Type
Customer	object
ID	text
First Name	text
Last Name	text
Email	text
Phone	text
Company	text
Auto Collection	text
Net Term Days	number
Allow Direct Debit	boolean
VAT Number	text

Create a FeatureAction

Input fields[3]

Field	Type
ID	text
NameRequired	text
Description	text
Type	choice
Status	choice
Unit	text
Level Name	text
Level Value	text

3other input fields

Output fields[3]

Field	Type
Feature	object
ID	text
Name	text
Description	text
Status	text
Type	text
Unit	text
Metered	boolean
Created At	date
Updated At	date
Levels	array

Create a Payment Schedule EstimateAction

Input fields[3]

Field	Type
Scheme IDRequired	text
Invoice ID	choice
Amount	number
Payment Schedule Start Date	date
Additional Fields	array
Field NameRequired	text
ValueRequired	text

Output fields[3]

Field	Type
Estimate	object
Created At	date
Payment Schedule Estimates	array

Create A Portal SessionAction

Input fields[3]

Field	Type
Redirect URL	text
Forward URL	text
Customer IDRequired	choice

Output fields[3]

Field	Type
Portal Session	object
ID	text
Token	text
Access URL	text
Redirect URL	text
Status	text
Created At	date
Expires At	date
Customer ID	text
Login At	date
Logout At	date

Create a ProductAction

Input fields[3]

Field	Type
NameRequired	text
External NameRequired	text
StatusRequired	choice
ID	text
Description	text
SKU	text
Shippable	boolean
Metadata	text

Output fields[3]

Field	Type
Product	object
ID	text
Name	text
External Name	text
Description	text
Has Variant	boolean
Status	text
Shippable	boolean
SKU	text
Created At	date
Updated At	date

Create a Quote for Subscription UpdateAction

Input fields[3]

Field	Type
Subscription IDRequired	choice
Name	text
Notes	text
Expires At	date
Replace Items List	boolean
Billing Cycles	number
Item Price IDRequired	choice
Quantity	number

4other input fields

Output fields[3]

Field	Type
Quote	object
ID	text
Customer ID	text
Subscription ID	text
Invoice ID	text
Name	text
Status	text
Operation Type	text
Date	date
Valid Till	date
Currency Code	text

Create a Refundable Credit NoteAction

Input fields[3]

Field	Type
Order IDRequired	choice
Reason CodeRequired	choice
TotalRequired	number
Customer Notes	text
Comment	text
Additional Fields	array
Field NameRequired	text
ValueRequired	text

Output fields[3]

Field	Type
Order	object
ID	text
Customer ID	text
Subscription ID	text
Invoice ID	text
Status	text
Fulfillment Status	text
Order Type	text
Order Date	date
Currency Code	text
Total	number

Create a UsageAction

Input fields[3]

Field	Type
Subscription IDRequired	choice
Item Price IDRequired	choice
QuantityRequired	text
Usage DateRequired	date
Usage ID	text
Note	text

Output fields[3]

Field	Type
Usage	object
ID	text
Subscription ID	text
Item Price ID	text
Quantity	text
Usage Date	date
Note	text
Created At	date

Create an Authorization PaymentAction

Input fields[3]

Field	Type
Customer IDRequired	choice
Payment Source ID	choice
Currency Code	text
AmountRequired	number
Additional Fields	array
Field NameRequired	text
ValueRequired	text

Output fields[3]

Field	Type
Transaction	object
ID	text
Customer ID	text
Subscription ID	text
Payment Source ID	text
Payment Method	text
Reference Number	text
Gateway	text
Gateway Account ID	text
Type	text
Date	date

Create an Invoice for Unbilled ChargesAction

Input fields[3]

Field	Type
Subscription ID	choice
Customer ID	choice
Additional Fields	array
Field NameRequired	text
ValueRequired	text

Output fields[3]

Field	Type
Invoices	array

Create an ItemAction

Input fields[3]

Field	Type
IDRequired	text
NameRequired	text
TypeRequired	choice
Item Family ID	choice
Description	text
External Name	text
Unit	text
Is Shippable	boolean

8other input fields

Output fields[3]

Field	Type
Item	object
ID	text
Name	text
External Name	text
Description	text
Status	text
Type	text
Item Family ID	text
Is Shippable	boolean
Is Giftable	boolean
Redirect URL	text

Create an Item FamilyAction

Input fields[3]

Field	Type
IDRequired	text
NameRequired	text
Description	text
Business Entity ID	text

Output fields[3]

Field	Type
Item Family	object
ID	text
Name	text
Description	text
Status	text
Channel	text
Business Entity ID	text
Updated At	date
Deleted	boolean

Create an Item PriceAction

Input fields[3]

Field	Type
IDRequired	text
NameRequired	text
Item IDRequired	choice
Description	text
External Name	text
Currency Code	text
Pricing Model	choice
Price	number

13other input fields

Output fields[3]

Field	Type
Item Price	object
ID	text
Name	text
Item ID	text
Item Family ID	text
Description	text
Status	text
External Name	text
Price Variant ID	text
Proration Type	text
Pricing Model	text

Create an OrderAction

Input fields[3]

Field	Type
Invoice IDRequired	choice
Status	choice
Reference ID	text
Fulfillment Status	text
Note	text
Tracking ID	text
Tracking URL	text
Batch ID	text

1other input field

Output fields[3]

Field	Type
Order	object
ID	text
Customer ID	text
Subscription ID	text
Invoice ID	text
Status	text
Fulfillment Status	text
Order Type	text
Order Date	date
Currency Code	text
Total	number

Create Checkout For A New SubscriptionAction

Input fields[3]

Field	Type
Redirect URL	text
Cancel URL	text
Business Entity ID	text
Customer ID	choice
New Customer Email	text
New Customer First Name	text
New Customer Last Name	text
Coupon	choice

4other input fields

Output fields[3]

Field	Type
Hosted Page	object
ID	text
Type	text
URL	text
State	text
Pass Thru Content	text
Layout	text
Business Entity ID	text
Created At	date
Expires At	date
Updated At	date

Create Checkout To Update A SubscriptionAction

Input fields[3]

Field	Type
Redirect URL	text
Cancel URL	text
Subscription IDRequired	choice
Replace Items List	boolean
Coupon	choice
Item Price ID	choice
Quantity	number
Additional Fields	array
Field NameRequired	text
ValueRequired	text

Output fields[3]

Field	Type
Hosted Page	object
ID	text
Type	text
URL	text
State	text
Pass Thru Content	text
Layout	text
Business Entity ID	text
Created At	date
Expires At	date
Updated At	date

Create Credit NoteAction

Input fields[3]

Field	Type
TypeRequired	choice
Reference Invoice ID	choice
Customer ID	choice
Reason Code	choice
Total	number
Date	date
Customer Notes	text
Currency Code	text

5other input fields

Output fields[3]

Field	Type
Credit Note	object
ID	text
Customer ID	text
Subscription ID	text
Reference Invoice ID	text
Type	text
Reason Code	text
Status	text
Date	date
Currency Code	text
Total	number
Invoice	object
ID	text
Customer ID	text
Subscription ID	text
Status	text
Date	date
Due Date	date
Currency Code	text
Total	number
Sub Total	number
Amount Paid	number

Create Invoice for Items and One-Time ChargesAction

Input fields[3]

Field	Type
Customer ID	choice
Subscription ID	choice
Currency Code	text
Invoice Note	text
PO Number	text
Item Price ID	choice
Quantity	number
Unit Price	number

11other input fields

Output fields[3]

Field	Type
Invoice	object
ID	text
Customer ID	text
Subscription ID	text
Status	text
Date	date
Due Date	date
Currency Code	text
Total	number
Sub Total	number
Amount Paid	number

Create Invoice for Items EstimateAction

Input fields[3]

Field	Type
Customer ID	choice
Subscription ID	choice
PO Number	text
Item Price ID	choice
Quantity	number
One-Time Charge Amount	number
One-Time Charge Description	text
Additional Fields	array
Field NameRequired	text
ValueRequired	text

Output fields[3]

Field	Type
Estimate	object
Created At	date
Invoice Estimate	object

Create Unbilled Charges for Item SubscriptionAction

Input fields[3]

Field	Type
Subscription IDRequired	choice
Currency Code	text
Item Price ID	choice
Quantity	number
Unit Price	number
Date From	date
Date To	date
Additional Fields	array
Field NameRequired	text
ValueRequired	text

Output fields[3]

Field	Type
Unbilled Charges	array

Create Using Permanent TokenAction

Input fields[3]

Field	Type
Customer IDRequired	choice
TypeRequired	choice
Gateway Account ID	text
Reference ID (Permanent Token)	text
Issuing Country	text
Replace Primary Payment Source	boolean
Payment Method Token	text
Customer Profile Token	text

1other input field

Output fields[3]

Field	Type
Customer	object
ID	text
First Name	text
Last Name	text
Email	text
Payment Source	object
ID	text
Resource Version	number
Customer ID	text
Type	text
Reference ID	text
Status	text
Gateway	text
Gateway Account ID	text
IP Address	text
Issuing Country	text

Delete a CouponAction

Input fields[3]

Field	Type
Coupon IDRequired	choice

Output fields[3]

Field	Type
Coupon	object
ID	text
Name	text
Invoice Name	text
Discount Type	text
Discount Percentage	number
Discount Amount	number
Discount Quantity	number
Currency Code	text
Duration Type	text
Valid From	date

Delete a CustomerAction

Input fields[3]

Field	Type
Customer IDRequired	choice
Delete Payment Method	boolean

Output fields[3]

Field	Type
Customer	object
ID	text
First Name	text
Last Name	text
Email	text
Phone	text
Company	text
Auto Collection	text
Net Term Days	number
Allow Direct Debit	boolean
VAT Number	text

Delete a FeatureAction

Input fields[3]

Field	Type
Feature IDRequired	choice

Output fields[3]

Field	Type
Feature	object
ID	text
Name	text
Description	text
Status	text
Type	text
Unit	text
Metered	boolean
Created At	date
Updated At	date
Levels	array

Delete a Payment SourceAction

Input fields[3]

Field	Type
Customer IDRequired	choice
Payment Source IDRequired	choice

Output fields[3]

Field	Type
Customer	object
ID	text
First Name	text
Last Name	text
Email	text
Payment Source	object
ID	text
Resource Version	number
Customer ID	text
Type	text
Reference ID	text
Status	text
Gateway	text
Gateway Account ID	text
IP Address	text
Issuing Country	text

Delete a QuoteAction

Input fields[3]

Field	Type
Quote IDRequired	choice
Comment	text
Additional Fields	array
Field NameRequired	text
ValueRequired	text

Output fields[3]

Field	Type
Quote	object
ID	text
Customer ID	text
Subscription ID	text
Invoice ID	text
Name	text
Status	text
Operation Type	text
Date	date
Valid Till	date
Currency Code	text

Delete a SubscriptionAction

Input fields[3]

Field	Type
Subscription IDRequired	choice

Output fields[3]

Field	Type
Subscription	object
ID	text
Customer ID	text
Status	text
Currency Code	text
Billing Period	number
Billing Period Unit	text
Current Term Start	date
Current Term End	date
Next Billing At	date
Created At	date

Delete an InvoiceAction

Input fields[3]

Field	Type
Invoice IDRequired	choice
Comment	text
Claim Credits	boolean
Additional Fields	array
Field NameRequired	text
ValueRequired	text

Output fields[3]

Field	Type
Invoice	object
ID	text
Customer ID	text
Subscription ID	text
Status	text
Date	date
Due Date	date
Currency Code	text
Total	number
Sub Total	number
Amount Paid	number

Delete an ItemAction

Input fields[3]

Field	Type
Item IDRequired	choice

Output fields[3]

Field	Type
Item	object
ID	text
Name	text
External Name	text
Description	text
Status	text
Type	text
Item Family ID	text
Is Shippable	boolean
Is Giftable	boolean
Redirect URL	text

Delete an Item FamilyAction

Input fields[3]

Field	Type
Item Family IDRequired	choice

Output fields[3]

Field	Type
Item Family	object
ID	text
Name	text
Description	text
Status	text
Channel	text
Business Entity ID	text
Updated At	date
Deleted	boolean

Delete an Item PriceAction

Input fields[3]

Field	Type
Item Price IDRequired	choice

Output fields[3]

Field	Type
Item Price	object
ID	text
Name	text
Item ID	text
Item Family ID	text
Description	text
Status	text
External Name	text
Price Variant ID	text
Proration Type	text
Pricing Model	text

Delete an Unbilled ChargeAction

Input fields[3]

Field	Type
Unbilled Charge IDRequired	choice

Output fields[3]

Field	Type
Unbilled Charge	object
ID	text
Customer ID	text
Subscription ID	text
Entity ID	text
Entity Type	text
Description	text
Date From	date
Date To	date
Unit Amount	number
Quantity	number

Delete Card for a CustomerAction

Input fields[3]

Field	Type
Customer IDRequired	choice

Output fields[3]

Field	Type
Customer	object
ID	text
First Name	text
Last Name	text
Email	text
Phone	text
Company	text
Auto Collection	text
Net Term Days	number
Allow Direct Debit	boolean
VAT Number	text

Delete Contacts for a CustomerAction

Input fields[3]

Field	Type
Customer IDRequired	choice
Contact IDRequired	choice

Output fields[3]

Field	Type
Customer	object
ID	text
First Name	text
Last Name	text
Email	text
Phone	text
Company	text
Auto Collection	text
Net Term Days	number
Allow Direct Debit	boolean
VAT Number	text

Edit Advance Invoice ScheduleAction

Input fields[3]

Field	Type
Subscription IDRequired	choice
Terms To Charge	number
Schedule TypeRequired	choice
Number Of Occurrences	number
Days Before Renewal	number
End Schedule On	choice
End Date	date
Additional Fields	array
Field NameRequired	text
ValueRequired	text

Output fields[3]

Field	Type
ID	text
Schedule Type	text

Enable or Disable Subscription EntitlementsAction

Input fields[3]

Field	Type
Subscription IDRequired	choice
Feature IDRequired	choice
Is EnabledRequired	boolean
Additional Fields	array
Field NameRequired	text
ValueRequired	text

Output fields[3]

Field	Type
Subscription Entitlement	array

Estimate for Creating a Customer and SubscriptionAction

Input fields[3]

Field	Type
Item Price IDRequired	choice
Quantity	number
Billing Cycles	number
Coupon ID	choice
Billing Alignment Mode	choice
Start Date	date
Trial End	date
Customer VAT Number	text

3other input fields

Output fields[3]

Field	Type
Estimate	object
Created At	date
Subscription Estimate	object
Invoice Estimate	object
Next Invoice Estimate	object

Estimate for Updating a SubscriptionAction

Input fields[3]

Field	Type
Subscription IDRequired	choice
Item Price ID	choice
Quantity	number
Replace Items List	boolean
Prorate	boolean
Apply At End Of Term	boolean
Invoice Immediately	boolean
Coupon ID	choice

1other input field

Output fields[3]

Field	Type
Estimate	object
Created At	date
Subscription Estimate	object
Invoice Estimate	object
Next Invoice Estimate	object
Credit Note Estimates	array

Logout A Portal SessionAction

Input fields[3]

Field	Type
Portal Session IDRequired	text

Output fields[3]

Field	Type
Portal Session	object
ID	text
Token	text
Access URL	text
Redirect URL	text
Status	text
Created At	date
Expires At	date
Customer ID	text
Login At	date
Logout At	date

Make an API Calluniversal

Input fields[3]

Field	Type
URLRequired	text
MethodRequired	choice
Headers	array
Header	object
Query String	array
Parameter	object
Body	text

Output fields[3]

Field	Type
Body	text
Headers	object
Status code	number

Manage Payment SourcesAction

Input fields[3]

Field	Type
Business Entity ID	text
Redirect URL	text
Customer IDRequired	choice
Card Gateway Account ID	text

Output fields[3]

Field	Type
Hosted Page	object
ID	text
Type	text
URL	text
State	text
Pass Thru Content	text
Layout	text
Business Entity ID	text
Created At	date
Expires At	date
Updated At	date

Merge CustomersAction

Input fields[3]

Field	Type
From Customer IDRequired	choice
To Customer IDRequired	choice

Output fields[3]

Field	Type
Customer	object
ID	text
First Name	text
Last Name	text
Email	text
Phone	text
Company	text
Auto Collection	text
Net Term Days	number
Allow Direct Debit	boolean
VAT Number	text

Pause a SubscriptionAction

Input fields[3]

Field	Type
Subscription IDRequired	choice
Pause Option	choice
Pause Date	date
Unbilled Charges Handling	choice
Invoice Dunning Handling	choice
Skip Billing Cycles	number
Resume Date	date

Output fields[3]

Field	Type
Subscription	object
ID	text
Customer ID	text
Status	text
Currency Code	text
Billing Period	number
Billing Period Unit	text
Current Term Start	date
Current Term End	date
Next Billing At	date
Created At	date

Reactivate a SubscriptionAction

Input fields[3]

Field	Type
Subscription IDRequired	choice
Trial End	date
Billing Cycles	number
Invoice Immediately	boolean
Billing Alignment Mode	choice
Terms To Charge	number
Invoice Date	date
Additional Fields	array
Field NameRequired	text
ValueRequired	text

Output fields[3]

Field	Type
Subscription	object
ID	text
Customer ID	text
Status	text
Currency Code	text
Billing Period	number
Billing Period Unit	text
Current Term Start	date
Current Term End	date
Next Billing At	date
Created At	date

Record an Excess Payment for a CustomerAction

Input fields[3]

Field	Type
Customer IDRequired	choice
Comment	text
Transaction ID	text
AmountRequired	number
Currency Code	text
DateRequired	date
Payment MethodRequired	choice
Reference Number	text

Output fields[3]

Field	Type
Customer	object
ID	text
First Name	text
Last Name	text
Email	text
Phone	text
Company	text
Auto Collection	text
Net Term Days	number
Allow Direct Debit	boolean
VAT Number	text
Transaction	object
ID	text
Amount	number
Currency Code	text
Date	date
Payment Method	text
Reference Number	text
Status	text

Record an Invoice PaymentAction

Input fields[3]

Field	Type
Invoice IDRequired	choice
Payment MethodRequired	choice
Amount	number
Reference Number	text
Comment	text
Additional Fields	array
Field NameRequired	text
ValueRequired	text

Output fields[3]

Field	Type
Invoice	object
ID	text
Customer ID	text
Subscription ID	text
Status	text
Date	date
Due Date	date
Currency Code	text
Total	number
Sub Total	number
Amount Paid	number
Transaction	object
ID	text
Status	text
Amount	number
Payment Method	text
Date	date
Reference Number	text
Currency Code	text
Customer ID	text
Gateway	text

Refund a Credit NoteAction

Input fields[3]

Field	Type
Credit Note IDRequired	choice
Refund Amount	number
Customer Notes	text
Refund Reason Code	text
Additional Fields	array
Field NameRequired	text
ValueRequired	text

Output fields[3]

Field	Type
Credit Note	object
ID	text
Customer ID	text
Subscription ID	text
Reference Invoice ID	text
Type	text
Reason Code	text
Status	text
Date	date
Currency Code	text
Total	number
Transaction	object
ID	text
Status	text
Amount	number
Payment Method	text
Date	date
Reference Number	text
Currency Code	text
Customer ID	text
Gateway	text

Refund a PaymentAction

Input fields[3]

Field	Type
Transaction IDRequired	choice
Amount	number
Comment	text

Output fields[3]

Field	Type
Transaction	object
ID	text
Customer ID	text
Subscription ID	text
Payment Source ID	text
Payment Method	text
Reference Number	text
Gateway	text
Gateway Account ID	text
Type	text
Date	date

Regenerate an InvoiceAction

Input fields[3]

Field	Type
Subscription IDRequired	choice
Date From	date
Date To	date
Prorate	boolean
Invoice Immediately	boolean

Output fields[3]

Field	Type
Invoice	object
ID	text
Status	text
Total	number

Remove Credit Note from an InvoiceAction

Input fields[3]

Field	Type
Invoice IDRequired	choice
Credit Note IDRequired	choice
Additional Fields	array
Field NameRequired	text
ValueRequired	text

Output fields[3]

Field	Type
Invoice	object
ID	text
Customer ID	text
Subscription ID	text
Status	text
Date	date
Due Date	date
Currency Code	text
Total	number
Sub Total	number
Amount Paid	number
Credit Note	object
ID	text
Customer ID	text
Subscription ID	text
Reference Invoice ID	text
Type	text
Reason Code	text
Status	text
Date	date
Currency Code	text
Total	number

Remove Payment from an InvoiceAction

Input fields[3]

Field	Type
Invoice IDRequired	choice
Transaction IDRequired	choice
Additional Fields	array
Field NameRequired	text
ValueRequired	text

Output fields[3]

Field	Type
Invoice	object
ID	text
Customer ID	text
Subscription ID	text
Status	text
Date	date
Due Date	date
Currency Code	text
Total	number
Sub Total	number
Amount Paid	number
Transaction	object
ID	text
Status	text
Amount	number
Payment Method	text
Date	date
Reference Number	text
Currency Code	text
Customer ID	text
Gateway	text

Remove Scheduled CancellationAction

Input fields[3]

Field	Type
Subscription IDRequired	choice
Billing Cycles	number
Contract Term Billing Cycle On Renewal	number

Output fields[3]

Field	Type
Subscription	object
ID	text
Customer ID	text
Status	text
Currency Code	text
Billing Period	number
Billing Period Unit	text
Current Term Start	date
Current Term End	date
Next Billing At	date
Created At	date

Remove Scheduled ResumptionAction

Input fields[3]

Field	Type
Subscription IDRequired	choice

Output fields[3]

Field	Type
Subscription	object
ID	text
Customer ID	text
Status	text
Currency Code	text
Billing Period	number
Billing Period Unit	text
Current Term Start	date
Current Term End	date
Next Billing At	date
Created At	date

Resume a SubscriptionAction

Input fields[3]

Field	Type
Subscription IDRequired	choice
Resume Option	choice
Resume Date	date
Charges Handling	choice
Unpaid Invoices Handling	choice

Output fields[3]

Field	Type
Subscription	object
ID	text
Customer ID	text
Status	text
Currency Code	text
Billing Period	number
Billing Period Unit	text
Current Term Start	date
Current Term End	date
Next Billing At	date
Created At	date

Unarchive a CouponAction

Input fields[3]

Field	Type
Coupon IDRequired	choice

Output fields[3]

Field	Type
Coupon	object
ID	text
Name	text
Invoice Name	text
Discount Type	text
Discount Percentage	number
Discount Amount	number
Discount Quantity	number
Currency Code	text
Duration Type	text
Valid From	date

Update a Card Payment SourceAction

Input fields[3]

Field	Type
Customer IDRequired	choice
Payment Source IDRequired	choice
Reference Transaction ID	text
Cardholder First Name	text
Cardholder Last Name	text
Card Number	secret
Expiry Month	number
Expiry Year	number

6other input fields

Output fields[3]

Field	Type
Payment Source	object
ID	text
Resource Version	number
Customer ID	text
Type	text
Reference ID	text
Status	text
Gateway	text
Gateway Account ID	text
IP Address	text
Issuing Country	text

Update a CustomerAction

Input fields[3]

Field	Type
Customer IDRequired	choice
First Name	text
Last Name	text
Email	text
Phone	text
Company	text
Auto Collection	choice
Net Term Days	number

4other input fields

Output fields[3]

Field	Type
Customer	object
ID	text
First Name	text
Last Name	text
Email	text
Phone	text
Company	text
Auto Collection	text
Net Term Days	number
Allow Direct Debit	boolean
VAT Number	text

Update a FeatureAction

Input fields[3]

Field	Type
Feature IDRequired	choice
Name	text
Description	text
Status	choice
Unit	text
Level Name	text
Level Value	text
Level Is Unlimited	boolean

2other input fields

Output fields[3]

Field	Type
Feature	object
ID	text
Name	text
Description	text
Status	text
Type	text
Unit	text
Metered	boolean
Created At	date
Updated At	date
Levels	array

Update a ProductAction

Input fields[3]

Field	Type
Product IDRequired	choice
Name	text
External Name	text
Description	text
Status	choice
SKU	text
Shippable	boolean
Metadata	text

Output fields[3]

Field	Type
Product	object
ID	text
Name	text
External Name	text
Description	text
Has Variant	boolean
Status	text
Shippable	boolean
SKU	text
Created At	date
Updated At	date

Update a SubscriptionAction

Input fields[3]

Field	Type
Subscription IDRequired	choice
Item Price ID	choice
Quantity	number
Prorate	boolean
Invoice Immediately	boolean
Apply At End Of Term	boolean
Replace Items List	boolean
Auto Collection	choice

2other input fields

Output fields[3]

Field	Type
Subscription	object
ID	text
Customer ID	text
Status	text
Currency Code	text
Billing Period	number
Billing Period Unit	text
Current Term Start	date
Current Term End	date
Next Billing At	date
Created At	date

Update a Webhook EndpointAction

Input fields[3]

Field	Type
Webhook Endpoint IDRequired	choice
Name	text
URL	text
API Version	choice
Primary URL	boolean
Send Card Resource	boolean
Disabled	boolean
Basic Auth Username	text

2other input fields

Output fields[3]

Field	Type
Webhook Endpoint	object
ID	text
Name	text
URL	text
Send Card Resource	boolean
Disabled	boolean
Primary URL	boolean
API Version	text
Chargebee Response Schema Type	text
Enabled Events	array

Update an ItemAction

Input fields[3]

Field	Type
Item IDRequired	choice
Name	text
Description	text
Item Family ID	choice
External Name	text
Unit	text
Is Shippable	boolean
Enabled For Checkout	boolean

4other input fields

Output fields[3]

Field	Type
Item	object
ID	text
Name	text
External Name	text
Description	text
Status	text
Type	text
Item Family ID	text
Is Shippable	boolean
Is Giftable	boolean
Redirect URL	text

Update an Item FamilyAction

Input fields[3]

Field	Type
Item Family IDRequired	choice
Name	text
Description	text

Output fields[3]

Field	Type
Item Family	object
ID	text
Name	text
Description	text
Status	text
Channel	text
Business Entity ID	text
Updated At	date
Deleted	boolean

Update an Item PriceAction

Input fields[3]

Field	Type
Item Price IDRequired	choice
Name	text
Description	text
External Name	text
Currency Code	text
Status	choice
Pricing Model	choice
Price	number

12other input fields

Output fields[3]

Field	Type
Item Price	object
ID	text
Name	text
Item ID	text
Item Family ID	text
Description	text
Status	text
External Name	text
Price Variant ID	text
Proration Type	text
Pricing Model	text

Update an OrderAction

Input fields[3]

Field	Type
Order IDRequired	choice
Reference ID	text
Batch ID	text
Note	text
Shipping Date	date
Order Date	date
Status	choice
Tracking ID	text

6other input fields

Output fields[3]

Field	Type
Order	object
ID	text
Customer ID	text
Subscription ID	text
Invoice ID	text
Status	text
Fulfillment Status	text
Order Type	text
Order Date	date
Currency Code	text
Total	number

Update Billing Info for a CustomerAction

Input fields[3]

Field	Type
Customer IDRequired	choice
VAT Number	text
Registered For GST	boolean
Billing First Name	text
Billing Last Name	text
Billing Email	text
Billing Company	text
Billing Phone	text

7other input fields

Output fields[3]

Field	Type
Customer	object
ID	text
First Name	text
Last Name	text
Email	text
Phone	text
Company	text
Auto Collection	text
Net Term Days	number
Allow Direct Debit	boolean
VAT Number	text

Update Card for a CustomerAction

Input fields[3]

Field	Type
Customer IDRequired	choice
Gateway Account ID	text
Temporary Token	text
Cardholder First Name	text
Cardholder Last Name	text
Card Number	secret
Expiry Month	number
Expiry Year	number

6other input fields

Output fields[3]

Field	Type
Customer	object
ID	text
First Name	text
Last Name	text
Email	text
Phone	text
Company	text
Auto Collection	text
Net Term Days	number
Allow Direct Debit	boolean
VAT Number	text

Update Contacts for a CustomerAction

Input fields[3]

Field	Type
Customer IDRequired	choice
Contact IDRequired	choice
First Name	text
Last Name	text
Email	text
Phone	text
Label	text
Enabled	boolean

2other input fields

Output fields[3]

Field	Type
Customer	object
ID	text
First Name	text
Last Name	text
Email	text
Phone	text
Company	text
Auto Collection	text
Net Term Days	number
Allow Direct Debit	boolean
VAT Number	text

Update Credit Note DetailsAction

Input fields[3]

Field	Type
Credit Note IDRequired	choice
Comment	text
Additional Fields	array
Field NameRequired	text
ValueRequired	text

Output fields[3]

Field	Type
Credit Note	object
ID	text
Customer ID	text
Subscription ID	text
Reference Invoice ID	text
Type	text
Reason Code	text
Status	text
Date	date
Currency Code	text
Total	number

Update Invoice DetailsAction

Input fields[3]

Field	Type
Invoice IDRequired	choice
VAT Number	text
VAT Number Prefix	text
PO Number	text
Comment	text
Billing Address Line 1	text
Billing City	text
Billing Country	text

5other input fields

Output fields[3]

Field	Type
Invoice	object
ID	text
Customer ID	text
Subscription ID	text
Status	text
Date	date
Due Date	date
Currency Code	text
Total	number
Sub Total	number
Amount Paid	number

Update Payment Method for a CustomerAction

Input fields[3]

Field	Type
Customer IDRequired	choice
Payment Method Type	text
Gateway Account ID	text
Reference ID	text
Temporary Token	text

Output fields[3]

Field	Type
Customer	object
ID	text
First Name	text
Last Name	text
Email	text
Phone	text
Company	text
Auto Collection	text
Net Term Days	number
Allow Direct Debit	boolean
VAT Number	text

Update Quote StatusAction

Input fields[3]

Field	Type
Quote IDRequired	choice
StatusRequired	choice
Comment	text
Additional Fields	array
Field NameRequired	text
ValueRequired	text

Output fields[3]

Field	Type
Quote	object
ID	text
Customer ID	text
Subscription ID	text
Invoice ID	text
Name	text
Status	text
Operation Type	text
Date	date
Valid Till	date
Currency Code	text

Void a Credit NoteAction

Input fields[3]

Field	Type
Credit Note IDRequired	choice
Comment	text
Additional Fields	array
Field NameRequired	text
ValueRequired	text

Output fields[3]

Field	Type
Credit Note	object
ID	text
Customer ID	text
Subscription ID	text
Reference Invoice ID	text
Type	text
Reason Code	text
Status	text
Date	date
Currency Code	text
Total	number

Void an Authorization TransactionAction

Input fields[3]

Field	Type
Transaction IDRequired	choice

Output fields[3]

Field	Type
Transaction	object
ID	text
Customer ID	text
Subscription ID	text
Payment Source ID	text
Payment Method	text
Reference Number	text
Gateway	text
Gateway Account ID	text
Type	text
Date	date

Void an InvoiceAction

Input fields[3]

Field	Type
Invoice IDRequired	choice
Comment	text
Void Reason Code	text
Additional Fields	array
Field NameRequired	text
ValueRequired	text

Output fields[3]

Field	Type
Invoice	object
ID	text
Customer ID	text
Subscription ID	text
Status	text
Date	date
Due Date	date
Currency Code	text
Total	number
Sub Total	number
Amount Paid	number
Credit Note	object
ID	text
Customer ID	text
Subscription ID	text
Reference Invoice ID	text
Type	text
Reason Code	text
Status	text
Date	date
Currency Code	text
Total	number

Write Off an InvoiceAction

Input fields[3]

Field	Type
Invoice IDRequired	choice
Comment	text
Additional Fields	array
Field NameRequired	text
ValueRequired	text

Output fields[3]

Field	Type
Invoice	object
ID	text
Customer ID	text
Subscription ID	text
Status	text
Date	date
Due Date	date
Currency Code	text
Total	number
Sub Total	number
Amount Paid	number
Credit Note	object
ID	text
Customer ID	text
Subscription ID	text
Reference Invoice ID	text
Type	text
Reason Code	text
Status	text
Date	date
Currency Code	text
Total	number

Templates

Look for Chargebee templates in the WEXTL template library.

Browse templates →

Explore alternative apps

More apps in Finance category →

References

WEXTL® Chargebee Source Code connector implementation.
Our users use cases and automations.
Official API Documentation for Chargebee.
WEXTL® visual workflow builder data.

Last updated: Aug 23, 2026 16:18

How we write our apps documentation

How we compile these docs — sources, AI's role, and how we verify.