About this integration
Subscription billing for customers, plans, invoices, and payments. Use it from the workflow canvas with no custom glue script required.
This integration exposes 2 triggers, 49 search modules and 99 actions as workflow nodes. Authentication uses basic authentication. Webhook-based triggers fire instantly without polling.
How to connect
The credential form asks for Site, API Key, Use test site, and Business Entity ID.
Prefer the interactive builder form? Open it on the app page.
Enter your credentials below. WEXTL stores them encrypted and uses them only to call the API on your behalf.
| Field | Type | Help |
|---|---|---|
SiteRequired | text | Chargebee site name only — not the full hostname. Example: |
API KeyRequired | password | Settings → Configure Chargebee → API Keys. Use a full-access key. |
Use test site | boolean | Connect to |
Business Entity ID | text | Only for multi-entity sites — sent as the |
Use it in workflow automation
Start with Watch Events, then add Accept A Quote.
Triggers, searches and actions
Use the tables below to inspect Chargebee's 2 triggers, 49 search modules, and 99 actions.
Triggers
2 triggers fire automatically when specified events occur — no polling or cron job needed.
- Watch Events
- Watch Events (Polling)
Searches
Fetch data on demand using 49 search modules that query the app during a run.
- Get Account Hierarchy for a Customer
- Get a Customer
- Get a Subscription
- List Attached Items
- List Contract Terms for a Subscription
44more searches
Actions
99 action modules cover the full range of create, update, and delete operations.
- Accept A Quote
- Acknowledge A Hosted Page
- Activate A Portal Session
- Add a Charge-Item to a Pending Invoice
- Add Contacts to a Customer
94more actions
Explore the fields available for each Chargebee trigger, search, and action.
Triggers
Output fields
| 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 |
Output fields
| 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 |
Searches
Input fields
| Field | Type |
|---|---|
Customer IDRequired | choice |
Output fields
| Field | Type |
|---|---|
Customer ID | text |
Parent ID | text |
Payment Owner ID | text |
Invoice Owner ID | text |
Has Children | boolean |
Children IDs | array |
Input fields
| Field | Type |
|---|---|
Customer IDRequired | choice |
Output fields
| 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 |
Input fields
| Field | Type |
|---|---|
Subscription IDRequired | choice |
Output fields
| 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 |
Input fields
| Field | Type |
|---|---|
Item IDRequired | choice |
Max results | number |
Output fields
| 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 |
Input fields
| Field | Type |
|---|---|
Subscription IDRequired | choice |
Max results | number |
Output fields
| 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 |
Input fields
| Field | Type |
|---|---|
Coupon ID | choice |
Status | choice |
Max results | number |
Output fields
| Field | Type |
|---|---|
Coupon Code | object |
Code | text |
Status | text |
Coupon ID | text |
Coupon Set ID | text |
Coupon Set Name | text |
Input fields
| Field | Type |
|---|---|
Status | choice |
Discount Type | choice |
Max results | number |
Output fields
| 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 |
Input fields
| Field | Type |
|---|---|
Customer ID | choice |
Subscription ID | choice |
Type | choice |
Status | choice |
Max results | number |
Output fields
| 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 |
Input fields
| Field | Type |
|---|---|
Email | text |
Max results | number |
Output fields
| 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 |
Input fields
| Field | Type |
|---|---|
Subscription IDRequired | choice |
Max results | number |
Output fields
| 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 |
Input fields
| Field | Type |
|---|---|
Event Type | choice |
Webhook Status | choice |
Source | choice |
Occurred After | date |
Occurred Before | date |
Max results | number |
Output fields
| 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 |
Input fields
| Field | Type |
|---|---|
Type | choice |
Status | choice |
Max results | number |
Output fields
| 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 |
Input fields
| Field | Type |
|---|---|
Type | choice |
State | choice |
Max results | number |
Output fields
| 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 |
Input fields
| Field | Type |
|---|---|
Customer ID | choice |
Subscription ID | choice |
Status | choice |
Max results | number |
Output fields
| 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 |
Input fields
| Field | Type |
|---|---|
Name | text |
Status | choice |
Max results | number |
Output fields
| Field | Type |
|---|---|
Item Family | object |
ID | text |
Name | text |
Description | text |
Status | text |
Channel | text |
Business Entity ID | text |
Updated At | date |
Deleted | boolean |
Input fields
| Field | Type |
|---|---|
Item ID | choice |
Item Family ID | choice |
Status | choice |
Max results | number |
Output fields
| 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 |
Input fields
| Field | Type |
|---|---|
Item Family ID | choice |
Type | choice |
Status | choice |
Max results | number |
Output fields
| 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 |
Input fields
| Field | Type |
|---|---|
Customer IDRequired | choice |
Max results | number |
Output fields
| 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 |
Input fields
| Field | Type |
|---|---|
Subscription ID | choice |
Invoice ID | choice |
Status | choice |
Max results | number |
Output fields
| 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 |
Input fields
| Field | Type |
|---|---|
Invoice IDRequired | choice |
Max results | number |
Output fields
| 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 |
Input fields
| Field | Type |
|---|---|
Customer ID | choice |
Subscription ID | choice |
Type | choice |
Status | choice |
Include Deleted | boolean |
Max results | number |
Output fields
| 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 |
Input fields
| Field | Type |
|---|---|
Status | choice |
Shippable | boolean |
Max results | number |
Output fields
| 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 |
Input fields
| Field | Type |
|---|---|
Customer ID | choice |
Subscription ID | choice |
Status | choice |
Max results | number |
Output fields
| 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 |
Input fields
| Field | Type |
|---|---|
Subscription IDRequired | choice |
Max results | number |
Output fields
| Field | Type |
|---|---|
Subscription Entitlement | object |
Feature ID | text |
Feature Name | text |
Value | text |
Is Enabled | boolean |
Is Overridden | boolean |
Input fields
| Field | Type |
|---|---|
Customer ID | choice |
Status | choice |
Max results | number |
Output fields
| 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 |
Input fields
| Field | Type |
|---|---|
Customer ID | choice |
Subscription ID | choice |
Payment Source ID | text |
Type | choice |
Status | choice |
Payment Method | choice |
Max results | number |
Output fields
| 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 |
Input fields
| Field | Type |
|---|---|
Subscription ID | choice |
Customer ID | choice |
Max results | number |
Output fields
| 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 |
Input fields
| Field | Type |
|---|---|
Max results | number |
Output fields
| 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 |
Input fields
| Field | Type |
|---|---|
Coupon IDRequired | choice |
Output fields
| 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 |
Input fields
| Field | Type |
|---|---|
Coupon CodeRequired | choice |
Output fields
| Field | Type |
|---|---|
Coupon Code | object |
Code | text |
Status | text |
Coupon ID | text |
Coupon Set ID | text |
Coupon Set Name | text |
Input fields
| Field | Type |
|---|---|
Credit Note IDRequired | choice |
Output fields
| 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 |
Input fields
| Field | Type |
|---|---|
Subscription IDRequired | choice |
Output fields
| Field | Type |
|---|---|
ID | text |
Schedule Type | text |
Input fields
| Field | Type |
|---|---|
Feature IDRequired | choice |
Output fields
| 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 |
Input fields
| Field | Type |
|---|---|
Hosted Page IDRequired | choice |
Output fields
| 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 |
Input fields
| Field | Type |
|---|---|
Event IDRequired | choice |
Output fields
| 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 |
Input fields
| Field | Type |
|---|---|
Invoice IDRequired | choice |
Output fields
| 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 |
Input fields
| Field | Type |
|---|---|
Item IDRequired | choice |
Output fields
| 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 |
Input fields
| Field | Type |
|---|---|
Item Family IDRequired | choice |
Output fields
| Field | Type |
|---|---|
Item Family | object |
ID | text |
Name | text |
Description | text |
Status | text |
Channel | text |
Business Entity ID | text |
Updated At | date |
Deleted | boolean |
Input fields
| Field | Type |
|---|---|
Item Price IDRequired | choice |
Output fields
| 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 |
Input fields
| Field | Type |
|---|---|
Order IDRequired | choice |
Output fields
| 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 |
Input fields
| Field | Type |
|---|---|
Customer IDRequired | choice |
Payment Source IDRequired | choice |
Output fields
| 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 |
Input fields
| Field | Type |
|---|---|
Portal Session IDRequired | text |
Output fields
| 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 |
Input fields
| Field | Type |
|---|---|
Product IDRequired | choice |
Output fields
| 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 |
Input fields
| Field | Type |
|---|---|
Quote IDRequired | choice |
Output fields
| 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 |
Input fields
| Field | Type |
|---|---|
Transaction IDRequired | choice |
Output fields
| 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 |
Input fields
| Field | Type |
|---|---|
Subscription IDRequired | choice |
Usage IDRequired | text |
Output fields
| Field | Type |
|---|---|
Usage | object |
ID | text |
Subscription ID | text |
Item Price ID | text |
Quantity | text |
Usage Date | date |
Note | text |
Created At | date |
Input fields
| Field | Type |
|---|---|
Webhook Endpoint IDRequired | choice |
Output fields
| 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 |
Input fields
| Field | Type |
|---|---|
Invoice IDRequired | choice |
Max results | number |
Output fields
| Field | Type |
|---|---|
ID | text |
Amount | number |
Currency Code | text |
Entity ID | text |
Entity Type | text |
Scheme ID | text |
Created At | date |
Updated At | date |
Input fields
| Field | Type |
|---|---|
Subscription IDRequired | choice |
Output fields
| Field | Type |
|---|---|
Created At | date |
Invoice Estimate | object |
Amount Due | number |
Sub Total | number |
Total | number |
Currency Code | text |
Actions
Input fields
| Field | Type |
|---|---|
Redirect URL | text |
Layout | choice |
Quote IDRequired | choice |
Output fields
| 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 |
Input fields
| Field | Type |
|---|---|
Hosted Page IDRequired | choice |
Output fields
| 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 |
Input fields
| Field | Type |
|---|---|
Portal Session IDRequired | text |
TokenRequired | text |
Output fields
| 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 |
Input fields
| Field | Type |
|---|---|
Invoice IDRequired | choice |
Item Price IDRequired | choice |
Quantity | number |
Unit Price | number |
Subscription ID | choice |
Comment | text |
Output fields
| 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 |
Input fields
| 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
| 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 |
Input fields
| Field | Type |
|---|---|
Invoice IDRequired | choice |
AmountRequired | number |
DescriptionRequired | text |
Subscription ID | choice |
Comment | text |
Output fields
| 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 |
Input fields
| Field | Type |
|---|---|
Invoice IDRequired | choice |
Credit Note ID | choice |
Comment | text |
Output fields
| 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 |
Input fields
| Field | Type |
|---|---|
Invoice IDRequired | choice |
Transaction ID | choice |
Amount | number |
Comment | text |
Output fields
| 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 |
Input fields
| Field | Type |
|---|---|
Order IDRequired | choice |
Cancellation ReasonRequired | choice |
Customer Notes | text |
Comment | text |
Credit Note Total | number |
Output fields
| 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 |
Input fields
| 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
| 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 |
Input fields
| Field | Type |
|---|---|
Subscription IDRequired | choice |
Term Ends AtRequired | date |
Prorate | boolean |
Invoice Immediately | boolean |
Output fields
| 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 |
Input fields
| 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
| 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 |
Input fields
| 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
| 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 |
Input fields
| 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
| 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 |
Input fields
| Field | Type |
|---|---|
Invoice IDRequired | choice |
Comment | text |
Invoice Note | text |
Remove General Note | boolean |
Invoice Date | date |
Output fields
| 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 |
Input fields
| Field | Type |
|---|---|
Redirect URL | text |
Currency Code | text |
Payment Method Save Policy | choice |
Customer IDRequired | choice |
Card Gateway Account ID | text |
Output fields
| 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 |
Input fields
| Field | Type |
|---|---|
Invoice IDRequired | choice |
Customer ID | choice |
Amount | number |
Payment Source ID | choice |
Authorization Transaction ID | text |
Payment Initiator | choice |
Comment | text |
Output fields
| 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 |
Input fields
| 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
| 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 |
Input fields
| 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 |
Output fields
| 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 |
Input fields
| Field | Type |
|---|---|
Customer IDRequired | choice |
Gateway Account IDRequired | text |
Output fields
| Field | Type |
|---|---|
Third Party Payment Method | object |
ID | text |
Status | text |
Input fields
| 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
| 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 |
Input fields
| 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
| 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 |
Input fields
| 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
| 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 |
Input fields
| 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
| 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 |
Input fields
| 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
| 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 |
Input fields
| Field | Type |
|---|---|
Customer IDRequired | choice |
Payment Source ID | choice |
Currency Code | text |
AmountRequired | number |
Additional Fields | array |
Field NameRequired | text |
ValueRequired | text |
Output fields
| 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 |
Input fields
| Field | Type |
|---|---|
Subscription ID | choice |
Customer ID | choice |
Output fields
| Field | Type |
|---|---|
Invoices | array |
Input fields
| 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
| 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 |
Input fields
| Field | Type |
|---|---|
IDRequired | text |
NameRequired | text |
Description | text |
Business Entity ID | text |
Output fields
| Field | Type |
|---|---|
Item Family | object |
ID | text |
Name | text |
Description | text |
Status | text |
Channel | text |
Business Entity ID | text |
Updated At | date |
Deleted | boolean |
Input fields
| 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
| 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 |
Input fields
| Field | Type |
|---|---|
Invoice IDRequired | choice |
Status | choice |
Reference ID | text |
Fulfillment Status | text |
Note | text |
Tracking ID | text |
Tracking URL | text |
Batch ID | text |
Output fields
| 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 |
Input fields
| Field | Type |
|---|---|
Scheme IDRequired | text |
Invoice ID | choice |
Amount | number |
Payment Schedule Start Date | date |
Output fields
| Field | Type |
|---|---|
Estimate | object |
Created At | date |
Payment Schedule Estimates | array |
Input fields
| Field | Type |
|---|---|
Redirect URL | text |
Forward URL | text |
Customer IDRequired | choice |
Output fields
| 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 |
Input fields
| Field | Type |
|---|---|
NameRequired | text |
External NameRequired | text |
StatusRequired | choice |
ID | text |
Description | text |
SKU | text |
Shippable | boolean |
Metadata | text |
Output fields
| 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 |
Input fields
| 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
| 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 |
Input fields
| Field | Type |
|---|---|
Order IDRequired | choice |
Reason CodeRequired | choice |
TotalRequired | number |
Customer Notes | text |
Comment | text |
Output fields
| 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 |
Input fields
| Field | Type |
|---|---|
Subscription IDRequired | choice |
Item Price IDRequired | choice |
QuantityRequired | text |
Usage DateRequired | date |
Usage ID | text |
Note | text |
Output fields
| Field | Type |
|---|---|
Usage | object |
ID | text |
Subscription ID | text |
Item Price ID | text |
Quantity | text |
Usage Date | date |
Note | text |
Created At | date |
Input fields
| 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
| 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 |
Input fields
| 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
| 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 |
Input fields
| 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
| 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 |
Input fields
| 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
| 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 |
Input fields
| 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
| Field | Type |
|---|---|
Estimate | object |
Created At | date |
Invoice Estimate | object |
Input fields
| 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
| Field | Type |
|---|---|
Unbilled Charges | array |
Input fields
| 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
| 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 |
Input fields
| Field | Type |
|---|---|
Coupon IDRequired | choice |
Output fields
| 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 |
Input fields
| Field | Type |
|---|---|
Customer IDRequired | choice |
Delete Payment Method | boolean |
Output fields
| 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 |
Input fields
| Field | Type |
|---|---|
Feature IDRequired | choice |
Output fields
| 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 |
Input fields
| Field | Type |
|---|---|
Invoice IDRequired | choice |
Comment | text |
Claim Credits | boolean |
Output fields
| 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 |
Input fields
| Field | Type |
|---|---|
Item IDRequired | choice |
Output fields
| 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 |
Input fields
| Field | Type |
|---|---|
Item Family IDRequired | choice |
Output fields
| Field | Type |
|---|---|
Item Family | object |
ID | text |
Name | text |
Description | text |
Status | text |
Channel | text |
Business Entity ID | text |
Updated At | date |
Deleted | boolean |
Input fields
| Field | Type |
|---|---|
Item Price IDRequired | choice |
Output fields
| 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 |
Input fields
| Field | Type |
|---|---|
Unbilled Charge IDRequired | choice |
Output fields
| 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 |
Input fields
| Field | Type |
|---|---|
Customer IDRequired | choice |
Payment Source IDRequired | choice |
Output fields
| 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 |
Input fields
| Field | Type |
|---|---|
Quote IDRequired | choice |
Comment | text |
Output fields
| 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 |
Input fields
| Field | Type |
|---|---|
Subscription IDRequired | choice |
Output fields
| 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 |
Input fields
| Field | Type |
|---|---|
Customer IDRequired | choice |
Output fields
| 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 |
Input fields
| Field | Type |
|---|---|
Customer IDRequired | choice |
Contact IDRequired | choice |
Output fields
| 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 |
Input fields
| 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
| Field | Type |
|---|---|
ID | text |
Schedule Type | text |
Input fields
| Field | Type |
|---|---|
Subscription IDRequired | choice |
Feature IDRequired | choice |
Is EnabledRequired | boolean |
Additional Fields | array |
Field NameRequired | text |
ValueRequired | text |
Output fields
| Field | Type |
|---|---|
Subscription Entitlement | array |
Input fields
| 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
| Field | Type |
|---|---|
Estimate | object |
Created At | date |
Subscription Estimate | object |
Invoice Estimate | object |
Next Invoice Estimate | object |
Input fields
| 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
| Field | Type |
|---|---|
Estimate | object |
Created At | date |
Subscription Estimate | object |
Invoice Estimate | object |
Next Invoice Estimate | object |
Credit Note Estimates | array |
Input fields
| Field | Type |
|---|---|
Portal Session IDRequired | text |
Output fields
| 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 |
Input fields
| Field | Type |
|---|---|
URLRequired | text |
MethodRequired | choice |
Headers | array |
Header | object |
Query String | array |
Parameter | object |
Body | text |
Output fields
| Field | Type |
|---|---|
Body | text |
Headers | object |
Status code | number |
Input fields
| Field | Type |
|---|---|
Business Entity ID | text |
Redirect URL | text |
Customer IDRequired | choice |
Card Gateway Account ID | text |
Output fields
| 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 |
Input fields
| Field | Type |
|---|---|
From Customer IDRequired | choice |
To Customer IDRequired | choice |
Output fields
| 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 |
Input fields
| 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
| 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 |
Input fields
| 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
| 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 |
Input fields
| 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
| 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 |
Input fields
| Field | Type |
|---|---|
Invoice IDRequired | choice |
Payment MethodRequired | choice |
Amount | number |
Reference Number | text |
Comment | text |
Output fields
| 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 |
Input fields
| Field | Type |
|---|---|
Credit Note IDRequired | choice |
Refund Amount | number |
Customer Notes | text |
Refund Reason Code | text |
Output fields
| 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 |
Input fields
| Field | Type |
|---|---|
Transaction IDRequired | choice |
Amount | number |
Comment | text |
Output fields
| 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 |
Input fields
| Field | Type |
|---|---|
Subscription IDRequired | choice |
Date From | date |
Date To | date |
Prorate | boolean |
Invoice Immediately | boolean |
Output fields
| Field | Type |
|---|---|
Invoice | object |
ID | text |
Status | text |
Total | number |
Input fields
| Field | Type |
|---|---|
Invoice IDRequired | choice |
Credit Note IDRequired | choice |
Output fields
| 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 |
Input fields
| Field | Type |
|---|---|
Invoice IDRequired | choice |
Transaction IDRequired | choice |
Output fields
| 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 |
Input fields
| Field | Type |
|---|---|
Subscription IDRequired | choice |
Billing Cycles | number |
Contract Term Billing Cycle On Renewal | number |
Output fields
| 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 |
Input fields
| Field | Type |
|---|---|
Subscription IDRequired | choice |
Output fields
| 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 |
Input fields
| Field | Type |
|---|---|
Subscription IDRequired | choice |
Resume Option | choice |
Resume Date | date |
Charges Handling | choice |
Unpaid Invoices Handling | choice |
Output fields
| 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 |
Input fields
| Field | Type |
|---|---|
Coupon IDRequired | choice |
Output fields
| 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 |
Input fields
| 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
| 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 |
Input fields
| 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
| 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 |
Input fields
| 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
| 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 |
Input fields
| 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
| 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 |
Input fields
| Field | Type |
|---|---|
Item Family IDRequired | choice |
Name | text |
Description | text |
Output fields
| Field | Type |
|---|---|
Item Family | object |
ID | text |
Name | text |
Description | text |
Status | text |
Channel | text |
Business Entity ID | text |
Updated At | date |
Deleted | boolean |
Input fields
| 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
| 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 |
Input fields
| 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
| 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 |
Input fields
| Field | Type |
|---|---|
Product IDRequired | choice |
Name | text |
External Name | text |
Description | text |
Status | choice |
SKU | text |
Shippable | boolean |
Metadata | text |
Output fields
| 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 |
Input fields
| 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
| 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 |
Input fields
| 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
| 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 |
Input fields
| 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
| 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 |
Input fields
| 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
| 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 |
Input fields
| 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
| 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 |
Input fields
| Field | Type |
|---|---|
Credit Note IDRequired | choice |
Comment | text |
Additional Fields | array |
Field NameRequired | text |
ValueRequired | text |
Output fields
| 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 |
Input fields
| 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
| 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 |
Input fields
| Field | Type |
|---|---|
Customer IDRequired | choice |
Payment Method Type | text |
Gateway Account ID | text |
Reference ID | text |
Temporary Token | text |
Output fields
| 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 |
Input fields
| Field | Type |
|---|---|
Quote IDRequired | choice |
StatusRequired | choice |
Comment | text |
Output fields
| 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 |
Input fields
| Field | Type |
|---|---|
Credit Note IDRequired | choice |
Comment | text |
Output fields
| 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 |
Input fields
| Field | Type |
|---|---|
Transaction IDRequired | choice |
Output fields
| 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 |
Input fields
| Field | Type |
|---|---|
Invoice IDRequired | choice |
Comment | text |
Void Reason Code | text |
Output fields
| 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 |
Input fields
| Field | Type |
|---|---|
Invoice IDRequired | choice |
Comment | text |
Output fields
| 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 |