Stripe to Xero Integration | MESA
Connect Stripe to Xero and automate your tasks
Describe to build
Activity reports
Fully supported
MESA's Stripe to Xero integration is the fastest way to sync data between the two — without touching a line of code. Choose which fields to send, how they're formatted, and when the sync happens. Start with a pre-built template, customize it with AI, or build something completely unique in under 10 minutes.
★★★★★ 4.9 rating on Shopify App Store
Start when...
Personalize with built-in tools...
Then, do this...
Trusted by 1,000+ Shopify merchants
Why integrate Stripe with Xero
The Stripe to Xero integration helps you sync data, automate manual tasks, and keep your stack aligned — without writing code.
Sync Stripe payment events with Shopify customer records
When a Stripe payment is completed, failed, or refunded, MESA updates the corresponding Shopify customer record with the transaction details. Your store reflects the full payment picture without anyone reconciling the two platforms manually.
Trigger Shopify workflows from Stripe subscription events
When a Stripe subscription starts, renews, or lapses, MESA kicks off the right action in Shopify — updating a customer tag, enrolling them in a Klaviyo flow, adjusting access. Your commerce workflows stay in step with your billing platform without custom development.
Keep your finance and ops tools current when payments change
When a Stripe payment event occurs — a charge, a dispute, a payout — MESA writes the details to QuickBooks, Xero, or Airtable automatically. Your financial records stay current from the moment a transaction happens without a manual entry step.
Send every Shopify order to Xero without manual entry
When an order is placed, MESA creates the corresponding record in Xero — customer, line items, amount — automatically. Your accounts stay current from the moment a sale happens without anyone re-entering data.
Generate Xero invoices from Shopify wholesale orders
When a B2B or wholesale order comes in, MESA creates an invoice in Xero and routes it to the right customer account. Your billing runs without the manual step between your store and your accounting software.
Keep customer records consistent across Shopify and Xero
When a new customer places their first order, MESA creates or updates their record in Xero to match Shopify. Your accounting and your storefront always reflect the same customer without periodic reconciliation.
Build any Stripe and Xero automation
MESA helps you connect apps to automate repetitive tasks. A trigger is an event that starts a workflow, and actions are the steps that occur when it's running.
Account Updated
Starts when a new account is updated.
Code
Name
Account ID
Type
Bank Account Number
Status
Description
Bank Account Type
Currency Code
Tax Type
Enable Payments To Account
Show In Expense Claims
Class
System Account
Reporting Code
Reporting Code Name
Updated Date U T C
Add To Watchlist
Contact Updated
Starts when a contact is updated.
Contact ID
Merged To Contact ID
Contact Number
Account Number
Contact Status
Name
First Name
Last Name
Company Number
Email Address
Skype User Name
Contact Persons
Bank Account Details
Tax Number
Accounts Receivable Tax Type
Accounts Payable Tax Type
Addresses
Phones
Is Supplier
Is Customer
Sales Default Line Amount Type
Purchases Default Line Amount Type
Default Currency
Xero Network Key
Sales Default Account Code
Purchases Default Account Code
Sales Tracking Categories
Purchases Tracking Categories
Tracking Category Name
Tracking Category Option
Payment Terms
Updated Date U T C
Contact Groups
Website
Branding Theme
Discount
Balances
Attachments
Status Attribute String
Employee Updated
Starts when an employee is updated.
Employee ID
Status
First Name
Last Name
External Link
Updated Date U T C
Status Attribute String
Expense Claim Updated
Starts when an expense claim is updated.
Expense Claim ID
Status
Payments
User
Receipts
Updated Date U T C
Total
Amount Due
Amount Paid
Payment Due Date
Reporting Date
Receipt ID
Invoice Updated
Starts when an invoice is updated.
Type
Contact
Line Items
Date
Due Date
Line Amount Types
Invoice Number
Reference
Branding Theme ID
URL
Currency Code
Currency Rate
Status
Sent To Contact
Expected Payment Date
Planned Payment Date
CISDeduction
CISRate
Sub Total
Total Tax
Total
Total Discount
Invoice ID
Repeating Invoice ID
Is Discounted
Payments
Prepayments
Overpayments
Amount Due
Amount Paid
Fully Paid On Date
Amount Credited
Updated Date U T C
Credit Notes
Attachments
Has Errors
Status Attribute String
Payment Updated
Starts when a payment is updated.
Type
Contact
Line Items
Date
Due Date
Line Amount Types
Invoice Number
Reference
Branding Theme ID
URL
Currency Code
Currency Rate
Status
Sent To Contact
Expected Payment Date
Planned Payment Date
CISDeduction
CISRate
Sub Total
Total Tax
Total
Total Discount
Invoice ID
Repeating Invoice ID
Is Discounted
Payments
Prepayments
Overpayments
Amount Due
Amount Paid
Fully Paid On Date
Amount Credited
Updated Date U T C
Credit Notes
Attachments
Has Errors
Status Attribute String
Purchase Order Updated
Starts when a purchase order is updated.
Contact ID
Merged To Contact ID
Contact Number
Account Number
Contact Status
Name
First Name
Last Name
Company Number
Email Address
Skype User Name
Contact Persons
Bank Account Details
Tax Number
Accounts Receivable Tax Type
Accounts Payable Tax Type
Addresses
Phones
Is Supplier
Is Customer
Sales Default Line Amount Type
Purchases Default Line Amount Type
Default Currency
Xero Network Key
Sales Default Account Code
Purchases Default Account Code
Sales Tracking Categories
Purchases Tracking Categories
Tracking Category Name
Tracking Category Option
Payment Terms
Updated Date U T C
Contact Groups
Website
Branding Theme
Discount
Balances
Attachments
Status Attribute String
Quote Updated
Starts when a quote is updated.
Quote ID
Quote Number
Reference
Terms
Contact
Line Items
Date
Date String
Expiry Date
Expiry Date String
Status
Currency Code
Currency Rate
Sub Total
Total Tax
Total
Total Discount
Title
Summary
Branding Theme ID
Updated Date U T C
Line Amount Types
Status Attribute String
Receipt Updated
Starts when a receipt is updated.
Date
Contact
Line Items
User
Reference
Line Amount Types
Sub Total
Total Tax
Total
Receipt ID
Status
Receipt Number
Updated Date U T C
URL
Attachments
User Updated
Starts when an user is updated.
User ID
Email Address
First Name
Last Name
Updated Date U T C
Is Subscriber
Organisation Role
Account Application Authorized
Starts when a user authorizes an application. Sent to the related application only.
ID
Object
Name
Scopes
User
Livemode
Status
Account Application Deauthorized
Starts when a user deauthorizes an application. Sent to the related application only.
ID
Object
Name
User
Livemode
Status
Application Fee Created
Starts when an application fee is created on a charge.
ID
Object
Amount
Amount Refunded
Application
Balance Transaction
Charge
Created
Currency
Originating Transaction
Refunded
Refunds
Application Fee Refund Updated
Starts when an application fee refund is updated.
ID
Object
Amount
Application
Balance Transaction
Charge
Created
Currency
Fee
Metadata
Reason
Status
Application Fee Refunded
Starts when an application fee is refunded, whether from refunding a charge or from refunding the application fee directly. This includes partial refunds.
ID
Object
Amount
Amount Refunded
Application
Balance Transaction
Charge
Created
Currency
Originating Transaction
Refunded
Refunds
Billing Portal Configuration Created
Starts when a portal configuration is created.
ID
Object
Created
Business Profile
Features
Billing Portal Configuration Updated
Starts when a portal configuration is updated.
ID
Object
Created
Business Profile
Features
Billing Portal Session Created
Starts when a portal session is created.
ID
Object
Created
Customer
Return URL
URL
Livemode
Cash Balance Funds Available
Starts when a positive remaining cash balance after Stripe automatically reconciles new funds into the cash balance. If you have manual reconciliation enabled, this will trigger whenever there are new funds into the cash balance.
ID
Object
Available On
Balance
Currency
Livemode
Pending
Charge Dispute Closed
Starts when a dispute is closed and the dispute status changes to lost, warning closed, or won.
ID
Object
Amount
Balance Transactions
Charge
Created
Currency
Evidence
Evidence Details
Is Charge Refundable
Livemode
Metadata
Reason
Status
Charge Dispute Created
Starts when a customer disputes a charge with their bank.
ID
Object
Amount
Balance Transactions
Charge
Created
Currency
Evidence
Evidence Details
Is Charge Refundable
Livemode
Metadata
Reason
Status
Charge Dispute Funds Reinstated
Starts when funds are reinstated to your account after a dispute is closed. This includes partially refunded payments.
ID
Object
Amount
Balance Transactions
Charge
Created
Currency
Evidence
Evidence Details
Is Charge Refundable
Livemode
Metadata
Reason
Status
Charge Dispute Funds Withdrawn
Starts when funds are removed from your account due to a dispute.
ID
Object
Amount
Balance Transactions
Charge
Created
Currency
Evidence
Evidence Details
Is Charge Refundable
Livemode
Metadata
Reason
Status
Charge Dispute Updated
Starts when the dispute is updated (usually with evidence).
ID
Object
Amount
Balance Transactions
Charge
Created
Currency
Evidence
Evidence Details
Is Charge Refundable
Livemode
Metadata
Reason
Status
Charge Refund Updated
Starts when a refund is updated, on selected payment methods.
ID
Object
Amount
Refunded
Refunds
Status
Checkout Session Async Payment Failed
Starts when a payment intent using a delayed payment method fails.
ID
Object
Allow Promotion Codes
Amount Subtotal
Amount Total
Billing Address Collection
Cancel URL
Client Reference ID
Currency
Customer
Customer Details
Customer Email
Livemode
Locale
Metadata
Mode
Payment Intent
Payment Method Options
Payment Method Types
Payment Status
Setup Intent
Shipping
Shipping Address Collection
Submit Type
Subscription
Success URL
Checkout Session Async Payment Succeeded
Starts when a payment intent using a delayed payment method finally succeeds.
ID
Object
Allow Promotion Codes
Amount Subtotal
Amount Total
Billing Address Collection
Cancel URL
Client Reference ID
Currency
Customer
Customer Details
Customer Email
Livemode
Locale
Metadata
Mode
Payment Intent
Payment Method Options
Payment Method Types
Payment Status
Setup Intent
Shipping
Shipping Address Collection
Submit Type
Subscription
Success URL
Checkout Session Completed
Starts when a checkout session is successfully completed.
ID
Object
Allow Promotion Codes
Amount Subtotal
Amount Total
Billing Address Collection
Cancel URL
Client Reference ID
Currency
Customer
Customer Details
Customer Email
Livemode
Locale
Metadata
Mode
Payment Intent
Payment Method Options
Payment Method Types
Payment Status
Setup Intent
Shipping
Shipping Address Collection
Submit Type
Subscription
Success URL
Checkout Session Expired
Starts when a checkout session has expired.
ID
Object
Allow Promotion Codes
Amount Subtotal
Amount Total
Billing Address Collection
Cancel URL
Client Reference ID
Currency
Customer
Customer Details
Customer Email
Livemode
Locale
Metadata
Mode
Payment Intent
Payment Method Options
Payment Method Types
Payment Status
Setup Intent
Shipping
Shipping Address Collection
Submit Type
Subscription
Success URL
Credit Note Created
Starts when a credit note has been created.
ID
Object
Amount
Created
Currency
Customer
Invoice
Livemode
Memo
Metadata
Number
Out Of Band Amount
Pdf
Reason
Refund
Status
Subtotal
Tax
Total
Type
Credit Note Updated
Starts when a credit note is updated.
ID
Object
Amount
Created
Currency
Customer
Invoice
Livemode
Memo
Reason
Status
Type
Updated
Credit Note Voided
Starts when a credit note is voided.
ID
Object
Amount
Created
Currency
Customer
Invoice
Livemode
Memo
Reason
Status
Type
Updated
Customer Cash Balance Transaction Created
Starts when a new customer cash balance transactions is created.
ID
Object
Amount
Created
Currency
Customer
Description
Type
Customer Created
Starts when a customer is updated.
ID
Object
Email
Metadata
Updated
Livemode
Customer Created
Starts when a customer is created.
ID
Object
Address
Balance
Created
Currency
Delinquent
Description
Discount
Email
Invoice Prefix
Invoice Settings
Livemode
Metadata
Name
Next Invoice Sequence
Phone
Preferred Locales
Shipping
Sources
Subscriptions
Tax Exempt
Tax Ids
Customer Deleted
Starts when a customer is removed.
ID
Object
Deleted
Customer Discount Created
Starts when a coupon is attached to a customer.
ID
Object
Coupon
Customer
End
Livemode
Start
Subscription
Customer Discount Deleted
Starts when a coupon is removed from a customer.
ID
Object
Coupon
Customer
End
Livemode
Start
Subscription
Customer Discount Updated
Starts when a customer is switched from one coupon to another.
ID
Object
Coupon
Customer
End
Livemode
Start
Subscription
Customer Source Created
Starts when a new source is created for a customer.
ID
Object
Address City
Address Country
Address Line1
Address Line1 Check
Address Line2
Address State
Address Zip
Address Zip Check
Brand
Country
Customer
Cvc Check
Dynamic Last4
Exp Month
Exp Year
Fingerprint
Funding
Last4
Metadata
Name
Tokenization Method
Customer Source Deleted
Starts when a source is removed from a customer.
ID
Object
Address City
Address Country
Address Line1
Address Line1 Check
Address Line2
Address State
Address Zip
Address Zip Check
Brand
Country
Customer
Cvc Check
Dynamic Last4
Exp Month
Exp Year
Fingerprint
Funding
Last4
Metadata
Name
Tokenization Method
Customer Source Expiring
Starts when a card or source will expire at the end of the month.
ID
Object
Address City
Address Country
Address Line1
Address Line1 Check
Address Line2
Address State
Address Zip
Address Zip Check
Brand
Country
Customer
Cvc Check
Dynamic Last4
Exp Month
Exp Year
Fingerprint
Funding
Last4
Metadata
Name
Tokenization Method
Customer Source Updated
Starts when a source’s details are changed.
ID
Object
Address City
Address Country
Address Line1
Address Line1 Check
Address Line2
Address State
Address Zip
Address Zip Check
Brand
Country
Customer
Cvc Check
Dynamic Last4
Exp Month
Exp Year
Fingerprint
Funding
Last4
Metadata
Name
Tokenization Method
Customer Subscription Created
Starts when a customer is signed up for a new plan.
ID
Object
Customer
Plan
Status
Start Date
Current Period Start
Current Period End
Canceled At
Ended At
Cancel At Period End
Metadata
Billing Cycle Anchor
Customer Subscription Deleted
Starts when a customer’s subscription ends.
ID
Object
Customer
Plan
Status
Start Date
Current Period Start
Current Period End
Canceled At
Ended At
Cancel At Period End
Metadata
Billing Cycle Anchor
Customer Subscription Paused
Starts when a customer's subscription is paused. Only applies when a subscription's status is paused, not when payment collection is paused.
ID
Object
Customer
Plan
Status
Start Date
Current Period Start
Current Period End
Canceled At
Ended At
Cancel At Period End
Metadata
Billing Cycle Anchor
Customer Subscription Pending Update Applied
Starts when a customer's subscription’s pending update is applied, and the subscription is updated.
Customer Subscription Pending Update Expired
Starts when a customer’s subscription’s pending update expires before the related invoice is paid.
Customer Subscription Resumed
Starts when a customer’s subscription is no longer paused. Only applies when a status=paused subscription is resumed, not when payment collection is resumed.
ID
Object
Customer
Plan
Status
Start Date
Current Period Start
Current Period End
Canceled At
Ended At
Cancel At Period End
Metadata
Billing Cycle Anchor
Customer Subscription Trial Will End
Starts three days before a subscription’s trial period is scheduled to end, or when a trial is ended immediately.
ID
Object
Customer
Plan
Status
Start Date
Current Period Start
Current Period End
Trial Start
Trial End
Canceled At
Ended At
Cancel At Period End
Metadata
Billing Cycle Anchor
Customer Subscription Updated
Starts when a subscription changes (e.g. switching from one plan to another, or changing the status from trial to active).
ID
Object
Customer
Plan
Status
Start Date
Current Period Start
Current Period End
Trial Start
Trial End
Canceled At
Ended At
Cancel At Period End
Metadata
Billing Cycle Anchor
Customer Tax Id Created
Starts when a tax ID is created for a customer.
ID
Object
Type
Value
Status
Verification
Customer
Created
Livemode
Customer Tax Id Deleted
Starts when a tax ID is deleted from a customer.
ID
Object
Type
Value
Status
Verification
Customer
Created
Livemode
Customer Tax Id Updated
Starts when a customer's tax ID is updated.
ID
Object
Type
Value
Status
Verification
Customer
Created
Livemode
External Account Created
Starts when an external account is created.
ID
Object
Account
Account Holder Name
Account Holder Type
Bank Name
Country
Currency
Fingerprint
Last4
Metadata
Routing Number
Status
External Account Deleted
Starts when an external account is deleted.
ID
Object
Account
Account Holder Name
Account Holder Type
Bank Name
Country
Currency
Fingerprint
Last4
Metadata
Routing Number
Status
External Account Updated
Starts when an external account is updated.
ID
Object
Account
Account Holder Name
Account Holder Type
Bank Name
Country
Currency
Fingerprint
Last4
Metadata
Routing Number
Status
Financial Connections Account Created
Starts when a new financial connections account is created.
ID
Object
Business Profile
Financial Connections Account Deactivated
Starts when a financial connections account’s status is updated from active to inactive.
ID
Object
Business Profile
Financial Connections Account Disconnected
Starts when a financial connections account is disconnected.
ID
Object
Business Profile
Financial Connections Account Reactivated
Starts when a financial connections account’s status is updated from inactive to active.
ID
Object
Business Profile
Financial Connections Account Refreshed Balance
Starts when an account’s balance refresh status transitions from pending to either succeeded or failed.
ID
Object
Previous Attributes
Request
Available
Connect Reserved
Livemode
Pending
Identity Verification Session Canceled
Starts when an identity verification session is canceled.
ID
Object
Canceled At
Created
Customer
Livemode
Options
Status
Type
Identity Verification Session Created
Starts when an identity verification session is created.
ID
Object
Created
Customer
Livemode
Options
Status
Type
Identity Verification Session Processing
Starts when an identity verification session transitions to processing.
ID
Object
Created
Customer
Livemode
Options
Status
Type
Identity Verification Session Redacted
Starts when identity verification session is redacted.
Identity Verification Session Requires Input
Starts when an identity verification session transitions to require user input.
ID
Object
Created
Customer
Livemode
Options
Status
Type
Identity Verification Session Verified
Starts when an identity verification session transitions to verified.
ID
Object
Created
Customer
Livemode
Options
Status
Type
Issuing Authorization Created
Starts when an authorization is created.
Issuing Authorization Request
Starts when an authorization request is made.
Issuing Authorization Updated
Starts when an authorization is updated.
Issuing Card Created
Starts when a card is created.
ID
Object
Authorization Controls
Issuing Card Updated
Starts when a card is updated.
ID
Object
Authorization Controls
Issuing Cardholder Created
Starts when a cardholder is issued.
ID
Object
Billing
Issuing Cardholder Updated
Starts when a cardholder is updated.
ID
Object
Billing
Created
Email
Livemode
Metadata
Name
Phone Number
Status
Type
Issuing Dispute Closed
Starts when a dispute is won, lost or expired.
ID
Object
Amount
Balance Transactions
Created
Currency
Evidence
Livemode
Metadata
Reason
Status
Issuing Dispute Created
Starts when a dispute is created.
ID
Object
Amount
Balance Transactions
Created
Currency
Evidence
Livemode
Metadata
Reason
Status
Issuing Dispute Funds Reinstated
Starts when funds are reinstated to your account for an issuing dispute.
ID
Object
Amount
Balance Transactions
Created
Currency
Evidence
Livemode
Metadata
Reason
Status
Issuing Dispute Submitted
Starts when a dispute is submitted.
ID
Object
Amount
Balance Transactions
Created
Currency
Evidence
Livemode
Metadata
Reason
Status
Issuing Dispute Updated
Starts when a dispute is updated.
ID
Object
Amount
Balance Transactions
Created
Currency
Evidence
Livemode
Metadata
Reason
Status
Issuing Transaction Created
Starts when an issuing transaction is created.
ID
Object
Amount
Authorization
Balance Transaction
Card
Cardholder
Created
Currency
Livemode
Merchant Amount
Merchant Currency
Metadata
Type
Issuing Transaction Updated
Starts when an issuing transaction is updated.
ID
Object
Amount
Currency
Status
Card
Payment Intent Amount Capturable Updated
Starts when a payment intent has funds to be captured.
ID
Object
Amount
Amount Capturable
Amount Received
Application
Application Fee Amount
Canceled At
Cancellation Reason
Capture Method
Charges
Client Secret
Confirmation Method
Created
Currency
Customer
Description
Payment Intent Canceled
Starts when a payment intent is canceled.
ID
Object
Amount
Amount Capturable
Amount Received
Application
Application Fee Amount
Canceled At
Cancellation Reason
Capture Method
Charges
Client Secret
Confirmation Method
Created
Currency
Customer
Description
Invoice
Last Payment Error
Livemode
Metadata
Next Action
On Behalf Of
Payment Method
Payment Method Options
Payment Intent Created
Starts when a payment intent is created.
ID
Object
Amount
Amount Capturable
Amount Received
Application
Application Fee Amount
Canceled At
Cancellation Reason
Capture Method
Charges
Client Secret
Confirmation Method
Created
Currency
Customer
Description
Invoice
Last Payment Error
Livemode
Metadata
Next Action
On Behalf Of
Payment Method
Payment Method Options
Payment Method Types
Receipt Email
Review
Setup Future Usage
Shipping
Source
Statement Descriptor
Statement Descriptor Suffix
Status
Transfer Data
Transfer Group
Payment Intent Partially Funded
Starts when funds are applied to a customer balance payment intent and the Amount Remaining changes.
ID
Object
Amount
Currency
Customer
Payment Method
Status
Amount Capturable
Payment Intent Payment Failed
Starts when a payment intent has failed the attempt to create a payment method or a payment.
ID
Object
Amount
Currency
Customer
Payment Method
Status
Last Payment Error
Payment Intent Processing
Starts when a payment intent is being processed.
ID
Object
Amount
Currency
Status
Customer
Description
Metadata
Payment Intent Requires Action
Starts when a payment intent needs further action.
ID
Object
Amount
Currency
Customer
Payment Method
Status
Next Action
Payment Intent Succeeded
Starts when a payment intent has successfully completed payment.
ID
Object
Amount
Amount Captured
Currency
Customer
Payment Method
Status
Charges
Payment Link Created
Starts when a payment link is created.
ID
Object
URL
Amount
Currency
Description
Expires At
Livemode
Metadata
Payment Link Updated
Starts when a payment link is updated.
ID
Object
Customer
Type
Card
Payment Method Attached
Starts when a new payment method is attached to a customer.
ID
Object
Customer
Type
Card
Payment Method Automatically Updated
Starts when a payment method’s details are automatically updated by the network.
ID
Object
Customer
Type
Card
Payment Method Detached
Starts when a payment method is detached from a customer.
ID
Object
Customer
Type
Card
Payment Method Updated
Starts when a payment method is updated via the Update Payment Method API endpoint (not available in MESA).
ID
Object
Customer
Type
Card
Promotion Code Created
Starts when a promotion code is created.
ID
Object
Coupon
Code
Active
Created
Promotion Code Updated
Starts when a promotion code is updated.
ID
Object
Coupon
Code
Active
Created
Updated
Radar Early Fraud Warning Created
Starts when an early fraud warning is created.
ID
Object
Created
Livemode
Reported
Reason
Rule
Transaction
Radar Early Fraud Warning Updated
Starts when an early fraud warning is updated.
ID
Object
Created
Livemode
Reported
Reason
Rule
Transaction
Status
Disputed Transaction
Reporting Report Run Failed
Starts when a requested report fails to complete.
ID
Object
Created
Data Available At
Error
Reporting Report Run Succeeded
Starts when a requested report runs successfully.
ID
Object
Created
Data Available At
Error
Livemode
Parameters
Reporting Report Type Updated
Starts when a report is updated (typically to indicate that a new day’s data has come available).
ID
Object
Data Updated
Livemode
Name
Updated
Version
Setup Intent Canceled
Starts when a setup intent is canceled.
ID
Object
Cancellation Reason
Client Secret
Created
Customer
Description
Last Setup Error
Livemode
Mandate
Next Action
On Behalf Of
Payment Method
Payment Method Types
Single Use
Status
Usage
Setup Intent Created
Starts when a setup intent is created.
ID
Object
Client Secret
Created
Customer
Description
Last Setup Error
Livemode
Mandate
Next Action
On Behalf Of
Payment Method
Payment Method Types
Single Use
Status
Usage
Setup Intent Requires Action
Starts when a setup action requires attention.
ID
Object
Client Secret
Created
Customer
Description
Last Setup Error
Livemode
Mandate
Next Action
On Behalf Of
Payment Method
Payment Method Types
Single Use
Status
Usage
Setup Intent Setup Failed
Starts when a setup intent has failed the attempt to setup a payment method.
ID
Object
Client Secret
Created
Customer
Description
Livemode
Mandate
On Behalf Of
Payment Method
Payment Method Types
Single Use
Status
Usage
Setup Intent Succeeded
Starts when a setup intent has successfully setup a payment method.
ID
Object
Client Secret
Created
Customer
Description
Last Setup Error
Livemode
Mandate
On Behalf Of
Payment Method
Payment Method Types
Single Use
Status
Usage
Sigma Scheduled Query Run Created
Starts when a Sigma scheduled query run finishes.
ID
Object
Created
Data Load Time
Error
Livemode
Query
Result Available Until
Sql
Status
Source Transaction Created
Starts when a source transaction is created.
ID
Object
Amount
Card
Client Secret
Created
Currency
Flow
Livemode
Metadata
Owner
Receiver
Statement Descriptor
Status
Type
Usage
Source Transaction Updated
Starts when a source transaction is updated.
ID
Object
Amount
Created
Currency
Livemode
Source
Status
Type
Subscription Schedule Aborted
Starts when a subscription schedule is canceled due to the underlying subscription being canceled because of delinquency.
ID
Object
Canceled At
Completed At
Created
Current Phase
Customer
End Behavior
Livemode
Metadata
Phases
Released At
Start Date
Status
Subscription
Subscription Schedule Canceled
Starts when a subscription schedule is canceled.
ID
Object
Canceled At
Completed At
Created
Current Phase
Customer
End Behavior
Livemode
Metadata
Phases
Subscription Schedule Completed
Starts when a new subscription schedule is completed.
ID
Object
Canceled At
Completed At
Created
Current Phase
Customer
End Behavior
Livemode
Metadata
Phases
Released At
Start Date
Status
Subscription
Subscription Schedule Created
Starts when a new subscription schedule is created.
ID
Object
Canceled At
Completed At
Created
Current Phase
Customer
End Behavior
Livemode
Metadata
Phases
Released At
Start Date
Status
Subscription
Subscription Schedule Expiring
Starts 7 days before a subscription schedule will expire.
ID
Object
Canceled At
Completed At
Created
Current Phase
Customer
End Behavior
Livemode
Metadata
Phases
Released At
Start Date
Status
Subscription
Subscription Schedule Released
Starts when a new subscription schedule is released.
ID
Object
Canceled At
Completed At
Created
Current Phase
Customer
End Behavior
Livemode
Metadata
Phases
Subscription Schedule Updated
Starts when a subscription schedule is updated.
ID
Object
Canceled At
Completed At
Created
Current Phase
Customer
End Behavior
Livemode
Metadata
Phases
Released At
Start Date
Status
Subscription
Tax Rate Created
Starts when a new tax rate is created.
ID
Object
Active
Created
Description
Display Name
Inclusive
Jurisdiction
Livemode
Metadata
Percentage
Tax Rate Updated
Starts when tax rate is updated.
ID
Object
Active
Created
Description
Display Name
Inclusive
Jurisdiction
Livemode
Metadata
Percentage
Terminal Reader Action Failed
Starts when an action sent to a terminal reader failed.
ID
Object
Device Sw Version
Device Type
Ip Address
Label
Location
Serial Number
Status
Livemode
Metadata
Registration Code
Status Timestamp
Terminal Reader Action Succeeded
Starts when an action sent to a terminal reader was successful.
ID
Object
Device Sw Version
Device Type
Ip Address
Label
Location
Serial Number
Status
Livemode
Metadata
Registration Code
Status Timestamp
Bulk Create Contacts
Create multiple contacts.
- Contacts
Create a Purchase Order Attachment
Create an attachment for a purchase order.
Create Account
Create a new account.
Code
Name
Account ID
Type
Bank Account Number
Status
Description
Bank Account Type
Currency Code
Tax Type
Enable Payments To Account
Show In Expense Claims
Reporting Code
Add To Watchlist
Create Allocation for Overpayment
Create an allocation for an overpayment.
- Allocations
Create Attachment
Create an attachment for a specific account.
Create Attachment for Repeating Invoice
Create an attachment for a specific repeating invoice.
Create Bank Transaction
Create a bank transaction.
- Bank Transactions
Create Bank Transaction Attachment
Create an attachment for a bank transaction.
Create Bank Transfer
Create a bank transfer.
- Bank Transfers
Create Bank Transfer Attachment by File Name
Create a bank transfer attachment by file name.
Create Batch Payment
Create a batch payment.
Create Branding Theme Payment Service
Create a custom payment service for branding theme.
- Payment Services
Create Contact Attachment by File Name
Create a contact attachment by file name.
Create Contact for Contact Group
Create a contact for a contact group.
- Contacts
Create Contact Group
Create a contact group.
- Contact Groups
Create Credit Note
Create a new credit note.
- Credit Notes
Create Credit Note Allocation
Create an allocation for a credit note.
- Allocations
Create Credit Note Attachment
Create an attachment for a credit note.
- Include Online
Create Currency
Create a new currency.
Code
Description
Create Draft Fixed Asset
Create a draft fixed asset.
Asset Name
Asset ID
Asset Type ID
Asset Number
Purchase Date
Purchase Price
Disposal Date
Disposal Price
Asset Status
Warranty Expiry Date
Serial Number
Book Depreciation Setting
Book Depreciation Detail
Can Rollback
Accounting Book Value
Is Delete Enabled For Date
Create Employee
Create an employee.
- Employees
Create Expense Claim
Create an expense claim.
- Expense Claims
Create Feed Connection
Create new feed connection.
Pagination
Items
Create File Association
Create a new file association.
File ID
Object ID
Object Group
Object Type
Create Fixed Asset Type
Create a fixed asset type.
Asset Type Name
Book Depreciation Setting
Asset Type ID
Fixed Asset Account ID
Depreciation Expense Account ID
Accumulated Depreciation Account ID
Locks
Create Folder
Create a new folder.
Name
File Count
Email
Is Inbox
ID
Create History Record for Bank Transaction
Create a bank transaction history record.
- History Records
Create History Record for Bank Transfer
Create a bank transfer history record.
- History Records
Create History Record for Batch Payment
Create a history record for a batch payment.
Create History Record for Contact
Create a history record for a contact.
- History Records
Create History Record for Invoice
Create a history record for a specific invoice.
- History Records
Create History Record for Item
Create a history record for an item.
- History Records
Create History Record for Manual Journal
Create a history record for a manual journal.
- History Records
Create History Record for Overpayment
Create a history record for an overpayment.
- History Records
Create History Record for Payment
Create a history record for a payment.
- History Records
Create History Record for Prepayment
Create a prepayment history record.
- History Records
Create History Record for Purchase Order
Create a history record for a specific purchase order.
- History Records
Create History Record for Quote
Create a history record for a quote.
- History Records
Create History Record for Repeating Invoices
Create a history record for a repeating invoice.
- History Records
Create Invoice
Create an invoice.
- Invoices
Create Invoice's Attachment by File Name
Create an attachment for an invoice or purchase bill by filename.
- Include Online
Create Item
Create an item.
- Items
Create Leave Application
Create a leave application.
Create Linked Transaction
Create a linked transaction.
Contact ID
Source Transaction ID
Source Line Item ID
Target Transaction ID
Target Line Item ID
Linked Transaction ID
Status
Type
Source Transaction Type Code
Create Manual Journal Attachment
Create an attachment for a manual journal.
Create Manual Journals
Create a manual journal.
- Manual Journals
Create Multiple Payments for Invoices or Credit Notes
Create multiple payments for invoices or credit notes.
- Payments
Create or Update Contacts
Create or modify contacts.
- Contacts
Create or Update Credit Notes
Create or modify an existing credit note.
- Credit Notes
Create or Update Employee
Create or update an employee.
- Employees
Create or Update Item
Create or modify an existing item.
- Items
Create or Update Manual Journal
Create or modify existing manual journal.
- Manual Journals
Create or Update Purchase Order
Create or modify existing purchase order.
- Purchase Orders
Create or Update Quote
Create or modify an existing quote.
- Quotes
Create or Update Repeating Invoice's
Create or modify an existing repeating invoice.
- Repeating Invoices
Create Pay Item
Create a pay item.
Earnings Rates
Deduction Types
Leave Types
Reimbursement Types
Create Pay Run
Create a pay run.
Create Payment for Invoices or Credit Notes
Create a payment for invoices or credit notes.
Invoice
Invoice Number
Credit Note Number
Account
Code
Date
Currency Rate
Amount
Bank Amount
Reference
Is Reconciled
Status
Payment ID
Batch Payment ID
Bank Account Number
Particulars
Details
Has Account
Status Attribute String
Create Payment Service
Create a payment service.
- Payment Services
Create Payroll Calendar
Create a payroll calendar.
Create Prepayment
Create an allocation for prepayment.
- Allocations
Create Project
Create a project(s).
Name
Contact ID
Estimate Amount
Deadline Utc
Create Purchase Order
Create one or more purchase orders.
- Purchase Orders
Create Quote
Create one or more quotes.
- Quotes
Create Quote Attachment
Create an attachment for a quote.
Create Repeating Invoice Template
Create one or more repeating invoice templates.
- Repeating Invoices
Create Statement
Create one or more new statements.
Pagination
Items
Create Superfund
Create a superfund.
Create Task
Create a task.
Name
Charge Type
Rate
Estimate Minutes
Create Tax Rates
Create one or more tax rates.
- Tax Rates
Create Time Entry for Project
Create a time entry for a project.
User ID
Task ID
Date Utc
Duration
Description
Create Timesheet
Create a timesheet.
Create Tracking Company
Create a tracking company.
Tracking Category ID
Tracking Option ID
Name
Option
Status
Options
Creates a Credit Note History
Create a credit note history.
Details
Changes
User
Date U T C
Creates History Record for Expense Claim
Create a history record for an expense claim.
Details
Changes
User
Date U T C
Creates Options for Tracking Category
Create tracking category options.
Tracking Option ID
Name
Status
Tracking Category ID
Creates Project for Contact
Create a project for a contact.
Delete Account
Remove an account.
Code
Name
Account ID
Type
Bank Account Number
Status
Description
Bank Account Type
Currency Code
Tax Type
Enable Payments To Account
Show In Expense Claims
Class
System Account
Reporting Code
Reporting Code Name
Updated Date U T C
Add To Watchlist
Delete Connection
Remove a connection.
Delete Contact from Contact Group
Remove a contact from a contact group.
Delete Contacts from Contact Group
Remove all contacts from a specific contact group.
Delete Feed Connection
Remove an existing feed connection.
Page
Page Size
Page Count
Item Count
Delete File
Remove a specific file.
Delete File Association
Remove an existing file association.
Delete Folder
Remove a folder.
Delete Item
Remove a specific item.
Delete Linked Transaction
Remove a linked transaction.
Delete Project's Time Entry
Remove a time entry for a project.
Delete Task
Remove a task.
Delete Tracking Category
Remove a tracking category.
Tracking Category ID
Tracking Option ID
Name
Option
Status
Options
Delete Tracking Category's Option
Remove a specific tracking category option.
Tracking Option ID
Name
Status
Tracking Category ID
Get List of 1099 Reports
Obtain a list of 1099 reports.
Report Name
Report Type
Report Title
Report Date
Updated Date U T C
Contacts
Get List of Account's Usage
Obtain a list of account's usage.
Organisation ID
Start Month
End Month
Account Usage
Get List of Accounting Bank Statements
Obtain a list of accounting bank statements.
Bank Account ID
Bank Account Name
Bank Account Currency Code
Statements
Get List of Accounts
Obtain a list of accounts.
Code
Name
Account ID
Type
Bank Account Number
Status
Description
Bank Account Type
Currency Code
Tax Type
Enable Payments To Account
Show In Expense Claims
Class
System Account
Reporting Code
Reporting Code Name
Updated Date U T C
Add To Watchlist
Get List of Aged Payables by Contact Reports
Obtain a list of aged payables by contact reports.
Report ID
Report Name
Report Title
Report Type
Report Titles
Report Date
Rows
Updated Date U T C
Fields
Get List of Aged Receivables by Contact Reports
Obtain a list of aged receivables by contact reports.
Report ID
Report Name
Report Title
Report Type
Report Titles
Report Date
Rows
Updated Date U T C
Fields
Get List of Asset Type
Obtain a list of asset types.
Asset Type ID
Asset Type Name
Fixed Asset Account ID
Depreciation Expense Account ID
Accumulated Depreciation Account ID
Book Depreciation Setting
Locks
Get List of Assets
Obtain a list of assets.
Page
Page Size
Page Count
Item Count
Get List of Attachments
Obtain a list of account's attachments.
Attachment ID
File Name
URL
Mime Type
Content Length
Include Online
Get List of Balance Sheet Reports
Obtain a list of balance sheet reports.
Report ID
Report Name
Report Title
Report Type
Report Titles
Report Date
Rows
Updated Date U T C
Fields
Get List of Balance Sheet Reports
Obtain a list of balance sheet reports.
Balance Date
Asset
Liability
Equity
Get List of Bank Summary Reports
Obtain a list of bank summary reports.
Report ID
Report Name
Report Title
Report Type
Report Titles
Report Date
Rows
Updated Date U T C
Fields
Get List of Bank Transaction Attachments
Obtain a list of bank transaction attachments.
Attachment ID
File Name
URL
Mime Type
Content Length
Include Online
Get List of Bank Transactions
Obtain a list of bank transactions.
Type
Contact
Line Items
Bank Account
Is Reconciled
Date
Reference
Currency Code
Currency Rate
URL
Status
Line Amount Types
Sub Total
Total Tax
Total
Bank Transaction ID
Prepayment ID
Overpayment ID
Updated Date U T C
Status Attribute String
Get List of Bank Transfer's Attachments
Obtain a list of bank transfer's attachments.
Attachment ID
File Name
URL
Mime Type
Content Length
Include Online
Get List of Bank Transfers
Obtain a list of bank transfers.
From Bank Account
To Bank Account
Amount
Date
Bank Transfer ID
Currency Rate
From Bank Transaction ID
To Bank Transaction ID
From Is Reconciled
To Is Reconciled
Reference
Created Date U T C
Get List of Batch Payments
Obtain a list of batch payments.
Get List of Branding Theme's Payment Services
Obtain a list of branding theme's payment services.
Payment Service ID
Payment Service Name
Payment Service URL
Pay Now Text
Payment Service Type
Get List of Branding Themes
Obtain a list of branding themes.
Branding Theme ID
Name
Logo URL
Type
Sort Order
Created Date U T C
Get List of Budget Summary Reports
Obtain a list of budget summary reports.
Report ID
Report Name
Report Title
Report Type
Report Titles
Report Date
Rows
Updated Date U T C
Fields
Get List of Budgets
Obtain a list of budgets.
Budget ID
Type
Description
Updated Date U T C
Budget Lines
Tracking
Get List of Cash Flow Reports
Obtain a list of cash flow reports.
Start Date
End Date
Cash Balance
Cashflow Activities
Get List of Cash Validations
Obtain a list of cash validations.
Account ID
Statement Balance
Statement Balance Date
Bank Statement
Cash Account
Get List of CIS Settings for Contact
Obtain a list of construction industry scheme settings for a contact.
CISEnabled
Rate
Get List of Connections
Obtain a list of connections.
Get List of Contact Groups
Obtain a list of contact groups.
Name
Status
Contact Group ID
Contacts
Get List of Contact's Attachments
Obtain a list of contact's attachments.
Attachment ID
File Name
URL
Mime Type
Content Length
Include Online
Get List of Contact's History Records
Obtain a list of contact's history records.
Details
Changes
User
Date U T C
Get List of Contacts
Obtain a list of contacts.
Contact ID
Merged To Contact ID
Contact Number
Account Number
Contact Status
Name
First Name
Last Name
Company Number
Email Address
Skype User Name
Contact Persons
Bank Account Details
Tax Number
Accounts Receivable Tax Type
Accounts Payable Tax Type
Addresses
Phones
Is Supplier
Is Customer
Sales Default Line Amount Type
Purchases Default Line Amount Type
Default Currency
Xero Network Key
Sales Default Account Code
Purchases Default Account Code
Sales Tracking Categories
Purchases Tracking Categories
Tracking Category Name
Tracking Category Option
Payment Terms
Updated Date U T C
Contact Groups
Website
Branding Theme
Discount
Balances
Attachments
Status Attribute String
Get List of Credit Note's Attachments
Obtain a list of credit note's attachments.
Attachment ID
File Name
URL
Mime Type
Content Length
Include Online
Get List of Credit Note's History
Obtain a list of credit note's history.
Details
Changes
User
Date U T C
Get List of Credit Note's PDFs
Obtain a list of credit note's pdfs.
Get List of Credit Notes
Obtain a list of credit notes.
Type
Contact
Date
Due Date
Status
Line Amount Types
Line Items
Sub Total
Total Tax
Total
CISDeduction
CISRate
Updated Date U T C
Currency Code
Fully Paid On Date
Credit Note ID
Credit Note Number
Reference
Sent To Contact
Currency Rate
Remaining Credit
Allocations
Applied Amount
Payments
Branding Theme ID
Status Attribute String
Has Errors
Get List of Currencies
Obtain a list of currencies.
Code
Description
Get List of Employees
Obtain a list of employees.
Employee ID
Status
First Name
Last Name
External Link
Updated Date U T C
Status Attribute String
Get List of Executive Summary Reports
Obtain a list of executive summary reports.
Report ID
Report Name
Report Title
Report Type
Report Titles
Report Date
Rows
Updated Date U T C
Fields
Get List of Expense Claim's History Records
Obtain a list of expense claim's history records.
Details
Changes
User
Date U T C
Get List of Expense Claims
Obtain a list of expense claims.
Expense Claim ID
Status
Payments
User
Receipts
Updated Date U T C
Total
Amount Due
Amount Paid
Payment Due Date
Reporting Date
Receipt ID
Get List of Expense Contacts Reports
Obtain a list of expense reports by contacts.
Start Date
End Date
Total
Total Detail
Total Other
Contacts
Manual Journals
Get List of Feed Connections
Obtain a list of feed connections.
Page
Page Size
Page Count
Item Count
Get List of File's Associations
Obtain a list of file's associations.
File ID
Object ID
Object Group
Object Type
Get List of Files
Obtain a list of files.
Total Count
Page
Per Page
Items
Get List of Finalized GST Reports
Obtain a list of finalized GST reports.
Report ID
Report Name
Report Title
Report Type
Report Titles
Report Date
Rows
Updated Date U T C
Fields
Get List of Fixed Asset Settings
Obtain a list of fixed asset settings.
Asset Number Prefix
Asset Number Sequence
Asset Start Date
Last Depreciation Date
Default Gain On Disposal Account ID
Default Loss On Disposal Account ID
Default Capital Gain On Disposal Account ID
Opt In For Tax
Get List of Folders
Obtain a list of folders.
Name
File Count
Email
Is Inbox
ID
Get List of Inboxes
Obtain a list of inboxes.
Name
File Count
Email
Is Inbox
ID
Get List of Invoice PDFs
Obtain a list of invoice pdfs.
Get List of Invoice Reminder's Settings
Obtain a list of invoice reminder's settings.
- Enabled
Get List of Invoice's Attachments
Obtain a list of invoice's attachments.
Attachment ID
File Name
URL
Mime Type
Content Length
Include Online
Get List of Invoice's History Records
Obtain a list of invoice's history records.
Details
Changes
User
Date U T C
Get List of Invoices
Obtain a list of invoices.
Type
Contact
Line Items
Date
Due Date
Line Amount Types
Invoice Number
Reference
Branding Theme ID
URL
Currency Code
Currency Rate
Status
Sent To Contact
Expected Payment Date
Planned Payment Date
CISDeduction
CISRate
Sub Total
Total Tax
Total
Total Discount
Invoice ID
Repeating Invoice ID
Is Discounted
Payments
Prepayments
Overpayments
Amount Due
Amount Paid
Fully Paid On Date
Amount Credited
Updated Date U T C
Credit Notes
Attachments
Has Errors
Status Attribute String
Get List of Items
Obtain a list of items.
Code
Inventory Asset Account Code
Name
Is Sold
Is Purchased
Description
Purchase Description
Purchase Details
Sales Details
Is Tracked As Inventory
Total Cost Pool
Quantity On Hand
Updated Date U T C
Item ID
Status Attribute String
Get List of Journals
Obtain a list of journals.
Journal ID
Journal Date
Journal Number
Created Date U T C
Reference
Source ID
Source Type
Journal Lines
Get List of Leave Applications
Obtain a list of leave applications.
Leave Application ID
Employee ID
Leave Type ID
Title
Start Date
End Date
Description
Pay Out Type
Leave Periods
Updated Date U T C
Get List of Linked Transaction
Obtain a list of linked transaction.
Source Transaction ID
Source Line Item ID
Contact ID
Target Transaction ID
Target Line Item ID
Linked Transaction ID
Status
Type
Updated Date U T C
Source Transaction Type Code
Get List of Lock History
Obtain a list of lock history.
Organisation ID
End Date
Lock Dates
Get List of Manual Journal's Attachments
Obtain a list of manual journal's attachments.
Attachment ID
File Name
URL
Mime Type
Content Length
Include Online
Get List of Manual Journal's History
Obtain a list of manual journal's history.
Details
Changes
User
Date U T C
Get List of Manual Journals
Obtain a list of manual journals.
Narration
Journal Lines
Date
Line Amount Types
Status
URL
Show On Cash Basis Reports
Updated Date U T C
Manual Journal ID
Status Attribute String
Attachments
Get List of Organization's CIS Settings
Obtain a list of organization's CIS settings.
C I S Contractor Enabled
C I S Sub Contractor Enabled
Rate
Get List of Overpayment's History
Obtain a list of overpayment's history.
Details
Changes
User
Date U T C
Get List of Overpayments
Obtain a list of overpayments.
Type
Contact
Date
Status
Line Amount Types
Line Items
Sub Total
Total Tax
Total
Updated Date U T C
Currency Code
Overpayment ID
Currency Rate
Remaining Credit
Allocations
Applied Amount
Payments
Attachments
Get List of Pay Items
Obtain a list of pay items.
Earnings Rates
Deduction Types
Leave Types
Reimbursement Types
Get List of Pay Runs
Obtain a list of pay runs.
Payroll Calendar ID
Pay Run ID
Pay Run Period Start Date
Pay Run Period End Date
Pay Run Status
Payment Date
Payslip Message
Updated Date U T C
Payslips
Wages
Deductions
Tax
Super
Reimbursement
Net Pay
Get List of Payment Services
Obtain a list of payment services.
Payment Service ID
Payment Service Name
Payment Service URL
Pay Now Text
Payment Service Type
Get List of Payment's History Records
Obtain a list of payment's history records.
Details
Changes
User
Date U T C
Get List of Payments for Invoices & Credit Notes
Obtain a list of payments for invoices and credit notes.
Invoice
Invoice Number
Credit Note Number
Account
Code
Date
Currency Rate
Amount
Bank Amount
Reference
Is Reconciled
Status
Payment Type
Updated Date U T C
Payment ID
Batch Payment ID
Bank Account Number
Particulars
Details
Has Account
Status Attribute String
Get List of Payroll Calendars
Obtain a list of payroll calendars.
Name
Calendar Type
Start Date
Payment Date
Payroll Calendar ID
Updated Date U T C
Reference Date
Get List of Payroll Settings
Obtain a list of payroll settings.
Accounts
Tracking Categories
Days In Payroll Year
Employees Are S T P2
Get List of Prepayment's History Records
Obtain a list of prepayment history records.
Details
Changes
User
Date U T C
Get List of Prepayments
Obtain a list of prepayments.
Type
Contact
Date
Status
Line Amount Types
Line Items
Sub Total
Total Tax
Total
Reference
Updated Date U T C
Currency Code
Prepayment ID
Currency Rate
Remaining Credit
Allocations
Payments
Applied Amount
Attachments
Get List of Profit & Loss Reports
Obtain a list of profit & loss reports.
Start Date
End Date
Net Profit Loss
Revenue
Expense
Get List of Profit and Loss Reports
Obtain a list of profit and loss reports.
Report ID
Report Name
Report Title
Report Type
Report Titles
Report Date
Rows
Updated Date U T C
Fields
Get List of Project Tasks
Obtain a list of project tasks.
Page
Page Size
Page Count
Item Count
Get List of Project Users
Obtain a list of project users.
Page
Page Size
Page Count
Item Count
Get List of Project's Time Entries
Obtain a list of time entries for a project.
Page
Page Size
Page Count
Item Count
Get List of Projects
Obtain a list of projects.
Page
Page Size
Page Count
Item Count
Get List of Purchase Order's Attachments
Obtain a list of purchase order's attachments.
Attachment ID
File Name
URL
Mime Type
Content Length
Include Online
Get List of Purchase Order's History
Obtain a list of purchase order's history.
Details
Changes
User
Date U T C
Get List of Purchase Orders
Obtain a list of purchase orders.
Contact
Line Items
Date
Delivery Date
Line Amount Types
Purchase Order Number
Reference
Branding Theme ID
Currency Code
Status
Sent To Contact
Delivery Address
Attention To
Telephone
Delivery Instructions
Expected Arrival Date
Purchase Order ID
Currency Rate
Sub Total
Total Tax
Total
Total Discount
Updated Date U T C
Status Attribute String
Attachments
Get List of Quote's Attachments
Obtain a list of a quote's attachments.
Attachment ID
File Name
URL
Mime Type
Content Length
Include Online
Get List of Quote's History
Obtain a list of quote's history.
Details
Changes
User
Date U T C
Get List of Repeating Invoice's Attachments
Obtain a list of repeat invoice's attachments.
Attachment ID
File Name
URL
Mime Type
Content Length
Include Online
Get List of Repeating Invoice's History
Obtain a list of repeating invoice's history.
Details
Changes
User
Date U T C
Get List of Repeating Invoices
Obtain a list of repeating invoices.
Type
Contact
Schedule
Line Items
Line Amount Types
Reference
Branding Theme ID
Currency Code
Status
Sub Total
Total Tax
Total
Repeating Invoice ID
ID
Attachments
Approved For Sending
Send Copy
Mark As Sent
Include P D F
Get List of Report Histories
Obtain a list of report histories.
Organisation ID
End Date
Reports
Get List of Revenue Contacts Reports
Obtain a list of revenue report by contacts.
Start Date
End Date
Total
Total Detail
Total Other
Contacts
Manual Journals
Get List of Sales Quotes
Obtain a list of sales quotes.
Quote ID
Quote Number
Reference
Terms
Contact
Line Items
Date
Date String
Expiry Date
Expiry Date String
Status
Currency Code
Currency Rate
Sub Total
Total Tax
Total
Total Discount
Title
Summary
Branding Theme ID
Updated Date U T C
Line Amount Types
Status Attribute String
Get List of Statements
Obtain a list of statements.
Page
Page Size
Page Count
Item Count
Get List of Subscription's Usage Records
Obtain a list of subscription's usage records.
Get List of Superfund Products
Obtain a list of superfund products.
ABN
USI
SPIN
Product Name
Get List of Superfunds
Obtain a list of superfunds.
Super Fund ID
Type
Name
ABN
BSB
Account Number
Account Name
Electronic Service Address
Employer Number
SPIN
USI
Updated Date U T C
Get List of Tax Rates
Obtain a list of tax rates.
Name
Tax Type
Tax Components
Status
Report Tax Type
Can Apply To Assets
Can Apply To Equity
Can Apply To Expenses
Can Apply To Liabilities
Can Apply To Revenue
Display Tax Rate
Effective Rate
Get List of Timesheets
Obtain a list of timesheets.
Employee ID
Start Date
End Date
Status
Hours
Timesheet ID
Timesheet Lines
Updated Date U T C
Get List of Tracking Categories and Options
Obtain a list of tracking categories and options.
Tracking Category ID
Tracking Option ID
Name
Option
Status
Options
Get List of Trial Balance Reports
Obtain a list of trial balance reports.
Report ID
Report Name
Report Title
Report Type
Report Titles
Report Date
Rows
Updated Date U T C
Fields
Get List of Trial Balance Reports
Obtain a list of trial balance reports.
Start Date
End Date
Accounts
Get List of User's Activities
Obtain a list of user's activities.
Organisation ID
Data Month
Users
Get List of Users
Obtain a list of users.
User ID
Email Address
First Name
Last Name
Updated Date U T C
Is Subscriber
Organisation Role
Retrieve Account
Grab all details about an account.
Code
Name
Account ID
Type
Bank Account Number
Status
Description
Bank Account Type
Currency Code
Tax Type
Enable Payments To Account
Show In Expense Claims
Class
System Account
Reporting Code
Reporting Code Name
Updated Date U T C
Add To Watchlist
Retrieve Association Count
Grab all details about an association count.
Retrieve Association Object
Grab all details about an association object.
File ID
Object ID
Object Group
Object Type
Retrieve Attachment by Attachment File Name
Grab all details about an account's attachment.
Retrieve Attachment by Attachment ID
Grab all details about an account's attachment.
Retrieve Bank Transaction
Grab all details about a bank transaction.
Type
Contact
Line Items
Bank Account
Is Reconciled
Date
Reference
Currency Code
Currency Rate
URL
Status
Line Amount Types
Sub Total
Total Tax
Total
Bank Transaction ID
Prepayment ID
Overpayment ID
Updated Date U T C
Status Attribute String
Retrieve Bank Transaction Attachment
Grab all details about a specific bank transaction attachment.
Retrieve Bank Transaction's Attachment by File Name
Grab all details about a bank transaction's attachment by file name.
Retrieve Bank Transaction's History
Grab all details about a bank transaction's history.
Details
Changes
User
Date U T C
Retrieve Bank Transfer
Grab all details about a bank transfer.
From Bank Account
To Bank Account
Amount
Date
Bank Transfer ID
Currency Rate
From Bank Transaction ID
To Bank Transaction ID
From Is Reconciled
To Is Reconciled
Reference
Created Date U T C
Retrieve Bank Transfer History
Grab all history details for a bank transfer.
Details
Changes
User
Date U T C
Retrieve Bank Transfer's Attachment
Grab all details about a bank transfer's attachment.
Retrieve Bank Transfer's Attachment by File Name
Grab all details about a bank transfer's attachment by file name.
Retrieve Batch Payment
Grab all details of a specific batch payment.
Retrieve Batch Payment History
Grab all details about the batch payment history.
Retrieve Branding Theme
Grab all details about a branding theme.
Branding Theme ID
Name
Logo URL
Type
Sort Order
Created Date U T C
Retrieve Budget
Grab all details about a specific budget including budget lines.
Budget ID
Type
Description
Updated Date U T C
Budget Lines
Tracking
Retrieve Contact
Grab all details about an existing contact.
Contact ID
Merged To Contact ID
Contact Number
Account Number
Contact Status
Name
First Name
Last Name
Company Number
Email Address
Skype User Name
Contact Persons
Bank Account Details
Tax Number
Accounts Receivable Tax Type
Accounts Payable Tax Type
Addresses
Phones
Is Supplier
Is Customer
Sales Default Line Amount Type
Purchases Default Line Amount Type
Default Currency
Xero Network Key
Sales Default Account Code
Purchases Default Account Code
Sales Tracking Categories
Purchases Tracking Categories
Tracking Category Name
Tracking Category Option
Payment Terms
Updated Date U T C
Contact Groups
Website
Branding Theme
Discount
Balances
Attachments
Status Attribute String
Retrieve Contact by Contact Number
Grab all details about a contact by contact number.
Retrieve Contact Group
Grab all details about a contact group.
Name
Status
Contact Group ID
Contacts
Retrieve Contact's Attachment
Grab all details about a contact's attachment.
Retrieve Contact's Attachment by File Name
Grab all details about a contact's attachment by file name.
Retrieve Credit Note
Grab all details about a credit note.
Type
Contact
Date
Due Date
Status
Line Amount Types
Line Items
Sub Total
Total Tax
Total
CISDeduction
CISRate
Updated Date U T C
Currency Code
Fully Paid On Date
Credit Note ID
Credit Note Number
Reference
Sent To Contact
Currency Rate
Remaining Credit
Allocations
Applied Amount
Payments
Branding Theme ID
Status Attribute String
Has Errors
Retrieve Credit Note's Attachment
Grab all details about a credit note's attachment.
Retrieve Credit Note's Attachment by File Name
Grab all details about a credit note's attachment by file name.
Retrieve Employee
Grab details of a specific employee.
Employee ID
Status
First Name
Last Name
External Link
Updated Date U T C
Status Attribute String
Retrieve Expense Claim
Grab all details about an expense claim.
Expense Claim ID
Status
Payments
User
Receipts
Updated Date U T C
Total
Amount Due
Amount Paid
Payment Due Date
Reporting Date
Receipt ID
Retrieve Feed Connection
Grab all details about a feed connection.
ID
Account Token
Account Number
Account Name
Account ID
Account Type
Currency
Country
Status
Error
Retrieve File
Grab all details about file.
Name
Mime Type
Size
Created Date Utc
Updated Date Utc
User
ID
Folder ID
Retrieve File's Content
Retrieve the file's content.
Retrieve Fixed Asset
Grab all details of a fixed asset.
Asset ID
Asset Name
Asset Type ID
Asset Number
Purchase Date
Purchase Price
Disposal Date
Disposal Price
Asset Status
Warranty Expiry Date
Serial Number
Book Depreciation Setting
Book Depreciation Detail
Can Rollback
Accounting Book Value
Is Delete Enabled For Date
Retrieve Folder
Grab all details about a folder.
Name
File Count
Email
Is Inbox
ID
Retrieve invoice
Grab all details about an invoice.
Type
Contact
Line Items
Date
Due Date
Line Amount Types
Invoice Number
Reference
Branding Theme ID
URL
Currency Code
Currency Rate
Status
Sent To Contact
Expected Payment Date
Planned Payment Date
CISDeduction
CISRate
Sub Total
Total Tax
Total
Total Discount
Invoice ID
Repeating Invoice ID
Is Discounted
Payments
Prepayments
Overpayments
Amount Due
Amount Paid
Fully Paid On Date
Amount Credited
Updated Date U T C
Credit Notes
Attachments
Has Errors
Status Attribute String
Retrieve Invoice's Attachment
Grab all details about an invoice's attachment.
Retrieve Invoice's Attachment by File Name
Grab all details about an invoice's attachment by file name.
Retrieve Item
Grab all details about an item.
Code
Inventory Asset Account Code
Name
Is Sold
Is Purchased
Description
Purchase Description
Purchase Details
Sales Details
Is Tracked As Inventory
Total Cost Pool
Quantity On Hand
Updated Date U T C
Item ID
Status Attribute String
Retrieve Item's History
Grab all details about an item's history.
Details
Changes
User
Date U T C
Retrieve Journal
Grab all details about the journal.
Journal ID
Journal Date
Journal Number
Created Date U T C
Reference
Source ID
Source Type
Journal Lines
Retrieve Journal by Journal Number
Grab all details about the journal by journal number.
Journal ID
Journal Date
Journal Number
Created Date U T C
Reference
Source ID
Source Type
Journal Lines
Retrieve Leave Application
Grab all details about a leave application.
Leave Application ID
Employee ID
Leave Type ID
Title
Start Date
End Date
Description
Pay Out Type
Leave Periods
Updated Date U T C
Retrieve Linked Transaction
Grab all details of a linked transaction.
Source Transaction ID
Source Line Item ID
Contact ID
Target Transaction ID
Target Line Item ID
Linked Transaction ID
Status
Type
Updated Date U T C
Source Transaction Type Code
Retrieve Manual Journal
Grab all details about a manual journal.
Narration
Journal Lines
Date
Line Amount Types
Status
URL
Show On Cash Basis Reports
Updated Date U T C
Manual Journal ID
Status Attribute String
Attachments
Retrieve Manual Journal's Attachment
Grab all details about a manual journal's attachment.
Retrieve Manual Journal's Attachment by File Name
Grab all details about a manual journal's attachment by file name.
Retrieve Online Invoice URL
Grab all details about an online invoice url.
- Online Invoice URL
Retrieve Organization
Grab all details about an organization.
Organisation ID
APIKey
Name
Legal Name
Pays Tax
Version
Organisation Type
Base Currency
Country Code
Is Demo Company
Organisation Status
Registration Number
Employer Identification Number
Tax Number
Financial Year End Day
Financial Year End Month
Sales Tax Basis
Sales Tax Period
Default Sales Tax
Default Purchases Tax
Period Lock Date
End Of Year Lock Date
Created Date U T C
Timezone
Organisation Entity Type
Short Code
Class
Edition
Line Of Business
Addresses
Phones
External Links
Payment Terms
Retrieve Overpayment
Grab all details about an overpayment.
Type
Contact
Date
Status
Line Amount Types
Line Items
Sub Total
Total Tax
Total
Updated Date U T C
Currency Code
Overpayment ID
Currency Rate
Remaining Credit
Allocations
Applied Amount
Payments
Attachments
Retrieve Pay Run
Grab all details of a pay run.
Payroll Calendar ID
Pay Run ID
Pay Run Period Start Date
Pay Run Period End Date
Pay Run Status
Payment Date
Payslip Message
Updated Date U T C
Payslips
Wages
Deductions
Tax
Super
Reimbursement
Net Pay
Retrieve Payment
Grab all details about a payment.
Invoice
Invoice Number
Credit Note Number
Account
Code
Date
Currency Rate
Amount
Bank Amount
Reference
Is Reconciled
Status
Payment Type
Updated Date U T C
Payment ID
Batch Payment ID
Bank Account Number
Particulars
Details
Has Account
Status Attribute String
Retrieve Payroll Calendar
Grab all details about a payroll calendar.
Name
Calendar Type
Start Date
Payment Date
Payroll Calendar ID
Updated Date U T C
Reference Date
Retrieve Payslip
Grab all details about a payslip.
Employee ID
Payslip ID
First Name
Last Name
Wages
Deductions
Tax
Super
Reimbursements
Net Pay
Earnings Lines
Leave Earnings Lines
Timesheet Earnings Lines
Deduction Lines
Leave Accrual Lines
Reimbursement Lines
Superannuation Lines
Tax Lines
Updated Date U T C
Retrieve Prepayment
Grab all details about a prepayment.
Type
Contact
Date
Status
Line Amount Types
Line Items
Sub Total
Total Tax
Total
Reference
Updated Date U T C
Currency Code
Prepayment ID
Currency Rate
Remaining Credit
Allocations
Payments
Applied Amount
Attachments
Retrieve Project
Grab all details about a project.
Project ID
Contact ID
Name
Currency Code
Minutes Logged
Total Task Amount
Total Expense Amount
Estimate Amount
Minutes To Be Invoiced
Task Amount To Be Invoiced
Task Amount Invoiced
Expense Amount To Be Invoiced
Expense Amount Invoiced
Project Amount Invoiced
Deposit
Deposit Applied
Credit Note Amount
Deadline Utc
Total Invoiced
Total To Be Invoiced
Estimate
Status
Retrieve Project's Time Entry
Grab all details about a time entry for a project.
Time Entry ID
User ID
Project ID
Task ID
Date Utc
Date Entered Utc
Duration
Description
Status
Retrieve Purchase Order
Grab all details about a purchase order.
Contact
Line Items
Date
Delivery Date
Line Amount Types
Purchase Order Number
Reference
Branding Theme ID
Currency Code
Status
Sent To Contact
Delivery Address
Attention To
Telephone
Delivery Instructions
Expected Arrival Date
Purchase Order ID
Currency Rate
Sub Total
Total Tax
Total
Total Discount
Updated Date U T C
Status Attribute String
Attachments
Retrieve Purchase Order as PDF
Grab all details about a purchase order as a pdf.
Retrieve Purchase Order by Order Number
Grab all details about a purchase order using order number.
Contact
Line Items
Date
Delivery Date
Line Amount Types
Purchase Order Number
Reference
Branding Theme ID
Currency Code
Status
Sent To Contact
Delivery Address
Attention To
Telephone
Delivery Instructions
Expected Arrival Date
Purchase Order ID
Currency Rate
Sub Total
Total Tax
Total
Total Discount
Updated Date U T C
Status Attribute String
Attachments
Retrieve Purchase Order's Attachment
Grab all details about a purchase order's attachment.
Retrieve Purchase Order's Attachment by File Name
Grab all details about a purchase order's attachment by file name.
Retrieve Quote
Grab all details about a quote.
Quote ID
Quote Number
Reference
Terms
Contact
Line Items
Date
Date String
Expiry Date
Expiry Date String
Status
Currency Code
Currency Rate
Sub Total
Total Tax
Total
Total Discount
Title
Summary
Branding Theme ID
Updated Date U T C
Line Amount Types
Status Attribute String
Retrieve Quote as PDF
Grab all details about a quote as a pdf.
Retrieve Quote's Attachment
Grab all details about a quote's attachment.
Retrieve Quote's Attachment by FIle Name
Grab all details about a quote's attachment by file name.
Retrieve Repeating Invoice
Grab all details of a repeating invoice.
Type
Contact
Schedule
Line Items
Line Amount Types
Reference
Branding Theme ID
Currency Code
Status
Sub Total
Total Tax
Total
Repeating Invoice ID
ID
Attachments
Approved For Sending
Send Copy
Mark As Sent
Include P D F
Retrieve Repeating Invoice's Attachment
Grab all details about a repeating invoice's attachment.
Retrieve Repeating Invoice's Attachment by File Name
Grab all details about a repeating invoice's attachment by file name.
Retrieve Report
Grab all details about a report.
Report ID
Report Name
Report Title
Report Type
Report Titles
Report Date
Rows
Updated Date U T C
Fields
Retrieve Statement
Grab all details about a statement.
ID
Feed Connection ID
Status
Start Date
End Date
Start Balance
End Balance
Statement Lines
Errors
Statement Line Count
Retrieve Subscriptions
Grab all details about a subscription.
Retrieve Superfund
Grab all details about a superfund.
Super Fund ID
Type
Name
ABN
BSB
Account Number
Account Name
Electronic Service Address
Employer Number
SPIN
USI
Updated Date U T C
Retrieve Task
Grab all details about a project task.
Task ID
Name
Rate
Charge Type
Estimate Minutes
Project ID
Total Minutes
Total Amount
Minutes Invoiced
Minutes To Be Invoiced
Fixed Minutes
Non Chargeable Minutes
Amount To Be Invoiced
Amount Invoiced
Status
Retrieve Timesheet
Grab all details about a timesheet.
Employee ID
Start Date
End Date
Status
Hours
Timesheet ID
Timesheet Lines
Updated Date U T C
Retrieve Tracking Company
Grab all details about a tracking company.
Tracking Category ID
Tracking Option ID
Name
Option
Status
Options
Retrieve User
Grab all details about a user.
User ID
Email Address
First Name
Last Name
Updated Date U T C
Is Subscriber
Organisation Role
Send Copy of Invoice by Email
Send a copy of an invoice to related contact via email.
Send Metered Usage for Subscription and Subscription Item
Send metered usage for a subscription and subscription item.
Set Chart of Accounts, Conversion Date, and Conversion Balances
Set the chart of accounts, conversion date, and conversion balances.
Accounts
Organisation
Update a Spent or Received Bank Transaction
Modify an existing bank transaction.
- Bank Transactions
Update Account
Modify an existing account's details.
- Accounts
Update Attachment
Modify an account's attachment.
Update Bank Transaction's Attachment by File Name
Modify a specific attachment from a specific bank transaction by filename.
Update Bank Transfer's Attachment
Modify a bank transfer's attachment.
Update Batch Payment
Modify a specific batch payment for invoices and credit notes.
Update Batch Payment by URL
Modify a specific batch payment for invoices and credit notes.
Update Contact
Modify an existing contact's details.
- Contacts
Update Contact Attachment by File Name
Modify an existing contact attachment by file name.
Update Contact Group
Modify a contact group.
- Contact Groups
Update Credit Note
Modify a credit note.
- Credit Notes
Update Credit Note's Attachment by File Name
Modify a credit note's attachment by file name.
Update Expense Claim
Modify a specific expense claim.
- Expense Claims
Update File
Modify a file.
Name
Mime Type
Size
Created Date Utc
Updated Date Utc
User
ID
Folder ID
Update Folder
Modify an existing folder.
Name
File Count
Email
Is Inbox
ID
Update Invoice
Modify a specific sales invoice or purchase bill.
- Invoices
Update Invoice's Attachment by File Name
Modify the attachment of a specific invoice or purchase bill using its file name.
Update Item
Modify an item's details.
- Items
Update Leave Application
Modify a leave application.
Update Linked Transaction
Modify a specific linked transaction.
- Linked Transactions
Update Manual Journal
Modify a specific manual journal.
- Manual Journals
Update Manual Journal's Attachment by File Name
Modify a manual journal's attachment by file name.
Update Metered Usage for Subscription and Subscription Item
Modify metered usage for a subscription and subscription item.
Update or Create a Spent Or Received Bank Transaction
Modify or create a spent or received money bank transaction.
- Bank Transactions
Update Pay Run
Modify a pay run.
Update Payment for Invoices & Credit Notes
Modify a payment's details for invoices and credit notes.
- Status
Update Payslip
Modify a payslip.
Update Project
Modify a project.
Name
Contact ID
Estimate Amount
Deadline Utc
Update Project's Time Entry
Modify a project's time entry.
User ID
Task ID
Date Utc
Duration
Description
Update Purchase Order
Modify a purchase order.
- Purchase Orders
Update Purchase Order Attachment
Modify a purchase order attachment.
Update Quote
Modify a specific quote.
- Quotes
Update Quote Attachment
Modify a quote's attachment.
Update Repeating Invoice Template
Modify a specific repeating invoice template.
- Repeating Invoices
Update Repeating Invoice's Attachment
Modify an existing repeating invoice's attachment.
Update Superfund
Modify a superfund.
Update Task
Modify task.
Name
Charge Type
Rate
Estimate Minutes
Update Tax Rate
Modify an existing tax rate.
- Tax Rates
Update Timesheet
Modify a timesheet.
Update Tracking Category's Option
Modify a tracking category option.
Tracking Option ID
Name
Status
Tracking Category ID
Update Tracking Company
Modify a specific tracking category.
Tracking Category ID
Tracking Option ID
Name
Option
Status
Options
Accept Quote
Accept the specified quote.
Amount Subtotal
Amount Total
Application
Application Fee Amount
Application Fee Percent
Automatic Tax
Collection Method
Computed
Created
Currency
Customer
Description
Discounts
Expires At
Footer
From Quote
Header
ID
Invoice
Invoice Settings
Line Items
Livemode
Metadata
Number
Object
On Behalf Of
Status
Status Transitions
Subscription
Subscription Data
Subscription Schedule
Test Clock
Total Details
Transfer Data
Add New Card to a Customer
Account Number
Bank Name
Fingerprint
Refund Account Holder Name
Refund Account Holder Type
Refund Routing Number
Routing Number
Swift Code
Approve Authorization
Approve a pending Issuing authorization.
Amount
Amount Details
Approved
Authorization Method
Balance Transactions
Card
Cardholder
Created
Currency
ID
Livemode
Merchant Amount
Merchant Currency
Merchant Data
Metadata
Network Data
Object
Pending Request
Request History
Status
Transactions
Treasury
Verification Data
Wallet
Approve Review
Approve a review, closing it, and removing it from the list of reviews.
Billing Zip
Charge
Closed Reason
Created
ID
Ip Address
Ip Address Location
Livemode
Object
Open
Opened Reason
Payment Intent
Reason
Session
Attach Payment Method to Customer
Appends a payment method to a customer.
Bank Name
Fingerprint
Institution Number
Last4
Transit Number
Attach Source
Append a source to a customer. The source must be in a chargeable or pending state.
Account Number
Bank Name
Fingerprint
Refund Account Holder Name
Refund Account Holder Type
Refund Routing Number
Routing Number
Swift Code
Calculate Tax
Calculate tax.
Amount Total
Currency
Customer
Customer Details
Expires At
ID
Line Items
Livemode
Object
Shipping Cost
Tax Amount Exclusive
Tax Amount Inclusive
Tax Breakdown
Tax Date
Cancel Current Reader Action
Cancel a current reader action.
Failure Code
Failure Message
Process Payment Intent
Process Setup Intent
Refund Payment
Set Reader Display
Status
Type
Cancel Inbound Transfer
Cancel an inbound transfer.
Amount
Cancelable
Created
Currency
Description
Failure Details
Financial Account
Hosted Regulatory Receipt URL
ID
Linked Flows
Livemode
Metadata
Object
Origin Payment Method
Origin Payment Method Details
Returned
Statement Descriptor
Status
Status Transitions
Transaction
Cancel Outbound Payment
Cancel an outbound payment.
Amount
Cancelable
Created
Currency
Customer
Description
Destination Payment Method
Destination Payment Method Details
End User Details
Expected Arrival Date
Financial Account
Hosted Regulatory Receipt URL
ID
Livemode
Metadata
Object
Returned Details
Statement Descriptor
Status
Status Transitions
Transaction
Cancel Outbound Transfer
Cancel an outbound transfer.
Amount
Cancelable
Created
Currency
Description
Destination Payment Method
Destination Payment Method Details
Expected Arrival Date
Financial Account
Hosted Regulatory Receipt URL
ID
Livemode
Metadata
Object
Returned Details
Statement Descriptor
Status
Status Transitions
Transaction
Cancel Payment Intent
Cancel a payment intent.
Amount
Amount Capturable
Amount Details
Amount Received
Application
Application Fee Amount
Automatic Payment Methods
Canceled At
Cancellation Reason
Capture Method
Client Secret
Confirmation Method
Created
Currency
Customer
Description
ID
Invoice
Last Payment Error
Latest Charge
Livemode
Metadata
Next Action
Object
On Behalf Of
Payment Method
Payment Method Options
Payment Method Types
Processing
Receipt Email
Review
Setup Future Usage
Shipping
Statement Descriptor
Statement Descriptor Suffix
Status
Transfer Data
Transfer Group
Cancel Payout
Cancel a payout.
Amount
Arrival Date
Automatic
Balance Transaction
Created
Currency
Description
Destination
Failure Balance Transaction
Failure Code
Failure Message
ID
Livemode
Metadata
Method
Object
Original Payout
Reconciliation Status
Reversed By
Source Type
Statement Descriptor
Status
Type
Cancel Quote
Cancel a quote.
Amount Subtotal
Amount Total
Application
Application Fee Amount
Application Fee Percent
Automatic Tax
Collection Method
Computed
Created
Currency
Customer
Description
Discounts
Expires At
Footer
From Quote
Header
ID
Invoice
Invoice Settings
Line Items
Livemode
Metadata
Number
Object
On Behalf Of
Status
Status Transitions
Subscription
Subscription Data
Subscription Schedule
Test Clock
Total Details
Transfer Data
Cancel Refund
Cancel a refund.
Amount
Balance Transaction
Charge
Created
Currency
Description
Failure Balance Transaction
Failure Reason
ID
Instructions Email
Metadata
Next Action
Object
Payment Intent
Reason
Receipt Number
Source Transfer Reversal
Status
Transfer Reversal
Cancel Schedule
Cancel a subscription schedule and its associated subscription immediately (if the subscription schedule has an active subscription)
ID
Name
Object
Cancel Subscription
Cancel a subscription.
Application
Application Fee Percent
Automatic Tax
Billing Cycle Anchor
Billing Thresholds
Cancel At
Cancel At Period End
Canceled At
Cancellation Details
Collection Method
Created
Currency
Current Period End
Current Period Start
Customer
Days Until Due
Description
Discount
Ended At
ID
Items
Latest Invoice
Livemode
Metadata
Next Pending Invoice Item Invoice
Object
On Behalf Of
Pause Collection
Payment Settings
Pending Invoice Item Interval
Pending Setup Intent
Pending Update
Schedule
Start Date
Status
Test Clock
Transfer Data
Trial End
Trial Settings
Trial Start
Cancel Top-Up
Cancel a top-up. Only pending top-ups can be canceled.
Amount
Balance Transaction
Created
Currency
Description
Expected Availability Date
Failure Code
Failure Message
ID
Livemode
Metadata
Object
Source
Statement Descriptor
Status
Transfer Group
Cancel Verification Session
Cancel a verification session.
Client Secret
Created
ID
Last Error
Last Verification Report
Livemode
Metadata
Object
Options
Redaction
Status
Type
URL
Verified Outputs
Cancels a customer’s subscription.
Application
Application Fee Percent
Automatic Tax
Billing Cycle Anchor
Billing Thresholds
Cancel At
Cancel At Period End
Canceled At
Cancellation Details
Collection Method
Created
Currency
Current Period End
Current Period Start
Customer
Days Until Due
Description
Discount
Ended At
ID
Items
Latest Invoice
Livemode
Metadata
Next Pending Invoice Item Invoice
Object
On Behalf Of
Pause Collection
Payment Settings
Pending Invoice Item Interval
Pending Setup Intent
Pending Update
Schedule
Start Date
Status
Test Clock
Transfer Data
Trial End
Trial Settings
Trial Start
Capture Charge
Capture a payment of an existing, uncaptured, charge.
Amount
Amount Captured
Amount Refunded
Application
Application Fee
Application Fee Amount
Balance Transaction
Billing Details
Calculated Statement Descriptor
Captured
Created
Currency
Customer
Description
Disputed
Failure Balance Transaction
Failure Code
Failure Message
Fraud Details
ID
Invoice
Livemode
Metadata
Object
On Behalf Of
Outcome
Paid
Payment Intent
Payment Method
Payment Method Details
Radar Options
Receipt Email
Receipt Number
Receipt URL
Refunded
Refunds
Review
Shipping
Source Transfer
Statement Descriptor
Statement Descriptor Suffix
Status
Transfer
Transfer Data
Transfer Group
Capture Payment Intent
Capture the funds of an existing uncapture payment intent when its status is requires capture.
Amount
Amount Capturable
Amount Details
Amount Received
Application
Application Fee Amount
Automatic Payment Methods
Canceled At
Cancellation Reason
Capture Method
Client Secret
Confirmation Method
Created
Currency
Customer
Description
ID
Invoice
Last Payment Error
Latest Charge
Livemode
Metadata
Next Action
Object
On Behalf Of
Payment Method
Payment Method Options
Payment Method Types
Processing
Receipt Email
Review
Setup Future Usage
Shipping
Statement Descriptor
Statement Descriptor Suffix
Status
Transfer Data
Transfer Group
Charge dispute close
Amount
Balance Transactions
Charge
Created
Currency
Evidence
Evidence Details
ID
Is Charge Refundable
Livemode
Metadata
Object
Payment Intent
Reason
Status
Close Dispute
Close a dispute. Closing a dispute for a charge indicates that you do not have any evidence to submit and are essentially dismissing the dispute, acknowledging it as lost.
Amount
Balance Transactions
Charge
Created
Currency
Evidence
Evidence Details
ID
Is Charge Refundable
Livemode
Metadata
Object
Payment Intent
Reason
Status
Confirm Payment Intent
Confirm that a customer intends to pay with current or provided payment method.
Amount
Amount Capturable
Amount Details
Amount Received
Application
Application Fee Amount
Automatic Payment Methods
Canceled At
Cancellation Reason
Capture Method
Client Secret
Confirmation Method
Created
Currency
Customer
Description
ID
Invoice
Last Payment Error
Latest Charge
Livemode
Metadata
Next Action
Object
On Behalf Of
Payment Method
Payment Method Options
Payment Method Types
Processing
Receipt Email
Review
Setup Future Usage
Shipping
Statement Descriptor
Statement Descriptor Suffix
Status
Transfer Data
Transfer Group
Create a Bank Account for a Customer
Alipay Account
Bank Account
Card
Expand
Metadata
Source
Create a refund
Create a refund.
Amount
Currency
Customer
Expand
Instructions Email
Metadata
Origin
Payment Intent
Reason
Refund Application Fee
Reverse Transfer
create a Session
To launch the Financial Connections authorization flow, create a Session. The session’s client_secret can be used to launch the flow using Stripe.js.
Account Holder
Expand
Filters
Permissions
Return URL
Create a Session
To launch the Financial Connections authorization flow, create a Session. The session’s client_secret can be used to launch the flow using Stripe.js.
Account Holder
Expand
Filters
Permissions
Return URL
Create a source
Creates a new source object.
Amount
Currency
Customer
Expand
Flow
Mandate
Metadata
Original Source
Owner
Receiver
Redirect
Source Order
Statement Descriptor
Token
Type
Usage
Create a usage record
Action
Expand
Quantity
Timestamp
Create Account
Create an account.
Account Token
Bank Account
Business Profile
Business Type
Capabilities
Company
Country
Documents
Email
Expand
External Account
Individual
Metadata
Settings
Tos Acceptance
Type
Create Account Links
Create an account link.
Account
Collect
Expand
Refresh URL
Return URL
Type
Create Apple Pay Domain
Create an Apple Pay domain.
Domain Name
Expand
Create Application Fee Refund
Refund an application fee that has previously been collected but not yet refunded.
Amount
Directive
Expand
Create Application Fee Refunds
Create an application fee refund.
Amount
Expand
Metadata
Create Cardholder
Create a new Issuing cardholder.
Billing
Company
Email
Expand
Individual
Metadata
Name
Phone Number
Spending Controls
Status
Type
Create Charge
Create a charge.
Amount
Application Fee
Application Fee Amount
Capture
Card
Currency
Customer
Description
Destination
Expand
Metadata
On Behalf Of
Radar Options
Receipt Email
Shipping
Source
Statement Descriptor
Statement Descriptor Suffix
Transfer Data
Transfer Group
Create charge dispute
Evidence
Expand
Metadata
Submit
Create Connection Token
Create a connection token.
Expand
Location
Create Coupon
Create a coupon.
Amount Off
Applies To
Currency
Currency Options
Duration
Duration In Months
Expand
ID
Max Redemptions
Metadata
Name
Percent Off
Redeem By
Create Credit Note
Create a credit note.
Amount
Credit Amount
Expand
Invoice
Lines
Memo
Metadata
Out Of Band Amount
Reason
Refund
Refund Amount
Shipping Cost
Create Credit Reversal
Reverse a received credit and create a credit reversal.
Expand
Metadata
Received Credit
Create Customer
Create a new customer.
Address
Balance
Cash Balance
Coupon
Description
Email
Expand
Invoice Prefix
Invoice Settings
Metadata
Name
Next Invoice Sequence
Payment Method
Phone
Preferred Locales
Promotion Code
Shipping
Source
Tax
Tax Exempt
Tax ID Data
Test Clock
Create Customer Balance Transaction
Create a customer balance transaction.
Amount
Currency
Description
Expand
Metadata
Create Debit Reversal
Reverse a received debit and create a debit reversal.
Expand
Metadata
Received Debit
Create Dispute
Create a dispute.
Evidence
Expand
Metadata
Submit
Create External Account for Specific Account
Create an external account.
Bank Account
Expand
External Account
Metadata
Create External Account for specific Account
Create an external account for an account.
Bank Account
Expand
External Account
Metadata
Create Financial Account
Create a new financial account. Each connected account can only have one financial account.
Expand
Features
Metadata
Platform Restrictions
Supported Currencies
Create Inbound Transfer
Create an inbound transfer.
Amount
Currency
Description
Expand
Financial Account
Metadata
Origin Payment Method
Statement Descriptor
Create Invoice
Create an invoice.
Account Tax Ids
Application Fee Amount
Auto Advance
Automatic Tax
Collection Method
Currency
Custom Fields
Customer
Days Until Due
Description
Discounts
Due Date
Expand
Footer
From Invoice
Metadata
On Behalf Of
Payment Settings
Pending Invoice Items Behavior
Rendering Options
Shipping Cost
Shipping Details
Statement Descriptor
Subscription
Transfer Data
Create Invoice Item
Create an invoice item.
Amount
Currency
Customer
Description
Discountable
Discounts
Expand
Invoice
Metadata
Period
Price
Price Data
Quantity
Subscription
Tax Behavior
Tax Code
Tax Rates
Unit Amount
Unit Amount Decimal
Create Issuing Card
Create an issuing card.
Cardholder
Currency
Expand
Financial Account
Metadata
Replacement For
Replacement Reason
Shipping
Spending Controls
Status
Type
Create Login Link
Create a login link for an Express account to access their Stripe dashboard.
- Expand
Create Outbound Payment
Create an outbound payment.
Amount
Currency
Customer
Description
Destination Payment Method
Destination Payment Method Data
Destination Payment Method Options
End User Details
Expand
Financial Account
Metadata
Statement Descriptor
Create Outbound Transfer
Create an outbound transfer.
Amount
Currency
Description
Destination Payment Method
Destination Payment Method Options
Expand
Financial Account
Metadata
Statement Descriptor
Create Payment Intent
Create a payment intent.
Amount
Application Fee Amount
Automatic Payment Methods
Capture Method
Confirm
Confirmation Method
Currency
Customer
Description
Error On Requires Action
Expand
Mandate
Mandate Data
Metadata
Off Session
On Behalf Of
Payment Method
Payment Method Data
Payment Method Options
Payment Method Types
Radar Options
Receipt Email
Return URL
Setup Future Usage
Shipping
Statement Descriptor
Statement Descriptor Suffix
Transfer Data
Transfer Group
Use Stripe Sdk
Create Payment Link.
Create a payment link.
After Completion
Allow Promotion Codes
Application Fee Amount
Application Fee Percent
Automatic Tax
Billing Address Collection
Consent Collection
Currency
Custom Fields
Custom Text
Customer Creation
Expand
Invoice Creation
Line Items
Metadata
On Behalf Of
Payment Intent Data
Payment Method Collection
Payment Method Types
Phone Number Collection
Shipping Address Collection
Shipping Options
Submit Type
Subscription Data
Tax ID Collection
Transfer Data
Create Payment Method
Create a payment method.
Acss Debit
Affirm
Afterpay Clearpay
Alipay
Au Becs Debit
Bacs Debit
Bancontact
Billing Details
Blik
Boleto
Card
Cashapp
Customer
Customer Balance
Eps
Expand
Fpx
Giropay
Grabpay
Ideal
Interac Present
Klarna
Konbini
Link
Metadata
Oxxo
P24
Payment Method
Paynow
Pix
Promptpay
Radar Options
Sepa Debit
Sofort
Type
Us Bank Account
Wechat Pay
Create Payout
Create a new payout.
Amount
Currency
Description
Destination
Expand
Metadata
Method
Source Type
Statement Descriptor
Create Plan
Create a plan.
Active
Aggregate Usage
Amount
Amount Decimal
Billing Scheme
Currency
Expand
ID
Interval
Interval Count
Metadata
Nickname
Product
Tiers
Tiers Mode
Transform Usage
Trial Period Days
Usage Type
Create Price
Create a price for an existing product.
Active
Billing Scheme
Currency
Currency Options
Custom Unit Amount
Expand
Lookup Key
Metadata
Nickname
Product
Product Data
Recurring
Tax Behavior
Tiers
Tiers Mode
Transfer Lookup Key
Transform Quantity
Unit Amount
Unit Amount Decimal
Create Product
Create a new product.
Active
Description
Expand
ID
Images
Metadata
Name
Package Dimensions
Shippable
Statement Descriptor
Tax Code
Unit Label
URL
Create Promotion Code
Create a promotion code.
Active
Code
Coupon
Customer
Expand
Expires At
Max Redemptions
Metadata
Restrictions
Create Quote
Create a quote.
Application Fee Amount
Application Fee Percent
Automatic Tax
Collection Method
Customer
Description
Discounts
Expand
Expires At
Footer
From Quote
Header
Invoice Settings
Line Items
Metadata
On Behalf Of
Subscription Data
Test Clock
Transfer Data
Create Reader
Create a reader.
Expand
Label
Location
Metadata
Registration Code
Create Refund
Create a refund.
Amount
Charge
Currency
Customer
Expand
Instructions Email
Metadata
Origin
Payment Intent
Reason
Refund Application Fee
Reverse Transfer
Create Report Run
Create a report run.
Expand
Parameters
Report Type
Create Reversal Tax Transaction
Partially or fully reverse a previously created transaction.
Expand
Line Items
Metadata
Mode
Original Transaction
Reference
Shipping Cost
Create Schedule
Create a new subscription schedule.
Customer
End Behavior
Expand
From Subscription
Metadata
Phases
Start Date
Create Shipping Rate
Create a shipping rate.
Delivery Estimate
Display Name
Expand
Fixed Amount
Metadata
Tax Behavior
Tax Code
Type
Create Subscription
Create a subscription.
Add Invoice Items
Application Fee Percent
Automatic Tax
Backdate Start Date
Billing Cycle Anchor
Billing Thresholds
Cancel At
Cancel At Period End
Collection Method
Coupon
Currency
Customer
Days Until Due
Description
Expand
Items
Metadata
Off Session
On Behalf Of
Payment Behavior
Payment Settings
Pending Invoice Item Interval
Promotion Code
Proration Behavior
Transfer Data
Trial End
Trial From Plan
Trial Period Days
Trial Settings
Create Subscription Item
Create a subscription item in an existing subscription. No existing items will be changed or replaced.
Billing Thresholds
Expand
Metadata
Payment Behavior
Price
Price Data
Proration Behavior
Proration Date
Quantity
Subscription
Tax Rates
Create Tax ID
Create a tax id.
Expand
Type
Value
Create Tax Rate
Create a tax rate.
Active
Country
Description
Display Name
Expand
Inclusive
Jurisdiction
Metadata
Percentage
State
Tax Type
Create Tax Transaction Calculation
Create a tax transaction from a calculation.
Calculation
Expand
Metadata
Reference
Create Terminal Configuration
Create a terminal configuration.
Bbpos Wisepos E
Expand
Tipping
Verifone P400
Create Terminal Location
Create a terminal location.
Address
Configuration Overrides
Display Name
Expand
Metadata
Create Top-Up
Create a top-up.
Amount
Currency
Description
Expand
Metadata
Source
Statement Descriptor
Transfer Group
Create Transfer
Create a transfer to send funds from your Stripe account to a connected account.
Amount
Currency
Description
Destination
Expand
Metadata
Source Transaction
Source Type
Transfer Group
Create Transfer Reversal
Create a transfer reversal.
Amount
Description
Expand
Metadata
Refund Application Fee
Create Value List
Create a value list.
Alias
Expand
Item Type
Metadata
Name
Create Value List Item
Create a value list item.
Expand
Value
Value List
Create Verification Session
Create a verification session.
Expand
Metadata
Options
Return URL
Type
Creates a configuration
Creates a configuration that describes the functionality and behavior of a PortalSession
Active
Application
Business Profile
Created
Features
ID
Livemode
Login Page
Metadata
Object
Updated
Creates a new person.
Creates a new person.
Account
Address
Address Kana
Address Kanji
Created
Dob
Email
First Name
First Name Kana
First Name Kanji
Full Name Aliases
Future Requirements
Gender
ID
ID Number Provided
ID Number Secondary Provided
Last Name
Last Name Kana
Last Name Kanji
Maiden Name
Metadata
Nationality
Object
Phone
Political Exposure
Registered Address
Relationship
Requirements
Ssn Last 4 Provided
Verification
Creates a new subscription on an existing customer.
Creates a new subscription on an existing customer.
Application
Application Fee Percent
Automatic Tax
Billing Cycle Anchor
Billing Thresholds
Cancel At
Cancel At Period End
Canceled At
Cancellation Details
Collection Method
Created
Currency
Current Period End
Current Period Start
Customer
Days Until Due
Description
Discount
Ended At
ID
Items
Latest Invoice
Livemode
Metadata
Next Pending Invoice Item Invoice
Object
On Behalf Of
Pause Collection
Payment Settings
Pending Invoice Item Interval
Pending Setup Intent
Pending Update
Schedule
Start Date
Status
Test Clock
Transfer Data
Trial End
Trial Settings
Trial Start
Creates Issuing Dispute
Create an issuing dispute.
Amount
Balance Transactions
Created
Currency
Evidence
ID
Livemode
Metadata
Object
Status
Transaction
Treasury
Creates New Person.
Create a new person.
Account
Address
Address Kana
Address Kanji
Created
Dob
Email
First Name
First Name Kana
First Name Kanji
Full Name Aliases
Future Requirements
Gender
ID
ID Number Provided
ID Number Secondary Provided
Last Name
Last Name Kana
Last Name Kanji
Maiden Name
Metadata
Nationality
Object
Phone
Political Exposure
Registered Address
Relationship
Requirements
Ssn Last 4 Provided
Verification
Decline Authorization
Decline a pending issuing authorization object.
Amount
Amount Details
Approved
Authorization Method
Balance Transactions
Card
Cardholder
Created
Currency
ID
Livemode
Merchant Amount
Merchant Currency
Merchant Data
Metadata
Network Data
Object
Pending Request
Request History
Status
Transactions
Treasury
Verification Data
Wallet
Delete a Bank Account for a Customer
Delete a specified source for a given customer.
Account Number
Bank Name
Fingerprint
Refund Account Holder Name
Refund Account Holder Type
Refund Routing Number
Routing Number
Swift Code
Delete Account
Remove an account.
Deleted
ID
Object
Delete Apple Pay Domain
Remove an Apple Pay domain.
Deleted
ID
Object
Delete Coupon
Remove a coupon.
Deleted
ID
Object
Delete Customer
Remove a customer.
Deleted
ID
Object
Delete Customer Discount
Remove the currently applied discount on a customer.
Checkout Session
Coupon
Customer
Deleted
ID
Invoice
Invoice Item
Object
Promotion Code
Start
Subscription
Delete Draft Invoice
Remove a draft invoice.
Deleted
ID
Object
Delete External Account for Specific Account
Remove a specified external account for an account.
Currency
Deleted
ID
Object
Delete Invoice Item
Remove an invoice item.
Deleted
ID
Object
Delete Person's Relationship to Account’s Legal Entity
Remove a person's relationship to the account's legal entity.
Deleted
ID
Object
Delete Plan
Remove a plan.
Deleted
ID
Object
Delete Product
Remove a product.
Deleted
ID
Object
Delete Reader
Remove a reader.
Deleted
ID
Object
Delete Specified External Account for Specific Account
Remove a specified external account for an account.
Currency
Deleted
ID
Object
Delete Subscription Discount
Remove a subscription discount.
Checkout Session
Coupon
Customer
Deleted
ID
Invoice
Invoice Item
Object
Promotion Code
Start
Subscription
Delete Subscription Item
Remove a subscription item from a subscription. Removing a subscription item from a subscription will not cancel the subscription.
Deleted
ID
Object
Delete Tax ID
Remove an existing tax id.
Deleted
ID
Object
Delete Terminal Configuration
Remove a terminal configuration.
Deleted
ID
Object
Delete Terminal Location
Remove a terminal location.
Deleted
ID
Object
Delete Value List
Remove a value list.
Deleted
ID
Object
Delete Value List Item
Remove a value list item.
Deleted
ID
Object
Deletes an existing person’s relationship to the account’s legal entity.
Deleted
ID
Object
Detach Payment Method from Customer
Detaches a payment method from a customer. After a payment method is detached, it can no longer be used for a payment or re-attached to a customer.
Bank Name
Fingerprint
Institution Number
Last4
Transit Number
Detach Source
Remove a source from a customer. The source's status is changed to consumed when it is detached and it can no longer be used to create a charge
Account Number
Bank Name
Fingerprint
Refund Account Holder Name
Refund Account Holder Type
Refund Routing Number
Routing Number
Swift Code
Disables your access to a Financial Connections Account
Disables your access to a Financial Connections Account. You will no longer be able to access data associated with the account (e.g. balances, transactions).
Account
Customer
Type
Discount Financial Connections Account
Disable your access to a financial connections account.
Account
Customer
Type
Download Quote PDF
Download a PDF for a finalized quote.
Finalize Invoice
Finalize a draft invoice.
Account Country
Account Name
Account Tax Ids
Amount Due
Amount Paid
Amount Remaining
Amount Shipping
Application
Application Fee Amount
Attempt Count
Attempted
Auto Advance
Automatic Tax
Billing Reason
Charge
Collection Method
Created
Currency
Custom Fields
Customer
Customer Address
Customer Email
Customer Name
Customer Phone
Customer Shipping
Customer Tax Exempt
Customer Tax Ids
Description
Discount
Discounts
Due Date
Ending Balance
Footer
From Invoice
Hosted Invoice URL
ID
Invoice Pdf
Last Finalization Error
Latest Revision
Lines
Livemode
Metadata
Next Payment Attempt
Number
Object
On Behalf Of
Paid
Paid Out Of Band
Payment Intent
Payment Settings
Period End
Period Start
Post Payment Credit Notes Amount
Pre Payment Credit Notes Amount
Quote
Receipt Number
Rendering Options
Shipping Cost
Shipping Details
Starting Balance
Statement Descriptor
Status
Status Transitions
Subscription
Subscription Proration Date
Subtotal
Subtotal Excluding Tax
Tax
Test Clock
Threshold Reason
Total
Total Discount Amounts
Total Excluding Tax
Total Tax Amounts
Transfer Data
Webhooks Delivered At
Finalize Quote
Finalize a quote.
Amount Subtotal
Amount Total
Application
Application Fee Amount
Application Fee Percent
Automatic Tax
Collection Method
Computed
Created
Currency
Customer
Description
Discounts
Expires At
Footer
From Quote
Header
ID
Invoice
Invoice Settings
Line Items
Livemode
Metadata
Number
Object
On Behalf Of
Status
Status Transitions
Subscription
Subscription Data
Subscription Schedule
Test Clock
Total Details
Transfer Data
Get a refund
Retrieves the details of an existing refund.
Amount
Balance Transaction
Charge
Created
Currency
Description
Failure Balance Transaction
Failure Reason
ID
Instructions Email
Metadata
Next Action
Object
Payment Intent
Reason
Receipt Number
Source Transfer Reversal
Status
Transfer Reversal
Get Customers Subscriptions
Checkout Session
Coupon
Customer
End
ID
Invoice
Invoice Item
Object
Promotion Code
Start
Subscription
Get Exchange Rates
Returns a list of objects that contain the rates at which foreign currencies are converted to one another. Only shows the currencies for which Stripe supports.
ID
Object
Rates
Get List of Account Capabilities
Obtain a list of account capabilities.
Account
Future Requirements
ID
Object
Requested
Requested At
Requirements
Status
Get List of Account's External Accounts
Obtain a list of external accounts for an account.
Account
Account Holder Name
Account Holder Type
Account Type
Available Payout Methods
Bank Name
Country
Currency
Customer
Fingerprint
Future Requirements
ID
Last4
Metadata
Object
Requirements
Routing Number
Status
Get List of Apple Pay Domains
Obtain a list of apple pay domains.
Created
Domain Name
ID
Livemode
Object
Get List of Application Fee Refunds
Obtain a list of application fee refunds.
Amount
Balance Transaction
Created
Currency
Fee
ID
Metadata
Object
Get List of Application Fees
Obtain a list of application fees.
Account
Amount
Amount Refunded
Application
Balance Transaction
Charge
Created
Currency
ID
Livemode
Object
Originating Transaction
Refunded
Refunds
Get List of Authorizations
Obtain a list of authorizations.
Amount
Amount Details
Approved
Authorization Method
Balance Transactions
Card
Cardholder
Created
Currency
ID
Livemode
Merchant Amount
Merchant Currency
Merchant Data
Metadata
Network Data
Object
Pending Request
Request History
Status
Transactions
Treasury
Verification Data
Wallet
Get List of Balance Transactions
Obtain a list of transactions that have contributed to the Stripe account balance (e.g., charges, transfers, and so forth).
Amount
Available On
Created
Currency
Description
Exchange Rate
Fee
Fee Details
ID
Net
Object
Reporting Category
Source
Status
Type
Get List of Charges
Obtain a list of charges.
Amount
Amount Captured
Amount Refunded
Application
Application Fee
Application Fee Amount
Balance Transaction
Billing Details
Calculated Statement Descriptor
Captured
Created
Currency
Customer
Description
Disputed
Failure Balance Transaction
Failure Code
Failure Message
Fraud Details
ID
Invoice
Livemode
Metadata
Object
On Behalf Of
Outcome
Paid
Payment Intent
Payment Method
Payment Method Details
Radar Options
Receipt Email
Receipt Number
Receipt URL
Refunded
Refunds
Review
Shipping
Source Transfer
Statement Descriptor
Statement Descriptor Suffix
Status
Transfer
Transfer Data
Transfer Group
Get List of Connected Accounts
Obtain a list of accounts connected your platform. If you’re not a platform, the list is empty.
Business Profile
Business Type
Capabilities
Charges Enabled
Company
Controller
Country
Created
Details Submitted
Email
External Accounts
Future Requirements
ID
Individual
Metadata
Object
Payouts Enabled
Requirements
Settings
Tos Acceptance
Type
Get List of Country Specs
Obtain a list of country spec objects available in the API.
ID
Object
Supported Bank Account Currencies
Supported Payment Currencies
Supported Payment Methods
Supported Transfer Countries
Verification Fields
Get List of Coupons
Obtain a list of coupons.
Amount Off
Applies To
Created
Currency
Currency Options
Duration
Duration In Months
ID
Livemode
Max Redemptions
Metadata
Name
Object
Percent Off
Redeem By
Times Redeemed
Valid
Get List of Credit Note Preview's Line Items
Obtain a list of a credit note preview's line items.
Amount
Amount Excluding Tax
Description
Discount Amount
Discount Amounts
ID
Invoice Line Item
Livemode
Object
Quantity
Tax Amounts
Tax Rates
Type
Unit Amount
Unit Amount Decimal
Unit Amount Excluding Tax
Get List of Credit Note's Line Items
Obtain a list of a credit note's line items.
Amount
Amount Excluding Tax
Description
Discount Amount
Discount Amounts
ID
Invoice Line Item
Livemode
Object
Quantity
Tax Amounts
Tax Rates
Type
Unit Amount
Unit Amount Decimal
Unit Amount Excluding Tax
Get List of Credit Notes
Obtain a list of credit notes.
Amount
Amount Shipping
Created
Currency
Customer
Customer Balance Transaction
Discount Amount
Discount Amounts
ID
Invoice
Lines
Livemode
Memo
Metadata
Number
Object
Out Of Band Amount
Pdf
Reason
Refund
Shipping Cost
Status
Subtotal
Subtotal Excluding Tax
Tax Amounts
Total
Total Excluding Tax
Type
Voided At
Get List of Credit Reversals
Obtain a list of credit reversals.
Amount
Created
Currency
Financial Account
Hosted Regulatory Receipt URL
ID
Livemode
Metadata
Network
Object
Received Credit
Status
Status Transitions
Transaction
Get List of Customer's Balance Transactions
Obtain a list of a customer's balance transactions.
Amount
Created
Credit Note
Currency
Customer
Description
Ending Balance
ID
Invoice
Livemode
Metadata
Object
Type
Get List of Customer's Cash Balance Transactions
Obtain a list of transactions that modified the customer's cash balance.
Applied To Payment
Created
Currency
Customer
Ending Balance
Funded
ID
Livemode
Net Amount
Object
Refunded From Payment
Type
Unapplied From Payment
Get List of Customer's Payment Methods
Obtain a list of customer's payment methods.
Acss Debit
Affirm
Afterpay Clearpay
Alipay
Au Becs Debit
Bacs Debit
Bancontact
Billing Details
Blik
Boleto
Card
Card Present
Cashapp
Created
Customer
Customer Balance
Eps
Fpx
Giropay
Grabpay
ID
Ideal
Interac Present
Klarna
Konbini
Link
Livemode
Metadata
Object
Oxxo
P24
Paynow
Pix
Promptpay
Radar Options
Sepa Debit
Sofort
Type
Us Bank Account
Wechat Pay
Get List of Customer's Tax IDs
Obtain a list of tax ids for a customer.
Country
Created
Customer
ID
Livemode
Object
Type
Value
Verification
Get List of Customers
Obtain a list of customers.
Address
Balance
Cash Balance
Created
Currency
Delinquent
Description
Email
ID
Invoice Credit Balance
Invoice Prefix
Invoice Settings
Livemode
Metadata
Name
Next Invoice Sequence
Object
Phone
Preferred Locales
Shipping
Sources
Subscriptions
Tax
Tax Exempt
Tax Ids
Test Clock
Get List of Debit Reversals
Obtain a list of debit reversals.
Amount
Created
Currency
Financial Account
Hosted Regulatory Receipt URL
ID
Linked Flows
Livemode
Metadata
Network
Object
Received Debit
Status
Status Transitions
Transaction
Get List of Disputes
Obtain a list of your disputes.
Amount
Balance Transactions
Charge
Created
Currency
Evidence
Evidence Details
ID
Is Charge Refundable
Livemode
Metadata
Object
Payment Intent
Reason
Status
Get List of Early Fraud Warnings
Obtain a list of early fraud warnings.
Actionable
Charge
Created
Fraud Type
ID
Livemode
Object
Payment Intent
Get List of Events
Obtain a list of events.
Account
Api Version
Created
Data
ID
Livemode
Object
Pending Webhooks
Request
Type
Get List of Financial Accounts
Obtain a list of financial accounts.
Active Features
Balance
Country
Created
Features
Financial Addresses
ID
Livemode
Metadata
Object
Pending Features
Platform Restrictions
Restricted Features
Status
Status Details
Supported Currencies
Get List of Financial Connections Accounts
Obtain a list of financial connections accounts.
Account Holder
Balance
Balance Refresh
Category
Created
Display Name
ID
Institution Name
Last4
Livemode
Object
Ownership
Ownership Refresh
Permissions
Status
Subcategory
Supported Payment Method Types
Get List of Inbound Transfers
Obtain a list of inbound transfers.
Amount
Cancelable
Created
Currency
Description
Failure Details
Financial Account
Hosted Regulatory Receipt URL
ID
Linked Flows
Livemode
Metadata
Object
Origin Payment Method
Origin Payment Method Details
Returned
Statement Descriptor
Status
Status Transitions
Transaction
Get List of Invoice Items
Obtain a list of invoice items.
Amount
Currency
Customer
Date
Description
Discountable
Discounts
ID
Invoice
Livemode
Metadata
Object
Period
Price
Proration
Quantity
Subscription
Subscription Item
Tax Rates
Test Clock
Unit Amount
Unit Amount Decimal
Get List of Invoices
Obtain a list of invoices.
Account Country
Account Name
Account Tax Ids
Amount Due
Amount Paid
Amount Remaining
Amount Shipping
Application
Application Fee Amount
Attempt Count
Attempted
Auto Advance
Automatic Tax
Billing Reason
Charge
Collection Method
Created
Currency
Custom Fields
Customer
Customer Address
Customer Email
Customer Name
Customer Phone
Customer Shipping
Customer Tax Exempt
Customer Tax Ids
Description
Discount
Discounts
Due Date
Ending Balance
Footer
From Invoice
Hosted Invoice URL
ID
Invoice Pdf
Last Finalization Error
Latest Revision
Lines
Livemode
Metadata
Next Payment Attempt
Number
Object
On Behalf Of
Paid
Paid Out Of Band
Payment Intent
Payment Settings
Period End
Period Start
Post Payment Credit Notes Amount
Pre Payment Credit Notes Amount
Quote
Receipt Number
Rendering Options
Shipping Cost
Shipping Details
Starting Balance
Statement Descriptor
Status
Status Transitions
Subscription
Subscription Proration Date
Subtotal
Subtotal Excluding Tax
Tax
Test Clock
Threshold Reason
Total
Total Discount Amounts
Total Excluding Tax
Total Tax Amounts
Transfer Data
Webhooks Delivered At
Get List of Issuing Cardholders
Obtain a list of issuing cardholders.
Billing
Company
Created
Email
ID
Individual
Livemode
Metadata
Name
Object
Phone Number
Requirements
Spending Controls
Status
Type
Get List of Issuing Cards
Obtain a list of issuing cards.
Brand
Cancellation Reason
Cardholder
Created
Currency
Cvc
Exp Month
Exp Year
Financial Account
ID
Last4
Livemode
Metadata
Number
Object
Replaced By
Replacement For
Replacement Reason
Shipping
Spending Controls
Status
Type
Wallets
Get List of Issuing Disputes
Obtain a list of issuing disputes.
Amount
Balance Transactions
Created
Currency
Evidence
ID
Livemode
Metadata
Object
Status
Transaction
Treasury
Get List of Issuing Transactions
Obtain a list of issuing transactions.
Amount
Amount Details
Authorization
Balance Transaction
Card
Cardholder
Created
Currency
Dispute
ID
Livemode
Merchant Amount
Merchant Currency
Merchant Data
Metadata
Object
Purchase Details
Treasury
Type
Wallet
Get List of Open Reviews
Obtain a list of open reviews.
Billing Zip
Charge
Closed Reason
Created
ID
Ip Address
Ip Address Location
Livemode
Object
Open
Opened Reason
Payment Intent
Reason
Session
Get List of Outbound Payments
Obtain a list of outbound payments.
Amount
Cancelable
Created
Currency
Customer
Description
Destination Payment Method
Destination Payment Method Details
End User Details
Expected Arrival Date
Financial Account
Hosted Regulatory Receipt URL
ID
Livemode
Metadata
Object
Returned Details
Statement Descriptor
Status
Status Transitions
Transaction
Get List of Outbound Transfers
Obtain a list of outbound transfers.
Amount
Cancelable
Created
Currency
Description
Destination Payment Method
Destination Payment Method Details
Expected Arrival Date
Financial Account
Hosted Regulatory Receipt URL
ID
Livemode
Metadata
Object
Returned Details
Statement Descriptor
Status
Status Transitions
Transaction
Get List of Payment Intents
Obtain a list of payment intents.
Amount
Amount Capturable
Amount Details
Amount Received
Application
Application Fee Amount
Automatic Payment Methods
Canceled At
Cancellation Reason
Capture Method
Client Secret
Confirmation Method
Created
Currency
Customer
Description
ID
Invoice
Last Payment Error
Latest Charge
Livemode
Metadata
Next Action
Object
On Behalf Of
Payment Method
Payment Method Options
Payment Method Types
Processing
Receipt Email
Review
Setup Future Usage
Shipping
Statement Descriptor
Statement Descriptor Suffix
Status
Transfer Data
Transfer Group
Get List of Payment Links
Obtain a list of payment links.
Active
After Completion
Allow Promotion Codes
Application Fee Amount
Application Fee Percent
Automatic Tax
Billing Address Collection
Consent Collection
Currency
Custom Fields
Custom Text
Customer Creation
ID
Invoice Creation
Line Items
Livemode
Metadata
Object
On Behalf Of
Payment Intent Data
Payment Method Collection
Payment Method Types
Phone Number Collection
Shipping Address Collection
Shipping Options
Submit Type
Subscription Data
Tax ID Collection
Transfer Data
URL
Get List of Payouts
Obtain a list of payouts.
Amount
Arrival Date
Automatic
Balance Transaction
Created
Currency
Description
Destination
Failure Balance Transaction
Failure Code
Failure Message
ID
Livemode
Metadata
Method
Object
Original Payout
Reconciliation Status
Reversed By
Source Type
Statement Descriptor
Status
Type
Get List of People Associated to Account’s Legal Entity
Obtain a list of people associated with the legal entity.
Account
Address
Address Kana
Address Kanji
Created
Dob
Email
First Name
First Name Kana
First Name Kanji
Full Name Aliases
Future Requirements
Gender
ID
ID Number Provided
ID Number Secondary Provided
Last Name
Last Name Kana
Last Name Kanji
Maiden Name
Metadata
Nationality
Object
Phone
Political Exposure
Registered Address
Relationship
Requirements
Ssn Last 4 Provided
Verification
Get List of Plans
Obtain a list of your plans.
Active
Aggregate Usage
Amount
Amount Decimal
Billing Scheme
Created
Currency
ID
Interval
Interval Count
Livemode
Metadata
Nickname
Object
Product
Tiers
Tiers Mode
Transform Usage
Trial Period Days
Usage Type
Get List of Prices
Obtain a list of prices.
Active
Billing Scheme
Created
Currency
Currency Options
Custom Unit Amount
ID
Livemode
Lookup Key
Metadata
Nickname
Object
Product
Recurring
Tax Behavior
Tiers
Tiers Mode
Transform Quantity
Type
Unit Amount
Unit Amount Decimal
Get List of Products
Obtain a list of products.
Active
Created
Description
ID
Images
Livemode
Metadata
Name
Object
Package Dimensions
Shippable
Statement Descriptor
Tax Code
Unit Label
Updated
URL
Get List of Promotion Codes
Obtain a list of promotion codes.
Active
Code
Coupon
Created
Customer
Expires At
ID
Livemode
Max Redemptions
Metadata
Object
Restrictions
Times Redeemed
Get List of Quotes
Obtain a list of quotes.
Amount Subtotal
Amount Total
Application
Application Fee Amount
Application Fee Percent
Automatic Tax
Collection Method
Computed
Created
Currency
Customer
Description
Discounts
Expires At
Footer
From Quote
Header
ID
Invoice
Invoice Settings
Line Items
Livemode
Metadata
Number
Object
On Behalf Of
Status
Status Transitions
Subscription
Subscription Data
Subscription Schedule
Test Clock
Total Details
Transfer Data
Get List of Readers
Obtain a list of readers.
Action
Device Sw Version
Device Type
ID
Ip Address
Label
Livemode
Location
Metadata
Object
Serial Number
Status
Get List of Received Credits
Obtain a list of received credits.
Amount
Created
Currency
Description
Failure Code
Financial Account
Hosted Regulatory Receipt URL
ID
Initiating Payment Method Details
Linked Flows
Livemode
Network
Object
Reversal Details
Status
Transaction
Get List of Received Debits
Obtain a list of received debits.
Amount
Created
Currency
Description
Failure Code
Financial Account
Hosted Regulatory Receipt URL
ID
Initiating Payment Method Details
Linked Flows
Livemode
Network
Object
Reversal Details
Status
Transaction
Get List of Refunds
Obtain a list of refunds.
Amount
Balance Transaction
Charge
Created
Currency
Description
Failure Balance Transaction
Failure Reason
ID
Instructions Email
Metadata
Next Action
Object
Payment Intent
Reason
Receipt Number
Source Transfer Reversal
Status
Transfer Reversal
Get List of Report Runs
Obtain a list of report runs.
Created
Error
ID
Livemode
Object
Parameters
Report Type
Result
Status
Succeeded At
Get List of Report Types
Obtain a list of report types.
Data Available End
Data Available Start
ID
Livemode
Name
Object
Updated
Version
Get List of Reversals
Obtain a list of reversals belonging to a specific transfer.
Amount
Balance Transaction
Created
Currency
Destination Payment Refund
ID
Metadata
Object
Source Refund
Transfer
Get List of Scheduled Query Runs
Obtain a list of scheduled query runs.
Created
Data Load Time
Error
File
ID
Livemode
Object
Result Available Until
Sql
Status
Title
Get List of Shipping Rates
Obtain a list of shipping rates.
Active
Created
Delivery Estimate
Display Name
Fixed Amount
ID
Livemode
Metadata
Object
Tax Behavior
Tax Code
Type
Get List of Subscription Items
Obtain a list of subscription items in a subscription.
Billing Thresholds
Created
ID
Metadata
Object
Price
Quantity
Subscription
Tax Rates
Get List of Subscription Schedules
Obtain a list of subscription schedules.
Application
Canceled At
Completed At
Created
Current Phase
Customer
End Behavior
ID
Livemode
Metadata
Object
Phases
Released At
Released Subscription
Status
Subscription
Test Clock
Get List of Subscriptions
Obtain a list of subscriptions.
Application
Application Fee Percent
Automatic Tax
Billing Cycle Anchor
Billing Thresholds
Cancel At
Cancel At Period End
Canceled At
Cancellation Details
Collection Method
Created
Currency
Current Period End
Current Period Start
Customer
Days Until Due
Description
Discount
Ended At
ID
Items
Latest Invoice
Livemode
Metadata
Next Pending Invoice Item Invoice
Object
On Behalf Of
Pause Collection
Payment Settings
Pending Invoice Item Interval
Pending Setup Intent
Pending Update
Schedule
Start Date
Status
Test Clock
Transfer Data
Trial End
Trial Settings
Trial Start
Get List of Tax Codes
Obtain a list of tax codes.
Description
ID
Name
Object
Get List of Tax Rates
Obtain a list of tax rates.
Active
Country
Created
Description
Display Name
ID
Inclusive
Jurisdiction
Livemode
Metadata
Object
Percentage
State
Tax Type
Get List of Terminal Configurations
Obtain a list of terminal configurations.
Bbpos Wisepos E
ID
Livemode
Object
Tipping
Verifone P400
Get List of Terminal Locations
Obtain a list of terminal locations.
Address
Configuration Overrides
Display Name
ID
Livemode
Metadata
Object
Get List of Transaction Entries
Obtain a list of transaction entries.
Balance Impact
Created
Currency
Effective At
Financial Account
Flow
Flow Details
Flow Type
ID
Livemode
Object
Transaction
Type
Get List of Transactions
Obtain a list of transactions.
Amount
Balance Impact
Created
Currency
Description
Entries
Financial Account
Flow
Flow Details
Flow Type
ID
Livemode
Object
Status
Status Transitions
Get List of Transfers
Obtain a list of transfers sent to connected accounts.
Amount
Amount Reversed
Balance Transaction
Created
Currency
Description
Destination
Destination Payment
ID
Livemode
Metadata
Object
Reversals
Reversed
Source Transaction
Source Type
Transfer Group
Get List of Value Lists
Obtain a list of value lists.
Alias
Created
Created By
ID
Item Type
List Items
Livemode
Metadata
Name
Object
Get List of Value Lists Items
Obtain a list of all value lists items.
Created
Created By
ID
Livemode
Object
Value
Value List
Get List of Verification Reports
Obtain a list of verification reports.
Created
Document
ID
ID Number
Livemode
Object
Options
Selfie
Type
Verification Session
Get List of Verification Sessions
Obtain a list of verification sessions.
Client Secret
Created
ID
Last Error
Last Verification Report
Livemode
Metadata
Object
Options
Redaction
Status
Type
URL
Verified Outputs
Hand-Off Setup Intent to Reader
Initiate a setup intent on a reader.
Failure Code
Failure Message
Process Payment Intent
Process Setup Intent
Refund Payment
Set Reader Display
Status
Type
List all subscription item period summaries
ID
Invoice
Livemode
Object
Period
Subscription Item
Total Usage
List All Top-Ups
List all top-ups.
Amount
Balance Transaction
Created
Currency
Description
Expected Availability Date
Failure Code
Failure Message
ID
Livemode
Metadata
Object
Source
Statement Descriptor
Status
Transfer Group
List of the customer’s active subscriptions
You can see a list of the customer’s active subscriptions. Note that the 10 most recent active subscriptions are always available by default on the customer object. If you need more than those 10, you can use the limit and starting_after parameters to page through additional subscriptions.
Application
Application Fee Percent
Automatic Tax
Billing Cycle Anchor
Billing Thresholds
Cancel At
Cancel At Period End
Canceled At
Cancellation Details
Collection Method
Created
Currency
Current Period End
Current Period Start
Customer
Days Until Due
Description
Discount
Ended At
ID
Items
Latest Invoice
Livemode
Metadata
Next Pending Invoice Item Invoice
Object
On Behalf Of
Pause Collection
Payment Settings
Pending Invoice Item Interval
Pending Setup Intent
Pending Update
Schedule
Start Date
Status
Test Clock
Transfer Data
Trial End
Trial Settings
Trial Start
list of the refunds
You can see a list of the refunds belonging to a specific charge. Note that the 10 most recent refunds are always available by default on the charge object. If you need more than those 10, you can use this API method and the limit and starting_after parameters to page through additional refunds.
Amount
Balance Transaction
Charge
Created
Currency
Description
Failure Balance Transaction
Failure Reason
ID
Instructions Email
Metadata
Next Action
Object
Payment Intent
Reason
Receipt Number
Source Transfer Reversal
Status
Transfer Reversal
List source transactions for a given source
List source transactions for a given source.
Ach Credit Transfer
Amount
Chf Credit Transfer
Created
Currency
Gbp Credit Transfer
ID
Livemode
Object
Paper Check
Sepa Credit Transfer
Source
Status
Type
List sources for a specified customer.
List sources for a specified customer.
Ach Credit Transfer
Ach Debit
Acss Debit
Alipay
Amount
Au Becs Debit
Bancontact
Card
Card Present
Client Secret
Code Verification
Created
Currency
Customer
Eps
Flow
Giropay
ID
Ideal
Klarna
Livemode
Metadata
Multibanco
Object
Owner
P24
Receiver
Redirect
Sepa Debit
Sofort
Source Order
Statement Descriptor
Status
Three D Secure
Type
Usage
Wechat
Lists all owners for a given Account
Lists all owners for a given Account
Email
ID
Name
Object
Ownership
Phone
Raw Address
Refreshed At
Lists all owners for a given Account
Lists all owners for a given Account
Email
ID
Name
Object
Ownership
Phone
Raw Address
Refreshed At
Mark Invoice Uncollectible
Mark an invoice as uncollectible.
Account Country
Account Name
Account Tax Ids
Amount Due
Amount Paid
Amount Remaining
Amount Shipping
Application
Application Fee Amount
Attempt Count
Attempted
Auto Advance
Automatic Tax
Billing Reason
Charge
Collection Method
Created
Currency
Custom Fields
Customer
Customer Address
Customer Email
Customer Name
Customer Phone
Customer Shipping
Customer Tax Exempt
Customer Tax Ids
Description
Discount
Discounts
Due Date
Ending Balance
Footer
From Invoice
Hosted Invoice URL
ID
Invoice Pdf
Last Finalization Error
Latest Revision
Lines
Livemode
Metadata
Next Payment Attempt
Number
Object
On Behalf Of
Paid
Paid Out Of Band
Payment Intent
Payment Settings
Period End
Period Start
Post Payment Credit Notes Amount
Pre Payment Credit Notes Amount
Quote
Receipt Number
Rendering Options
Shipping Cost
Shipping Details
Starting Balance
Statement Descriptor
Status
Status Transitions
Subscription
Subscription Proration Date
Subtotal
Subtotal Excluding Tax
Tax
Test Clock
Threshold Reason
Total
Total Discount Amounts
Total Excluding Tax
Total Tax Amounts
Transfer Data
Webhooks Delivered At
Pay Invoice
Pay an invoice out of the normal collection schedule or for some other reason.
Account Country
Account Name
Account Tax Ids
Amount Due
Amount Paid
Amount Remaining
Amount Shipping
Application
Application Fee Amount
Attempt Count
Attempted
Auto Advance
Automatic Tax
Billing Reason
Charge
Collection Method
Created
Currency
Custom Fields
Customer
Customer Address
Customer Email
Customer Name
Customer Phone
Customer Shipping
Customer Tax Exempt
Customer Tax Ids
Description
Discount
Discounts
Due Date
Ending Balance
Footer
From Invoice
Hosted Invoice URL
ID
Invoice Pdf
Last Finalization Error
Latest Revision
Lines
Livemode
Metadata
Next Payment Attempt
Number
Object
On Behalf Of
Paid
Paid Out Of Band
Payment Intent
Payment Settings
Period End
Period Start
Post Payment Credit Notes Amount
Pre Payment Credit Notes Amount
Quote
Receipt Number
Rendering Options
Shipping Cost
Shipping Details
Starting Balance
Statement Descriptor
Status
Status Transitions
Subscription
Subscription Proration Date
Subtotal
Subtotal Excluding Tax
Tax
Test Clock
Threshold Reason
Total
Total Discount Amounts
Total Excluding Tax
Total Tax Amounts
Transfer Data
Webhooks Delivered At
Perform an incremental authorization
Amount
Amount Capturable
Amount Details
Amount Received
Application
Application Fee Amount
Automatic Payment Methods
Canceled At
Cancellation Reason
Capture Method
Client Secret
Confirmation Method
Created
Currency
Customer
Description
ID
Invoice
Last Payment Error
Latest Charge
Livemode
Metadata
Next Action
Object
On Behalf Of
Payment Method
Payment Method Options
Payment Method Types
Processing
Receipt Email
Review
Setup Future Usage
Shipping
Statement Descriptor
Statement Descriptor Suffix
Status
Transfer Data
Transfer Group
Preview Credit Note
Obtain a preview of a credit note without creating it.
Amount
Amount Shipping
Created
Currency
Customer
Customer Balance Transaction
Discount Amount
Discount Amounts
ID
Invoice
Lines
Livemode
Memo
Metadata
Number
Object
Out Of Band Amount
Pdf
Reason
Refund
Shipping Cost
Status
Subtotal
Subtotal Excluding Tax
Tax Amounts
Total
Total Excluding Tax
Type
Voided At
Reconcile Customer Balance Payment Intent
Reconcile the remaining amount for a customer balance payment intent.
Amount
Amount Capturable
Amount Details
Amount Received
Application
Application Fee Amount
Automatic Payment Methods
Canceled At
Cancellation Reason
Capture Method
Client Secret
Confirmation Method
Created
Currency
Customer
Description
ID
Invoice
Last Payment Error
Latest Charge
Livemode
Metadata
Next Action
Object
On Behalf Of
Payment Method
Payment Method Options
Payment Method Types
Processing
Receipt Email
Review
Setup Future Usage
Shipping
Statement Descriptor
Statement Descriptor Suffix
Status
Transfer Data
Transfer Group
Redact Verification Session
Redact a verification session to remove all collected information from Stripe.
Client Secret
Created
ID
Last Error
Last Verification Report
Livemode
Metadata
Object
Options
Redaction
Status
Type
URL
Verified Outputs
Refresh Financial Connections Account
Refreshes the data of a financial connections account.
Account
Customer
Type
Refreshes the data associated with a Financial Connections Account
Refreshes the data associated with a Financial Connections Account.
Account
Customer
Type
Refund a Charge
Amount
Amount Captured
Amount Refunded
Application
Application Fee
Application Fee Amount
Balance Transaction
Billing Details
Calculated Statement Descriptor
Captured
Created
Currency
Customer
Description
Disputed
Failure Balance Transaction
Failure Code
Failure Message
Fraud Details
ID
Invoice
Livemode
Metadata
Object
On Behalf Of
Outcome
Paid
Payment Intent
Payment Method
Payment Method Details
Radar Options
Receipt Email
Receipt Number
Receipt URL
Refunded
Refunds
Review
Shipping
Source Transfer
Statement Descriptor
Statement Descriptor Suffix
Status
Transfer
Transfer Data
Transfer Group
Refund Charge or Payment Intent In-Person on Reader
Initiate a refund on a reader.
Failure Code
Failure Message
Process Payment Intent
Process Setup Intent
Refund Payment
Set Reader Display
Status
Type
Reject Account
Reject an account.
Mcc
Name
Product Description
Support Address
Support Email
Support Phone
Support URL
URL
Release Schedule
Release a subscription schedule immediately, which will stop scheduling of its phases, but leave any existing subscription in place.
ID
Name
Object
Remove a Card from a Customer
Delete a specified source for a given customer.
Account Number
Bank Name
Fingerprint
Refund Account Holder Name
Refund Account Holder Type
Refund Routing Number
Routing Number
Swift Code
Removes the currently applied discount on a customer.
Removes the currently applied discount on a customer.
Checkout Session
Coupon
Customer
Deleted
ID
Invoice
Invoice Item
Object
Promotion Code
Start
Subscription
Resume Subscription
Initiate resumption of a paused subscription.
Application
Application Fee Percent
Automatic Tax
Billing Cycle Anchor
Billing Thresholds
Cancel At
Cancel At Period End
Canceled At
Cancellation Details
Collection Method
Created
Currency
Current Period End
Current Period Start
Customer
Days Until Due
Description
Discount
Ended At
ID
Items
Latest Invoice
Livemode
Metadata
Next Pending Invoice Item Invoice
Object
On Behalf Of
Pause Collection
Payment Settings
Pending Invoice Item Interval
Pending Setup Intent
Pending Update
Schedule
Start Date
Status
Test Clock
Transfer Data
Trial End
Trial Settings
Trial Start
Retrieve a Bank Account for a Customer
By default, you can see the 10 most recent sources stored on a Customer directly on the object, but you can also retrieve details about a specific bank account stored on the Stripe account.
Account
Account Holder Name
Account Holder Type
Account Type
Available Payout Methods
Bank Name
Country
Currency
Customer
Fingerprint
Future Requirements
ID
Last4
Metadata
Object
Requirements
Routing Number
Status
Retrieve a Customer's Discount
Checkout Session
Coupon
Customer
End
ID
Invoice
Invoice Item
Object
Promotion Code
Start
Subscription
Retrieve a dispute for a specified charge.
Retrieve a dispute for a specified charge.
Amount
Balance Transactions
Charge
Created
Currency
Evidence
Evidence Details
ID
Is Charge Refundable
Livemode
Metadata
Object
Payment Intent
Reason
Status
Retrieve a List of Cards Associated with a Customer
You can always see the 10 most recent cards directly on a customer; this method lets you retrieve details about a specific card stored on the customer.
Account
Address City
Address Country
Address Line1
Address Line1 Check
Address Line2
Address State
Address Zip
Address Zip Check
Available Payout Methods
Brand
Country
Currency
Customer
Cvc Check
Dynamic Last4
Exp Month
Exp Year
Fingerprint
Funding
ID
Last4
Metadata
Name
Object
Status
Tokenization Method
Retrieve a List of Cards Associated with a Customer
You can see a list of the cards belonging to a customer.Note that the 10 most recent sources are always available on the Customer object.If you need more than those 10, you can use this API method and the limit and starting_after parameters to page through additional cards.
Account
Address City
Address Country
Address Line1
Address Line1 Check
Address Line2
Address State
Address Zip
Address Zip Check
Available Payout Methods
Brand
Country
Currency
Customer
Cvc Check
Dynamic Last4
Exp Month
Exp Year
Fingerprint
Funding
ID
Last4
Metadata
Name
Object
Status
Tokenization Method
Retrieve a list of people associated with a connected account
Returns a list of people associated with the account’s legal entity. The people are returned sorted by creation date, with the most recent people appearing first.
Account
Address
Address Kana
Address Kanji
Created
Dob
Email
First Name
First Name Kana
First Name Kanji
Full Name Aliases
Future Requirements
Gender
ID
ID Number Provided
ID Number Secondary Provided
Last Name
Last Name Kana
Last Name Kanji
Maiden Name
Metadata
Nationality
Object
Phone
Political Exposure
Registered Address
Relationship
Requirements
Ssn Last 4 Provided
Verification
Retrieve a source
Retrieves an existing source object. Supply the unique source ID from a source creation request and Stripe will return the corresponding up-to-date source object information.
Account Number
Bank Name
Fingerprint
Refund Account Holder Name
Refund Account Holder Type
Refund Routing Number
Routing Number
Swift Code
Retrieve a specified source for a given customer
Retrieve a specified source for a given customer.
Account Number
Bank Name
Fingerprint
Refund Account Holder Name
Refund Account Holder Type
Refund Routing Number
Routing Number
Swift Code
Retrieve Account
Grab all details about the account.
Mcc
Name
Product Description
Support Address
Support Email
Support Phone
Support URL
URL
Retrieve Account
Grab all details about your account.
Mcc
Name
Product Description
Support Address
Support Email
Support Phone
Support URL
URL
Retrieve an existing source transaction
Retrieve an existing source transaction object. Supply the unique source ID from a source creation request and the source transaction ID and Stripe will return the corresponding up-to-date source object information.
Customer Data
Fingerprint
Last4
Routing Number
Retrieve Apple Pay Domain
Grab all details about an apple pay domain.
Created
Domain Name
ID
Livemode
Object
Retrieve Application Fee
Grab all details about an application fee.
Account
Amount
Amount Refunded
Application
Balance Transaction
Charge
Created
Currency
ID
Livemode
Object
Originating Transaction
Refunded
Refunds
Retrieve Application Fee Refund
Grab all details about an application fee refund.
Amount
Balance Transaction
Created
Currency
Fee
ID
Metadata
Object
Retrieve Balance
Grab all details about the current account balance.
Amount
Currency
Source Types
Retrieve Balance Transaction
Grab all details about a balance transaction.
Amount
Available On
Created
Currency
Description
Exchange Rate
Fee
Fee Details
ID
Net
Object
Reporting Category
Source
Status
Type
Retrieve Bank Accounts for a Customer
You can see a list of the bank accounts belonging to a Customer. Note that the 10 most recent sources are always available by default on the Customer. If you need more than those 10, you can use this API method and the limit and starting_after parameters to page through additional bank accounts.
Account
Account Holder Name
Account Holder Type
Account Type
Available Payout Methods
Bank Name
Country
Currency
Customer
Fingerprint
Future Requirements
ID
Last4
Metadata
Object
Requirements
Routing Number
Status
Retrieve Cardholder
Grab all details about an issuing cardholder.
- Address
Retrieve Charge
Grab all details about a charge.
Amount
Amount Captured
Amount Refunded
Application
Application Fee
Application Fee Amount
Balance Transaction
Billing Details
Calculated Statement Descriptor
Captured
Created
Currency
Customer
Description
Disputed
Failure Balance Transaction
Failure Code
Failure Message
Fraud Details
ID
Invoice
Livemode
Metadata
Object
On Behalf Of
Outcome
Paid
Payment Intent
Payment Method
Payment Method Details
Radar Options
Receipt Email
Receipt Number
Receipt URL
Refunded
Refunds
Review
Shipping
Source Transfer
Statement Descriptor
Statement Descriptor Suffix
Status
Transfer
Transfer Data
Transfer Group
Retrieve Country Spec
Grab all details about a country spec.
ID
Object
Supported Bank Account Currencies
Supported Payment Currencies
Supported Payment Methods
Supported Transfer Countries
Verification Fields
Retrieve Coupon
Grab all details about a coupon.
Amount Off
Applies To
Created
Currency
Currency Options
Duration
Duration In Months
ID
Livemode
Max Redemptions
Metadata
Name
Object
Percent Off
Redeem By
Times Redeemed
Valid
Retrieve Credit Note
Grab all details about a credit note.
Amount
Amount Shipping
Created
Currency
Customer
Customer Balance Transaction
Discount Amount
Discount Amounts
ID
Invoice
Lines
Livemode
Memo
Metadata
Number
Object
Out Of Band Amount
Pdf
Reason
Refund
Shipping Cost
Status
Subtotal
Subtotal Excluding Tax
Tax Amounts
Total
Total Excluding Tax
Type
Voided At
Retrieve Credit Reversal
Grab all details about a credit reversal.
Amount
Created
Currency
Financial Account
Hosted Regulatory Receipt URL
ID
Livemode
Metadata
Network
Object
Received Credit
Status
Status Transitions
Transaction
Retrieve Customer
Grab all details about a customer.
City
Country
Line1
Line2
Postal Code
State
Retrieve Customer Balance Transaction
Grab all details about a customer balance transaction.
Amount
Created
Credit Note
Currency
Customer
Description
Ending Balance
ID
Invoice
Livemode
Metadata
Object
Type
Retrieve Customer's Cash Balance
Grab all details about a customer's cash balance.
Retrieve Customer's Cash Balance Transaction
Grab all details about a specific cash balance transaction, which updated the customer's cash balance.
- Payment Intent
Retrieve Customer's Payment Method
Grab all details about a customer's specific payment method.
Bank Name
Fingerprint
Institution Number
Last4
Transit Number
Retrieve Debit Reversal
Grab all details about a debit reversal.
Amount
Created
Currency
Financial Account
Hosted Regulatory Receipt URL
ID
Linked Flows
Livemode
Metadata
Network
Object
Received Debit
Status
Status Transitions
Transaction
Retrieve Dispute
Grab all details about a dispute.
Amount
Balance Transactions
Charge
Created
Currency
Evidence
Evidence Details
ID
Is Charge Refundable
Livemode
Metadata
Object
Payment Intent
Reason
Status
Retrieve Early Fraud Warning
Grab all details about an early fraud warning.
Actionable
Charge
Created
Fraud Type
ID
Livemode
Object
Payment Intent
Retrieve Event
Grab all details about an event.
Account
Api Version
Created
Data
ID
Livemode
Object
Pending Webhooks
Request
Type
Retrieve External Account for Specific Account
Grab all details of a specified external account for an account.
Account
Account Holder Name
Account Holder Type
Account Type
Available Payout Methods
Bank Name
Country
Currency
Customer
Fingerprint
Future Requirements
ID
Last4
Metadata
Object
Requirements
Routing Number
Status
Retrieve Financial Account
Grab all details about a financial account.
- 0
Retrieve Financial Account Features
Grab all details about a financial account's features.
Requested
Status
Status Details
Retrieve Financial Connections Account
Grab all details of a financial connections account.
Account
Customer
Type
Retrieve Financial Connections Session
Grab all details about a financial connections session.
Account
Customer
Type
Retrieve Funding Instruction for a Customer
Country
Financial Addresses
Type
Retrieve Inbound Transfer
Grab all details about an inbound transfer.
Amount
Cancelable
Created
Currency
Description
Failure Details
Financial Account
Hosted Regulatory Receipt URL
ID
Linked Flows
Livemode
Metadata
Object
Origin Payment Method
Origin Payment Method Details
Returned
Statement Descriptor
Status
Status Transitions
Transaction
Retrieve Invoice
Grab all details about an invoice.
Account Country
Account Name
Account Tax Ids
Amount Due
Amount Paid
Amount Remaining
Amount Shipping
Application
Application Fee Amount
Attempt Count
Attempted
Auto Advance
Automatic Tax
Billing Reason
Charge
Collection Method
Created
Currency
Custom Fields
Customer
Customer Address
Customer Email
Customer Name
Customer Phone
Customer Shipping
Customer Tax Exempt
Customer Tax Ids
Description
Discount
Discounts
Due Date
Ending Balance
Footer
From Invoice
Hosted Invoice URL
ID
Invoice Pdf
Last Finalization Error
Latest Revision
Lines
Livemode
Metadata
Next Payment Attempt
Number
Object
On Behalf Of
Paid
Paid Out Of Band
Payment Intent
Payment Settings
Period End
Period Start
Post Payment Credit Notes Amount
Pre Payment Credit Notes Amount
Quote
Receipt Number
Rendering Options
Shipping Cost
Shipping Details
Starting Balance
Statement Descriptor
Status
Status Transitions
Subscription
Subscription Proration Date
Subtotal
Subtotal Excluding Tax
Tax
Test Clock
Threshold Reason
Total
Total Discount Amounts
Total Excluding Tax
Total Tax Amounts
Transfer Data
Webhooks Delivered At
Retrieve Invoice Item
Grab all details about an invoice item.
Amount
Currency
Customer
Date
Description
Discountable
Discounts
ID
Invoice
Livemode
Metadata
Object
Period
Price
Proration
Quantity
Subscription
Subscription Item
Tax Rates
Test Clock
Unit Amount
Unit Amount Decimal
Retrieve Invoice's Line Items
Grab all details about an invoice's line items.
Amount
Amount Excluding Tax
Currency
Description
Discount Amounts
Discountable
Discounts
ID
Invoice Item
Livemode
Metadata
Object
Period
Price
Proration
Proration Details
Quantity
Subscription
Subscription Item
Tax Amounts
Tax Rates
Type
Unit Amount Excluding Tax
Retrieve Issuing Authorization
Grab all details about issuing an authorization.
Amount
Amount Details
Approved
Authorization Method
Balance Transactions
Card
Cardholder
Created
Currency
ID
Livemode
Merchant Amount
Merchant Currency
Merchant Data
Metadata
Network Data
Object
Pending Request
Request History
Status
Transactions
Treasury
Verification Data
Wallet
Retrieve Issuing Card
Grab all details about an issuing card.
Brand
Cancellation Reason
Cardholder
Created
Currency
Cvc
Exp Month
Exp Year
Financial Account
ID
Last4
Livemode
Metadata
Number
Object
Replaced By
Replacement For
Replacement Reason
Shipping
Spending Controls
Status
Type
Wallets
Retrieve Issuing Dispute
Grab all details about an issuing dispute.
Amount
Balance Transactions
Created
Currency
Evidence
ID
Livemode
Metadata
Object
Status
Transaction
Treasury
Retrieve Issuing Transaction
Grab all details about an issuing transaction.
Amount
Amount Details
Authorization
Balance Transaction
Card
Cardholder
Created
Currency
Dispute
ID
Livemode
Merchant Amount
Merchant Currency
Merchant Data
Metadata
Object
Purchase Details
Treasury
Type
Wallet
Retrieve Mandate
Grab all details about a mandate.
Accepted At
Offline
Online
Type
Retrieve Outbound Payment
Grab all details about an outbound payment.
Amount
Cancelable
Created
Currency
Customer
Description
Destination Payment Method
Destination Payment Method Details
End User Details
Expected Arrival Date
Financial Account
Hosted Regulatory Receipt URL
ID
Livemode
Metadata
Object
Returned Details
Statement Descriptor
Status
Status Transitions
Transaction
Retrieve Outbound Transfer
Grab all details about an outbound transfer.
Amount
Cancelable
Created
Currency
Description
Destination Payment Method
Destination Payment Method Details
Expected Arrival Date
Financial Account
Hosted Regulatory Receipt URL
ID
Livemode
Metadata
Object
Returned Details
Statement Descriptor
Status
Status Transitions
Transaction
Retrieve Payment Intent
Grab all details about a payment intent.
Amount
Amount Capturable
Amount Details
Amount Received
Application
Application Fee Amount
Automatic Payment Methods
Canceled At
Cancellation Reason
Capture Method
Client Secret
Confirmation Method
Created
Currency
Customer
Description
ID
Invoice
Last Payment Error
Latest Charge
Livemode
Metadata
Next Action
Object
On Behalf Of
Payment Method
Payment Method Options
Payment Method Types
Processing
Receipt Email
Review
Setup Future Usage
Shipping
Statement Descriptor
Statement Descriptor Suffix
Status
Transfer Data
Transfer Group
Retrieve Payment Link
Grab all details about a payment link.
Active
After Completion
Allow Promotion Codes
Application Fee Amount
Application Fee Percent
Automatic Tax
Billing Address Collection
Consent Collection
Currency
Custom Fields
Custom Text
Customer Creation
ID
Invoice Creation
Line Items
Livemode
Metadata
Object
On Behalf Of
Payment Intent Data
Payment Method Collection
Payment Method Types
Phone Number Collection
Shipping Address Collection
Shipping Options
Submit Type
Subscription Data
Tax ID Collection
Transfer Data
URL
Retrieve Payment Link's Line Items
Grab all details about a payment link's line items.
Amount Discount
Amount Subtotal
Amount Tax
Amount Total
Currency
Description
Discounts
ID
Object
Price
Quantity
Taxes
Retrieve Payout
Grab all details about a payout.
Amount
Arrival Date
Automatic
Balance Transaction
Created
Currency
Description
Destination
Failure Balance Transaction
Failure Code
Failure Message
ID
Livemode
Metadata
Method
Object
Original Payout
Reconciliation Status
Reversed By
Source Type
Statement Descriptor
Status
Type
Retrieve Person
Grab all details about a person.
Account
Address
Address Kana
Address Kanji
Created
Dob
Email
First Name
First Name Kana
First Name Kanji
Full Name Aliases
Future Requirements
Gender
ID
ID Number Provided
ID Number Secondary Provided
Last Name
Last Name Kana
Last Name Kanji
Maiden Name
Metadata
Nationality
Object
Phone
Political Exposure
Registered Address
Relationship
Requirements
Ssn Last 4 Provided
Verification
Retrieve Plan
Grab all details about a plan.
Active
Aggregate Usage
Amount
Amount Decimal
Billing Scheme
Created
Currency
ID
Interval
Interval Count
Livemode
Metadata
Nickname
Object
Product
Tiers
Tiers Mode
Transform Usage
Trial Period Days
Usage Type
Retrieve Price
Grab all details about a price.
Active
Billing Scheme
Created
Currency
Currency Options
Custom Unit Amount
ID
Livemode
Lookup Key
Metadata
Nickname
Object
Product
Recurring
Tax Behavior
Tiers
Tiers Mode
Transform Quantity
Type
Unit Amount
Unit Amount Decimal
Retrieve Product
Grab all details about a product.
Active
Created
Description
ID
Images
Livemode
Metadata
Name
Object
Package Dimensions
Shippable
Statement Descriptor
Tax Code
Unit Label
Updated
URL
Retrieve Promotion Code
Grab all details about a promotion code.
Active
Code
Coupon
Created
Customer
Expires At
ID
Livemode
Max Redemptions
Metadata
Object
Restrictions
Times Redeemed
Retrieve Quote
Grab all details about a quote.
Amount Subtotal
Amount Total
Application
Application Fee Amount
Application Fee Percent
Automatic Tax
Collection Method
Computed
Created
Currency
Customer
Description
Discounts
Expires At
Footer
From Quote
Header
ID
Invoice
Invoice Settings
Line Items
Livemode
Metadata
Number
Object
On Behalf Of
Status
Status Transitions
Subscription
Subscription Data
Subscription Schedule
Test Clock
Total Details
Transfer Data
Retrieve Quote's Line Items
Grab all details about a quote's line items.
Amount Discount
Amount Subtotal
Amount Tax
Amount Total
Currency
Description
Discounts
ID
Object
Price
Quantity
Taxes
Retrieve Quote's Upfront Line Items
Grab all details about a quote's upfront line items
Amount Discount
Amount Subtotal
Amount Tax
Amount Total
Currency
Description
Discounts
ID
Object
Price
Quantity
Taxes
Retrieve Reader
Grab all details about a reader.
Failure Code
Failure Message
Process Payment Intent
Process Setup Intent
Refund Payment
Set Reader Display
Status
Type
Retrieve Received Credit
Grab all details about an existing received credit.
Amount
Created
Currency
Description
Failure Code
Financial Account
Hosted Regulatory Receipt URL
ID
Initiating Payment Method Details
Linked Flows
Livemode
Network
Object
Reversal Details
Status
Transaction
Retrieve Received Debit
Grab all details about an existing received debit.
Amount
Created
Currency
Description
Failure Code
Financial Account
Hosted Regulatory Receipt URL
ID
Initiating Payment Method Details
Linked Flows
Livemode
Network
Object
Reversal Details
Status
Transaction
Retrieve Refund
Grab all details about a refund.
Amount
Balance Transaction
Charge
Created
Currency
Description
Failure Balance Transaction
Failure Reason
ID
Instructions Email
Metadata
Next Action
Object
Payment Intent
Reason
Receipt Number
Source Transfer Reversal
Status
Transfer Reversal
Retrieve Report Run
Grab all details about a run report.
Created
Error
ID
Livemode
Object
Parameters
Report Type
Result
Status
Succeeded At
Retrieve Report Type
Grab all details about a report type.
Data Available End
Data Available Start
ID
Livemode
Name
Object
Updated
Version
Retrieve Reversal
Grab all details about a reversal.
Amount
Balance Transaction
Created
Currency
Destination Payment Refund
ID
Metadata
Object
Source Refund
Transfer
Retrieve Review
Grab all details about a review.
Billing Zip
Charge
Closed Reason
Created
ID
Ip Address
Ip Address Location
Livemode
Object
Open
Opened Reason
Payment Intent
Reason
Session
Retrieve Schedule
Grab all details about an existing subscription schedule.
ID
Name
Object
Retrieve Scheduled Query Run
Grab all details about a scheduled query run.
Created
Data Load Time
Error
File
ID
Livemode
Object
Result Available Until
Sql
Status
Title
Retrieve Shipping Rate
Grab all details about a shipping rate.
Active
Created
Delivery Estimate
Display Name
Fixed Amount
ID
Livemode
Metadata
Object
Tax Behavior
Tax Code
Type
Retrieve Specified External Account for Specific Account
Grab all details of a specified external account for an account.
Account
Account Holder Name
Account Holder Type
Account Type
Available Payout Methods
Bank Name
Country
Currency
Customer
Fingerprint
Future Requirements
ID
Last4
Metadata
Object
Requirements
Routing Number
Status
Retrieve Subscription
Grab all details about a subscription.
Application
Application Fee Percent
Automatic Tax
Billing Cycle Anchor
Billing Thresholds
Cancel At
Cancel At Period End
Canceled At
Cancellation Details
Collection Method
Created
Currency
Current Period End
Current Period Start
Customer
Days Until Due
Description
Discount
Ended At
ID
Items
Latest Invoice
Livemode
Metadata
Next Pending Invoice Item Invoice
Object
On Behalf Of
Pause Collection
Payment Settings
Pending Invoice Item Interval
Pending Setup Intent
Pending Update
Schedule
Start Date
Status
Test Clock
Transfer Data
Trial End
Trial Settings
Trial Start
Retrieve Subscription Item
Grab all details about a subscription's subscription item.
- Usage Gte
Retrieve Tax Calculation's Line Items
Grab all details about the line items of a persisted tax calculation.
Amount
Amount Tax
ID
Livemode
Object
Product
Quantity
Reference
Tax Behavior
Tax Breakdown
Tax Code
Retrieve Tax Code
Grab all details about a tax code.
Description
ID
Name
Object
Retrieve Tax ID
Grab all details about a tax id.
Country
Created
Customer
ID
Livemode
Object
Type
Value
Verification
Retrieve Tax Rate
Grab all details about a tax rate.
Active
Country
Created
Description
Display Name
ID
Inclusive
Jurisdiction
Livemode
Metadata
Object
Percentage
State
Tax Type
Retrieve Tax Transaction
Grab all details about a tax transaction.
Created
Currency
Customer
Customer Details
ID
Line Items
Livemode
Metadata
Object
Reference
Reversal
Shipping Cost
Tax Date
Type
Retrieve Terminal Configuration
Grab all details about a terminal configuration.
- Splashscreen
Retrieve Terminal Location
Grab all details about a terminal location.
City
Country
Line1
Line2
Postal Code
State
Retrieve Top-Up
Grab all details about a top-up that has previously been created.
Amount
Balance Transaction
Created
Currency
Description
Expected Availability Date
Failure Code
Failure Message
ID
Livemode
Metadata
Object
Source
Statement Descriptor
Status
Transfer Group
Retrieve Transaction
Grab all details about an existing transaction.
Amount
Balance Impact
Created
Currency
Description
Entries
Financial Account
Flow
Flow Details
Flow Type
ID
Livemode
Object
Status
Status Transitions
Retrieve Transaction Entry
Grab all details about a transaction entry.
Cash
Inbound Pending
Outbound Pending
Retrieve Transaction's Line Items
Grab all details about the line items of a committed standalone transaction as a collection.
Amount
Amount Tax
ID
Livemode
Metadata
Object
Quantity
Reference
Reversal
Tax Behavior
Tax Code
Type
Retrieve Transfer
Grab all details about a transfer.
Amount
Amount Reversed
Balance Transaction
Created
Currency
Description
Destination
Destination Payment
ID
Livemode
Metadata
Object
Reversals
Reversed
Source Transaction
Source Type
Transfer Group
Retrieve Upcoming Invoice
Grab all details about an upcoming invoice.
Account Country
Account Name
Account Tax Ids
Amount Due
Amount Paid
Amount Remaining
Amount Shipping
Application
Application Fee Amount
Attempt Count
Attempted
Auto Advance
Automatic Tax
Billing Reason
Charge
Collection Method
Created
Currency
Custom Fields
Customer
Customer Address
Customer Email
Customer Name
Customer Phone
Customer Shipping
Customer Tax Exempt
Customer Tax Ids
Description
Discount
Discounts
Due Date
Ending Balance
Footer
From Invoice
Hosted Invoice URL
ID
Invoice Pdf
Last Finalization Error
Latest Revision
Lines
Livemode
Metadata
Next Payment Attempt
Number
Object
On Behalf Of
Paid
Paid Out Of Band
Payment Intent
Payment Settings
Period End
Period Start
Post Payment Credit Notes Amount
Pre Payment Credit Notes Amount
Quote
Receipt Number
Rendering Options
Shipping Cost
Shipping Details
Starting Balance
Statement Descriptor
Status
Status Transitions
Subscription
Subscription Proration Date
Subtotal
Subtotal Excluding Tax
Tax
Test Clock
Threshold Reason
Total
Total Discount Amounts
Total Excluding Tax
Total Tax Amounts
Transfer Data
Webhooks Delivered At
Retrieve Upcoming Invoice's Line Items
Grab all details about an upcoming invoice's line items.
Amount
Amount Excluding Tax
Currency
Description
Discount Amounts
Discountable
Discounts
ID
Invoice Item
Livemode
Metadata
Object
Period
Price
Proration
Proration Details
Quantity
Subscription
Subscription Item
Tax Amounts
Tax Rates
Type
Unit Amount Excluding Tax
Retrieve Value List
Grab all details about a value list.
Alias
Created
Created By
ID
Item Type
List Items
Livemode
Metadata
Name
Object
Retrieve Value List Item
Grab all details about a value list Items.
Created
Created By
ID
Livemode
Object
Value
Value List
Retrieve Verification Report
Grab all details about a verification report.
Created
Document
ID
ID Number
Livemode
Object
Options
Selfie
Type
Verification Session
Retrieve Verification Session
Grab all details about a verification session.
Client Secret
Created
ID
Last Error
Last Verification Report
Livemode
Metadata
Object
Options
Redaction
Status
Type
URL
Verified Outputs
Retrieves a configuration
Retrieves a configuration that describes the functionality of the customer portal.
Active
Application
Business Profile
Created
Features
ID
Livemode
Login Page
Metadata
Object
Updated
Retrieves a new Source MandateNotification
Retrieves a new Source MandateNotification.
- Statement Descriptor
Retrieves a subscription
Retrieves the subscription with the given ID.
Application
Application Fee Percent
Automatic Tax
Billing Cycle Anchor
Billing Thresholds
Cancel At
Cancel At Period End
Canceled At
Cancellation Details
Collection Method
Created
Currency
Current Period End
Current Period Start
Customer
Days Until Due
Description
Discount
Ended At
ID
Items
Latest Invoice
Livemode
Metadata
Next Pending Invoice Item Invoice
Object
On Behalf Of
Pause Collection
Payment Settings
Pending Invoice Item Interval
Pending Setup Intent
Pending Update
Schedule
Start Date
Status
Test Clock
Transfer Data
Trial End
Trial Settings
Trial Start
Retrieves Account Capability
Grab all details about an account capability.
Account
Future Requirements
ID
Object
Requested
Requested At
Requirements
Status
Retrieves an existing person.
Retrieves an existing person.
Account
Address
Address Kana
Address Kanji
Created
Dob
Email
First Name
First Name Kana
First Name Kanji
Full Name Aliases
Future Requirements
Gender
ID
ID Number Provided
ID Number Secondary Provided
Last Name
Last Name Kana
Last Name Kanji
Maiden Name
Metadata
Nationality
Object
Phone
Political Exposure
Registered Address
Relationship
Requirements
Ssn Last 4 Provided
Verification
Retrieves an Issuing Settlement
Retrieves an Issuing Settlement object.
Bin
Clearing Date
Created
Currency
ID
Interchange Fees
Livemode
Metadata
Net Total
Network
Network Fees
Network Settlement Identifier
Object
Settlement Service
Transaction Count
Transaction Volume
Retrieves Payment Method
Grab all details about a payment method.
Bank Name
Fingerprint
Institution Number
Last4
Transit Number
Retrieves the balance transaction
Retrieves the balance transaction with the given ID.Note that this endpoint previously used the path /v1/balance/history/:id.
Amount
Available On
Created
Currency
Description
Exchange Rate
Fee
Fee Details
ID
Net
Object
Reporting Category
Source
Status
Type
Retrieves the details of a Financial Connections Session
Retrieves the details of a Financial Connections Session
Account
Customer
Type
Retrieves the details of an Financial Connections Account.
Retrieves the details of an Financial Connections Account.
Account
Customer
Type
Retrieves the exchange rates
Retrieves the exchange rates from the given currency to every supported currency.
ID
Object
Rates
Returns a list of configurations
Returns a list of configurations that describe the functionality of the customer portal.
Active
Application
Business Profile
Created
Features
ID
Livemode
Login Page
Metadata
Object
Updated
Returns a list of Financial Connections Account
Returns a list of Financial Connections Account objects.
Account Holder
Balance
Balance Refresh
Category
Created
Display Name
ID
Institution Name
Last4
Livemode
Object
Ownership
Ownership Refresh
Permissions
Status
Subcategory
Supported Payment Method Types
Returns a list of Issuing Settlement
Returns a list of Issuing Settlement objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.
Bin
Clearing Date
Created
Currency
ID
Interchange Fees
Livemode
Metadata
Net Total
Network
Network Fees
Network Settlement Identifier
Object
Settlement Service
Transaction Count
Transaction Volume
Returns a list of PaymentMethods for Treasury flows
Returns a list of PaymentMethods for Treasury flows. If you want to list the PaymentMethods attached to a Customer for payments, you should use the List a Customer’s PaymentMethods API instead.
Acss Debit
Affirm
Afterpay Clearpay
Alipay
Au Becs Debit
Bacs Debit
Bancontact
Billing Details
Blik
Boleto
Card
Card Present
Cashapp
Created
Customer
Customer Balance
Eps
Fpx
Giropay
Grabpay
ID
Ideal
Interac Present
Klarna
Konbini
Link
Livemode
Metadata
Object
Oxxo
P24
Paynow
Pix
Promptpay
Radar Options
Sepa Debit
Sofort
Type
Us Bank Account
Wechat Pay
Returns a list of transactions
Amount
Available On
Created
Currency
Description
Exchange Rate
Fee
Fee Details
ID
Net
Object
Reporting Category
Source
Status
Type
Reverse Payout
Reverse a payout by debiting the destination bank account.
Amount
Arrival Date
Automatic
Balance Transaction
Created
Currency
Description
Destination
Failure Balance Transaction
Failure Code
Failure Message
ID
Livemode
Metadata
Method
Object
Original Payout
Reconciliation Status
Reversed By
Source Type
Statement Descriptor
Status
Type
Search customers
Address
Balance
Cash Balance
Created
Currency
Delinquent
Description
Email
ID
Invoice Credit Balance
Invoice Prefix
Invoice Settings
Livemode
Metadata
Name
Next Invoice Sequence
Object
Phone
Preferred Locales
Shipping
Sources
Subscriptions
Tax
Tax Exempt
Tax Ids
Test Clock
Search for PaymentIntents
Amount
Amount Capturable
Amount Details
Amount Received
Application
Application Fee Amount
Automatic Payment Methods
Canceled At
Cancellation Reason
Capture Method
Client Secret
Confirmation Method
Created
Currency
Customer
Description
ID
Invoice
Last Payment Error
Latest Charge
Livemode
Metadata
Next Action
Object
On Behalf Of
Payment Method
Payment Method Options
Payment Method Types
Processing
Receipt Email
Review
Setup Future Usage
Shipping
Statement Descriptor
Statement Descriptor Suffix
Status
Transfer Data
Transfer Group
Search invoices
Account Country
Account Name
Account Tax Ids
Amount Due
Amount Paid
Amount Remaining
Amount Shipping
Application
Application Fee Amount
Attempt Count
Attempted
Auto Advance
Automatic Tax
Billing Reason
Charge
Collection Method
Created
Currency
Custom Fields
Customer
Customer Address
Customer Email
Customer Name
Customer Phone
Customer Shipping
Customer Tax Exempt
Customer Tax Ids
Description
Discount
Discounts
Due Date
Ending Balance
Footer
From Invoice
Hosted Invoice URL
ID
Invoice Pdf
Last Finalization Error
Latest Revision
Lines
Livemode
Metadata
Next Payment Attempt
Number
Object
On Behalf Of
Paid
Paid Out Of Band
Payment Intent
Payment Settings
Period End
Period Start
Post Payment Credit Notes Amount
Pre Payment Credit Notes Amount
Quote
Receipt Number
Rendering Options
Shipping Cost
Shipping Details
Starting Balance
Statement Descriptor
Status
Status Transitions
Subscription
Subscription Proration Date
Subtotal
Subtotal Excluding Tax
Tax
Test Clock
Threshold Reason
Total
Total Discount Amounts
Total Excluding Tax
Total Tax Amounts
Transfer Data
Webhooks Delivered At
Search prices
Active
Billing Scheme
Created
Currency
Currency Options
Custom Unit Amount
ID
Livemode
Lookup Key
Metadata
Nickname
Object
Product
Recurring
Tax Behavior
Tiers
Tiers Mode
Transform Quantity
Type
Unit Amount
Unit Amount Decimal
Search products
Active
Created
Description
ID
Images
Livemode
Metadata
Name
Object
Package Dimensions
Shippable
Statement Descriptor
Tax Code
Unit Label
Updated
URL
Search subscriptions
Application
Application Fee Percent
Automatic Tax
Billing Cycle Anchor
Billing Thresholds
Cancel At
Cancel At Period End
Canceled At
Cancellation Details
Collection Method
Created
Currency
Current Period End
Current Period Start
Customer
Days Until Due
Description
Discount
Ended At
ID
Items
Latest Invoice
Livemode
Metadata
Next Pending Invoice Item Invoice
Object
On Behalf Of
Pause Collection
Payment Settings
Pending Invoice Item Interval
Pending Setup Intent
Pending Update
Schedule
Start Date
Status
Test Clock
Transfer Data
Trial End
Trial Settings
Trial Start
Send Invoice Manual Payment
Send an invoice for a manual payment.
Account Country
Account Name
Account Tax Ids
Amount Due
Amount Paid
Amount Remaining
Amount Shipping
Application
Application Fee Amount
Attempt Count
Attempted
Auto Advance
Automatic Tax
Billing Reason
Charge
Collection Method
Created
Currency
Custom Fields
Customer
Customer Address
Customer Email
Customer Name
Customer Phone
Customer Shipping
Customer Tax Exempt
Customer Tax Ids
Description
Discount
Discounts
Due Date
Ending Balance
Footer
From Invoice
Hosted Invoice URL
ID
Invoice Pdf
Last Finalization Error
Latest Revision
Lines
Livemode
Metadata
Next Payment Attempt
Number
Object
On Behalf Of
Paid
Paid Out Of Band
Payment Intent
Payment Settings
Period End
Period Start
Post Payment Credit Notes Amount
Pre Payment Credit Notes Amount
Quote
Receipt Number
Rendering Options
Shipping Cost
Shipping Details
Starting Balance
Statement Descriptor
Status
Status Transitions
Subscription
Subscription Proration Date
Subtotal
Subtotal Excluding Tax
Tax
Test Clock
Threshold Reason
Total
Total Discount Amounts
Total Excluding Tax
Total Tax Amounts
Transfer Data
Webhooks Delivered At
Set Reader Display
Set reader display to show cart details.
Failure Code
Failure Message
Process Payment Intent
Process Setup Intent
Refund Payment
Set Reader Display
Status
Type
Simulate Reader by Presenting a Payment Method
Present a payment method on a simulated reader.
Failure Code
Failure Message
Process Payment Intent
Process Setup Intent
Refund Payment
Set Reader Display
Status
Type
Submit Issuing Dispute
Submit an issuing dispute to the card network.
Amount
Balance Transactions
Created
Currency
Evidence
ID
Livemode
Metadata
Object
Status
Transaction
Treasury
Update a Bank Account for a Customer
Account Holder Name
Account Holder Type
Address City
Address Country
Address Line1
Address Line2
Address State
Address Zip
Exp Month
Exp Year
Expand
Metadata
Name
Owner
Update a source
Amount
Expand
Mandate
Metadata
Owner
Source Order
Update a specified refund.
Update a specified refund.
Expand
Metadata
Update a specified source for a given customer
Update a specified source for a given customer.
Account Holder Name
Account Holder Type
Address City
Address Country
Address Line1
Address Line2
Address State
Address Zip
Exp Month
Exp Year
Expand
Metadata
Name
Owner
Update a specified source for a given customer.
Update a specified source for a given customer.
Account Holder Name
Account Holder Type
Address City
Address Country
Address Line1
Address Line2
Address State
Address Zip
Exp Month
Exp Year
Expand
Metadata
Name
Owner
Update Account
Modify an account.
Account Token
Business Profile
Business Type
Capabilities
Company
Documents
Email
Expand
External Account
Individual
Metadata
Settings
Tos Acceptance
Update Account Capability
Modify an existing account capability
Expand
Requested
Update Application Fee Refund
Modify an application fee refund.
Expand
Metadata
Update Authorization
Modify a specified issuing authorization.
Expand
Metadata
Update Cardholder
Modify the specified issuing cardholder.
Billing
Company
Email
Expand
Individual
Metadata
Phone Number
Spending Controls
Status
Update Charge
Modify a charge's details.
Customer
Description
Expand
Fraud Details
Metadata
Receipt Email
Shipping
Transfer Group
Update Coupon
Modify a coupon.
Currency Options
Expand
Metadata
Name
Update Credit Note
Modify a credit note.
Expand
Memo
Metadata
Update Customer
Modify a customer's details.
Address
Balance
Bank Account
Card
Cash Balance
Coupon
Description
Email
Expand
Invoice Prefix
Invoice Settings
Metadata
Name
Next Invoice Sequence
Phone
Preferred Locales
Promotion Code
Shipping
Source
Tax
Tax Exempt
Update Customer Credit Balance Transaction
Modify a customer's credit balance.
Description
Expand
Metadata
Update Customer's Cash Balance Settings
Modify cash balance settings for a customer.
Expand
Settings
Update External Account for Specific Account
Update metadata for a specified account's external accounts.
Account Holder Name
Account Holder Type
Account Type
Address City
Address Country
Address Line1
Address Line2
Address State
Address Zip
Documents
Exp Month
Exp Year
Expand
Metadata
Name
Update Financial Account
Modify an existing financial account's details.
Expand
Features
Metadata
Platform Restrictions
Update Financial Account Features
Modify features of an existing financial account.
Card Issuing
Deposit Insurance
Expand
Financial Addresses
Inbound Transfers
Intra Stripe Flows
Outbound Payments
Outbound Transfers
Update Invoice
Modify an invoice.
Account Tax Ids
Application Fee Amount
Auto Advance
Automatic Tax
Collection Method
Custom Fields
Days Until Due
Description
Discounts
Due Date
Expand
Footer
Metadata
On Behalf Of
Payment Settings
Rendering Options
Shipping Cost
Shipping Details
Statement Descriptor
Transfer Data
Update Invoice Item
Modify an invoice item.
Amount
Description
Discountable
Discounts
Expand
Metadata
Period
Price
Price Data
Quantity
Tax Behavior
Tax Code
Tax Rates
Unit Amount
Unit Amount Decimal
Update Issuing Card
Modify the specified issuing card.
Cancellation Reason
Expand
Metadata
Pin
Spending Controls
Status
Update Issuing Dispute
Modify an issuing dispute.
Amount
Evidence
Expand
Metadata
Update Issuing Transaction
Modify an issuing transaction.
Expand
Metadata
Update Payment Intent
Modify a payment intent without confirming.
Amount
Application Fee Amount
Capture Method
Currency
Customer
Description
Expand
Metadata
Payment Method
Payment Method Data
Payment Method Options
Payment Method Types
Receipt Email
Setup Future Usage
Shipping
Statement Descriptor
Statement Descriptor Suffix
Transfer Data
Transfer Group
Update Payment Method
Modify a payment method.
Billing Details
Card
Expand
Link
Metadata
Us Bank Account
Update Payout
Modify a payout's details.
Expand
Metadata
Update Person
Modify an existing person's details.
Address
Address Kana
Address Kanji
Dob
Documents
Email
Expand
First Name
First Name Kana
First Name Kanji
Full Name Aliases
Gender
ID Number
ID Number Secondary
Last Name
Last Name Kana
Last Name Kanji
Maiden Name
Metadata
Nationality
Person Token
Phone
Political Exposure
Registered Address
Relationship
Ssn Last 4
Verification
Update Plan
Modify a plan.
Active
Expand
Metadata
Nickname
Product
Trial Period Days
Update Price
Modify a price.
Active
Currency Options
Expand
Lookup Key
Metadata
Nickname
Tax Behavior
Transfer Lookup Key
Update Product
Modify a product.
Active
Description
Expand
Images
Metadata
Name
Package Dimensions
Shippable
Statement Descriptor
Tax Code
Unit Label
URL
Update Promotion Code
Modify a promotion code's details.
Active
Expand
Metadata
Restrictions
Update Quote
Modify a quote's details.
Application Fee Amount
Application Fee Percent
Automatic Tax
Collection Method
Customer
Description
Discounts
Expand
Expires At
Footer
Header
Invoice Settings
Line Items
Metadata
On Behalf Of
Subscription Data
Transfer Data
Update Reader
Modify a reader's details.
Expand
Label
Metadata
Update Refund
Modify a refund.
Expand
Metadata
Update Reversal
Modify an existing reversal's details.
Expand
Metadata
Update Schedule
Modify an existing subscription schedule.
End Behavior
Expand
Metadata
Phases
Proration Behavior
Update Shipping Rate
Modify a shipping rate's details.
Active
Expand
Fixed Amount
Metadata
Tax Behavior
Update Specified External Account for Specific Account
Updates the metadata, account holder name, account holder type of a bank account belonging to a custom account, and optionally sets it as the default for its currency.
Account Holder Name
Account Holder Type
Account Type
Address City
Address Country
Address Line1
Address Line2
Address State
Address Zip
Documents
Exp Month
Exp Year
Expand
Metadata
Name
Update Subscription
Modify a subscription.
Add Invoice Items
Application Fee Percent
Automatic Tax
Billing Cycle Anchor
Billing Thresholds
Cancel At
Cancel At Period End
Cancellation Details
Collection Method
Coupon
Days Until Due
Description
Expand
Items
Metadata
Off Session
On Behalf Of
Pause Collection
Payment Behavior
Payment Settings
Pending Invoice Item Interval
Promotion Code
Proration Behavior
Proration Date
Transfer Data
Trial End
Trial From Plan
Trial Settings
Update Subscription Item
Modify a subscription plan or quantity of an item on a current subscription.
Billing Thresholds
Expand
Metadata
Off Session
Payment Behavior
Price
Price Data
Proration Behavior
Proration Date
Quantity
Tax Rates
Update Tax Rate
Modify a tax rate.
Active
Country
Description
Display Name
Expand
Jurisdiction
Metadata
State
Tax Type
Update Terminal Configuration
Modify a terminal configuration.
Bbpos Wisepos E
Expand
Tipping
Verifone P400
Update Terminal Location
Modify a terminal's location.
Address
Configuration Overrides
Display Name
Expand
Metadata
Update Top-Up
Modify the metadata of an existing top-up
Description
Expand
Metadata
Update Transfer
Modify an existing transfer's details.
Description
Expand
Metadata
Update Value List
Modify a value list's details.
Alias
Expand
Metadata
Name
Update Verification Session
Modify a verification session.
Expand
Metadata
Options
Type
Updates a configuration
Updates a configuration that describes the functionality of the customer portal.
Active
Application
Business Profile
Created
Features
ID
Livemode
Login Page
Metadata
Object
Updated
Updates an existing person.
Updates an existing person.
Account
Address
Address Kana
Address Kanji
Created
Dob
Email
First Name
First Name Kana
First Name Kanji
Full Name Aliases
Future Requirements
Gender
ID
ID Number Provided
ID Number Secondary Provided
Last Name
Last Name Kana
Last Name Kanji
Maiden Name
Metadata
Nationality
Object
Phone
Political Exposure
Registered Address
Relationship
Requirements
Ssn Last 4 Provided
Verification
Updates an existing subscription
Application
Application Fee Percent
Automatic Tax
Billing Cycle Anchor
Billing Thresholds
Cancel At
Cancel At Period End
Canceled At
Cancellation Details
Collection Method
Created
Currency
Current Period End
Current Period Start
Customer
Days Until Due
Description
Discount
Ended At
ID
Items
Latest Invoice
Livemode
Metadata
Next Pending Invoice Item Invoice
Object
On Behalf Of
Pause Collection
Payment Settings
Pending Invoice Item Interval
Pending Setup Intent
Pending Update
Schedule
Start Date
Status
Test Clock
Transfer Data
Trial End
Trial Settings
Trial Start
Updates Payment Link
Modify a payment link.
Active
After Completion
Allow Promotion Codes
Application Fee Amount
Application Fee Percent
Automatic Tax
Billing Address Collection
Consent Collection
Currency
Custom Fields
Custom Text
Customer Creation
ID
Invoice Creation
Line Items
Livemode
Metadata
Object
On Behalf Of
Payment Intent Data
Payment Method Collection
Payment Method Types
Phone Number Collection
Shipping Address Collection
Shipping Options
Submit Type
Subscription Data
Tax ID Collection
Transfer Data
URL
Updates the specified Issuing Settlement
Updates the specified Issuing Settlement object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
Bin
Clearing Date
Created
Currency
ID
Interchange Fees
Livemode
Metadata
Net Total
Network
Network Fees
Network Settlement Identifier
Object
Settlement Service
Transaction Count
Transaction Volume
Verify a Bank Account for a Customer
Verify a specified bank account for a given customer.
Account
Account Holder Name
Account Holder Type
Account Type
Available Payout Methods
Bank Name
Country
Currency
Customer
Fingerprint
Future Requirements
ID
Last4
Metadata
Object
Requirements
Routing Number
Status
Verify a given source
Verify a given source.
Account Number
Bank Name
Fingerprint
Refund Account Holder Name
Refund Account Holder Type
Refund Routing Number
Routing Number
Swift Code
Verify Bank Account
Verify a bank account. A customer's bank account must first be verified before it can be charged.
Account
Account Holder Name
Account Holder Type
Account Type
Available Payout Methods
Bank Name
Country
Currency
Customer
Fingerprint
Future Requirements
ID
Last4
Metadata
Object
Requirements
Routing Number
Status
Verify Microdeposits on Payment Intent
Verify microdeposits for a payment intent.
Amount
Amount Capturable
Amount Details
Amount Received
Application
Application Fee Amount
Automatic Payment Methods
Canceled At
Cancellation Reason
Capture Method
Client Secret
Confirmation Method
Created
Currency
Customer
Description
ID
Invoice
Last Payment Error
Latest Charge
Livemode
Metadata
Next Action
Object
On Behalf Of
Payment Method
Payment Method Options
Payment Method Types
Processing
Receipt Email
Review
Setup Future Usage
Shipping
Statement Descriptor
Statement Descriptor Suffix
Status
Transfer Data
Transfer Group
Void Credit Note
Mark a credit note as void.
Amount
Amount Shipping
Created
Currency
Customer
Customer Balance Transaction
Discount Amount
Discount Amounts
ID
Invoice
Lines
Livemode
Memo
Metadata
Number
Object
Out Of Band Amount
Pdf
Reason
Refund
Shipping Cost
Status
Subtotal
Subtotal Excluding Tax
Tax Amounts
Total
Total Excluding Tax
Type
Voided At
Void Invoice
Void an invoice.
Account Country
Account Name
Account Tax Ids
Amount Due
Amount Paid
Amount Remaining
Amount Shipping
Application
Application Fee Amount
Attempt Count
Attempted
Auto Advance
Automatic Tax
Billing Reason
Charge
Collection Method
Created
Currency
Custom Fields
Customer
Customer Address
Customer Email
Customer Name
Customer Phone
Customer Shipping
Customer Tax Exempt
Customer Tax Ids
Description
Discount
Discounts
Due Date
Ending Balance
Footer
From Invoice
Hosted Invoice URL
ID
Invoice Pdf
Last Finalization Error
Latest Revision
Lines
Livemode
Metadata
Next Payment Attempt
Number
Object
On Behalf Of
Paid
Paid Out Of Band
Payment Intent
Payment Settings
Period End
Period Start
Post Payment Credit Notes Amount
Pre Payment Credit Notes Amount
Quote
Receipt Number
Rendering Options
Shipping Cost
Shipping Details
Starting Balance
Statement Descriptor
Status
Status Transitions
Subscription
Subscription Proration Date
Subtotal
Subtotal Excluding Tax
Tax
Test Clock
Threshold Reason
Total
Total Discount Amounts
Total Excluding Tax
Total Tax Amounts
Transfer Data
Webhooks Delivered At
Not just software—partnership
Expert support included
MESA includes hands-on support from automation experts who know how to get things done.
Free workflow setup
We'll build your first workflow with you live. Most merchants walk away with automation saving 5+ hours/week.
Fast response times
Average first response: Same day. Critical issues: Immediate escalation. Complex builds: 24-48 hours.
Managed services available
Personalized workflow reviews, and quarterly check-ins to identify new opportunities as your business grows.
Real humans, always
Chat with real automation experts (not bots). Email support 9am-5pm PST. Google Meet sessions for complex workflows.
Integrate Stripe with Xero today.
Enjoy a 7-day free trial. Get your first workflow in minutes.
MESA AI assistant
+×
Describe your task...
You've known what your store should be doing. Now it can. Describe the task then MESA handles it from there.