About this integration
Payments infrastructure for online businesses.
There are 24 triggers, 62 search modules and 93 actions available. The integration connects via basic authentication. Webhook-based triggers fire instantly without polling.
How to connect
The credential form asks for API Key.
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 |
|---|---|---|
API KeyRequired | password | Go to |
Use it in workflow automation
Start with Watch Accounts, then add Attach Payment to an Invoice.
The canvas below runs Watch Accounts into Attach Payment to an Invoice — watch the video, then drop a node onto the canvas.
Select the Watch Payment Intents trigger and the workflow fires automatically when the event occurs — no polling required.
Then add Create a Payment Configuration as the next node. Branch, filter, or hand off to other integrations from there.
The integration includes 117 ready-made modules for finance work — each run logs its inputs and outputs for debugging.
Stripe workflow on the canvas: Watch Payment Intents then Create a Payment Configuration
Triggers, searches and actions
Open any Stripe trigger, search, or action to see its inputs and outputs — 24 triggers, 62 searchs, 93 actions.
Triggers
Use one of 24 triggers to kick off a workflow as soon as an event occurs in the app.
- Watch Accounts
- Watch Balance Transactions
- Watch Charges
- Watch Checkout Sessions
- Watch Coupons
Searches
This integration includes 62 search modules for looking data up mid-run.
- Get a Bank Account
- Get a Card
- Get a Cash Balance Transaction
- Get a Charge
- Get a Checkout Session
Actions
Take action during a run with 93 available modules that write data back into the app.
- Attach Payment to an Invoice
- Atttach a Payment Method to Customer
- Cancel a Payment Intent
- Cancel a Payout
- Cancel a Refund
Explore the fields available for each Stripe trigger, search, and action.
Triggers
| Field | Type |
|---|---|
ID | text |
Object | text |
Applied configurations | array |
Contact email | |
Created | date |
Display name | text |
Livemode | boolean |
| Field | Type |
|---|---|
ID | text |
Object | text |
Amount | number |
Available on | number |
Created | date |
Currency | text |
Description | text |
| Field | Type |
|---|---|
ID | text |
Object | text |
Amount | number |
Amount captured | number |
Amount refunded | number |
Application | text |
Application fee | text |
| Field | Type |
|---|---|
ID | text |
Object | text |
After expiration | text |
Allow promotion codes | text |
Amount subtotal | number |
Amount total | number |
Automatic tax | object |
Enabled | boolean |
Liability | text |
Status | text |
| Field | Type |
|---|---|
ID | text |
Object | text |
Amount off | text |
Created | date |
Currency | text |
Duration | text |
Duration in months | number |
| Field | Type |
|---|---|
ID | text |
Object | text |
Address | text |
Balance | number |
Created | date |
Currency | text |
Default source | text |
| Field | Type |
|---|---|
ID | text |
Object | text |
Amount | number |
Balance transactions | array |
Charge | text |
Created | date |
Currency | text |
| Field | Type |
|---|---|
ID | text |
Object | text |
Created | date |
Description | text |
Enabled events | array |
Event payload | text |
Events from | array |
| Field | Type |
|---|---|
Enabled EventsRequired | array |
| Field | Type |
|---|---|
ID | text |
Object | text |
Created | date |
Expires at | date |
Filename | text |
Links | object |
Object | text |
Data | array |
Has more | boolean |
URL | text |
Purpose | text |
| Field | Type |
|---|---|
ID | text |
Object | text |
Amount | number |
Currency | text |
Customer | text |
Date | date |
Description | text |
| Field | Type |
|---|---|
ID | text |
Object | text |
Account country | text |
Account name | text |
Account tax ids | text |
Amount due | number |
Amount paid | number |
| Field | Type |
|---|---|
ID | text |
Object | text |
Context | text |
Created | date |
Data | object |
Developer message summary | text |
Reason | object |
Validation end | date |
Validation start | date |
Livemode | boolean |
Reason | text |
| Field | Type |
|---|---|
ID | text |
Object | text |
Amount | number |
Amount capturable | number |
Amount details | object |
Tip | object |
Amount received | number |
Application | text |
| Field | Type |
|---|---|
ID | text |
Object | text |
Billing details | object |
Address | object |
Email | text |
Name | text |
Phone | text |
Card | object |
Brand | text |
Checks | object |
Country | text |
Exp month | number |
Exp year | number |
Fingerprint | text |
Funding | text |
Generated from | text |
Last 4 | text |
Networks | object |
Created | date |
Customer | text |
Livemode | boolean |
| Field | Type |
|---|---|
ID | text |
Object | text |
Amount | number |
Arrival date | date |
Automatic | boolean |
Balance transaction | text |
Created | date |
| Field | Type |
|---|---|
ID | text |
Object | text |
Active | boolean |
Billing scheme | text |
Created | date |
Currency | text |
Custom unit amount | text |
| Field | Type |
|---|---|
ID | text |
Object | text |
Active | boolean |
Created | date |
Default price | text |
Description | text |
Images | array |
| Field | Type |
|---|---|
ID | text |
Object | text |
Active | boolean |
Code | text |
Promotion | object |
Type | text |
Coupon | text |
Created | date |
Customer | text |
| Field | Type |
|---|---|
ID | text |
Object | text |
Amount | number |
Balance transaction | text |
Charge | text |
Created | date |
Currency | text |
| Field | Type |
|---|---|
ID | text |
Object | text |
Application | text |
Created | date |
Customer | text |
Flow directions | text |
Livemode | boolean |
| Field | Type |
|---|---|
ID | text |
Object | text |
Application | text |
Cancellation reason | text |
Client secret | text |
Created | number |
Customer | text |
| Field | Type |
|---|---|
ID | text |
Object | text |
Active | boolean |
Created | date |
Delivery estimate | text |
Display name | text |
Fixed amount | object |
Amount | number |
Currency | text |
| Field | Type |
|---|---|
ID | text |
Object | text |
Active | boolean |
Country | text |
Created | date |
Description | text |
Display name | text |
Searches
| Field | Type |
|---|---|
Customer IDRequired | choice |
| Field | Type |
|---|---|
ID | text |
Object | text |
Account holder name | text |
Account holder type | text |
Account type | text |
Bank name | text |
Country | text |
| Field | Type |
|---|---|
Customer IDRequired | choice |
| Field | Type |
|---|---|
ID | text |
Object | text |
Address city | text |
Address country | text |
Address line 1 | text |
Address line 1 check | text |
Address line 2 | text |
| Field | Type |
|---|---|
Customer IDRequired | choice |
| Field | Type |
|---|---|
Object | text |
Bank transfer | object |
Country | text |
Financial addresses | array |
Type | text |
Currency | text |
Funding type | text |
Livemode | boolean |
| Field | Type |
|---|---|
Charge IDRequired | choice |
| Field | Type |
|---|---|
ID | text |
Object | text |
Amount | number |
Amount captured | number |
Amount refunded | number |
Application | text |
Application fee | text |
| Field | Type |
|---|---|
Checkout Session IDRequired | choice |
| Field | Type |
|---|---|
ID | text |
Object | text |
After expiration | text |
Allow promotion codes | text |
Amount subtotal | number |
Amount total | number |
Automatic tax | object |
Enabled | boolean |
Liability | text |
Status | text |
| Field | Type |
|---|---|
Coupon IDRequired | choice |
| Field | Type |
|---|---|
ID | text |
Object | text |
Amount off | text |
Created | date |
Currency | text |
Duration | text |
Livemode | boolean |
| Field | Type |
|---|---|
Customer IDRequired | choice |
| Field | Type |
|---|---|
ID | text |
Object | text |
Address | text |
Balance | number |
Created | date |
Currency | text |
Default source | text |
| Field | Type |
|---|---|
Dispute IDRequired | choice |
| Field | Type |
|---|---|
ID | text |
Object | text |
Address | text |
Balance | number |
Created | date |
Currency | text |
Default source | text |
| Field | Type |
|---|---|
Event Destination IDRequired | choice |
| Field | Type |
|---|---|
ID | text |
Object | text |
Created | date |
Description | text |
Enabled events | array |
Event payload | text |
Events from | array |
| Field | Type |
|---|---|
File IDRequired | choice |
| Field | Type |
|---|---|
ID | text |
Object | text |
Created | date |
Expires at | date |
Filename | text |
Links | object |
Object | text |
Data | array |
Has more | boolean |
URL | text |
Purpose | text |
| Field | Type |
|---|---|
File Link IDRequired | choice |
| Field | Type |
|---|---|
ID | text |
Object | text |
Created | date |
Expired | boolean |
Expires at | date |
File | text |
Livemode | boolean |
| Field | Type |
|---|---|
Account IDRequired | choice |
Include | choice |
| Field | Type |
|---|---|
ID | text |
Object | text |
Applied configurations | array |
Configuration | object |
Customer | object |
Merchant | object |
Contact email | text |
Created | date |
Dashboard | text |
| Field | Type |
|---|---|
Event IDRequired | choice |
| Field | Type |
|---|---|
ID | text |
Object | text |
Context | text |
Created | date |
Data | object |
Developer message summary | text |
Reason | object |
Validation end | date |
Validation start | date |
Livemode | boolean |
Reason | text |
| Field | Type |
|---|---|
Invoice IDRequired | choice |
| Field | Type |
|---|---|
ID | text |
Object | text |
Account country | text |
Account name | text |
Account tax ids | text |
Amount due | number |
Amount paid | number |
| Field | Type |
|---|---|
Invoice Item IDRequired | choice |
| Field | Type |
|---|---|
ID | text |
Object | text |
Amount | number |
Currency | text |
Customer | text |
Date | date |
Description | text |
| Field | Type |
|---|---|
Configuration IDRequired | choice |
| Field | Type |
|---|---|
ID | text |
Object | text |
Acss debit | object |
Available | boolean |
Display preference | object |
Active | boolean |
Affirm | object |
Available | boolean |
Display preference | object |
Afterpay clearpay | object |
Available | boolean |
Display preference | object |
Alipay | object |
Available | boolean |
Display preference | object |
| Field | Type |
|---|---|
Payment Intent IDRequired | choice |
| Field | Type |
|---|---|
ID | text |
Object | text |
Amount | number |
Amount capturable | number |
Amount details | object |
Tip | object |
Amount received | number |
Application | text |
| Field | Type |
|---|---|
Payment Link IDRequired | choice |
| Field | Type |
|---|---|
ID | text |
Object | text |
Active | boolean |
After completion | object |
Hosted confirmation | object |
Type | text |
Allow promotion codes | boolean |
Application fee amount | text |
Application fee percent | text |
| Field | Type |
|---|---|
Payment IDRequired | text |
| Field | Type |
|---|---|
ID | text |
Object | text |
Allow redisplay | text |
Billing details | object |
Address | object |
Email | text |
Name | text |
Phone | text |
Created | date |
Customer | text |
Livemode | boolean |
| Field | Type |
|---|---|
Payout IDRequired | choice |
| Field | Type |
|---|---|
ID | text |
Object | text |
Amount | number |
Arrival date | date |
Automatic | boolean |
Balance transaction | text |
Created | date |
| Field | Type |
|---|---|
Account ID | choice |
| Field | Type |
|---|---|
ID | text |
Object | text |
Account | text |
Additional addresses | array |
Additional names | array |
Address | object |
City | text |
Country | text |
Line 1 | text |
Postal code | text |
State | text |
Created | date |
| Field | Type |
|---|---|
Price IDRequired | choice |
| Field | Type |
|---|---|
ID | text |
Object | text |
Active | boolean |
Billing scheme | text |
Created | date |
Currency | text |
Custom unit amount | text |
| Field | Type |
|---|---|
Product IDRequired | choice |
| Field | Type |
|---|---|
ID | text |
Object | text |
Active | boolean |
Created | date |
Default price | text |
Description | text |
Images | array |
| Field | Type |
|---|---|
Promotion Code IDRequired | choice |
| Field | Type |
|---|---|
ID | text |
Object | text |
Active | boolean |
Code | text |
Promotion | object |
Type | text |
Coupon | text |
Created | date |
Customer | text |
| Field | Type |
|---|---|
Refund IDRequired | choice |
| Field | Type |
|---|---|
ID | text |
Object | text |
Amount | number |
Balance transaction | text |
Charge | text |
Created | date |
Currency | text |
| Field | Type |
|---|---|
Setup Intent IDRequired | choice |
| Field | Type |
|---|---|
ID | text |
Object | text |
Application | text |
Automatic payment methods | object |
Enabled | boolean |
Cancellation reason | text |
Client secret | text |
Created | date |
| Field | Type |
|---|---|
Shipping Rate IDRequired | choice |
| Field | Type |
|---|---|
ID | text |
Object | text |
Active | boolean |
Created | date |
Delivery estimate | text |
Display name | text |
Fixed amount | object |
Amount | number |
Currency | text |
| Field | Type |
|---|---|
Tax Rate IDRequired | choice |
| Field | Type |
|---|---|
ID | text |
Object | text |
Active | boolean |
Country | text |
Created | date |
Description | text |
Display name | text |
| Field | Type |
|---|---|
Token IDRequired | text |
| Field | Type |
|---|---|
ID | text |
Object | text |
Card | object |
ID | text |
Object | text |
Address city | text |
Address country | text |
Address line 1 | text |
Address line 1 check | text |
Address line 2 | text |
Address state | text |
Address zip | text |
Address zip check | text |
Client IP | text |
Created | date |
Livemode | boolean |
Type | text |
| Field | Type |
|---|---|
Transaction Balance IDRequired | choice |
| Field | Type |
|---|---|
ID | text |
Object | text |
Amount | number |
Available on | number |
Created | date |
Currency | text |
Description | text |
| Field | Type |
|---|---|
Applied Configurations | array |
Closed | boolean |
Limit | number |
| Field | Type |
|---|---|
ID | text |
Object | text |
Applied configurations | array |
Contact email | |
Created | date |
Display name | text |
Livemode | boolean |
| Field | Type |
|---|---|
Payout | text |
Type | choice |
Created | object |
Greater Than | date |
Greater Than or Equal | date |
Less Than | date |
Less Than or Equal | date |
Currency | text |
Limit | number |
| Field | Type |
|---|---|
ID | text |
Object | text |
Amount | number |
Available on | number |
Created | date |
Currency | text |
Description | text |
| Field | Type |
|---|---|
Customer | choice |
Limit | number |
| Field | Type |
|---|---|
ID | text |
Object | text |
Amount | number |
Amount captured | number |
Amount refunded | number |
Application | text |
Application fee | text |
| Field | Type |
|---|---|
Payment Intent | choice |
Subscription | choice |
Created | object |
Greater Than | date |
Greater Than or Equal To | date |
Less Than | date |
Less Than or Equal To | date |
Limit | number |
| Field | Type |
|---|---|
ID | text |
Object | text |
After expiration | text |
Allow promotion codes | text |
Amount subtotal | number |
Amount total | number |
Automatic tax | object |
Enabled | boolean |
Liability | text |
Status | text |
| Field | Type |
|---|---|
Created | object |
Greater Than | date |
Greater Than or Equal To | date |
Less Than | date |
Less Than or Equal To | date |
Limit | number |
| Field | Type |
|---|---|
ID | text |
Object | text |
Amount off | text |
Created | date |
Currency | text |
Duration | text |
Duration in months | number |
| Field | Type |
|---|---|
Customer IDRequired | choice |
Limit | number |
| Field | Type |
|---|---|
ID | text |
Object | text |
Account holder name | text |
Account holder type | text |
Account type | text |
Bank name | text |
Country | text |
| Field | Type |
|---|---|
Customer IDRequired | choice |
Limit | number |
| Field | Type |
|---|---|
ID | text |
Object | text |
Address city | text |
Address country | text |
Address line 1 | text |
Address line 1 check | text |
Address line 2 | text |
| Field | Type |
|---|---|
Customer IDRequired | choice |
Limit | number |
| Field | Type |
|---|---|
ID | text |
Object | text |
Created | date |
Currency | text |
Customer | text |
Ending balance | number |
Funded | object |
Bank transfer | object |
| Field | Type |
|---|---|
Customer IDRequired | choice |
Type | choice |
Allow Redisplay | choice |
Limit | number |
| Field | Type |
|---|---|
ID | text |
Object | text |
Billing details | object |
Address | object |
Email | text |
Name | text |
Phone | text |
Card | object |
Brand | text |
Checks | object |
Country | text |
Exp month | number |
Exp year | number |
Fingerprint | text |
Funding | text |
Generated from | text |
Last 4 | text |
Networks | object |
Created | date |
Customer | text |
Livemode | boolean |
| Field | Type |
|---|---|
Email | |
Created | object |
Created After (Exclusive) | date |
Created After (Inclusive) | date |
Created Before (Exclusive) | date |
Created Before (Inclusive) | date |
Test Clock | text |
Limit | number |
| Field | Type |
|---|---|
ID | text |
Object | text |
Address | text |
Balance | number |
Created | date |
Currency | text |
Default source | text |
| Field | Type |
|---|---|
Charge ID | choice |
Payment Intent ID | choice |
Created | object |
Created After (Exclusive) | date |
Created After (Inclusive) | date |
Created Before (Exclusive) | date |
Created Before (Inclusive) | date |
Test Clock | text |
Limit | number |
| Field | Type |
|---|---|
ID | text |
Object | text |
Amount | number |
Balance transactions | array |
Charge | text |
Created | date |
Currency | text |
| Field | Type |
|---|---|
Include | choice |
Limit | number |
| Field | Type |
|---|---|
ID | text |
Object | text |
Created | date |
Description | text |
Enabled events | array |
Event payload | text |
Events from | array |
| Field | Type |
|---|---|
Created | object |
Created After (Exclusive) | date |
Created After (Inclusive) | date |
Created Before (Exclusive) | date |
Created Before (Inclusive) | date |
Types | array |
Event Name | text |
Limit | number |
| Field | Type |
|---|---|
ID | text |
Object | text |
Context | text |
Created | date |
Data | object |
Developer message summary | text |
Reason | object |
Validation end | date |
Validation start | date |
Livemode | boolean |
Reason | text |
| Field | Type |
|---|---|
File | choice |
Expired | boolean |
Created | object |
Created After | date |
Created After or Equal | date |
Created Before | date |
Created Before or Equal | date |
Limit | number |
| Field | Type |
|---|---|
ID | text |
Object | text |
Created | date |
Expired | boolean |
Expires at | date |
File | text |
Livemode | boolean |
| Field | Type |
|---|---|
PurposeRequired | choice |
Created | object |
Created After | date |
Created After or Equal | date |
Created Before | date |
Created Before or Equal | date |
Limit | number |
| Field | Type |
|---|---|
ID | text |
Object | text |
Created | date |
Expires at | date |
Filename | text |
Links | object |
Object | text |
Data | array |
Has more | boolean |
URL | text |
Purpose | text |
| Field | Type |
|---|---|
Customer | choice |
Customer Account | choice |
Status | choice |
Subscription | text |
Collection Method | choice |
Created | object |
Greater Than | date |
Greater Than or Equal To | date |
Less Than | date |
Less Than or Equal To | date |
Limit | number |
| Field | Type |
|---|---|
ID | text |
Object | text |
Amount | number |
Currency | text |
Customer | text |
Date | date |
Description | text |
| Field | Type |
|---|---|
Customer | choice |
Customer Account | choice |
Status | choice |
Subscription | text |
Collection Method | choice |
Created | object |
Greater Than | date |
Greater Than or Equal To | date |
Less Than | date |
Less Than or Equal To | date |
Limit | number |
| Field | Type |
|---|---|
ID | text |
Object | text |
Account country | text |
Account name | text |
Account tax ids | text |
Amount due | number |
Amount paid | number |
| Field | Type |
|---|---|
Customer ID | choice |
Customer Account ID | text |
Created | object |
Created After | date |
Created After or Equal | date |
Created Before | date |
Created Before or Equal | date |
Limit | number |
| Field | Type |
|---|---|
ID | text |
Object | text |
Amount | number |
Amount capturable | number |
Amount details | object |
Tip | object |
Amount received | number |
Application | text |
| Field | Type |
|---|---|
Active | boolean |
Limit | number |
| Field | Type |
|---|---|
ID | text |
Object | text |
Active | boolean |
After completion | object |
Hosted confirmation | object |
Type | text |
Allow promotion codes | boolean |
Application fee amount | text |
Application fee percent | text |
| Field | Type |
|---|---|
Customer ID | choice |
Customer Account ID | choice |
Type | choice |
Allow Redisplay | choice |
Limit | number |
| Field | Type |
|---|---|
ID | text |
Object | text |
Billing details | object |
Address | object |
Email | text |
Name | text |
Phone | text |
Card | object |
Brand | text |
Checks | object |
Country | text |
Exp month | number |
Exp year | number |
Fingerprint | text |
Funding | text |
Generated from | text |
Last 4 | text |
Networks | object |
Created | date |
Customer | text |
Livemode | boolean |
| Field | Type |
|---|---|
Limit | number |
| Field | Type |
|---|---|
ID | text |
Object | text |
Acss debit | object |
Available | boolean |
Display preference | object |
Active | boolean |
Affirm | object |
Available | boolean |
Display preference | object |
Afterpay clearpay | object |
Available | boolean |
Display preference | object |
Alipay | object |
Available | boolean |
Display preference | object |
| Field | Type |
|---|---|
Status | choice |
Arrival Date | object |
Greater Than | date |
Greater Than or Equal To | date |
Less Than | date |
Less Than or Equal To | date |
Created | object |
Greater Than | date |
Greater Than or Equal To | date |
Less Than | date |
Less Than or Equal To | date |
Destination | text |
Limit | number |
| Field | Type |
|---|---|
ID | text |
Object | text |
Amount | number |
Arrival date | date |
Automatic | boolean |
Balance transaction | text |
Created | date |
| Field | Type |
|---|---|
Account IDRequired | choice |
Limit | number |
| Field | Type |
|---|---|
ID | text |
Object | text |
Account | text |
Additional addresses | array |
Additional names | array |
Address | object |
City | text |
Country | text |
Line 1 | text |
Postal code | text |
State | text |
Created | date |
| Field | Type |
|---|---|
Active | boolean |
Currency | choice |
Product | choice |
Type | choice |
Created | object |
Greater Than | date |
Greater Than or Equal To | date |
Less Than | date |
Less Than or Equal To | date |
Limit | number |
| Field | Type |
|---|---|
ID | text |
Object | text |
Active | boolean |
Billing scheme | text |
Created | date |
Currency | text |
Custom unit amount | text |
| Field | Type |
|---|---|
Active | boolean |
Shippable | boolean |
Created | object |
Greater Than | date |
Greater Than or Equal To | date |
Less Than | date |
Less Than or Equal To | date |
Limit | number |
| Field | Type |
|---|---|
ID | text |
Object | text |
Active | boolean |
Created | date |
Default price | text |
Description | text |
Images | array |
| Field | Type |
|---|---|
Created | object |
Greater Than | date |
Greater Than or Equal To | date |
Less Than | date |
Less Than or Equal To | date |
Limit | number |
| Field | Type |
|---|---|
ID | text |
Object | text |
Active | boolean |
Code | text |
Promotion | object |
Type | text |
Coupon | text |
Created | date |
Customer | text |
| Field | Type |
|---|---|
Charge ID | choice |
Payment Intent ID | choice |
Created | object |
Greater Than | date |
Greater Than or Equal To | date |
Less Than | date |
Less Than or Equal To | date |
Destination | text |
Limit | number |
| Field | Type |
|---|---|
ID | text |
Object | text |
Amount | number |
Balance transaction | text |
Charge | text |
Created | date |
Currency | text |
| Field | Type |
|---|---|
Setup IntentRequired | choice |
Created | object |
Created After | date |
Created After or Equal | date |
Created Before | date |
Created Before or Equal | date |
Limit | number |
| Field | Type |
|---|---|
ID | text |
Object | text |
Application | text |
Created | date |
Customer | text |
Flow directions | text |
Livemode | boolean |
| Field | Type |
|---|---|
Customer ID | choice |
Customer Account ID | choice |
Payment Method | choice |
Created | object |
Created After | date |
Created After or Equal | date |
Created Before | date |
Created Before or Equal | date |
Limit | number |
| Field | Type |
|---|---|
ID | text |
Object | text |
Application | text |
Cancellation reason | text |
Client secret | text |
Created | number |
Customer | text |
| Field | Type |
|---|---|
Active | boolean |
Created | object |
Greater Than | date |
Greater Than or Equal To | date |
Less Than | date |
Less Than or Equal To | date |
Limit | number |
| Field | Type |
|---|---|
ID | text |
Object | text |
Active | boolean |
Created | date |
Delivery estimate | text |
Display name | text |
Fixed amount | object |
Amount | number |
Currency | text |
| Field | Type |
|---|---|
Active | boolean |
Created | object |
Greater Than | date |
Greater Than or Equal To | date |
Less Than | date |
Less Than or Equal To | date |
Limit | number |
| Field | Type |
|---|---|
ID | text |
Object | text |
Active | boolean |
Country | text |
Created | date |
Description | text |
Display name | text |
| Field | Type |
|---|---|
Object | text |
Available | array |
Connect reserved | array |
Livemode | boolean |
Pending | array |
Actions
| Field | Type |
|---|---|
Invoice IDRequired | choice |
Payment IntentRequired | choice |
Payment Record | choice |
| Field | Type |
|---|---|
ID | text |
Object | text |
Account country | text |
Account name | text |
Account tax ids | text |
Amount due | number |
Amount paid | number |
| Field | Type |
|---|---|
Payment IDRequired | text |
Customer IDRequired | choice |
Customer Account ID | choice |
| Field | Type |
|---|---|
ID | text |
Object | text |
Allow redisplay | text |
Billing details | object |
Address | object |
Email | text |
Name | text |
Phone | text |
Created | date |
Customer | text |
Livemode | boolean |
| Field | Type |
|---|---|
Payment Intent IDRequired | choice |
Cancellation Reason | choice |
| Field | Type |
|---|---|
ID | text |
Object | text |
Amount | number |
Amount capturable | number |
Amount details | object |
Tip | object |
Amount received | number |
Application | text |
| Field | Type |
|---|---|
Payout IDRequired | choice |
| Field | Type |
|---|---|
Refund IDRequired | choice |
| Field | Type |
|---|---|
Setup Intent IDRequired | choice |
Cancellation Reason | choice |
| Field | Type |
|---|---|
ID | text |
Object | text |
Application | text |
Automatic payment methods | object |
Enabled | boolean |
Cancellation reason | text |
Client secret | text |
Created | date |
| Field | Type |
|---|---|
Charge IDRequired | choice |
| Field | Type |
|---|---|
ID | text |
Object | text |
Amount | number |
Amount captured | number |
Amount refunded | number |
Application | text |
Application fee | text |
| Field | Type |
|---|---|
Payment Intent IDRequired | choice |
Amount to Capture | number |
Metadata | array |
| Field | Type |
|---|---|
ID | text |
Object | text |
Amount | number |
Amount capturable | number |
Amount details | object |
Tip | object |
Amount received | number |
Application | text |
| Field | Type |
|---|---|
Dispute IDRequired | choice |
| Field | Type |
|---|---|
ID | text |
Object | text |
Address | text |
Balance | number |
Created | date |
Currency | text |
Default source | text |
| Field | Type |
|---|---|
Account IDRequired | choice |
Include | choice |
| Field | Type |
|---|---|
ID | text |
Object | text |
Applied configurations | array |
Configuration | object |
Customer | object |
Merchant | object |
Contact email | text |
Created | date |
Dashboard | text |
| Field | Type |
|---|---|
Payment Intent IDRequired | choice |
Payment MethodRequired | choice |
ShippingRequired | object |
AddressRequired | object |
NameRequired | text |
Carrier | text |
Phone | text |
Tracking Number | text |
Receipt Email | |
Setup Future Usage | choice |
| Field | Type |
|---|---|
ID | text |
Object | text |
Amount | number |
Amount capturable | number |
Amount details | object |
Tip | object |
Amount received | number |
Application | text |
| Field | Type |
|---|---|
Setup Intent IDRequired | choice |
Payment MethodRequired | choice |
| Field | Type |
|---|---|
ID | text |
Object | text |
Application | text |
Automatic payment methods | object |
Enabled | boolean |
Cancellation reason | text |
Client secret | text |
Created | date |
| Field | Type |
|---|---|
Customer IDRequired | choice |
Account NumberRequired | text |
CountryRequired | text |
CurrencyRequired | text |
Object TypeRequired | text |
Account Holder NameRequired | text |
Account Holder TypeRequired | choice |
| Field | Type |
|---|---|
ID | text |
Object | text |
Account holder name | text |
Account holder type | text |
Account type | text |
Bank name | text |
Country | text |
| Field | Type |
|---|---|
Bank Account | object |
Account NumberRequired | text |
CountryRequired | text |
Account Holder Name | text |
Account Holder Type | choice |
Account Type | choice |
Currency | choice |
Payment Method | choice |
Routing Number | text |
Customer | choice |
| Field | Type |
|---|---|
ID | text |
Object | text |
Bank account | object |
ID | text |
Object | text |
Account holder name | text |
Account holder type | text |
Account type | text |
Bank name | text |
Country | text |
Currency | text |
Fingerprint | text |
Last 4 | text |
Client IP | text |
Created | date |
Livemode | boolean |
Redaction | text |
| Field | Type |
|---|---|
Customer IDRequired | choice |
Expiration MonthRequired | number |
Expiration YearRequired | number |
Card NumberRequired | text |
Currency | choice |
Address City | text |
Address Country | text |
| Field | Type |
|---|---|
ID | text |
Object | text |
Address city | text |
Address country | text |
Address line 1 | text |
Address line 1 check | text |
Address line 2 | text |
| Field | Type |
|---|---|
Card | object |
Expiration MonthRequired | text |
Expiration YearRequired | text |
Card NumberRequired | text |
CurrencyRequired | text |
CVC | text |
Address City | text |
Address Country | text |
Address Line 1 | text |
Address Line 2 | text |
Address State | text |
| Field | Type |
|---|---|
ID | text |
Object | text |
Card | object |
ID | text |
Object | text |
Address city | text |
Address country | text |
Address line 1 | text |
Address line 1 check | text |
Address line 2 | text |
Address state | text |
Address zip | text |
Address zip check | text |
Client IP | text |
Created | date |
Livemode | boolean |
Type | text |
| Field | Type |
|---|---|
AmountRequired | number |
CurrencyRequired | text |
Customer ID | choice |
Description | text |
Metadata | array |
Receipt Email | |
Shipping | object |
AddressRequired | object |
Recipient NameRequired | text |
Carrier | text |
Phone | text |
Tracking Number | text |
| Field | Type |
|---|---|
ID | text |
Object | text |
Amount | number |
Amount captured | number |
Amount refunded | number |
Application | text |
Application fee | text |
| Field | Type |
|---|---|
Automatic Tax | object |
EnabledRequired | boolean |
Liability | object |
Client Reference ID | choice |
Customer | choice |
Customer Email | |
Line Items | array |
ModeRequired | choice |
Return URL | url |
| Field | Type |
|---|---|
ID | text |
Object | text |
After expiration | text |
Allow promotion codes | text |
Amount subtotal | number |
Amount total | number |
Automatic tax | object |
Enabled | boolean |
Liability | text |
Status | text |
| Field | Type |
|---|---|
Applies To | object |
Products | choice |
Currency Options | object |
Amount OffRequired | number |
Duration In Months | number |
ID | text |
Max Redemptions | number |
Redeem By | date |
Metadata | array |
| Field | Type |
|---|---|
ID | text |
Object | text |
Amount off | text |
Created | date |
Currency | text |
Duration | text |
Livemode | boolean |
| Field | Type |
|---|---|
AddressRequired | object |
City | text |
Country | text |
Line 1 | text |
Line 2 | text |
Postal Code | text |
State | text |
Shipping | object |
AddressRequired | object |
NameRequired | text |
Phone | text |
Description | text |
Email | |
Metadata | array |
Name | text |
Payment Method | text |
| Field | Type |
|---|---|
ID | text |
Object | text |
Address | text |
Balance | number |
Created | date |
Currency | text |
Default source | text |
| Field | Type |
|---|---|
CVC UpdateRequired | object |
CVCRequired | text |
| Field | Type |
|---|---|
ID | text |
Object | text |
Client IP | text |
Created | date |
Livemode | boolean |
Redaction | text |
Type | text |
| Field | Type |
|---|---|
Enabled EventsRequired | array |
Event | text |
Event PayloadRequired | choice |
NameRequired | text |
TypeRequired | choice |
Amazon EventBridge | object |
AWS Account IDRequired | text |
AWS RegionRequired | text |
Azure Event Grid | object |
Azure RegionRequired | text |
Azure Resource Group NameRequired | text |
Azure Subscription IDRequired | text |
Description | text |
| Field | Type |
|---|---|
ID | text |
Object | text |
Created | date |
Description | text |
Enabled events | array |
Event payload | text |
Events from | array |
| Field | Type |
|---|---|
FileRequired | text |
PurposeRequired | choice |
File Link Data | object |
CreateRequired | boolean |
Expires At | date |
Description | text |
Metadata | array |
| Field | Type |
|---|---|
ID | text |
Object | text |
Created | date |
Expires at | date |
Filename | text |
Links | object |
Object | text |
Data | array |
Has more | boolean |
URL | text |
Purpose | text |
| Field | Type |
|---|---|
File IDRequired | choice |
PurposeRequired | choice |
Expires At | date |
Metadata | array |
| Field | Type |
|---|---|
ID | text |
Object | text |
Created | date |
Expired | boolean |
Expires at | date |
File | text |
Livemode | boolean |
| Field | Type |
|---|---|
Contact Email | |
Display Name | text |
Identity | object |
Country | choice |
Entity Type | choice |
Business Details | object |
Configuration | object |
Customer | object |
Merchant | object |
Defaults | object |
Responsibilities | object |
Dashboard | choice |
Include | array |
| Field | Type |
|---|---|
ID | text |
Object | text |
Applied configurations | array |
Configuration | object |
Customer | object |
Merchant | object |
Contact email | text |
Created | date |
Dashboard | text |
| Field | Type |
|---|---|
Account IDRequired | choice |
Use CaseRequired | object |
TypeRequired | choice |
Account Onboarding | object |
Account Update | object |
| Field | Type |
|---|---|
Object | text |
Account | text |
Created | date |
Expires at | date |
Livemode | boolean |
URL | text |
Use case | object |
Account onboarding | object |
Type | text |
| Field | Type |
|---|---|
Business TypeRequired | choice |
Company | object |
Company's Legal Name | text |
Company's Legal Name Kana | text |
Company's Legal Name Kanji | text |
Company Address | object |
Company Address Kana | object |
Company Address Kanji | object |
Directors Provided | boolean |
Directorship Declaration | object |
Executives Provided | boolean |
Export License ID | text |
| Field | Type |
|---|---|
ID | text |
Object | text |
Client IP | text |
Created | date |
Livemode | boolean |
Redaction | text |
Type | text |
| Field | Type |
|---|---|
Customer IDRequired | choice |
Automatic Tax | object |
EnabledRequired | boolean |
Tax Liability | object |
Collection Method | choice |
From Invoice | object |
ActionRequired | text |
Invoice IDRequired | choice |
Customer Account ID | choice |
Description | text |
Subscription ID | choice |
| Field | Type |
|---|---|
ID | text |
Object | text |
Account country | text |
Account name | text |
Account tax ids | text |
Amount due | number |
Amount paid | number |
| Field | Type |
|---|---|
AmountRequired | number |
CurrencyRequired | choice |
Customer IDRequired | choice |
Customer Account ID | choice |
Description | text |
Metadata | array |
Period | object |
Period StartRequired | date |
Period EndRequired | date |
| Field | Type |
|---|---|
ID | text |
Object | text |
Amount | number |
Currency | text |
Customer | text |
Date | date |
Description | text |
| Field | Type |
|---|---|
NameRequired | text |
ParentRequired | choice |
| Field | Type |
|---|---|
ID | text |
Object | text |
Acss debit | object |
Available | boolean |
Display preference | object |
Active | boolean |
Affirm | object |
Available | boolean |
Display preference | object |
Afterpay clearpay | object |
Available | boolean |
Display preference | object |
Alipay | object |
Available | boolean |
Display preference | object |
| Field | Type |
|---|---|
AmountRequired | number |
CurrencyRequired | choice |
Automatic Payment Methods | object |
EnabledRequired | boolean |
Allow Redirects | choice |
Confirm | boolean |
Customer | choice |
Customer Account | choice |
Description | text |
| Field | Type |
|---|---|
ID | text |
Object | text |
Amount | number |
Amount capturable | number |
Amount details | object |
Tip | object |
Amount received | number |
Application | text |
| Field | Type |
|---|---|
Line Items | array |
Metadata | array |
| Field | Type |
|---|---|
ID | text |
Object | text |
Active | boolean |
After completion | object |
Hosted confirmation | object |
Type | text |
Allow promotion codes | boolean |
Application fee amount | text |
Application fee percent | text |
| Field | Type |
|---|---|
TypeRequired | choice |
Billing Details | object |
Full Name | text |
Email | |
Phone | text |
Tax ID | text |
Address | object |
Metadata | array |
ACSS Debit | object |
Account NumberRequired | text |
Institution NumberRequired | text |
Transit NumberRequired | text |
Allow Redisplay | choice |
Boleto | object |
Tax IDRequired | text |
Card | object |
NumberRequired | text |
Expiration MonthRequired | number |
Expiration YearRequired | number |
CVC | text |
Networks | object |
| Field | Type |
|---|---|
ID | text |
Object | text |
Allow redisplay | text |
Billing details | object |
Address | object |
Email | text |
Name | text |
Phone | text |
Created | date |
Customer | text |
Livemode | boolean |
| Field | Type |
|---|---|
AmountRequired | number |
CurrencyRequired | choice |
DescriptionRequired | text |
Destination | text |
Method | choice |
Payout Method | choice |
Source Type | choice |
| Field | Type |
|---|---|
ID | text |
Object | text |
Amount | number |
Arrival date | date |
Automatic | boolean |
Balance transaction | text |
Created | date |
| Field | Type |
|---|---|
Account IDRequired | choice |
Given NameRequired | text |
SurnameRequired | text |
EmailRequired | |
AddressRequired | object |
Address Line 1Required | text |
CityRequired | text |
Postal CodeRequired | text |
StateRequired | text |
CountryRequired | text |
ID Numbers | array |
RelationshipRequired | object |
OwnerRequired | boolean |
Percent OwnershipRequired | number |
RepresentativeRequired | boolean |
Title | text |
| Field | Type |
|---|---|
ID | text |
Object | text |
Account | text |
Additional addresses | array |
Additional names | array |
Address | object |
City | text |
Country | text |
Line 1 | text |
Postal code | text |
State | text |
Created | date |
| Field | Type |
|---|---|
EmailRequired | |
First NameRequired | text |
First Name Kana | text |
First Name Kanji | text |
Full Name Aliases | array |
Gender | choice |
ID Number | text |
| Field | Type |
|---|---|
ID | text |
Object | text |
Client IP | text |
Created | date |
Livemode | boolean |
Redaction | text |
Type | text |
| Field | Type |
|---|---|
PIIRequired | object |
ID Number | text |
| Field | Type |
|---|---|
ID | text |
Object | text |
Client IP | text |
Created | date |
Livemode | boolean |
Redaction | text |
Type | text |
| Field | Type |
|---|---|
CurrencyRequired | choice |
Product IDRequired | choice |
Recurring | object |
IntervalRequired | choice |
Interval Count | number |
Meter | text |
Usage Type | choice |
Unit Amount | number |
Active | boolean |
Nickname | text |
Tax Behavior | choice |
| Field | Type |
|---|---|
ID | text |
Object | text |
Active | boolean |
Billing scheme | text |
Created | date |
Currency | text |
Custom unit amount | text |
| Field | Type |
|---|---|
NameRequired | text |
Active | boolean |
Description | text |
ID | text |
Tax Code | text |
Tax Details | object |
Tax Code | text |
Performance Location | text |
Metadata | array |
| Field | Type |
|---|---|
ID | text |
Object | text |
Active | boolean |
Created | date |
Default price | text |
Description | text |
Images | array |
| Field | Type |
|---|---|
PromotionRequired | object |
TypeRequired | choice |
Coupon | text |
Code | text |
Metadata | array |
| Field | Type |
|---|---|
ID | text |
Object | text |
Active | boolean |
Code | text |
Promotion | object |
Type | text |
Coupon | text |
Created | date |
Customer | text |
| Field | Type |
|---|---|
Charge IDRequired | choice |
AmountRequired | number |
ReasonRequired | choice |
Payment Intent IDRequired | choice |
Metadata | array |
Instructions Email | |
Origin | choice |
| Field | Type |
|---|---|
ID | text |
Object | text |
Amount | number |
Balance transaction | text |
Charge | text |
Created | date |
Currency | text |
| Field | Type |
|---|---|
Display NameRequired | text |
TypeRequired | choice |
Fixed Amount | object |
AmountRequired | number |
CurrencyRequired | choice |
Currency Options | object |
Tax Behavior | choice |
Tax Code | choice |
Delivery Estimate | object |
Minimum | object |
Maximum | object |
Metadata | array |
| Field | Type |
|---|---|
ID | text |
Object | text |
Active | boolean |
Created | date |
Delivery estimate | text |
Display name | text |
Fixed amount | object |
Amount | number |
Currency | text |
| Field | Type |
|---|---|
Display NameRequired | text |
InclusiveRequired | boolean |
PercentageRequired | number |
Active | boolean |
Country | text |
Description | text |
Jurisdiction | text |
| Field | Type |
|---|---|
ID | text |
Object | text |
Active | boolean |
Country | text |
Created | date |
Description | text |
Display name | text |
| Field | Type |
|---|---|
Customer IDRequired | choice |
CurrencyRequired | choice |
Funding TypeRequired | choice |
Bank TransferRequired | object |
TypeRequired | choice |
EU Bank Transfer | object |
Requested Address Types | array |
| Field | Type |
|---|---|
Object | text |
Bank transfer | object |
Country | text |
Financial addresses | array |
Type | text |
Currency | text |
Funding type | text |
Livemode | boolean |
| Field | Type |
|---|---|
Automatic Payment Methods | object |
EnabledRequired | boolean |
Allow Redirects | choice |
DescriptionRequired | text |
Confirm | boolean |
Customer | choice |
Customer Account | choice |
Payment Method | text |
Usage | choice |
| Field | Type |
|---|---|
ID | text |
Object | text |
Application | text |
Automatic payment methods | object |
Enabled | boolean |
Cancellation reason | text |
Client secret | text |
Created | date |
| Field | Type |
|---|---|
Customer IDRequired | choice |
| Field | Type |
|---|---|
Customer IDRequired | choice |
| Field | Type |
|---|---|
Coupon IDRequired | choice |
| Field | Type |
|---|---|
Customer IDRequired | choice |
| Field | Type |
|---|---|
Event Destination IDRequired | choice |
| Field | Type |
|---|---|
Invoice IDRequired | choice |
| Field | Type |
|---|---|
Invoice Item IDRequired | choice |
| Field | Type |
|---|---|
Account ID | choice |
| Field | Type |
|---|---|
Product IDRequired | choice |
| Field | Type |
|---|---|
Payment IDRequired | text |
| Field | Type |
|---|---|
ID | text |
Object | text |
Allow redisplay | text |
Billing details | object |
Address | object |
Email | text |
Name | text |
Phone | text |
Created | date |
Customer | text |
Livemode | boolean |
| Field | Type |
|---|---|
Event Destination IDRequired | choice |
| Field | Type |
|---|---|
ID | text |
Object | text |
Created | date |
Description | text |
Enabled events | array |
Event payload | text |
Events from | array |
| Field | Type |
|---|---|
Event Destination IDRequired | choice |
| Field | Type |
|---|---|
ID | text |
Object | text |
Created | date |
Description | text |
Enabled events | array |
Event payload | text |
Events from | array |
| Field | Type |
|---|---|
Checkout Session IDRequired | choice |
| Field | Type |
|---|---|
ID | text |
Object | text |
After expiration | text |
Allow promotion codes | text |
Amount subtotal | number |
Amount total | number |
Automatic tax | object |
Enabled | boolean |
Liability | text |
Status | text |
| Field | Type |
|---|---|
Invoice IDRequired | choice |
Auto Advance | boolean |
| Field | Type |
|---|---|
ID | text |
Object | text |
Account country | text |
Account name | text |
Account tax ids | text |
Amount due | number |
Amount paid | number |
| Field | Type |
|---|---|
Customer IDRequired | choice |
AmountRequired | number |
CurrencyRequired | choice |
Reference | text |
| Field | Type |
|---|---|
ID | text |
Object | text |
Created | date |
Currency | text |
Customer | text |
Ending balance | number |
Funded | object |
Bank transfer | object |
| Field | Type |
|---|---|
URLRequired | text |
MethodRequired | choice |
Headers | array |
Header | object |
Query String | array |
Parameter | object |
Body | text |
| Field | Type |
|---|---|
Body | text |
Headers | object |
Status code | number |
| Field | Type |
|---|---|
Invoice IDRequired | choice |
| Field | Type |
|---|---|
ID | text |
Object | text |
Account country | text |
Account name | text |
Account tax ids | text |
Amount due | number |
Amount paid | number |
| Field | Type |
|---|---|
Invoice IDRequired | choice |
| Field | Type |
|---|---|
ID | text |
Object | text |
Account country | text |
Account name | text |
Account tax ids | text |
Amount due | number |
Amount paid | number |
| Field | Type |
|---|---|
Payment Intent IDRequired | choice |
Amount | number |
Currency | choice |
| Field | Type |
|---|---|
ID | text |
Object | text |
Amount | number |
Amount capturable | number |
Amount details | object |
Tip | object |
Amount received | number |
Application | text |
| Field | Type |
|---|---|
Payout IDRequired | choice |
Metadata | array |
| Field | Type |
|---|---|
ID | text |
Object | text |
Amount | number |
Arrival date | date |
Automatic | boolean |
Balance transaction | text |
Created | date |
| Field | Type |
|---|---|
Invoice IDRequired | choice |
| Field | Type |
|---|---|
ID | text |
Object | text |
Account country | text |
Account name | text |
Account tax ids | text |
Amount due | number |
Amount paid | number |
| Field | Type |
|---|---|
Customer IDRequired | choice |
Account Holder Name | text |
Account Holder Type | choice |
Metadata | array |
| Field | Type |
|---|---|
ID | text |
Object | text |
Account holder name | text |
Account holder type | text |
Account type | text |
Bank name | text |
Country | text |
| Field | Type |
|---|---|
Customer IDRequired | choice |
Address City | text |
Address Country | text |
Address Line 1 | text |
Address Line 2 | text |
Address State | text |
Address ZIP | text |
| Field | Type |
|---|---|
ID | text |
Object | text |
Address city | text |
Address country | text |
Address line 1 | text |
Address line 1 check | text |
Address line 2 | text |
| Field | Type |
|---|---|
Charge IDRequired | choice |
Amount | number |
Currency | text |
Customer ID | choice |
Description | text |
Metadata | array |
Receipt Email |
| Field | Type |
|---|---|
ID | text |
Object | text |
Amount | number |
Amount captured | number |
Amount refunded | number |
Application | text |
Application fee | text |
| Field | Type |
|---|---|
Checkout Session IDRequired | choice |
Line Items | array |
Metadata | array |
| Field | Type |
|---|---|
ID | text |
Object | text |
After expiration | text |
Allow promotion codes | text |
Amount subtotal | number |
Amount total | number |
Automatic tax | object |
Enabled | boolean |
Liability | text |
Status | text |
| Field | Type |
|---|---|
Coupon IDRequired | choice |
Currency Options | object |
Amount OffRequired | number |
Metadata | array |
| Field | Type |
|---|---|
ID | text |
Object | text |
Amount off | text |
Created | date |
Currency | text |
Duration | text |
Livemode | boolean |
| Field | Type |
|---|---|
Customer IDRequired | choice |
Address | object |
City | text |
Country | text |
Line 1 | text |
Line 2 | text |
Postal Code | text |
State | text |
Shipping | object |
AddressRequired | object |
NameRequired | text |
Phone | text |
Description | text |
Email | |
Metadata | array |
Name | text |
| Field | Type |
|---|---|
ID | text |
Object | text |
Address | text |
Balance | number |
Created | date |
Currency | text |
Default source | text |
| Field | Type |
|---|---|
Dispute IDRequired | choice |
Evidence | object |
Access Activity Log | text |
Billing Address | text |
Cancellation Policy | text |
Cancellation Policy Disclosure | text |
Cancellation Rebuttal | text |
Customer Communication | text |
Customer Email Address | |
Customer Name | text |
Customer Purchase IP | text |
Customer Signature | text |
Metadata | array |
Submit | boolean |
| Field | Type |
|---|---|
ID | text |
Object | text |
Address | text |
Balance | number |
Created | date |
Currency | text |
Default source | text |
| Field | Type |
|---|---|
Event Destination IDRequired | choice |
Enabled Events | array |
Event | text |
Event Payload | choice |
Name | text |
Type | choice |
Amazon EventBridge | object |
AWS Account ID | text |
AWS Region | text |
Azure Event Grid | object |
Azure Region | text |
Azure Resource Group NameRequired | text |
Azure Subscription IDRequired | text |
| Field | Type |
|---|---|
ID | text |
Object | text |
Created | date |
Description | text |
Enabled events | array |
Event payload | text |
Events from | array |
| Field | Type |
|---|---|
File Link IDRequired | choice |
Expires At | date |
Metadata | array |
| Field | Type |
|---|---|
ID | text |
Object | text |
Created | date |
Expired | boolean |
Expires at | date |
File | text |
Livemode | boolean |
| Field | Type |
|---|---|
Account IDRequired | choice |
Contact Email | |
Display Name | text |
Identity | object |
Country | choice |
Entity Type | choice |
Business Details | object |
Configuration | object |
Customer | object |
Merchant | object |
Defaults | object |
Responsibilities | object |
Dashboard | choice |
| Field | Type |
|---|---|
ID | text |
Object | text |
Applied configurations | array |
Configuration | object |
Customer | object |
Merchant | object |
Contact email | text |
Created | date |
Dashboard | text |
| Field | Type |
|---|---|
Invoice IDRequired | choice |
Customer ID | choice |
Automatic Tax | object |
Enabled | boolean |
Tax Liability | object |
Collection Method | choice |
From Invoice | object |
ActionRequired | text |
Invoice ID | choice |
Customer Account ID | choice |
Description | text |
| Field | Type |
|---|---|
ID | text |
Object | text |
Account country | text |
Account name | text |
Account tax ids | text |
Amount due | number |
Amount paid | number |
| Field | Type |
|---|---|
Invoice Item IDRequired | choice |
Amount | number |
Currency | choice |
Customer ID | choice |
Customer Account ID | choice |
Description | text |
Metadata | array |
| Field | Type |
|---|---|
ID | text |
Object | text |
Amount | number |
Currency | text |
Customer | text |
Date | date |
Description | text |
| Field | Type |
|---|---|
Configuration IDRequired | choice |
Name | text |
Parent | choice |
| Field | Type |
|---|---|
ID | text |
Object | text |
Acss debit | object |
Available | boolean |
Display preference | object |
Active | boolean |
Affirm | object |
Available | boolean |
Display preference | object |
Afterpay clearpay | object |
Available | boolean |
Display preference | object |
Alipay | object |
Available | boolean |
Display preference | object |
| Field | Type |
|---|---|
Payment Intent IDRequired | choice |
Amount | number |
Currency | choice |
Automatic Payment Methods | object |
Enabled | boolean |
Allow Redirects | choice |
Confirm | boolean |
Customer | choice |
Customer Account | choice |
| Field | Type |
|---|---|
ID | text |
Object | text |
Amount | number |
Amount capturable | number |
Amount details | object |
Tip | object |
Amount received | number |
Application | text |
| Field | Type |
|---|---|
Payment Link IDRequired | choice |
Line Items | array |
Metadata | array |
| Field | Type |
|---|---|
ID | text |
Object | text |
Active | boolean |
After completion | object |
Hosted confirmation | object |
Type | text |
Allow promotion codes | boolean |
Application fee amount | text |
Application fee percent | text |
| Field | Type |
|---|---|
Payment IDRequired | text |
Type | choice |
Billing Details | object |
Full Name | text |
Email | |
Phone | text |
Tax ID | text |
Address | object |
Metadata | array |
ACSS Debit | object |
Account NumberRequired | text |
Institution NumberRequired | text |
Transit NumberRequired | text |
Allow Redisplay | choice |
Boleto | object |
Tax IDRequired | text |
| Field | Type |
|---|---|
ID | text |
Object | text |
Allow redisplay | text |
Billing details | object |
Address | object |
Email | text |
Name | text |
Phone | text |
Created | date |
Customer | text |
Livemode | boolean |
| Field | Type |
|---|---|
Payout IDRequired | choice |
Amount | number |
Currency | choice |
Description | text |
Destination | text |
Method | choice |
Payout Method | choice |
| Field | Type |
|---|---|
ID | text |
Object | text |
Amount | number |
Arrival date | date |
Automatic | boolean |
Balance transaction | text |
Created | date |
| Field | Type |
|---|---|
Account ID | choice |
Address | object |
CountryRequired | choice |
City | text |
Line 1 | text |
Line 2 | text |
Postal Code | text |
State | text |
Town | text |
Date of Birth | object |
DayRequired | number |
MonthRequired | number |
YearRequired | number |
Email | |
Given Name | text |
ID Numbers | array |
Legal Gender | choice |
| Field | Type |
|---|---|
ID | text |
Object | text |
Account | text |
Additional addresses | array |
Additional names | array |
Address | object |
City | text |
Country | text |
Line 1 | text |
Postal code | text |
State | text |
Created | date |
| Field | Type |
|---|---|
Price IDRequired | choice |
Active | boolean |
Nickname | text |
Tax Behavior | choice |
Currency Options | object |
Custom Unit Amount | object |
Tax Behavior | choice |
Tiers | array |
Unit Amount | number |
Unit Amount Decimal | text |
Lookup Key | text |
Transfer Lookup Key | boolean |
| Field | Type |
|---|---|
ID | text |
Object | text |
Active | boolean |
Billing scheme | text |
Created | date |
Currency | text |
Custom unit amount | text |
| Field | Type |
|---|---|
Product IDRequired | choice |
Name | text |
Active | boolean |
Description | text |
Tax Code | text |
Tax Details | object |
Tax Code | text |
Performance Location | text |
Metadata | array |
| Field | Type |
|---|---|
ID | text |
Object | text |
Active | boolean |
Created | date |
Default price | text |
Description | text |
Images | array |
| Field | Type |
|---|---|
IDRequired | choice |
Active | boolean |
Restrictions | object |
Currency Options | object |
Metadata | array |
| Field | Type |
|---|---|
ID | text |
Object | text |
Active | boolean |
Code | text |
Promotion | object |
Type | text |
Coupon | text |
Created | date |
Customer | text |
| Field | Type |
|---|---|
Refund IDRequired | choice |
Charge ID | choice |
Amount | number |
Reason | choice |
Payment Intent ID | choice |
Metadata | array |
Instructions Email |
| Field | Type |
|---|---|
ID | text |
Object | text |
Amount | number |
Balance transaction | text |
Charge | text |
Created | date |
Currency | text |
| Field | Type |
|---|---|
Setup Intent IDRequired | choice |
Automatic Payment Methods | object |
EnabledRequired | boolean |
Allow Redirects | choice |
Description | text |
Confirm | boolean |
Customer | choice |
Customer Account | choice |
Payment Method | text |
| Field | Type |
|---|---|
ID | text |
Object | text |
Application | text |
Automatic payment methods | object |
Enabled | boolean |
Cancellation reason | text |
Client secret | text |
Created | date |
| Field | Type |
|---|---|
Shipping Rate IDRequired | choice |
Fixed Amount | object |
AmountRequired | number |
CurrencyRequired | choice |
Currency Options | object |
Tax Behavior | choice |
Metadata | array |
| Field | Type |
|---|---|
ID | text |
Object | text |
Active | boolean |
Created | date |
Delivery estimate | text |
Display name | text |
Fixed amount | object |
Amount | number |
Currency | text |
| Field | Type |
|---|---|
Tax Rate IDRequired | choice |
Display Name | text |
Inclusive | boolean |
Percentage | number |
Active | boolean |
Country | text |
Description | text |
| Field | Type |
|---|---|
ID | text |
Object | text |
Active | boolean |
Country | text |
Created | date |
Description | text |
Display name | text |
| Field | Type |
|---|---|
Customer IDRequired | choice |
Amounts | array |
Amount in Cents | number |
| Field | Type |
|---|---|
ID | text |
Object | text |
Account holder name | text |
Account holder type | text |
Account type | text |
Bank name | text |
Country | text |
| Field | Type |
|---|---|
Invoice IDRequired | choice |
| Field | Type |
|---|---|
ID | text |
Object | text |
Account country | text |
Account name | text |
Account tax ids | text |
Amount due | number |
Amount paid | number |

