When you configure an export, import, or other type of flow step using the prebuilt Stripe connector, you can select any of the API operations listed below*, organized by API type.
Note
If your API endpoint isn’t listed here, switch the flow step to HTTP mode and configure the endpoint provided in the Stripe API documentation. *You can also create a composite endpoint for this application in HTTP mode.
| Resource | API endpoint | Export | Import |
|---|---|---|---|
| Accounts | List all accounts | X | |
| Retrieve an account | X | ||
| Create an account | X | ||
| Reject an account | X | ||
| Create a login link | X | ||
| Update an account | X | ||
| Delete an account | X | ||
| Account Links | Create an account link | X | |
| Application Fee Refunds | Create an application fee refund | X | |
| Update an application fee refund | X | ||
| List all application fee refunds | X | ||
| Retrieve an application fee refund | X | ||
| Application Fee | List all application fees | X | |
| Retrieve an application fee | X | ||
| Balance | List all balance history | X | |
| Retrieve balance | X | ||
| Retrieve a balance transaction | X | ||
| Bank Accounts | List all bank accounts | X | |
| Retrieve a bank account | X | ||
| Create a bank account | X | ||
| Update a bank account | X | ||
| Verify a bank account | X | ||
| Delete a bank account | X | ||
| Capabilities | List all capabilities | X | |
| Retrieve an account capability | X | ||
| Update an account capability | X | ||
| Cards | List all cards | X | |
| Retrieve a card | X | ||
| Create a card | X | ||
| Update a card | X | ||
| Delete a card Based on CUSTOMER_ID | X | ||
| Charges | List all charges | X | |
| Retrieve a charge | X | ||
| Create a charge | X | ||
| Update a charge | X | ||
| Capture a charge | X | ||
| Checkout Sessions | List all checkout sessions | X | |
| Retrieve a checkout session | X | ||
| Retrieve a checkout session's line items | X | ||
| Create a checkout session | X | ||
| Expire a checkout session | X | ||
| Country specs | List country specs | X | |
| Retrieve a country spec | X | ||
| Coupons | List all coupon | X | |
| Retrieve a coupon | X | ||
| Create a coupon | X | ||
| Update a coupon | X | ||
| Delete a coupon | X | ||
| Credit Notes | List all credit note | X | |
| Retrieve a credit note | X | ||
| Retrieve a credit note's line items | X | ||
| Create a credit note | X | ||
| Update a credit note | X | ||
| Customer Balance Transactions | List all customer balance transactions | X | |
| Retrieve a bank account | X | ||
| Create a customer balance transaction | X | ||
| Update a customer balance transaction | X | ||
| Customer Portal | Create a session | X | |
| Customer Tax Ids | List all tax IDs | X | |
| Retrieve a tax ID | X | ||
| Create a tax ID | X | ||
| Delete a tax ID | X | ||
| Customers | List all customers | X | |
| Retrieve a customer | X | ||
| Create a customer | X | ||
| Update a customer | X | ||
| Delete a customer | X | ||
| Discounts | Delete a customer discount | X | |
| Delete a subscription discount | X | ||
| Disputes | List all disputes | X | |
| Retrieve a dispute | X | ||
| Update a dispute | X | ||
| Close a dispute | X | ||
| Early Fraud Warnings | List all early fraud warnings | X | |
| Retrieve an early fraud warnings | X | ||
| Events | List all events | X | |
| Retrieve an event | X | ||
| External Accounts | List all bank accounts | X | |
| List all cards | X | ||
| Retrieve a bank account | X | ||
| Retrieve a card | X | ||
| Create a bank account | X | ||
| Update a bank account | X | ||
| Delete a bank account | X | ||
| Create a card | X | ||
| Update a card | X | ||
| Delete a card | X | ||
| File Links | List all file links | X | |
| Retrieve a file link | X | ||
| Create a file link | X | ||
| Update a file link | X | ||
| File | List all files | X | |
| Retrieve a file | X | ||
| Financial Connections Sessions | Retrieve a session | X | |
| Create a session | X | ||
| Invoice items | List all invoice items | X | |
| Retrieve an invoice item | X | ||
| Create an invoice item | X | ||
| Update an invoice item | X | ||
| Detach an invoice item | X | ||
| Invoices | List all invoices | X | |
| Retrieve an invoice | X | ||
| Retrieve an upcoming invoice | X | ||
| Retrieve an invoice's line items | X | ||
| Create an invoice | X | ||
| Update an invoice | X | ||
| Pay an invoice | X | ||
| Mandates | Retrieve a mandate | X | |
| Order returns | List all order returns | X | |
| Retrieve an order return | X | ||
| Orders | List all orders | X | |
| Retrieve an order | X | ||
| Create an order | X | ||
| Pay an order | X | ||
| Update an order | X | ||
| Return an order | X | ||
| Payment Intents | List all payment intents | X | |
| Retrieve a payment intents | X | ||
| Create a payment intent | X | ||
| Update a payment intent | X | ||
| Confirm payment intent | X | ||
| Capture a payment intent | X | ||
| Cancel a payment intent | X | ||
| Payment Methods | List a customer's payment methods | X | |
| Retrieve a payment method | X | ||
| Create a payment method | X | ||
| Update a payment method | X | ||
| Attach a payment method to a customer | X | ||
| Detach a payment method from a customer | X | ||
| Payouts | List all payouts | X | |
| Retrieve a payout | X | ||
| Create a payout | X | ||
| Update a payout | X | ||
| Cancel a payout | X | ||
| Persons | List all persons | X | |
| Retrieve a person | X | ||
| Create a person | X | ||
| Update a person | X | ||
| Delete a person | X | ||
| Plans | List all plans | X | |
| Retrieve a plan | X | ||
| Create a plan | X | ||
| Update a plan | X | ||
| Detach a plan | X | ||
| Prices | List all prices | X | |
| Retrieve a price | X | ||
| Create a price | X | ||
| Update a price | X | ||
| Products | List all products | X | |
| Retrieve a product | X | ||
| Create a product | X | ||
| Update a product | X | ||
| Delete a product | X | ||
| Promotion Codes | List all promotion codes | X | |
| Retrieve a promotion code | X | ||
| Create a promotion code | X | ||
| Update a promotion code | X | ||
| Refunds | List all refunds | X | |
| Retrieve a refund | X | ||
| Update a refund | X | ||
| Reviews | List all open reviews | X | |
| Retrieve a review | X | ||
| Approve a review | X | ||
| Setup Intents | List all setupintents | X | |
| Retrieve a setup intent | X | ||
| Create a setup intent | X | ||
| Update a setup intent | X | ||
| Cancel a setup intent | X | ||
| Confirm setup intent | X | ||
| SKUs | List all SKUs | X | |
| Retrieve a SKUs | X | ||
| Create an SKU | X | ||
| Update an SKU | X | ||
| Delete an SKU | X | ||
| Sources | Retrieve a source | X | |
| Create a source | X | ||
| Update a source | X | ||
| Attach a source | X | ||
| Detach a source | X | ||
| Subscription Items | List all subscription items | X | |
| Retrieve a subscription item | X | ||
| Create a subscription item | X | ||
| Update a subscription item | X | ||
| Detach a subscription item | X | ||
| Subscription Schedules | List all schedules | X | |
| Retrieve a schedule | X | ||
| Create a schedule | X | ||
| Update a schedule | X | ||
| Cancel a schedule | X | ||
| Release a schedule | X | ||
| Subscription | List subscriptions | X | |
| Retrieve a subscription | X | ||
| Create a subscription | X | ||
| Update a subscription | X | ||
| Detach a subscription | X | ||
| Tax Rates | List all tax rates | X | |
| Retrieve a tax rate | X | ||
| Create a tax rate | X | ||
| Update a tax rate | X | ||
| Tokens | Retrieve a token | X | |
| Create a token | X | ||
| Top-Ups | List all top-ups | X | |
| Retrieve a top-up | X | ||
| Create a top-up | x | ||
| Update a top-up | X | ||
| Cancel a top-up | X | ||
| Transfer Reversals | List all reversals | X | |
| Retrieve a reversal | X | ||
| Create a transfer reversal | X | ||
| Update a transfer reversal | X | ||
| Transfers | List all transfers | X | |
| Retrieve a transfer | X | ||
| Create a transfer | X | ||
| Update a transfer | X | ||
| Usage Records | List all subscription item period summaries | X | |
| Create a usage record | X | ||
| Value List Items | List all value list items | X | |
| Retrieve a value list item | X | ||
| Create a value list item | X | ||
| Delete a value list item | X | ||
| Value Lists | List all value lists | X | |
| Retrieve a value list | X | ||
| Create a value list | X | ||
| Update a value list | X | ||
| Delete a value list | X |
Available DI objects
The following objects are available when using Stripe as a source in Celigo Data Integration (DI).
Primary key: Stripe assigns a unique id (prefixed by object type, e.g. ch_ for charges, cus_ for customers, in_ for invoices) to every API object.
Note
Stripe hard deletes records. Deleted records are not retrievable via the API. Celigo syncs all data returned by the source as-is.
| Object | API endpoint | Available extract modes | Delta field |
|---|---|---|---|
| Accounts | List all Accounts | Full, Incremental | created[gte] |
| Application Fees | List all application fees | Full, Incremental | created[gte] |
| Charges | List all charges | Full, Incremental | created[gte] |
| Checkout Sessions | List all Checkout Sessions | Full, Incremental | created[gte] |
| Coupons | List all coupons | Full, Incremental | created[gte] |
| Credit Notes | List all Credit Notes | Full, Incremental | created[gte] |
| Customers | List all customers | Full, Incremental | created[gte] |
| Disputes | List all disputes | Full, Incremental | created[gte] |
| Early Fraud Warnings | List all Early Fraud Warnings | Full, Incremental | created[gte] |
| Events | List all events | Full, Incremental | created[gte] |
| Invoice items | List all invoice items | Full, Incremental | created[gte] |
| Invoices | List all invoices | Full, Incremental | created[gte] |
| Payment Intents | List all Payment Intents | Full, Incremental | created[gte] |
| Payouts | List all payouts | Full, Incremental | created[gte] |
| Plans | List all plans | Full, Incremental | created[gte] |
| Prices | List all Prices | Full, Incremental | created[gte] |
| Products | List all products | Full, Incremental | created[gte] |
| Refunds | List all refunds | Full, Incremental | created[gte] |
| Reviews | List all Open Reviews | Full, Incremental | created[gte] |
| Setup Intents | List all Setup Intents | Full, Incremental | created[gte] |
| Subscription schedules | List all Schedules | Full, Incremental | created[gte] |
| Subscriptions | List all subscriptions | Full, Incremental | created[gte] |
| Top-Ups | List all Top-Ups | Full, Incremental | created[gte] |
| Transfers | List all transfers | Full, Incremental | created[gte] |
Response schemas
Click an object below to view its response fields and delta configuration.
Accounts — List all Accounts
Delta configuration: use it to request incremental data.
| Setting | Value |
|---|---|
| Delta filter | created[gte] = {{{lastExportDateTime}}} |
| Date format | X |
Response schema:
| Field | Type |
|---|---|
business_profile |
string |
business_type |
string |
capabilities |
object |
capabilities.acss_debit_payments |
string |
capabilities.affirm_payments |
string |
capabilities.afterpay_clearpay_payments |
string |
capabilities.alma_payments |
string |
capabilities.amazon_pay_payments |
string |
capabilities.app_distribution |
string |
capabilities.au_becs_debit_payments |
string |
capabilities.bacs_debit_payments |
string |
capabilities.bancontact_payments |
string |
capabilities.bank_transfer_payments |
string |
capabilities.billie_payments |
string |
capabilities.bizum_payments |
string |
capabilities.blik_payments |
string |
capabilities.boleto_payments |
string |
capabilities.card_issuing |
string |
capabilities.card_payments |
string |
capabilities.cartes_bancaires_payments |
string |
capabilities.cashapp_payments |
string |
capabilities.crypto_payments |
string |
capabilities.eps_payments |
string |
capabilities.fpx_payments |
string |
capabilities.gb_bank_transfer_payments |
string |
capabilities.giropay_payments |
string |
capabilities.grabpay_payments |
string |
capabilities.ideal_payments |
string |
capabilities.india_international_payments |
string |
capabilities.jcb_payments |
string |
capabilities.jp_bank_transfer_payments |
string |
capabilities.kakao_pay_payments |
string |
capabilities.klarna_payments |
string |
capabilities.konbini_payments |
string |
capabilities.kr_card_payments |
string |
capabilities.legacy_payments |
string |
capabilities.link_payments |
string |
capabilities.mb_way_payments |
string |
capabilities.mobilepay_payments |
string |
capabilities.multibanco_payments |
string |
capabilities.mx_bank_transfer_payments |
string |
capabilities.naver_pay_payments |
string |
capabilities.nz_bank_account_becs_debit_payments |
string |
capabilities.oxxo_payments |
string |
capabilities.p24_payments |
string |
capabilities.pay_by_bank_payments |
string |
capabilities.payco_payments |
string |
capabilities.paynow_payments |
string |
capabilities.payto_payments |
string |
capabilities.pix_payments |
string |
capabilities.promptpay_payments |
string |
capabilities.revolut_pay_payments |
string |
capabilities.samsung_pay_payments |
string |
capabilities.satispay_payments |
string |
capabilities.scalapay_payments |
string |
capabilities.sepa_bank_transfer_payments |
string |
capabilities.sepa_debit_payments |
string |
capabilities.sofort_payments |
string |
capabilities.sunbit_payments |
string |
capabilities.swish_payments |
string |
capabilities.tax_reporting_us_1099_k |
string |
capabilities.tax_reporting_us_1099_misc |
string |
capabilities.transfers |
string |
capabilities.treasury |
string |
capabilities.twint_payments |
string |
capabilities.upi_payments |
string |
capabilities.us_bank_account_ach_payments |
string |
capabilities.us_bank_transfer_payments |
string |
capabilities.zip_payments |
string |
charges_enabled |
boolean |
company |
object |
company.address |
object |
company.address.city |
string |
company.address.country |
string |
company.address.line1 |
string |
company.address.line2 |
string |
company.address.postal_code |
string |
company.address.state |
string |
company.address_kana |
string |
company.address_kanji |
string |
company.directors_provided |
boolean |
company.directorship_declaration |
string |
company.executives_provided |
boolean |
company.export_license_id |
string |
company.export_purpose_code |
string |
company.name |
string |
company.name_kana |
string |
company.name_kanji |
string |
company.owners_provided |
boolean |
company.ownership_declaration |
string |
company.ownership_exemption_reason |
string |
company.phone |
string |
company.registration_date |
object |
company.registration_date.day |
number |
company.registration_date.month |
number |
company.registration_date.year |
number |
company.representative_declaration |
string |
company.structure |
string |
company.tax_id_provided |
boolean |
company.tax_id_registrar |
string |
company.vat_id_provided |
boolean |
company.verification |
string |
controller |
object |
controller.fees |
object |
controller.fees.payer |
string |
controller.is_controller |
boolean |
controller.losses |
object |
controller.losses.payments |
string |
controller.requirement_collection |
string |
controller.stripe_dashboard |
object |
controller.stripe_dashboard.type |
string |
controller.type |
string |
country |
string |
created |
string |
default_currency |
string |
details_submitted |
boolean |
email |
string |
external_accounts |
object |
external_accounts.data |
stringarray |
external_accounts.has_more |
boolean |
external_accounts.object |
string |
external_accounts.url |
string |
future_requirements |
object |
future_requirements.alternatives |
objectarray |
future_requirements.alternatives.alternative_fields_due |
stringarray |
future_requirements.alternatives.original_fields_due |
stringarray |
future_requirements.current_deadline |
number |
future_requirements.currently_due |
stringarray |
future_requirements.disabled_reason |
string |
future_requirements.errors |
objectarray |
future_requirements.errors.code |
string |
future_requirements.errors.reason |
string |
future_requirements.errors.requirement |
string |
future_requirements.eventually_due |
stringarray |
future_requirements.past_due |
stringarray |
future_requirements.pending_verification |
stringarray |
groups |
string |
id |
string (Primary key) |
individual |
object |
individual.account |
string |
individual.additional_tos_acceptances |
object |
individual.additional_tos_acceptances.account |
string |
individual.address |
object |
individual.address.city |
string |
individual.address.country |
string |
individual.address.line1 |
string |
individual.address.line2 |
string |
individual.address.postal_code |
string |
individual.address.state |
string |
individual.address_kana |
string |
individual.address_kanji |
string |
individual.created |
string |
individual.dob |
object |
individual.dob.day |
number |
individual.dob.month |
number |
individual.dob.year |
number |
individual.email |
string |
individual.first_name |
string |
individual.first_name_kana |
string |
individual.first_name_kanji |
string |
individual.full_name_aliases |
stringarray |
individual.future_requirements |
string |
individual.gender |
string |
individual.id |
string |
individual.id_number_provided |
boolean |
individual.id_number_secondary_provided |
boolean |
individual.last_name |
string |
individual.last_name_kana |
string |
individual.last_name_kanji |
string |
individual.maiden_name |
string |
individual.metadata |
object |
individual.nationality |
string |
individual.object |
string |
individual.phone |
string |
individual.political_exposure |
string |
individual.registered_address |
object |
individual.registered_address.city |
string |
individual.registered_address.country |
string |
individual.registered_address.line1 |
string |
individual.registered_address.line2 |
string |
individual.registered_address.postal_code |
string |
individual.registered_address.state |
string |
individual.relationship |
object |
individual.relationship.authorizer |
boolean |
individual.relationship.director |
boolean |
individual.relationship.executive |
boolean |
individual.relationship.legal_guardian |
boolean |
individual.relationship.owner |
boolean |
individual.relationship.percent_ownership |
number |
individual.relationship.representative |
boolean |
individual.relationship.title |
string |
individual.requirements |
string |
individual.ssn_last_4_provided |
boolean |
individual.us_cfpb_data |
string |
individual.verification |
object |
individual.verification.additional_document |
string |
individual.verification.details |
string |
individual.verification.details_code |
string |
individual.verification.document |
object |
individual.verification.document.back |
string |
individual.verification.document.details |
string |
individual.verification.document.details_code |
string |
individual.verification.document.front |
string |
individual.verification.status |
string |
metadata |
object |
object |
string |
payouts_enabled |
boolean |
requirements |
object |
requirements.alternatives |
objectarray |
requirements.alternatives.alternative_fields_due |
stringarray |
requirements.alternatives.original_fields_due |
stringarray |
requirements.current_deadline |
number |
requirements.currently_due |
stringarray |
requirements.disabled_reason |
string |
requirements.errors |
objectarray |
requirements.errors.code |
string |
requirements.errors.reason |
string |
requirements.errors.requirement |
string |
requirements.eventually_due |
stringarray |
requirements.past_due |
stringarray |
requirements.pending_verification |
stringarray |
settings |
string |
tos_acceptance |
object |
tos_acceptance.date |
string |
tos_acceptance.ip |
string |
tos_acceptance.service_agreement |
string |
tos_acceptance.user_agent |
string |
type |
string |
Application Fees — List all application fees
Delta configuration: use it to request incremental data.
| Setting | Value |
|---|---|
| Delta filter | created[gte] = {{{lastExportDateTime}}} |
| Date format | X |
Response schema:
| Field | Type |
|---|---|
account |
string |
amount |
number |
amount_refunded |
number |
application |
string |
balance_transaction |
string |
charge |
string |
created |
string |
currency |
string |
fee_source |
string |
id |
string (Primary key) |
livemode |
boolean |
object |
string |
originating_transaction |
string |
refunded |
boolean |
refunds |
object |
refunds.data |
objectarray |
refunds.data.amount |
number |
refunds.data.balance_transaction |
string |
refunds.data.created |
string |
refunds.data.currency |
string |
refunds.data.fee |
string |
refunds.data.id |
string |
refunds.data.metadata |
object |
refunds.data.object |
string |
refunds.has_more |
boolean |
refunds.object |
string |
refunds.url |
string |
Charges — List all charges
Delta configuration: use it to request incremental data.
| Setting | Value |
|---|---|
| Delta filter | created[gte] = {{{lastExportDateTime}}} |
| Date format | X |
Response schema:
| Field | Type |
|---|---|
amount |
number |
amount_captured |
number |
amount_refunded |
number |
application |
string |
application_fee |
string |
application_fee_amount |
number |
balance_transaction |
string |
billing_details |
object |
billing_details.address |
string |
billing_details.email |
string |
billing_details.name |
string |
billing_details.phone |
string |
billing_details.tax_id |
string |
calculated_statement_descriptor |
string |
captured |
boolean |
created |
string |
currency |
string |
customer |
string |
description |
string |
disputed |
boolean |
failure_balance_transaction |
string |
failure_code |
string |
failure_message |
string |
fraud_details |
string |
id |
string (Primary key) |
livemode |
boolean |
metadata |
object |
object |
string |
on_behalf_of |
string |
outcome |
string |
paid |
boolean |
payment_intent |
string |
payment_method |
string |
payment_method_details |
string |
presentment_details |
object |
presentment_details.presentment_amount |
number |
presentment_details.presentment_currency |
string |
radar_options |
object |
radar_options.session |
string |
receipt_email |
string |
receipt_number |
string |
receipt_url |
string |
refunded |
boolean |
refunds |
object |
refunds.data |
objectarray |
refunds.data.amount |
number |
refunds.data.balance_transaction |
string |
refunds.data.charge |
string |
refunds.data.created |
string |
refunds.data.currency |
string |
refunds.data.description |
string |
refunds.data.destination_details |
object |
refunds.data.destination_details.affirm |
object |
refunds.data.destination_details.afterpay_clearpay |
object |
refunds.data.destination_details.alipay |
object |
refunds.data.destination_details.alma |
object |
refunds.data.destination_details.amazon_pay |
object |
refunds.data.destination_details.au_bank_transfer |
object |
refunds.data.destination_details.blik |
object |
refunds.data.destination_details.blik.network_decline_code |
string |
refunds.data.destination_details.blik.reference |
string |
refunds.data.destination_details.blik.reference_status |
string |
refunds.data.destination_details.br_bank_transfer |
object |
refunds.data.destination_details.br_bank_transfer.reference |
string |
refunds.data.destination_details.br_bank_transfer.reference_status |
string |
refunds.data.destination_details.card |
object |
refunds.data.destination_details.card.reference |
string |
refunds.data.destination_details.card.reference_status |
string |
refunds.data.destination_details.card.reference_type |
string |
refunds.data.destination_details.card.type |
string |
refunds.data.destination_details.cashapp |
object |
refunds.data.destination_details.crypto |
object |
refunds.data.destination_details.crypto.reference |
string |
refunds.data.destination_details.customer_cash_balance |
object |
refunds.data.destination_details.eps |
object |
refunds.data.destination_details.eu_bank_transfer |
object |
refunds.data.destination_details.eu_bank_transfer.reference |
string |
refunds.data.destination_details.eu_bank_transfer.reference_status |
string |
refunds.data.destination_details.gb_bank_transfer |
object |
refunds.data.destination_details.gb_bank_transfer.reference |
string |
refunds.data.destination_details.gb_bank_transfer.reference_status |
string |
refunds.data.destination_details.giropay |
object |
refunds.data.destination_details.grabpay |
object |
refunds.data.destination_details.jp_bank_transfer |
object |
refunds.data.destination_details.jp_bank_transfer.reference |
string |
refunds.data.destination_details.jp_bank_transfer.reference_status |
string |
refunds.data.destination_details.klarna |
object |
refunds.data.destination_details.mb_way |
object |
refunds.data.destination_details.mb_way.reference |
string |
refunds.data.destination_details.mb_way.reference_status |
string |
refunds.data.destination_details.multibanco |
object |
refunds.data.destination_details.multibanco.reference |
string |
refunds.data.destination_details.multibanco.reference_status |
string |
refunds.data.destination_details.mx_bank_transfer |
object |
refunds.data.destination_details.mx_bank_transfer.reference |
string |
refunds.data.destination_details.mx_bank_transfer.reference_status |
string |
refunds.data.destination_details.nz_bank_transfer |
object |
refunds.data.destination_details.p24 |
object |
refunds.data.destination_details.p24.reference |
string |
refunds.data.destination_details.p24.reference_status |
string |
refunds.data.destination_details.paynow |
object |
refunds.data.destination_details.paypal |
object |
refunds.data.destination_details.paypal.network_decline_code |
string |
refunds.data.destination_details.pix |
object |
refunds.data.destination_details.revolut |
object |
refunds.data.destination_details.scalapay |
object |
refunds.data.destination_details.sofort |
object |
refunds.data.destination_details.swish |
object |
refunds.data.destination_details.swish.network_decline_code |
string |
refunds.data.destination_details.swish.reference |
string |
refunds.data.destination_details.swish.reference_status |
string |
refunds.data.destination_details.th_bank_transfer |
object |
refunds.data.destination_details.th_bank_transfer.reference |
string |
refunds.data.destination_details.th_bank_transfer.reference_status |
string |
refunds.data.destination_details.twint |
object |
refunds.data.destination_details.type |
string |
refunds.data.destination_details.us_bank_transfer |
object |
refunds.data.destination_details.us_bank_transfer.reference |
string |
refunds.data.destination_details.us_bank_transfer.reference_status |
string |
refunds.data.destination_details.wechat_pay |
object |
refunds.data.destination_details.zip |
object |
refunds.data.failure_balance_transaction |
string |
refunds.data.failure_reason |
string |
refunds.data.id |
string |
refunds.data.instructions_email |
string |
refunds.data.metadata |
object |
refunds.data.next_action |
object |
refunds.data.next_action.display_details |
object |
refunds.data.next_action.display_details.email_sent |
object |
refunds.data.next_action.display_details.email_sent.email_sent_at |
string |
refunds.data.next_action.display_details.email_sent.email_sent_to |
string |
refunds.data.next_action.display_details.expires_at |
string |
refunds.data.next_action.type |
string |
refunds.data.object |
string |
refunds.data.payment_intent |
string |
refunds.data.pending_reason |
string |
refunds.data.presentment_details |
object |
refunds.data.presentment_details.presentment_amount |
number |
refunds.data.presentment_details.presentment_currency |
string |
refunds.data.reason |
string |
refunds.data.receipt_number |
string |
refunds.data.source_transfer_reversal |
string |
refunds.data.status |
string |
refunds.data.transfer_reversal |
string |
refunds.has_more |
boolean |
refunds.object |
string |
refunds.url |
string |
review |
string |
shipping |
string |
source_transfer |
string |
statement_descriptor |
string |
statement_descriptor_suffix |
string |
status |
string |
transfer |
string |
transfer_data |
string |
transfer_group |
string |
Checkout Sessions — List all Checkout Sessions
Delta configuration: use it to request incremental data.
| Setting | Value |
|---|---|
| Delta filter | created[gte] = {{{lastExportDateTime}}} |
| Date format | X |
Response schema:
| Field | Type |
|---|---|
adaptive_pricing |
string |
after_expiration |
string |
allow_promotion_codes |
boolean |
amount_subtotal |
number |
amount_total |
number |
automatic_tax |
object |
automatic_tax.enabled |
boolean |
automatic_tax.liability |
string |
automatic_tax.provider |
string |
automatic_tax.status |
string |
billing_address_collection |
string |
branding_settings |
object |
branding_settings.background_color |
string |
branding_settings.border_style |
string |
branding_settings.button_color |
string |
branding_settings.display_name |
string |
branding_settings.font_family |
string |
branding_settings.icon |
string |
branding_settings.logo |
string |
cancel_url |
string |
client_reference_id |
string |
client_secret |
string |
collected_information |
string |
consent |
string |
consent_collection |
string |
created |
string |
currency |
string |
currency_conversion |
string |
custom_fields |
objectarray |
custom_fields.dropdown |
object |
custom_fields.dropdown.default_value |
string |
custom_fields.dropdown.options |
objectarray |
custom_fields.dropdown.options.label |
string |
custom_fields.dropdown.options.value |
string |
custom_fields.dropdown.value |
string |
custom_fields.key |
string |
custom_fields.label |
object |
custom_fields.label.custom |
string |
custom_fields.label.type |
string |
custom_fields.numeric |
object |
custom_fields.numeric.default_value |
string |
custom_fields.numeric.maximum_length |
number |
custom_fields.numeric.minimum_length |
number |
custom_fields.numeric.value |
string |
custom_fields.optional |
boolean |
custom_fields.text |
object |
custom_fields.text.default_value |
string |
custom_fields.text.maximum_length |
number |
custom_fields.text.minimum_length |
number |
custom_fields.text.value |
string |
custom_fields.type |
string |
custom_text |
object |
custom_text.after_submit |
string |
custom_text.shipping_address |
string |
custom_text.submit |
string |
custom_text.terms_of_service_acceptance |
string |
customer |
string |
customer_account |
string |
customer_creation |
string |
customer_details |
string |
customer_email |
string |
discounts |
objectarray |
discounts.coupon |
string |
discounts.promotion_code |
string |
excluded_payment_method_types |
stringarray |
expires_at |
string |
id |
string (Primary key) |
integration_identifier |
string |
invoice |
string |
invoice_creation |
string |
line_items |
object |
line_items.data |
objectarray |
line_items.data.adjustable_quantity |
string |
line_items.data.amount_discount |
number |
line_items.data.amount_subtotal |
number |
line_items.data.amount_tax |
number |
line_items.data.amount_total |
number |
line_items.data.currency |
string |
line_items.data.description |
string |
line_items.data.discounts |
objectarray |
line_items.data.discounts.amount |
number |
line_items.data.discounts.discount |
object |
line_items.data.discounts.discount.checkout_session |
string |
line_items.data.discounts.discount.customer |
string |
line_items.data.discounts.discount.customer_account |
string |
line_items.data.discounts.discount.end |
number |
line_items.data.discounts.discount.id |
string |
line_items.data.discounts.discount.invoice |
string |
line_items.data.discounts.discount.invoice_item |
string |
line_items.data.discounts.discount.object |
string |
line_items.data.discounts.discount.promotion_code |
string |
line_items.data.discounts.discount.source |
object |
line_items.data.discounts.discount.source.coupon |
string |
line_items.data.discounts.discount.source.type |
string |
line_items.data.discounts.discount.start |
number |
line_items.data.discounts.discount.subscription |
string |
line_items.data.discounts.discount.subscription_item |
string |
line_items.data.id |
string |
line_items.data.metadata |
object |
line_items.data.object |
string |
line_items.data.price |
string |
line_items.data.quantity |
number |
line_items.data.taxes |
objectarray |
line_items.data.taxes.amount |
number |
line_items.data.taxes.rate |
object |
line_items.data.taxes.rate.active |
boolean |
line_items.data.taxes.rate.country |
string |
line_items.data.taxes.rate.created |
string |
line_items.data.taxes.rate.description |
string |
line_items.data.taxes.rate.display_name |
string |
line_items.data.taxes.rate.effective_percentage |
number |
line_items.data.taxes.rate.flat_amount |
string |
line_items.data.taxes.rate.id |
string |
line_items.data.taxes.rate.inclusive |
boolean |
line_items.data.taxes.rate.jurisdiction |
string |
line_items.data.taxes.rate.jurisdiction_level |
string |
line_items.data.taxes.rate.livemode |
boolean |
line_items.data.taxes.rate.metadata |
string |
line_items.data.taxes.rate.object |
string |
line_items.data.taxes.rate.percentage |
number |
line_items.data.taxes.rate.rate_type |
string |
line_items.data.taxes.rate.state |
string |
line_items.data.taxes.rate.tax_type |
string |
line_items.data.taxes.taxability_reason |
string |
line_items.data.taxes.taxable_amount |
number |
line_items.has_more |
boolean |
line_items.object |
string |
line_items.url |
string |
livemode |
boolean |
locale |
string |
managed_payments |
string |
metadata |
object |
mode |
string |
name_collection |
object |
name_collection.business |
object |
name_collection.business.enabled |
boolean |
name_collection.business.optional |
boolean |
name_collection.individual |
object |
name_collection.individual.enabled |
boolean |
name_collection.individual.optional |
boolean |
object |
string |
optional_items |
objectarray |
optional_items.adjustable_quantity |
string |
optional_items.price |
string |
optional_items.quantity |
number |
origin_context |
string |
payment_intent |
string |
payment_link |
string |
payment_method_collection |
string |
payment_method_configuration_details |
string |
payment_method_options |
string |
payment_method_types |
stringarray |
payment_status |
string |
permissions |
string |
phone_number_collection |
object |
phone_number_collection.enabled |
boolean |
presentment_details |
object |
presentment_details.presentment_amount |
number |
presentment_details.presentment_currency |
string |
recovered_from |
string |
redirect_on_completion |
string |
return_url |
string |
saved_payment_method_options |
string |
setup_intent |
string |
shipping_address_collection |
string |
shipping_cost |
string |
shipping_options |
objectarray |
shipping_options.shipping_amount |
number |
shipping_options.shipping_rate |
string |
status |
string |
submit_type |
string |
subscription |
string |
success_url |
string |
tax_id_collection |
object |
tax_id_collection.enabled |
boolean |
tax_id_collection.required |
string |
total_details |
string |
ui_mode |
string |
url |
string |
wallet_options |
string |
Coupons — List all coupons
Delta configuration: use it to request incremental data.
| Setting | Value |
|---|---|
| Delta filter | created[gte] = {{{lastExportDateTime}}} |
| Date format | X |
Response schema:
| Field | Type |
|---|---|
amount_off |
number |
applies_to |
object |
applies_to.products |
stringarray |
created |
string |
currency |
string |
currency_options |
string |
duration |
string |
duration_in_months |
number |
id |
string (Primary key) |
livemode |
boolean |
max_redemptions |
number |
metadata |
object |
name |
string |
object |
string |
percent_off |
number |
redeem_by |
number |
times_redeemed |
number |
valid |
boolean |
Credit Notes — List all Credit Notes
Delta configuration: use it to request incremental data.
| Setting | Value |
|---|---|
| Delta filter | created[gte] = {{{lastExportDateTime}}} |
| Date format | X |
Response schema:
| Field | Type |
|---|---|
amount |
number |
amount_shipping |
number |
created |
string |
currency |
string |
customer |
string |
customer_account |
string |
customer_balance_transaction |
string |
discount_amount |
number |
discount_amounts |
objectarray |
discount_amounts.amount |
number |
discount_amounts.discount |
string |
effective_at |
string |
id |
string (Primary key) |
invoice |
string |
lines |
object |
lines.data |
objectarray |
lines.data.amount |
number |
lines.data.description |
string |
lines.data.discount_amount |
number |
lines.data.discount_amounts |
objectarray |
lines.data.discount_amounts.amount |
number |
lines.data.discount_amounts.discount |
string |
lines.data.id |
string |
lines.data.invoice_line_item |
string |
lines.data.livemode |
boolean |
lines.data.metadata |
object |
lines.data.object |
string |
lines.data.pretax_credit_amounts |
objectarray |
lines.data.pretax_credit_amounts.amount |
number |
lines.data.pretax_credit_amounts.credit_balance_transaction |
string |
lines.data.pretax_credit_amounts.discount |
string |
lines.data.pretax_credit_amounts.type |
string |
lines.data.quantity |
number |
lines.data.tax_rates |
objectarray |
lines.data.tax_rates.active |
boolean |
lines.data.tax_rates.country |
string |
lines.data.tax_rates.created |
string |
lines.data.tax_rates.description |
string |
lines.data.tax_rates.display_name |
string |
lines.data.tax_rates.effective_percentage |
number |
lines.data.tax_rates.flat_amount |
string |
lines.data.tax_rates.id |
string |
lines.data.tax_rates.inclusive |
boolean |
lines.data.tax_rates.jurisdiction |
string |
lines.data.tax_rates.jurisdiction_level |
string |
lines.data.tax_rates.livemode |
boolean |
lines.data.tax_rates.metadata |
string |
lines.data.tax_rates.object |
string |
lines.data.tax_rates.percentage |
number |
lines.data.tax_rates.rate_type |
string |
lines.data.tax_rates.state |
string |
lines.data.tax_rates.tax_type |
string |
lines.data.taxes |
objectarray |
lines.data.taxes.amount |
number |
lines.data.taxes.tax_behavior |
string |
lines.data.taxes.tax_rate_details |
string |
lines.data.taxes.taxability_reason |
string |
lines.data.taxes.taxable_amount |
number |
lines.data.taxes.type |
string |
lines.data.type |
string |
lines.data.unit_amount |
number |
lines.data.unit_amount_decimal |
string |
lines.has_more |
boolean |
lines.object |
string |
lines.url |
string |
livemode |
boolean |
memo |
string |
metadata |
object |
number |
string |
object |
string |
out_of_band_amount |
number |
pdf |
string |
post_payment_amount |
number |
pre_payment_amount |
number |
pretax_credit_amounts |
objectarray |
pretax_credit_amounts.amount |
number |
pretax_credit_amounts.credit_balance_transaction |
string |
pretax_credit_amounts.discount |
string |
pretax_credit_amounts.type |
string |
reason |
string |
refunds |
objectarray |
refunds.amount_refunded |
number |
refunds.payment_record_refund |
string |
refunds.refund |
string |
refunds.type |
string |
shipping_cost |
string |
status |
string |
subtotal |
number |
subtotal_excluding_tax |
number |
total |
number |
total_excluding_tax |
number |
total_taxes |
objectarray |
total_taxes.amount |
number |
total_taxes.tax_behavior |
string |
total_taxes.tax_rate_details |
string |
total_taxes.taxability_reason |
string |
total_taxes.taxable_amount |
number |
total_taxes.type |
string |
type |
string |
voided_at |
string |
Customers — List all customers
Delta configuration: use it to request incremental data.
| Setting | Value |
|---|---|
| Delta filter | created[gte] = {{{lastExportDateTime}}} |
| Date format | X |
Response schema:
| Field | Type |
|---|---|
address |
string |
balance |
number |
business_name |
string |
cash_balance |
string |
created |
string |
currency |
string |
customer_account |
string |
default_source |
string |
delinquent |
boolean |
description |
string |
discount |
string |
email |
string |
id |
string (Primary key) |
individual_name |
string |
invoice_credit_balance |
string |
invoice_prefix |
string |
invoice_settings |
object |
invoice_settings.custom_fields |
objectarray |
invoice_settings.custom_fields.name |
string |
invoice_settings.custom_fields.value |
string |
invoice_settings.default_payment_method |
string |
invoice_settings.footer |
string |
invoice_settings.rendering_options |
string |
livemode |
boolean |
metadata |
object |
name |
string |
next_invoice_sequence |
number |
object |
string |
phone |
string |
preferred_locales |
stringarray |
shipping |
string |
sources |
object |
sources.data |
objectarray |
sources.data.id |
string |
sources.data.object |
string |
sources.has_more |
boolean |
sources.object |
string |
sources.url |
string |
subscriptions |
object |
subscriptions.data |
objectarray |
subscriptions.data.application |
string |
subscriptions.data.application_fee_percent |
number |
subscriptions.data.automatic_tax |
object |
subscriptions.data.automatic_tax.disabled_reason |
string |
subscriptions.data.automatic_tax.enabled |
boolean |
subscriptions.data.automatic_tax.liability |
string |
subscriptions.data.billing_cycle_anchor |
number |
subscriptions.data.billing_cycle_anchor_config |
string |
subscriptions.data.billing_mode |
object |
subscriptions.data.billing_mode.flexible |
string |
subscriptions.data.billing_mode.type |
string |
subscriptions.data.billing_mode.updated_at |
string |
subscriptions.data.billing_schedules |
objectarray |
subscriptions.data.billing_schedules.applies_to |
objectarray |
subscriptions.data.billing_schedules.applies_to.price |
string |
subscriptions.data.billing_schedules.applies_to.type |
string |
subscriptions.data.billing_schedules.bill_until |
object |
subscriptions.data.billing_schedules.bill_until.computed_timestamp |
string |
subscriptions.data.billing_schedules.bill_until.duration |
string |
subscriptions.data.billing_schedules.bill_until.timestamp |
string |
subscriptions.data.billing_schedules.bill_until.type |
string |
subscriptions.data.billing_schedules.key |
string |
subscriptions.data.billing_thresholds |
string |
subscriptions.data.cancel_at |
string |
subscriptions.data.cancel_at_period_end |
boolean |
subscriptions.data.canceled_at |
string |
subscriptions.data.cancellation_details |
string |
subscriptions.data.collection_method |
string |
subscriptions.data.created |
string |
subscriptions.data.currency |
string |
subscriptions.data.customer |
string |
subscriptions.data.customer_account |
string |
subscriptions.data.days_until_due |
number |
subscriptions.data.default_payment_method |
string |
subscriptions.data.default_source |
string |
subscriptions.data.default_tax_rates |
objectarray |
subscriptions.data.default_tax_rates.active |
boolean |
subscriptions.data.default_tax_rates.country |
string |
subscriptions.data.default_tax_rates.created |
string |
subscriptions.data.default_tax_rates.description |
string |
subscriptions.data.default_tax_rates.display_name |
string |
subscriptions.data.default_tax_rates.effective_percentage |
number |
subscriptions.data.default_tax_rates.flat_amount |
string |
subscriptions.data.default_tax_rates.id |
string |
subscriptions.data.default_tax_rates.inclusive |
boolean |
subscriptions.data.default_tax_rates.jurisdiction |
string |
subscriptions.data.default_tax_rates.jurisdiction_level |
string |
subscriptions.data.default_tax_rates.livemode |
boolean |
subscriptions.data.default_tax_rates.metadata |
string |
subscriptions.data.default_tax_rates.object |
string |
subscriptions.data.default_tax_rates.percentage |
number |
subscriptions.data.default_tax_rates.rate_type |
string |
subscriptions.data.default_tax_rates.state |
string |
subscriptions.data.default_tax_rates.tax_type |
string |
subscriptions.data.description |
string |
subscriptions.data.discounts |
stringarray |
subscriptions.data.ended_at |
string |
subscriptions.data.id |
string |
subscriptions.data.invoice_settings |
object |
subscriptions.data.invoice_settings.account_tax_ids |
stringarray |
subscriptions.data.invoice_settings.custom_fields |
objectarray |
subscriptions.data.invoice_settings.custom_fields.name |
string |
subscriptions.data.invoice_settings.custom_fields.value |
string |
subscriptions.data.invoice_settings.description |
string |
subscriptions.data.invoice_settings.footer |
string |
subscriptions.data.invoice_settings.issuer |
object |
subscriptions.data.invoice_settings.issuer.account |
string |
subscriptions.data.invoice_settings.issuer.type |
string |
subscriptions.data.items |
object |
subscriptions.data.items.data |
objectarray |
subscriptions.data.items.data.billed_until |
number |
subscriptions.data.items.data.billing_thresholds |
string |
subscriptions.data.items.data.created |
string |
subscriptions.data.items.data.current_period_end |
string |
subscriptions.data.items.data.current_period_start |
string |
subscriptions.data.items.data.discounts |
stringarray |
subscriptions.data.items.data.id |
string |
subscriptions.data.items.data.metadata |
string |
subscriptions.data.items.data.object |
string |
subscriptions.data.items.data.price |
object |
subscriptions.data.items.data.price.active |
boolean |
subscriptions.data.items.data.price.billing_scheme |
string |
subscriptions.data.items.data.price.created |
string |
subscriptions.data.items.data.price.currency |
string |
subscriptions.data.items.data.price.currency_options |
string |
subscriptions.data.items.data.price.custom_unit_amount |
string |
subscriptions.data.items.data.price.id |
string |
subscriptions.data.items.data.price.livemode |
boolean |
subscriptions.data.items.data.price.lookup_key |
string |
subscriptions.data.items.data.price.metadata |
string |
subscriptions.data.items.data.price.nickname |
string |
subscriptions.data.items.data.price.object |
string |
subscriptions.data.items.data.price.product |
string |
subscriptions.data.items.data.price.recurring |
string |
subscriptions.data.items.data.price.tax_behavior |
string |
subscriptions.data.items.data.price.tiers |
objectarray |
subscriptions.data.items.data.price.tiers.flat_amount |
number |
subscriptions.data.items.data.price.tiers.flat_amount_decimal |
string |
subscriptions.data.items.data.price.tiers.unit_amount |
number |
subscriptions.data.items.data.price.tiers.unit_amount_decimal |
string |
subscriptions.data.items.data.price.tiers.up_to |
number |
subscriptions.data.items.data.price.tiers_mode |
string |
subscriptions.data.items.data.price.transform_quantity |
string |
subscriptions.data.items.data.price.type |
string |
subscriptions.data.items.data.price.unit_amount |
number |
subscriptions.data.items.data.price.unit_amount_decimal |
string |
subscriptions.data.items.data.quantity |
number |
subscriptions.data.items.data.subscription |
string |
subscriptions.data.items.data.tax_rates |
objectarray |
subscriptions.data.items.data.tax_rates.active |
boolean |
subscriptions.data.items.data.tax_rates.country |
string |
subscriptions.data.items.data.tax_rates.created |
string |
subscriptions.data.items.data.tax_rates.description |
string |
subscriptions.data.items.data.tax_rates.display_name |
string |
subscriptions.data.items.data.tax_rates.effective_percentage |
number |
subscriptions.data.items.data.tax_rates.flat_amount |
string |
subscriptions.data.items.data.tax_rates.id |
string |
subscriptions.data.items.data.tax_rates.inclusive |
boolean |
subscriptions.data.items.data.tax_rates.jurisdiction |
string |
subscriptions.data.items.data.tax_rates.jurisdiction_level |
string |
subscriptions.data.items.data.tax_rates.livemode |
boolean |
subscriptions.data.items.data.tax_rates.metadata |
string |
subscriptions.data.items.data.tax_rates.object |
string |
subscriptions.data.items.data.tax_rates.percentage |
number |
subscriptions.data.items.data.tax_rates.rate_type |
string |
subscriptions.data.items.data.tax_rates.state |
string |
subscriptions.data.items.data.tax_rates.tax_type |
string |
subscriptions.data.items.has_more |
boolean |
subscriptions.data.items.object |
string |
subscriptions.data.items.url |
string |
subscriptions.data.latest_invoice |
string |
subscriptions.data.livemode |
boolean |
subscriptions.data.managed_payments |
string |
subscriptions.data.metadata |
object |
subscriptions.data.next_pending_invoice_item_invoice |
number |
subscriptions.data.object |
string |
subscriptions.data.on_behalf_of |
string |
subscriptions.data.pause_collection |
string |
subscriptions.data.payment_settings |
string |
subscriptions.data.pending_invoice_item_interval |
string |
subscriptions.data.pending_setup_intent |
string |
subscriptions.data.pending_update |
string |
subscriptions.data.presentment_details |
object |
subscriptions.data.presentment_details.presentment_currency |
string |
subscriptions.data.schedule |
string |
subscriptions.data.start_date |
string |
subscriptions.data.status |
string |
subscriptions.data.test_clock |
string |
subscriptions.data.transfer_data |
string |
subscriptions.data.trial_end |
number |
subscriptions.data.trial_settings |
string |
subscriptions.data.trial_start |
number |
subscriptions.has_more |
boolean |
subscriptions.object |
string |
subscriptions.url |
string |
tax |
object |
tax.automatic_tax |
string |
tax.ip_address |
string |
tax.location |
string |
tax.provider |
string |
tax_exempt |
string |
tax_ids |
object |
tax_ids.data |
objectarray |
tax_ids.data.country |
string |
tax_ids.data.created |
string |
tax_ids.data.customer |
string |
tax_ids.data.customer_account |
string |
tax_ids.data.id |
string |
tax_ids.data.livemode |
boolean |
tax_ids.data.object |
string |
tax_ids.data.owner |
string |
tax_ids.data.type |
string |
tax_ids.data.value |
string |
tax_ids.data.verification |
string |
tax_ids.has_more |
boolean |
tax_ids.object |
string |
tax_ids.url |
string |
test_clock |
string |
Disputes — List all disputes
Delta configuration: use it to request incremental data.
| Setting | Value |
|---|---|
| Delta filter | created[gte] = {{{lastExportDateTime}}} |
| Date format | X |
Response schema:
| Field | Type |
|---|---|
amount |
number |
balance_transactions |
objectarray |
balance_transactions.amount |
number |
balance_transactions.available_on |
string |
balance_transactions.balance_type |
string |
balance_transactions.created |
string |
balance_transactions.currency |
string |
balance_transactions.description |
string |
balance_transactions.exchange_rate |
number |
balance_transactions.fee |
number |
balance_transactions.fee_details |
objectarray |
balance_transactions.fee_details.amount |
number |
balance_transactions.fee_details.application |
string |
balance_transactions.fee_details.currency |
string |
balance_transactions.fee_details.description |
string |
balance_transactions.fee_details.type |
string |
balance_transactions.id |
string |
balance_transactions.net |
number |
balance_transactions.object |
string |
balance_transactions.reporting_category |
string |
balance_transactions.source |
string |
balance_transactions.status |
string |
balance_transactions.type |
string |
charge |
string |
created |
string |
currency |
string |
enhanced_eligibility_types |
stringarray |
evidence |
object |
evidence.access_activity_log |
string |
evidence.billing_address |
string |
evidence.cancellation_policy |
string |
evidence.cancellation_policy_disclosure |
string |
evidence.cancellation_rebuttal |
string |
evidence.customer_communication |
string |
evidence.customer_email_address |
string |
evidence.customer_name |
string |
evidence.customer_purchase_ip |
string |
evidence.customer_signature |
string |
evidence.duplicate_charge_documentation |
string |
evidence.duplicate_charge_explanation |
string |
evidence.duplicate_charge_id |
string |
evidence.enhanced_evidence |
object |
evidence.enhanced_evidence.mastercard_compliance |
object |
evidence.enhanced_evidence.mastercard_compliance.fee_acknowledged |
boolean |
evidence.enhanced_evidence.visa_compelling_evidence_3 |
object |
evidence.enhanced_evidence.visa_compelling_evidence_3.disputed_transaction |
string |
evidence.enhanced_evidence.visa_compelling_evidence_3.prior_undisputed_transactions |
objectarray |
evidence.enhanced_evidence.visa_compelling_evidence_3.prior_undisputed_transactions.charge |
string |
evidence.enhanced_evidence.visa_compelling_evidence_3.prior_undisputed_transactions.customer_account_id |
string |
evidence.enhanced_evidence.visa_compelling_evidence_3.prior_undisputed_transactions.customer_device_fingerprint |
string |
evidence.enhanced_evidence.visa_compelling_evidence_3.prior_undisputed_transactions.customer_device_id |
string |
evidence.enhanced_evidence.visa_compelling_evidence_3.prior_undisputed_transactions.customer_email_address |
string |
evidence.enhanced_evidence.visa_compelling_evidence_3.prior_undisputed_transactions.customer_purchase_ip |
string |
evidence.enhanced_evidence.visa_compelling_evidence_3.prior_undisputed_transactions.product_description |
string |
evidence.enhanced_evidence.visa_compelling_evidence_3.prior_undisputed_transactions.shipping_address |
string |
evidence.enhanced_evidence.visa_compliance |
object |
evidence.enhanced_evidence.visa_compliance.fee_acknowledged |
boolean |
evidence.product_description |
string |
evidence.receipt |
string |
evidence.refund_policy |
string |
evidence.refund_policy_disclosure |
string |
evidence.refund_refusal_explanation |
string |
evidence.service_date |
string |
evidence.service_documentation |
string |
evidence.shipping_address |
string |
evidence.shipping_carrier |
string |
evidence.shipping_date |
string |
evidence.shipping_documentation |
string |
evidence.shipping_tracking_number |
string |
evidence.uncategorized_file |
string |
evidence.uncategorized_text |
string |
evidence_details |
object |
evidence_details.due_by |
number |
evidence_details.enhanced_eligibility |
object |
evidence_details.enhanced_eligibility.mastercard_compliance |
object |
evidence_details.enhanced_eligibility.mastercard_compliance.status |
string |
evidence_details.enhanced_eligibility.visa_compelling_evidence_3 |
object |
evidence_details.enhanced_eligibility.visa_compelling_evidence_3.required_actions |
stringarray |
evidence_details.enhanced_eligibility.visa_compelling_evidence_3.status |
string |
evidence_details.enhanced_eligibility.visa_compliance |
object |
evidence_details.enhanced_eligibility.visa_compliance.status |
string |
evidence_details.has_evidence |
boolean |
evidence_details.past_due |
boolean |
evidence_details.submission_count |
number |
id |
string (Primary key) |
is_charge_refundable |
boolean |
livemode |
boolean |
metadata |
object |
object |
string |
payment_intent |
string |
payment_method_details |
object |
payment_method_details.amazon_pay |
object |
payment_method_details.amazon_pay.dispute_type |
string |
payment_method_details.card |
object |
payment_method_details.card.brand |
string |
payment_method_details.card.case_type |
string |
payment_method_details.card.network_reason_code |
string |
payment_method_details.klarna |
object |
payment_method_details.klarna.chargeback_loss_reason_code |
string |
payment_method_details.klarna.reason_code |
string |
payment_method_details.paypal |
object |
payment_method_details.paypal.case_id |
string |
payment_method_details.paypal.reason_code |
string |
payment_method_details.type |
string |
reason |
string |
status |
string |
Early Fraud Warnings — List all Early Fraud Warnings
Delta configuration: use it to request incremental data.
| Setting | Value |
|---|---|
| Delta filter | created[gte] = {{{lastExportDateTime}}} |
| Date format | X |
Response schema:
| Field | Type |
|---|---|
actionable |
boolean |
charge |
string |
created |
string |
fraud_type |
string |
id |
string (Primary key) |
livemode |
boolean |
object |
string |
payment_intent |
string |
Events — List all events
Delta configuration: use it to request incremental data.
| Setting | Value |
|---|---|
| Delta filter | created[gte] = {{{lastExportDateTime}}} |
| Date format | X |
Response schema:
| Field | Type |
|---|---|
account |
string |
api_version |
string |
context |
string |
created |
string |
data |
object |
data.object |
string |
data.previous_attributes |
string |
id |
string (Primary key) |
livemode |
boolean |
object |
string |
pending_webhooks |
number |
request |
string |
type |
string |
Invoice items — List all invoice items
Delta configuration: use it to request incremental data.
| Setting | Value |
|---|---|
| Delta filter | created[gte] = {{{lastExportDateTime}}} |
| Date format | X |
Response schema:
| Field | Type |
|---|---|
amount |
number |
currency |
string |
customer |
string |
customer_account |
string |
date |
string |
description |
string |
discountable |
boolean |
discounts |
stringarray |
id |
string (Primary key) |
invoice |
string |
livemode |
boolean |
metadata |
object |
net_amount |
number |
object |
string |
parent |
string |
period |
object |
period.end |
number |
period.start |
number |
pricing |
string |
proration |
boolean |
proration_details |
object |
proration_details.credited_items |
string |
proration_details.discount_amounts |
objectarray |
proration_details.discount_amounts.amount |
number |
proration_details.discount_amounts.discount |
string |
quantity |
number |
quantity_decimal |
string |
tax_rates |
objectarray |
tax_rates.active |
boolean |
tax_rates.country |
string |
tax_rates.created |
string |
tax_rates.description |
string |
tax_rates.display_name |
string |
tax_rates.effective_percentage |
number |
tax_rates.flat_amount |
string |
tax_rates.id |
string |
tax_rates.inclusive |
boolean |
tax_rates.jurisdiction |
string |
tax_rates.jurisdiction_level |
string |
tax_rates.livemode |
boolean |
tax_rates.metadata |
object |
tax_rates.object |
string |
tax_rates.percentage |
number |
tax_rates.rate_type |
string |
tax_rates.state |
string |
tax_rates.tax_type |
string |
test_clock |
string |
Invoices — List all invoices
Delta configuration: use it to request incremental data.
| Setting | Value |
|---|---|
| Delta filter | created[gte] = {{{lastExportDateTime}}} |
| Date format | X |
Response schema:
| Field | Type |
|---|---|
account_country |
string |
account_name |
string |
account_tax_ids |
stringarray |
amount_due |
number |
amount_overpaid |
number |
amount_paid |
number |
amount_paid_off_stripe |
number |
amount_remaining |
number |
amount_shipping |
number |
application |
string |
attempt_count |
number |
attempted |
boolean |
auto_advance |
boolean |
automatic_tax |
object |
automatic_tax.disabled_reason |
string |
automatic_tax.enabled |
boolean |
automatic_tax.liability |
string |
automatic_tax.provider |
string |
automatic_tax.status |
string |
automatically_finalizes_at |
string |
billing_reason |
string |
collection_method |
string |
confirmation_secret |
string |
created |
string |
currency |
string |
custom_fields |
objectarray |
custom_fields.name |
string |
custom_fields.value |
string |
customer |
string |
customer_account |
string |
customer_address |
string |
customer_email |
string |
customer_name |
string |
customer_phone |
string |
customer_shipping |
string |
customer_tax_exempt |
string |
customer_tax_ids |
objectarray |
customer_tax_ids.type |
string |
customer_tax_ids.value |
string |
default_payment_method |
string |
default_source |
string |
default_tax_rates |
objectarray |
default_tax_rates.active |
boolean |
default_tax_rates.country |
string |
default_tax_rates.created |
string |
default_tax_rates.description |
string |
default_tax_rates.display_name |
string |
default_tax_rates.effective_percentage |
number |
default_tax_rates.flat_amount |
string |
default_tax_rates.id |
string |
default_tax_rates.inclusive |
boolean |
default_tax_rates.jurisdiction |
string |
default_tax_rates.jurisdiction_level |
string |
default_tax_rates.livemode |
boolean |
default_tax_rates.metadata |
object |
default_tax_rates.object |
string |
default_tax_rates.percentage |
number |
default_tax_rates.rate_type |
string |
default_tax_rates.state |
string |
default_tax_rates.tax_type |
string |
description |
string |
discounts |
stringarray |
due_date |
string |
effective_at |
string |
ending_balance |
number |
footer |
string |
from_invoice |
string |
hosted_invoice_url |
string |
id |
string (Primary key) |
invoice_pdf |
string |
issuer |
object |
issuer.account |
string |
issuer.type |
string |
last_finalization_error |
string |
latest_revision |
string |
lines |
object |
lines.data |
objectarray |
lines.data.amount |
number |
lines.data.currency |
string |
lines.data.description |
string |
lines.data.discount_amounts |
objectarray |
lines.data.discount_amounts.amount |
number |
lines.data.discount_amounts.discount |
string |
lines.data.discountable |
boolean |
lines.data.discounts |
stringarray |
lines.data.id |
string |
lines.data.invoice |
string |
lines.data.livemode |
boolean |
lines.data.metadata |
object |
lines.data.object |
string |
lines.data.parent |
string |
lines.data.period |
object |
lines.data.period.end |
number |
lines.data.period.start |
number |
lines.data.pretax_credit_amounts |
objectarray |
lines.data.pretax_credit_amounts.amount |
number |
lines.data.pretax_credit_amounts.credit_balance_transaction |
string |
lines.data.pretax_credit_amounts.discount |
string |
lines.data.pretax_credit_amounts.type |
string |
lines.data.pricing |
string |
lines.data.quantity |
number |
lines.data.quantity_decimal |
string |
lines.data.subscription |
string |
lines.data.subtotal |
number |
lines.data.taxes |
objectarray |
lines.data.taxes.amount |
number |
lines.data.taxes.tax_behavior |
string |
lines.data.taxes.tax_rate_details |
string |
lines.data.taxes.taxability_reason |
string |
lines.data.taxes.taxable_amount |
number |
lines.data.taxes.type |
string |
lines.has_more |
boolean |
lines.object |
string |
lines.url |
string |
livemode |
boolean |
metadata |
object |
next_payment_attempt |
string |
number |
string |
object |
string |
on_behalf_of |
string |
parent |
object |
parent.subscription_details |
object |
parent.subscription_details.subscription |
string |
payments |
object |
payments.data |
objectarray |
payments.data.amount_paid |
number |
payments.data.amount_requested |
number |
payments.data.created |
string |
payments.data.currency |
string |
payments.data.id |
string |
payments.data.invoice |
string |
payments.data.is_default |
boolean |
payments.data.livemode |
boolean |
payments.data.object |
string |
payments.data.payment |
object |
payments.data.payment.charge |
string |
payments.data.payment.payment_intent |
string |
payments.data.payment.payment_record |
string |
payments.data.payment.type |
string |
payments.data.status |
string |
payments.data.status_transitions |
object |
payments.data.status_transitions.canceled_at |
string |
payments.data.status_transitions.paid_at |
string |
payments.has_more |
boolean |
payments.object |
string |
payments.url |
string |
period_end |
string |
period_start |
string |
post_payment_credit_notes_amount |
number |
pre_payment_credit_notes_amount |
number |
receipt_number |
string |
rendering |
string |
shipping_cost |
string |
shipping_details |
string |
starting_balance |
number |
statement_descriptor |
string |
status |
string |
status_transitions |
object |
status_transitions.finalized_at |
string |
status_transitions.marked_uncollectible_at |
string |
status_transitions.paid_at |
string |
status_transitions.voided_at |
string |
subtotal |
number |
subtotal_excluding_tax |
number |
test_clock |
string |
threshold_reason |
object |
threshold_reason.amount_gte |
number |
threshold_reason.item_reasons |
objectarray |
threshold_reason.item_reasons.line_item_ids |
stringarray |
threshold_reason.item_reasons.usage_gte |
number |
total |
number |
total_discount_amounts |
objectarray |
total_discount_amounts.amount |
number |
total_discount_amounts.discount |
string |
total_excluding_tax |
number |
total_pretax_credit_amounts |
objectarray |
total_pretax_credit_amounts.amount |
number |
total_pretax_credit_amounts.credit_balance_transaction |
string |
total_pretax_credit_amounts.discount |
string |
total_pretax_credit_amounts.type |
string |
total_taxes |
objectarray |
total_taxes.amount |
number |
total_taxes.tax_behavior |
string |
total_taxes.tax_rate_details |
string |
total_taxes.taxability_reason |
string |
total_taxes.taxable_amount |
number |
total_taxes.type |
string |
webhooks_delivered_at |
string |
Payment Intents — List all Payment Intents
Delta configuration: use it to request incremental data.
| Setting | Value |
|---|---|
| Delta filter | created[gte] = {{{lastExportDateTime}}} |
| Date format | X |
Response schema:
| Field | Type |
|---|---|
amount |
number |
amount_capturable |
number |
amount_details |
string |
amount_received |
number |
application |
string |
application_fee_amount |
number |
automatic_payment_methods |
string |
canceled_at |
string |
cancellation_reason |
string |
capture_method |
string |
client_secret |
string |
confirmation_method |
string |
created |
string |
currency |
string |
customer |
string |
customer_account |
string |
description |
string |
excluded_payment_method_types |
stringarray |
hooks |
object |
hooks.inputs |
object |
hooks.inputs.tax |
object |
hooks.inputs.tax.calculation |
string |
id |
string (Primary key) |
last_payment_error |
string |
latest_charge |
string |
livemode |
boolean |
managed_payments |
string |
metadata |
object |
next_action |
string |
object |
string |
on_behalf_of |
string |
payment_details |
object |
payment_details.customer_reference |
string |
payment_details.order_reference |
string |
payment_method |
string |
payment_method_configuration_details |
string |
payment_method_options |
string |
payment_method_types |
stringarray |
presentment_details |
object |
presentment_details.presentment_amount |
number |
presentment_details.presentment_currency |
string |
processing |
string |
receipt_email |
string |
review |
string |
setup_future_usage |
string |
shipping |
string |
statement_descriptor |
string |
statement_descriptor_suffix |
string |
status |
string |
transfer_data |
string |
transfer_group |
string |
Payouts — List all payouts
Delta configuration: use it to request incremental data.
| Setting | Value |
|---|---|
| Delta filter | created[gte] = {{{lastExportDateTime}}} |
| Date format | X |
Response schema:
| Field | Type |
|---|---|
amount |
number |
application_fee |
string |
application_fee_amount |
number |
arrival_date |
string |
automatic |
boolean |
balance_transaction |
string |
created |
string |
currency |
string |
description |
string |
destination |
string |
failure_balance_transaction |
string |
failure_code |
string |
failure_message |
string |
id |
string (Primary key) |
livemode |
boolean |
metadata |
object |
method |
string |
object |
string |
original_payout |
string |
payout_method |
string |
reconciliation_status |
string |
reversed_by |
string |
source_type |
string |
statement_descriptor |
string |
status |
string |
trace_id |
string |
type |
string |
Plans — List all plans
Delta configuration: use it to request incremental data.
| Setting | Value |
|---|---|
| Delta filter | created[gte] = {{{lastExportDateTime}}} |
| Date format | X |
Response schema:
| Field | Type |
|---|---|
active |
boolean |
amount |
number |
amount_decimal |
string |
billing_scheme |
string |
created |
string |
currency |
string |
id |
string (Primary key) |
interval |
string |
interval_count |
number |
livemode |
boolean |
metadata |
object |
meter |
string |
nickname |
string |
object |
string |
product |
string |
tiers |
objectarray |
tiers.flat_amount |
number |
tiers.flat_amount_decimal |
string |
tiers.unit_amount |
number |
tiers.unit_amount_decimal |
string |
tiers.up_to |
number |
tiers_mode |
string |
transform_usage |
string |
trial_period_days |
number |
usage_type |
string |
Prices — List all Prices
Delta configuration: use it to request incremental data.
| Setting | Value |
|---|---|
| Delta filter | created[gte] = {{{lastExportDateTime}}} |
| Date format | X |
Response schema:
| Field | Type |
|---|---|
active |
boolean |
billing_scheme |
string |
created |
string |
currency |
string |
currency_options |
string |
custom_unit_amount |
string |
id |
string (Primary key) |
livemode |
boolean |
lookup_key |
string |
metadata |
object |
nickname |
string |
object |
string |
product |
string |
recurring |
object |
recurring.interval |
string |
recurring.interval_count |
number |
recurring.trial_period_days |
number |
recurring.usage_type |
string |
tax_behavior |
string |
tiers |
objectarray |
tiers.flat_amount |
number |
tiers.flat_amount_decimal |
string |
tiers.unit_amount |
number |
tiers.unit_amount_decimal |
string |
tiers.up_to |
number |
tiers_mode |
string |
transform_quantity |
string |
type |
string |
unit_amount |
number |
unit_amount_decimal |
string |
Products — List all products
Delta configuration: use it to request incremental data.
| Setting | Value |
|---|---|
| Delta filter | created[gte] = {{{lastExportDateTime}}} |
| Date format | X |
Response schema:
| Field | Type |
|---|---|
active |
boolean |
created |
string |
default_price |
string |
description |
string |
id |
string (Primary key) |
images |
stringarray |
livemode |
boolean |
marketing_features |
objectarray |
marketing_features.name |
string |
metadata |
object |
name |
string |
object |
string |
package_dimensions |
object |
package_dimensions.height |
number |
package_dimensions.length |
number |
package_dimensions.weight |
number |
package_dimensions.width |
number |
shippable |
boolean |
statement_descriptor |
string |
tax_code |
string |
unit_label |
string |
updated |
string |
url |
string |
Refunds — List all refunds
Delta configuration: use it to request incremental data.
| Setting | Value |
|---|---|
| Delta filter | created[gte] = {{{lastExportDateTime}}} |
| Date format | X |
Response schema:
| Field | Type |
|---|---|
amount |
number |
balance_transaction |
string |
charge |
string |
created |
string |
currency |
string |
description |
string |
destination_details |
object |
destination_details.affirm |
object |
destination_details.afterpay_clearpay |
object |
destination_details.alipay |
object |
destination_details.alma |
object |
destination_details.amazon_pay |
object |
destination_details.au_bank_transfer |
object |
destination_details.blik |
object |
destination_details.blik.network_decline_code |
string |
destination_details.blik.reference |
string |
destination_details.blik.reference_status |
string |
destination_details.br_bank_transfer |
object |
destination_details.br_bank_transfer.reference |
string |
destination_details.br_bank_transfer.reference_status |
string |
destination_details.card |
object |
destination_details.card.reference |
string |
destination_details.card.reference_status |
string |
destination_details.card.reference_type |
string |
destination_details.card.type |
string |
destination_details.cashapp |
object |
destination_details.crypto |
object |
destination_details.crypto.reference |
string |
destination_details.customer_cash_balance |
object |
destination_details.eps |
object |
destination_details.eu_bank_transfer |
object |
destination_details.eu_bank_transfer.reference |
string |
destination_details.eu_bank_transfer.reference_status |
string |
destination_details.gb_bank_transfer |
object |
destination_details.gb_bank_transfer.reference |
string |
destination_details.gb_bank_transfer.reference_status |
string |
destination_details.giropay |
object |
destination_details.grabpay |
object |
destination_details.jp_bank_transfer |
object |
destination_details.jp_bank_transfer.reference |
string |
destination_details.jp_bank_transfer.reference_status |
string |
destination_details.klarna |
object |
destination_details.mb_way |
object |
destination_details.mb_way.reference |
string |
destination_details.mb_way.reference_status |
string |
destination_details.multibanco |
object |
destination_details.multibanco.reference |
string |
destination_details.multibanco.reference_status |
string |
destination_details.mx_bank_transfer |
object |
destination_details.mx_bank_transfer.reference |
string |
destination_details.mx_bank_transfer.reference_status |
string |
destination_details.nz_bank_transfer |
object |
destination_details.p24 |
object |
destination_details.p24.reference |
string |
destination_details.p24.reference_status |
string |
destination_details.paynow |
object |
destination_details.paypal |
object |
destination_details.paypal.network_decline_code |
string |
destination_details.pix |
object |
destination_details.revolut |
object |
destination_details.scalapay |
object |
destination_details.sofort |
object |
destination_details.swish |
object |
destination_details.swish.network_decline_code |
string |
destination_details.swish.reference |
string |
destination_details.swish.reference_status |
string |
destination_details.th_bank_transfer |
object |
destination_details.th_bank_transfer.reference |
string |
destination_details.th_bank_transfer.reference_status |
string |
destination_details.twint |
object |
destination_details.type |
string |
destination_details.us_bank_transfer |
object |
destination_details.us_bank_transfer.reference |
string |
destination_details.us_bank_transfer.reference_status |
string |
destination_details.wechat_pay |
object |
destination_details.zip |
object |
failure_balance_transaction |
string |
failure_reason |
string |
id |
string (Primary key) |
instructions_email |
string |
metadata |
object |
next_action |
object |
next_action.display_details |
object |
next_action.display_details.email_sent |
object |
next_action.display_details.email_sent.email_sent_at |
string |
next_action.display_details.email_sent.email_sent_to |
string |
next_action.display_details.expires_at |
string |
next_action.type |
string |
object |
string |
payment_intent |
string |
pending_reason |
string |
presentment_details |
object |
presentment_details.presentment_amount |
number |
presentment_details.presentment_currency |
string |
reason |
string |
receipt_number |
string |
source_transfer_reversal |
string |
status |
string |
transfer_reversal |
string |
Reviews — List all Open Reviews
Delta configuration: use it to request incremental data.
| Setting | Value |
|---|---|
| Delta filter | created[gte] = {{{lastExportDateTime}}} |
| Date format | X |
Response schema:
| Field | Type |
|---|---|
billing_zip |
string |
charge |
string |
closed_reason |
string |
created |
string |
id |
string (Primary key) |
ip_address |
string |
ip_address_location |
string |
livemode |
boolean |
object |
string |
open |
boolean |
opened_reason |
string |
payment_intent |
string |
reason |
string |
session |
string |
Setup Intents — List all Setup Intents
Delta configuration: use it to request incremental data.
| Setting | Value |
|---|---|
| Delta filter | created[gte] = {{{lastExportDateTime}}} |
| Date format | X |
Response schema:
| Field | Type |
|---|---|
application |
string |
attach_to_self |
boolean |
automatic_payment_methods |
string |
cancellation_reason |
string |
client_secret |
string |
created |
string |
customer |
string |
customer_account |
string |
description |
string |
excluded_payment_method_types |
stringarray |
flow_directions |
stringarray |
id |
string (Primary key) |
last_setup_error |
object |
last_setup_error.code |
string |
last_setup_error.message |
string |
last_setup_error.decline_code |
string |
latest_attempt |
string |
livemode |
boolean |
managed_payments |
string |
mandate |
string |
metadata |
object |
next_action |
string |
object |
string |
on_behalf_of |
string |
payment_method |
string |
payment_method_configuration_details |
string |
payment_method_options |
string |
payment_method_types |
stringarray |
single_use_mandate |
string |
status |
string |
usage |
string |
Subscription schedules — List all Schedules
Delta configuration: use it to request incremental data.
| Setting | Value |
|---|---|
| Delta filter | created[gte] = {{{lastExportDateTime}}} |
| Date format | X |
Response schema:
| Field | Type |
|---|---|
application |
string |
billing_mode |
object |
billing_mode.flexible |
string |
billing_mode.type |
string |
billing_mode.updated_at |
string |
canceled_at |
string |
completed_at |
string |
created |
string |
current_phase |
string |
customer |
string |
customer_account |
string |
default_settings |
object |
default_settings.application_fee_percent |
number |
default_settings.automatic_tax |
object |
default_settings.automatic_tax.disabled_reason |
string |
default_settings.automatic_tax.enabled |
boolean |
default_settings.automatic_tax.liability |
string |
default_settings.billing_cycle_anchor |
string |
default_settings.billing_thresholds |
string |
default_settings.collection_method |
string |
default_settings.default_payment_method |
string |
default_settings.description |
string |
default_settings.invoice_settings |
object |
default_settings.invoice_settings.account_tax_ids |
stringarray |
default_settings.invoice_settings.days_until_due |
number |
default_settings.invoice_settings.issuer |
object |
default_settings.invoice_settings.issuer.account |
string |
default_settings.invoice_settings.issuer.type |
string |
default_settings.on_behalf_of |
string |
default_settings.transfer_data |
string |
end_behavior |
string |
id |
string (Primary key) |
livemode |
boolean |
metadata |
object |
object |
string |
phases |
objectarray |
phases.add_invoice_items |
objectarray |
phases.add_invoice_items.discountable |
boolean |
phases.add_invoice_items.discounts |
objectarray |
phases.add_invoice_items.discounts.coupon |
string |
phases.add_invoice_items.discounts.discount |
string |
phases.add_invoice_items.discounts.promotion_code |
string |
phases.add_invoice_items.metadata |
object |
phases.add_invoice_items.period |
object |
phases.add_invoice_items.period.end |
object |
phases.add_invoice_items.period.end.timestamp |
string |
phases.add_invoice_items.period.end.type |
string |
phases.add_invoice_items.period.start |
object |
phases.add_invoice_items.period.start.timestamp |
string |
phases.add_invoice_items.period.start.type |
string |
phases.add_invoice_items.price |
string |
phases.add_invoice_items.quantity |
number |
phases.add_invoice_items.tax_rates |
objectarray |
phases.add_invoice_items.tax_rates.active |
boolean |
phases.add_invoice_items.tax_rates.country |
string |
phases.add_invoice_items.tax_rates.created |
string |
phases.add_invoice_items.tax_rates.description |
string |
phases.add_invoice_items.tax_rates.display_name |
string |
phases.add_invoice_items.tax_rates.effective_percentage |
number |
phases.add_invoice_items.tax_rates.flat_amount |
string |
phases.add_invoice_items.tax_rates.id |
string |
phases.add_invoice_items.tax_rates.inclusive |
boolean |
phases.add_invoice_items.tax_rates.jurisdiction |
string |
phases.add_invoice_items.tax_rates.jurisdiction_level |
string |
phases.add_invoice_items.tax_rates.livemode |
boolean |
phases.add_invoice_items.tax_rates.metadata |
string |
phases.add_invoice_items.tax_rates.object |
string |
phases.add_invoice_items.tax_rates.percentage |
number |
phases.add_invoice_items.tax_rates.rate_type |
string |
phases.add_invoice_items.tax_rates.state |
string |
phases.add_invoice_items.tax_rates.tax_type |
string |
phases.application_fee_percent |
number |
phases.automatic_tax |
object |
phases.automatic_tax.disabled_reason |
string |
phases.automatic_tax.enabled |
boolean |
phases.automatic_tax.liability |
string |
phases.billing_cycle_anchor |
string |
phases.billing_thresholds |
string |
phases.collection_method |
string |
phases.currency |
string |
phases.default_payment_method |
string |
phases.default_tax_rates |
objectarray |
phases.default_tax_rates.active |
boolean |
phases.default_tax_rates.country |
string |
phases.default_tax_rates.created |
string |
phases.default_tax_rates.description |
string |
phases.default_tax_rates.display_name |
string |
phases.default_tax_rates.effective_percentage |
number |
phases.default_tax_rates.flat_amount |
string |
phases.default_tax_rates.id |
string |
phases.default_tax_rates.inclusive |
boolean |
phases.default_tax_rates.jurisdiction |
string |
phases.default_tax_rates.jurisdiction_level |
string |
phases.default_tax_rates.livemode |
boolean |
phases.default_tax_rates.metadata |
object |
phases.default_tax_rates.object |
string |
phases.default_tax_rates.percentage |
number |
phases.default_tax_rates.rate_type |
string |
phases.default_tax_rates.state |
string |
phases.default_tax_rates.tax_type |
string |
phases.description |
string |
phases.discounts |
objectarray |
phases.discounts.coupon |
string |
phases.discounts.discount |
string |
phases.discounts.promotion_code |
string |
phases.end_date |
string |
phases.invoice_settings |
string |
phases.items |
objectarray |
phases.items.billing_thresholds |
string |
phases.items.discounts |
objectarray |
phases.items.discounts.coupon |
string |
phases.items.discounts.discount |
string |
phases.items.discounts.promotion_code |
string |
phases.items.metadata |
object |
phases.items.price |
string |
phases.items.quantity |
number |
phases.items.tax_rates |
objectarray |
phases.items.tax_rates.active |
boolean |
phases.items.tax_rates.country |
string |
phases.items.tax_rates.created |
string |
phases.items.tax_rates.description |
string |
phases.items.tax_rates.display_name |
string |
phases.items.tax_rates.effective_percentage |
number |
phases.items.tax_rates.flat_amount |
string |
phases.items.tax_rates.id |
string |
phases.items.tax_rates.inclusive |
boolean |
phases.items.tax_rates.jurisdiction |
string |
phases.items.tax_rates.jurisdiction_level |
string |
phases.items.tax_rates.livemode |
boolean |
phases.items.tax_rates.metadata |
string |
phases.items.tax_rates.object |
string |
phases.items.tax_rates.percentage |
number |
phases.items.tax_rates.rate_type |
string |
phases.items.tax_rates.state |
string |
phases.items.tax_rates.tax_type |
string |
phases.metadata |
object |
phases.on_behalf_of |
string |
phases.proration_behavior |
string |
phases.start_date |
string |
phases.transfer_data |
string |
phases.trial_end |
number |
released_at |
string |
released_subscription |
string |
status |
string |
subscription |
string |
test_clock |
string |
Subscriptions — List all subscriptions
Delta configuration: use it to request incremental data.
| Setting | Value |
|---|---|
| Delta filter | created[gte] = {{{lastExportDateTime}}} |
| Date format | X |
Response schema:
| Field | Type |
|---|---|
application |
string |
application_fee_percent |
number |
automatic_tax |
object |
automatic_tax.disabled_reason |
string |
automatic_tax.enabled |
boolean |
automatic_tax.liability |
string |
billing_cycle_anchor |
number |
billing_cycle_anchor_config |
string |
billing_mode |
object |
billing_mode.flexible |
string |
billing_mode.type |
string |
billing_mode.updated_at |
string |
billing_schedules |
objectarray |
billing_schedules.applies_to |
objectarray |
billing_schedules.applies_to.price |
string |
billing_schedules.applies_to.type |
string |
billing_schedules.bill_until |
object |
billing_schedules.bill_until.computed_timestamp |
string |
billing_schedules.bill_until.duration |
string |
billing_schedules.bill_until.timestamp |
string |
billing_schedules.bill_until.type |
string |
billing_schedules.key |
string |
billing_thresholds |
string |
cancel_at |
string |
cancel_at_period_end |
boolean |
canceled_at |
string |
cancellation_details |
string |
collection_method |
string |
created |
string |
currency |
string |
customer |
string |
customer_account |
string |
days_until_due |
number |
default_payment_method |
string |
default_source |
string |
default_tax_rates |
objectarray |
default_tax_rates.active |
boolean |
default_tax_rates.country |
string |
default_tax_rates.created |
string |
default_tax_rates.description |
string |
default_tax_rates.display_name |
string |
default_tax_rates.effective_percentage |
number |
default_tax_rates.flat_amount |
string |
default_tax_rates.id |
string |
default_tax_rates.inclusive |
boolean |
default_tax_rates.jurisdiction |
string |
default_tax_rates.jurisdiction_level |
string |
default_tax_rates.livemode |
boolean |
default_tax_rates.metadata |
object |
default_tax_rates.object |
string |
default_tax_rates.percentage |
number |
default_tax_rates.rate_type |
string |
default_tax_rates.state |
string |
default_tax_rates.tax_type |
string |
description |
string |
discounts |
stringarray |
ended_at |
string |
id |
string (Primary key) |
invoice_settings |
object |
invoice_settings.account_tax_ids |
stringarray |
invoice_settings.custom_fields |
objectarray |
invoice_settings.custom_fields.name |
string |
invoice_settings.custom_fields.value |
string |
invoice_settings.description |
string |
invoice_settings.footer |
string |
invoice_settings.issuer |
object |
invoice_settings.issuer.account |
string |
invoice_settings.issuer.type |
string |
items |
object |
items.data |
objectarray |
items.data.billed_until |
number |
items.data.billing_thresholds |
string |
items.data.created |
string |
items.data.current_period_end |
string |
items.data.current_period_start |
string |
items.data.discounts |
stringarray |
items.data.id |
string |
items.data.metadata |
object |
items.data.object |
string |
items.data.price |
object |
items.data.price.active |
boolean |
items.data.price.billing_scheme |
string |
items.data.price.created |
string |
items.data.price.currency |
string |
items.data.price.currency_options |
string |
items.data.price.custom_unit_amount |
string |
items.data.price.id |
string |
items.data.price.livemode |
boolean |
items.data.price.lookup_key |
string |
items.data.price.metadata |
string |
items.data.price.nickname |
string |
items.data.price.object |
string |
items.data.price.product |
string |
items.data.price.recurring |
string |
items.data.price.tax_behavior |
string |
items.data.price.tiers |
objectarray |
items.data.price.tiers.flat_amount |
number |
items.data.price.tiers.flat_amount_decimal |
string |
items.data.price.tiers.unit_amount |
number |
items.data.price.tiers.unit_amount_decimal |
string |
items.data.price.tiers.up_to |
number |
items.data.price.tiers_mode |
string |
items.data.price.transform_quantity |
string |
items.data.price.type |
string |
items.data.price.unit_amount |
number |
items.data.price.unit_amount_decimal |
string |
items.data.quantity |
number |
items.data.subscription |
string |
items.data.tax_rates |
objectarray |
items.data.tax_rates.active |
boolean |
items.data.tax_rates.country |
string |
items.data.tax_rates.created |
string |
items.data.tax_rates.description |
string |
items.data.tax_rates.display_name |
string |
items.data.tax_rates.effective_percentage |
number |
items.data.tax_rates.flat_amount |
string |
items.data.tax_rates.id |
string |
items.data.tax_rates.inclusive |
boolean |
items.data.tax_rates.jurisdiction |
string |
items.data.tax_rates.jurisdiction_level |
string |
items.data.tax_rates.livemode |
boolean |
items.data.tax_rates.metadata |
string |
items.data.tax_rates.object |
string |
items.data.tax_rates.percentage |
number |
items.data.tax_rates.rate_type |
string |
items.data.tax_rates.state |
string |
items.data.tax_rates.tax_type |
string |
items.has_more |
boolean |
items.object |
string |
items.url |
string |
latest_invoice |
string |
livemode |
boolean |
managed_payments |
string |
metadata |
object |
next_pending_invoice_item_invoice |
number |
object |
string |
on_behalf_of |
string |
pause_collection |
string |
payment_settings |
string |
pending_invoice_item_interval |
string |
pending_setup_intent |
string |
pending_update |
string |
presentment_details |
object |
presentment_details.presentment_currency |
string |
schedule |
string |
start_date |
string |
status |
string |
test_clock |
string |
transfer_data |
string |
trial_end |
number |
trial_settings |
string |
trial_start |
number |
Top-Ups — List all Top-Ups
Delta configuration: use it to request incremental data.
| Setting | Value |
|---|---|
| Delta filter | created[gte] = {{{lastExportDateTime}}} |
| Date format | X |
Response schema:
| Field | Type |
|---|---|
amount |
number |
balance_transaction |
string |
created |
string |
currency |
string |
description |
string |
expected_availability_date |
string |
failure_code |
string |
failure_message |
string |
id |
string (Primary key) |
livemode |
boolean |
metadata |
object |
object |
string |
source |
object |
statement_descriptor |
string |
status |
string |
transfer_group |
string |
Transfers — List all transfers
Delta configuration: use it to request incremental data.
| Setting | Value |
|---|---|
| Delta filter | created[gte] = {{{lastExportDateTime}}} |
| Date format | X |
Response schema:
| Field | Type |
|---|---|
amount |
number |
amount_reversed |
number |
balance_transaction |
string |
created |
string |
currency |
string |
description |
string |
destination |
string |
destination_payment |
string |
id |
string (Primary key) |
livemode |
boolean |
metadata |
object |
object |
string |
reversals |
object |
reversals.data |
objectarray |
reversals.data.amount |
number |
reversals.data.balance_transaction |
string |
reversals.data.created |
string |
reversals.data.currency |
string |
reversals.data.destination_payment_refund |
string |
reversals.data.id |
string |
reversals.data.metadata |
object |
reversals.data.object |
string |
reversals.data.source_refund |
string |
reversals.data.transfer |
string |
reversals.has_more |
boolean |
reversals.object |
string |
reversals.url |
string |
reversed |
boolean |
source_transaction |
string |
source_type |
string |
transfer_group |
string |