# Stripe Source Connector Record Schemas This reference lists the record value schema the Stripe Source connector uses for each Stripe resource and its events topic, which schema it applies, and how it handles fields that Stripe adds later. ## Record schemas The connector includes a schema for each resource. When a topic has no value schema in Schema Registry, the connector registers this built-in schema under `-value`. - Every field is optional except `id`. - Objects and lists, such as `metadata`, `address`, and `lines`, are JSON text in a string field. - Timestamps such as `created` are Unix seconds. Amounts are integers in the currency’s smallest unit, except `*_decimal` fields such as `unit_amount_decimal`, which are decimal strings. - Records are read with Stripe API version `2026-08-26.dahlia`. ## Which schema is used | Situation | Schema evolution mode EVOLVE (default) | Schema evolution mode NONE | |----------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | No schema registered for the topic | The built-in schema. | The built-in schema. | | You registered a schema before creating the connector | Your schema. Fields it lacks are added with the type of the first value the connector reads for each field, so start from the fields listed in Resources and add your own. | The built-in schema. With AVRO or PROTOBUF, it replaces your schema. With JSON_SR, the connector fails if your schema has fields the built-in schema lacks. To use your own schema, use EVOLVE. | | The topic already has a schema from an earlier connector | The existing schema. | The built-in schema. With JSON_SR, the connector fails if the existing schema has fields the built-in schema lacks. | ## New fields from Stripe - `EVOLVE`: the connector registers a new schema version that adds the field, with the type of the first value it reads. - `NONE`: the field is written as an optional string, only in the records that carry it. ## Events topics Each record in `_events` is the full Stripe event. `data.object` has the resource’s fields. `data.previous_attributes` is JSON text with the changed fields’ old values. Stripe renders event data in your account’s default API version, so keep it at `2026-08-26.dahlia` or a later `dahlia` version. A later major version can include breaking changes. ### Event record fields | Field | Type | Optional | |--------------------|---------|------------| | `account` | string | Yes | | `api_version` | string | Yes | | `context` | string | Yes | | `created` | long | Yes | | `data` | record | No | | `id` | string | No | | `livemode` | boolean | Yes | | `object` | string | Yes | | `pending_webhooks` | long | Yes | | `request` | string | Yes | | `type` | string | Yes | ## Resources Topic names start with `topic.prefix` (default `stripe-`). If a resource’s events are “every x.\* event”, the connector also captures new event types that Stripe adds under that prefix. Otherwise, it captures only the listed types. ### `accounts` **Topics:** `accounts` and `accounts_events`. **Event types in** `accounts_events`: `account.updated`. ### Accounts fields (23) | Field | Type | Optional | |-----------------------|---------|------------| | `business_profile` | string | Yes | | `business_type` | string | Yes | | `capabilities` | string | Yes | | `charges_enabled` | boolean | Yes | | `company` | string | Yes | | `controller` | string | Yes | | `country` | string | Yes | | `created` | long | Yes | | `default_currency` | string | Yes | | `details_submitted` | boolean | Yes | | `email` | string | Yes | | `external_accounts` | string | Yes | | `future_requirements` | string | Yes | | `groups` | string | Yes | | `id` | string | No | | `individual` | string | Yes | | `metadata` | string | Yes | | `object` | string | Yes | | `payouts_enabled` | boolean | Yes | | `requirements` | string | Yes | | `settings` | string | Yes | | `tos_acceptance` | string | Yes | | `type` | string | Yes | ### `application_fees` **Topics:** `application_fees` and `application_fees_events`. **Event types in** `application_fees_events`: `application_fee.created`, `application_fee.refunded`. ### Application Fees fields (15) | Field | Type | Optional | |---------------------------|---------|------------| | `account` | string | Yes | | `amount` | long | Yes | | `amount_refunded` | long | Yes | | `application` | string | Yes | | `balance_transaction` | string | Yes | | `charge` | string | Yes | | `created` | long | Yes | | `currency` | string | Yes | | `fee_source` | string | Yes | | `id` | string | No | | `livemode` | boolean | Yes | | `object` | string | Yes | | `originating_transaction` | string | Yes | | `refunded` | boolean | Yes | | `refunds` | string | Yes | ### `balance_transactions` **Topics:** `balance_transactions` only (no events topic). ### Balance Transactions fields (16) | Field | Type | Optional | |----------------------|--------|------------| | `amount` | long | Yes | | `available_on` | long | Yes | | `balance_type` | string | Yes | | `created` | long | Yes | | `currency` | string | Yes | | `description` | string | Yes | | `exchange_rate` | double | Yes | | `fee` | long | Yes | | `fee_details` | string | Yes | | `id` | string | No | | `net` | long | Yes | | `object` | string | Yes | | `reporting_category` | string | Yes | | `source` | string | Yes | | `status` | string | Yes | | `type` | string | Yes | ### `charges` **Topics:** `charges` and `charges_events`. **Event types in** `charges_events`: `charge.captured`, `charge.expired`, `charge.failed`, `charge.pending`, `charge.refunded`, `charge.succeeded`, `charge.updated`. ### Charges fields (51) | Field | Type | Optional | |-----------------------------------|---------|------------| | `amount` | long | Yes | | `amount_captured` | long | Yes | | `amount_refunded` | long | Yes | | `amount_updates` | string | Yes | | `application` | string | Yes | | `application_fee` | string | Yes | | `application_fee_amount` | long | Yes | | `balance_transaction` | string | Yes | | `billing_details` | string | Yes | | `calculated_statement_descriptor` | string | Yes | | `captured` | boolean | Yes | | `created` | long | Yes | | `currency` | string | Yes | | `customer` | string | Yes | | `description` | string | Yes | | `destination` | string | Yes | | `dispute` | string | Yes | | `disputed` | boolean | Yes | | `failure_balance_transaction` | string | Yes | | `failure_code` | string | Yes | | `failure_message` | string | Yes | | `fraud_details` | string | Yes | | `id` | string | No | | `invoice` | string | Yes | | `livemode` | boolean | Yes | | `metadata` | string | Yes | | `object` | string | Yes | | `on_behalf_of` | string | Yes | | `order` | string | Yes | | `outcome` | string | Yes | | `paid` | boolean | Yes | | `payment_intent` | string | Yes | | `payment_method` | string | Yes | | `payment_method_details` | string | Yes | | `presentment_details` | string | Yes | | `radar_options` | string | Yes | | `receipt_email` | string | Yes | | `receipt_number` | string | Yes | | `receipt_url` | string | Yes | | `refunded` | boolean | Yes | | `refunds` | string | Yes | | `review` | string | Yes | | `shipping` | string | Yes | | `source` | string | Yes | | `source_transfer` | string | Yes | | `statement_descriptor` | string | Yes | | `statement_descriptor_suffix` | string | Yes | | `status` | string | Yes | | `transfer` | string | Yes | | `transfer_data` | string | Yes | | `transfer_group` | string | Yes | ### `checkout_sessions` **Topics:** `checkout_sessions` and `checkout_sessions_events`. **Event types:** Every `checkout.session.*` event. The current types are `checkout.session.async_payment_failed`, `checkout.session.async_payment_succeeded`, `checkout.session.completed`, and `checkout.session.expired`. ### Checkout Sessions fields (72) | Field | Type | Optional | |----------------------------------------|---------|------------| | `adaptive_pricing` | string | Yes | | `after_expiration` | string | Yes | | `allow_promotion_codes` | boolean | Yes | | `allowed_payment_method_types` | string | Yes | | `amount_subtotal` | long | Yes | | `amount_total` | long | Yes | | `automatic_tax` | string | Yes | | `billing_address_collection` | string | Yes | | `branding_settings` | string | Yes | | `cancel_url` | string | Yes | | `client_reference_id` | string | Yes | | `client_secret` | string | Yes | | `collected_information` | string | Yes | | `consent` | string | Yes | | `consent_collection` | string | Yes | | `created` | long | Yes | | `currency` | string | Yes | | `currency_conversion` | string | Yes | | `custom_fields` | string | Yes | | `custom_text` | string | Yes | | `customer` | string | Yes | | `customer_account` | string | Yes | | `customer_creation` | string | Yes | | `customer_details` | string | Yes | | `customer_email` | string | Yes | | `discounts` | string | Yes | | `excluded_payment_method_types` | string | Yes | | `expires_at` | long | Yes | | `id` | string | No | | `integration_identifier` | string | Yes | | `invoice` | string | Yes | | `invoice_creation` | string | Yes | | `line_items` | string | Yes | | `livemode` | boolean | Yes | | `locale` | string | Yes | | `managed_payments` | string | Yes | | `metadata` | string | Yes | | `mode` | string | Yes | | `name_collection` | string | Yes | | `object` | string | Yes | | `optional_items` | string | Yes | | `origin_context` | string | Yes | | `payment_intent` | string | Yes | | `payment_link` | string | Yes | | `payment_method_collection` | string | Yes | | `payment_method_configuration_details` | string | Yes | | `payment_method_options` | string | Yes | | `payment_method_types` | string | Yes | | `payment_status` | string | Yes | | `permissions` | string | Yes | | `phone_number_collection` | string | Yes | | `presentment_details` | string | Yes | | `recovered_from` | string | Yes | | `redirect_on_completion` | string | Yes | | `return_url` | string | Yes | | `saved_payment_method_options` | string | Yes | | `setup_intent` | string | Yes | | `shipping` | string | Yes | | `shipping_address_collection` | string | Yes | | `shipping_cost` | string | Yes | | `shipping_details` | string | Yes | | `shipping_options` | string | Yes | | `shipping_rate` | string | Yes | | `status` | string | Yes | | `submit_type` | string | Yes | | `subscription` | string | Yes | | `success_url` | string | Yes | | `tax_id_collection` | string | Yes | | `total_details` | string | Yes | | `ui_mode` | string | Yes | | `url` | string | Yes | | `wallet_options` | string | Yes | ### `coupons` **Topics:** `coupons` and `coupons_events`. **Event types in** `coupons_events`: every `coupon.*` event, currently: `coupon.created`, `coupon.deleted`, `coupon.updated`. ### Coupons fields (17) | Field | Type | Optional | |----------------------|---------|------------| | `amount_off` | long | Yes | | `applies_to` | string | Yes | | `created` | long | Yes | | `currency` | string | Yes | | `currency_options` | string | Yes | | `duration` | string | Yes | | `duration_in_months` | long | Yes | | `id` | string | No | | `livemode` | boolean | Yes | | `max_redemptions` | long | Yes | | `metadata` | string | Yes | | `name` | string | Yes | | `object` | string | Yes | | `percent_off` | double | Yes | | `redeem_by` | long | Yes | | `times_redeemed` | long | Yes | | `valid` | boolean | Yes | ### `credit_notes` **Topics:** `credit_notes` and `credit_notes_events`. **Event types in** `credit_notes_events`: every `credit_note.*` event, currently: `credit_note.created`, `credit_note.updated`, `credit_note.voided`. ### Credit Notes fields (36) | Field | Type | Optional | |--------------------------------|---------|------------| | `amount` | long | Yes | | `amount_shipping` | long | Yes | | `created` | long | Yes | | `currency` | string | Yes | | `customer` | string | Yes | | `customer_account` | string | Yes | | `customer_balance_transaction` | string | Yes | | `discount_amount` | long | Yes | | `discount_amounts` | string | Yes | | `effective_at` | long | Yes | | `id` | string | No | | `invoice` | string | Yes | | `lines` | string | Yes | | `livemode` | boolean | Yes | | `memo` | string | Yes | | `metadata` | string | Yes | | `number` | string | Yes | | `object` | string | Yes | | `out_of_band_amount` | long | Yes | | `pdf` | string | Yes | | `post_payment_amount` | long | Yes | | `pre_payment_amount` | long | Yes | | `pretax_credit_amounts` | string | Yes | | `reason` | string | Yes | | `refund` | string | Yes | | `refunds` | string | Yes | | `shipping_cost` | string | Yes | | `status` | string | Yes | | `subtotal` | long | Yes | | `subtotal_excluding_tax` | long | Yes | | `tax_amounts` | string | Yes | | `total` | long | Yes | | `total_excluding_tax` | long | Yes | | `total_taxes` | string | Yes | | `type` | string | Yes | | `voided_at` | long | Yes | ### `customers` **Topics:** `customers` and `customers_events`. **Event types in** `customers_events`: `customer.created`, `customer.deleted`, `customer.updated`. ### Customers fields (32) | Field | Type | Optional | |--------------------------|---------|------------| | `address` | string | Yes | | `balance` | long | Yes | | `business_name` | string | Yes | | `cash_balance` | string | Yes | | `created` | long | Yes | | `currency` | string | Yes | | `customer_account` | string | Yes | | `default_currency` | string | Yes | | `default_source` | string | Yes | | `delinquent` | boolean | Yes | | `description` | string | Yes | | `discount` | string | Yes | | `email` | string | Yes | | `id` | string | No | | `individual_name` | string | Yes | | `invoice_credit_balance` | string | Yes | | `invoice_prefix` | string | Yes | | `invoice_settings` | string | Yes | | `livemode` | boolean | Yes | | `metadata` | string | Yes | | `name` | string | Yes | | `next_invoice_sequence` | long | Yes | | `object` | string | Yes | | `phone` | string | Yes | | `preferred_locales` | string | Yes | | `shipping` | string | Yes | | `sources` | string | Yes | | `subscriptions` | string | Yes | | `tax` | string | Yes | | `tax_exempt` | string | Yes | | `tax_ids` | string | Yes | | `test_clock` | string | Yes | ### `disputes` **Topics:** `disputes` and `disputes_events`. **Event types in** `disputes_events`: every `charge.dispute.*` event, currently: `charge.dispute.closed`, `charge.dispute.created`, `charge.dispute.funds_reinstated`, `charge.dispute.funds_withdrawn`, `charge.dispute.updated`. ### Disputes fields (18) | Field | Type | Optional | |------------------------------|---------|------------| | `amount` | long | Yes | | `balance_transaction` | string | Yes | | `balance_transactions` | string | Yes | | `charge` | string | Yes | | `created` | long | Yes | | `currency` | string | Yes | | `enhanced_eligibility_types` | string | Yes | | `evidence` | string | Yes | | `evidence_details` | string | Yes | | `id` | string | No | | `is_charge_refundable` | boolean | Yes | | `livemode` | boolean | Yes | | `metadata` | string | Yes | | `object` | string | Yes | | `payment_intent` | string | Yes | | `payment_method_details` | string | Yes | | `reason` | string | Yes | | `status` | string | Yes | ### `early_fraud_warnings` **Topics:** `early_fraud_warnings` and `early_fraud_warnings_events`. **Event types in** `early_fraud_warnings_events`: every `radar.early_fraud_warning.*` event, currently: `radar.early_fraud_warning.created`, `radar.early_fraud_warning.updated`. ### Early Fraud Warnings fields (8) | Field | Type | Optional | |------------------|---------|------------| | `actionable` | boolean | Yes | | `charge` | string | Yes | | `created` | long | Yes | | `fraud_type` | string | Yes | | `id` | string | No | | `livemode` | boolean | Yes | | `object` | string | Yes | | `payment_intent` | string | Yes | ### `events` **Topics:** `events` only (no events topic). ### Events fields (11) | Field | Type | Optional | |--------------------|---------|------------| | `account` | string | Yes | | `api_version` | string | Yes | | `context` | string | Yes | | `created` | long | Yes | | `data` | string | Yes | | `id` | string | No | | `livemode` | boolean | Yes | | `object` | string | Yes | | `pending_webhooks` | long | Yes | | `request` | string | Yes | | `type` | string | Yes | ### `file_links` **Topics:** `file_links` only (no events topic). ### File Links fields (9) | Field | Type | Optional | |--------------|---------|------------| | `created` | long | Yes | | `expired` | boolean | Yes | | `expires_at` | long | Yes | | `file` | string | Yes | | `id` | string | No | | `livemode` | boolean | Yes | | `metadata` | string | Yes | | `object` | string | Yes | | `url` | string | Yes | ### `files` **Topics:** `files` only (no events topic). ### Files fields (11) | Field | Type | Optional | |--------------|--------|------------| | `created` | long | Yes | | `expires_at` | long | Yes | | `filename` | string | Yes | | `id` | string | No | | `links` | string | Yes | | `object` | string | Yes | | `purpose` | string | Yes | | `size` | long | Yes | | `title` | string | Yes | | `type` | string | Yes | | `url` | string | Yes | ### `invoice_items` **Topics:** `invoice_items` and `invoice_items_events`. **Event types in** `invoice_items_events`: every `invoiceitem.*` event, currently: `invoiceitem.created`, `invoiceitem.deleted`. ### Invoice Items fields (31) | Field | Type | Optional | |-----------------------|---------|------------| | `amount` | long | Yes | | `currency` | string | Yes | | `customer` | string | Yes | | `customer_account` | string | Yes | | `date` | long | Yes | | `description` | string | Yes | | `discountable` | boolean | Yes | | `discounts` | string | Yes | | `frozen_fields` | string | Yes | | `id` | string | No | | `invoice` | string | Yes | | `invoicing_rules` | string | Yes | | `livemode` | boolean | Yes | | `metadata` | string | Yes | | `net_amount` | long | Yes | | `object` | string | Yes | | `parent` | string | Yes | | `period` | string | Yes | | `plan` | string | Yes | | `price` | string | Yes | | `pricing` | string | Yes | | `proration` | boolean | Yes | | `proration_details` | string | Yes | | `quantity` | long | Yes | | `quantity_decimal` | string | Yes | | `subscription` | string | Yes | | `subscription_item` | string | Yes | | `tax_rates` | string | Yes | | `test_clock` | string | Yes | | `unit_amount` | long | Yes | | `unit_amount_decimal` | string | Yes | ### `invoices` **Topics:** `invoices` and `invoices_events`. **Event types in** `invoices_events`: `invoice.created`, `invoice.deleted`, `invoice.finalization_failed`, `invoice.finalized`, `invoice.marked_uncollectible`, `invoice.overdue`, `invoice.overpaid`, `invoice.paid`, `invoice.payment_action_required`, `invoice.payment_attempt_required`, `invoice.payment_failed`, `invoice.payment_succeeded`, `invoice.sent`, `invoice.updated`, `invoice.voided`, `invoice.will_be_due`. ### Invoices fields (93) | Field | Type | Optional | |------------------------------------|---------|------------| | `account_country` | string | Yes | | `account_name` | string | Yes | | `account_tax_ids` | string | Yes | | `amount_due` | long | Yes | | `amount_overpaid` | long | Yes | | `amount_paid` | long | Yes | | `amount_paid_off_stripe` | long | Yes | | `amount_remaining` | long | Yes | | `amount_shipping` | long | Yes | | `application` | string | Yes | | `application_fee_amount` | long | Yes | | `attempt_count` | long | Yes | | `attempted` | boolean | Yes | | `auto_advance` | boolean | Yes | | `automatic_tax` | string | Yes | | `automatically_finalizes_at` | long | Yes | | `billing_reason` | string | Yes | | `charge` | string | Yes | | `collection_method` | string | Yes | | `confirmation_secret` | string | Yes | | `created` | long | Yes | | `currency` | string | Yes | | `custom_fields` | string | Yes | | `customer` | string | Yes | | `customer_account` | string | Yes | | `customer_address` | string | Yes | | `customer_email` | string | Yes | | `customer_name` | string | Yes | | `customer_phone` | string | Yes | | `customer_shipping` | string | Yes | | `customer_tax_exempt` | string | Yes | | `customer_tax_ids` | string | Yes | | `default_payment_method` | string | Yes | | `default_source` | string | Yes | | `default_tax_rates` | string | Yes | | `description` | string | Yes | | `discount` | string | Yes | | `discounts` | string | Yes | | `due_date` | long | Yes | | `effective_at` | long | Yes | | `ending_balance` | long | Yes | | `footer` | string | Yes | | `from_invoice` | string | Yes | | `hosted_invoice_url` | string | Yes | | `id` | string | No | | `invoice_pdf` | string | Yes | | `issuer` | string | Yes | | `last_finalization_error` | string | Yes | | `latest_revision` | string | Yes | | `lines` | string | Yes | | `livemode` | boolean | Yes | | `metadata` | string | Yes | | `next_payment_attempt` | long | Yes | | `number` | string | Yes | | `object` | string | Yes | | `on_behalf_of` | string | Yes | | `paid` | boolean | Yes | | `paid_out_of_band` | boolean | Yes | | `parent` | string | Yes | | `payment_intent` | string | Yes | | `payment_settings` | string | Yes | | `payments` | string | Yes | | `period_end` | long | Yes | | `period_start` | long | Yes | | `post_payment_credit_notes_amount` | long | Yes | | `pre_payment_credit_notes_amount` | long | Yes | | `quote` | string | Yes | | `receipt_number` | string | Yes | | `rendering` | string | Yes | | `rendering_options` | string | Yes | | `shipping_cost` | string | Yes | | `shipping_details` | string | Yes | | `starting_balance` | long | Yes | | `statement_descriptor` | string | Yes | | `status` | string | Yes | | `status_details` | string | Yes | | `status_transitions` | string | Yes | | `subscription` | string | Yes | | `subscription_details` | string | Yes | | `subscription_proration_date` | long | Yes | | `subtotal` | long | Yes | | `subtotal_excluding_tax` | long | Yes | | `tax` | long | Yes | | `test_clock` | string | Yes | | `threshold_reason` | string | Yes | | `total` | long | Yes | | `total_discount_amounts` | string | Yes | | `total_excluding_tax` | long | Yes | | `total_pretax_credit_amounts` | string | Yes | | `total_tax_amounts` | string | Yes | | `total_taxes` | string | Yes | | `transfer_data` | string | Yes | | `webhooks_delivered_at` | long | Yes | ### `payment_intents` **Topics:** `payment_intents` and `payment_intents_events`. **Event types in** `payment_intents_events`: every `payment_intent.*` event, currently: `payment_intent.amount_capturable_updated`, `payment_intent.canceled`, `payment_intent.created`, `payment_intent.partially_funded`, `payment_intent.payment_failed`, `payment_intent.processing`, `payment_intent.requires_action`, `payment_intent.succeeded`. ### Payment Intents fields (50) | Field | Type | Optional | |----------------------------------------|---------|------------| | `allowed_payment_method_types` | string | Yes | | `amount` | long | Yes | | `amount_capturable` | long | Yes | | `amount_details` | string | Yes | | `amount_received` | long | Yes | | `application` | string | Yes | | `application_fee_amount` | long | Yes | | `automatic_payment_methods` | string | Yes | | `canceled_at` | long | Yes | | `cancellation_reason` | string | Yes | | `capture_method` | string | Yes | | `charges` | string | Yes | | `client_secret` | string | Yes | | `confirmation_method` | string | Yes | | `created` | long | Yes | | `currency` | string | Yes | | `customer` | string | Yes | | `customer_account` | string | Yes | | `description` | string | Yes | | `excluded_payment_method_types` | string | Yes | | `hooks` | string | Yes | | `id` | string | No | | `invoice` | string | Yes | | `last_payment_error` | string | Yes | | `latest_charge` | string | Yes | | `livemode` | boolean | Yes | | `managed_payments` | string | Yes | | `metadata` | string | Yes | | `next_action` | string | Yes | | `object` | string | Yes | | `on_behalf_of` | string | Yes | | `payment_details` | string | Yes | | `payment_method` | string | Yes | | `payment_method_configuration_details` | string | Yes | | `payment_method_options` | string | Yes | | `payment_method_types` | string | Yes | | `payment_record` | string | Yes | | `presentment_details` | string | Yes | | `processing` | string | Yes | | `receipt_email` | string | Yes | | `review` | string | Yes | | `setup_future_usage` | string | Yes | | `shared_payment_granted_token` | string | Yes | | `shipping` | string | Yes | | `source` | string | Yes | | `statement_descriptor` | string | Yes | | `statement_descriptor_suffix` | string | Yes | | `status` | string | Yes | | `transfer_data` | string | Yes | | `transfer_group` | string | Yes | ### `payouts` **Topics:** `payouts` and `payouts_events`. **Event types in** `payouts_events`: every `payout.*` event, currently: `payout.canceled`, `payout.created`, `payout.failed`, `payout.paid`, `payout.reconciliation_completed`, `payout.updated`. ### Payouts fields (27) | Field | Type | Optional | |-------------------------------|---------|------------| | `amount` | long | Yes | | `application_fee` | string | Yes | | `application_fee_amount` | long | Yes | | `arrival_date` | long | Yes | | `automatic` | boolean | Yes | | `balance_transaction` | string | Yes | | `created` | long | Yes | | `currency` | string | Yes | | `description` | string | Yes | | `destination` | string | Yes | | `failure_balance_transaction` | string | Yes | | `failure_code` | string | Yes | | `failure_message` | string | Yes | | `id` | string | No | | `livemode` | boolean | Yes | | `metadata` | string | Yes | | `method` | string | Yes | | `object` | string | Yes | | `original_payout` | string | Yes | | `payout_method` | string | Yes | | `reconciliation_status` | string | Yes | | `reversed_by` | string | Yes | | `source_type` | string | Yes | | `statement_descriptor` | string | Yes | | `status` | string | Yes | | `trace_id` | string | Yes | | `type` | string | Yes | ### `plans` **Topics:** `plans` and `plans_events`. **Event types in** `plans_events`: every `plan.*` event, currently: `plan.created`, `plan.deleted`, `plan.updated`. ### Plans fields (21) | Field | Type | Optional | |---------------------|---------|------------| | `active` | boolean | Yes | | `aggregate_usage` | string | Yes | | `amount` | long | Yes | | `amount_decimal` | string | Yes | | `billing_scheme` | string | Yes | | `created` | long | Yes | | `currency` | string | Yes | | `id` | string | No | | `interval` | string | Yes | | `interval_count` | long | Yes | | `livemode` | boolean | Yes | | `metadata` | string | Yes | | `meter` | string | Yes | | `nickname` | string | Yes | | `object` | string | Yes | | `product` | string | Yes | | `tiers` | string | Yes | | `tiers_mode` | string | Yes | | `transform_usage` | string | Yes | | `trial_period_days` | long | Yes | | `usage_type` | string | Yes | ### `prices` **Topics:** `prices` and `prices_events`. **Event types in** `prices_events`: every `price.*` event, currently: `price.created`, `price.deleted`, `price.updated`. ### Prices fields (21) | Field | Type | Optional | |-----------------------|---------|------------| | `active` | boolean | Yes | | `billing_scheme` | string | Yes | | `created` | long | Yes | | `currency` | string | Yes | | `currency_options` | string | Yes | | `custom_unit_amount` | string | Yes | | `id` | string | No | | `livemode` | boolean | Yes | | `lookup_key` | string | Yes | | `metadata` | string | Yes | | `nickname` | string | Yes | | `object` | string | Yes | | `product` | string | Yes | | `recurring` | string | Yes | | `tax_behavior` | string | Yes | | `tiers` | string | Yes | | `tiers_mode` | string | Yes | | `transform_quantity` | string | Yes | | `type` | string | Yes | | `unit_amount` | long | Yes | | `unit_amount_decimal` | string | Yes | ### `products` **Topics:** `products` and `products_events`. **Event types in** `products_events`: every `product.*` event, currently: `product.created`, `product.deleted`, `product.updated`. ### Products fields (22) | Field | Type | Optional | |------------------------|---------|------------| | `active` | boolean | Yes | | `attributes` | string | Yes | | `created` | long | Yes | | `default_price` | string | Yes | | `description` | string | Yes | | `features` | string | Yes | | `id` | string | No | | `images` | string | Yes | | `livemode` | boolean | Yes | | `marketing_features` | string | Yes | | `metadata` | string | Yes | | `name` | string | Yes | | `object` | string | Yes | | `package_dimensions` | string | Yes | | `shippable` | boolean | Yes | | `statement_descriptor` | string | Yes | | `tax_code` | string | Yes | | `tax_details` | string | Yes | | `type` | string | Yes | | `unit_label` | string | Yes | | `updated` | long | Yes | | `url` | string | Yes | ### `promotion_codes` **Topics:** `promotion_codes` and `promotion_codes_events`. **Event types in** `promotion_codes_events`: every `promotion_code.*` event, currently: `promotion_code.created`, `promotion_code.updated`. ### Promotion Codes fields (15) | Field | Type | Optional | |--------------------|---------|------------| | `active` | boolean | Yes | | `code` | string | Yes | | `coupon` | string | Yes | | `created` | long | Yes | | `customer` | string | Yes | | `customer_account` | string | Yes | | `expires_at` | long | Yes | | `id` | string | No | | `livemode` | boolean | Yes | | `max_redemptions` | long | Yes | | `metadata` | string | Yes | | `object` | string | Yes | | `promotion` | string | Yes | | `restrictions` | string | Yes | | `times_redeemed` | long | Yes | ### `refunds` **Topics:** `refunds` and `refunds_events`. **Event types in** `refunds_events`: `refund.created`, `refund.failed`, `refund.updated`, `charge.refund.updated`. ### Refunds fields (25) | Field | Type | Optional | |-------------------------------|--------|------------| | `amount` | long | Yes | | `balance_transaction` | string | Yes | | `charge` | string | Yes | | `created` | long | Yes | | `currency` | string | Yes | | `customer` | string | Yes | | `customer_account` | string | Yes | | `description` | string | Yes | | `destination_details` | string | Yes | | `failure_balance_transaction` | string | Yes | | `failure_reason` | string | Yes | | `id` | string | No | | `instructions_email` | string | Yes | | `metadata` | string | Yes | | `next_action` | string | Yes | | `object` | string | Yes | | `payment_intent` | string | Yes | | `payment_method` | string | Yes | | `pending_reason` | string | Yes | | `presentment_details` | string | Yes | | `reason` | string | Yes | | `receipt_number` | string | Yes | | `source_transfer_reversal` | string | Yes | | `status` | string | Yes | | `transfer_reversal` | string | Yes | ### `reviews` **Topics:** `reviews` and `reviews_events`. **Event types in** `reviews_events`: every `review.*` event, currently: `review.closed`, `review.opened`. ### Reviews fields (15) | Field | Type | Optional | |-----------------------|---------|------------| | `billing_zip` | string | Yes | | `charge` | string | Yes | | `closed_reason` | string | Yes | | `created` | long | Yes | | `id` | string | No | | `ip_address` | string | Yes | | `ip_address_location` | string | Yes | | `livemode` | boolean | Yes | | `object` | string | Yes | | `open` | boolean | Yes | | `opened_reason` | string | Yes | | `payment_intent` | string | Yes | | `reason` | string | Yes | | `refund_signals` | string | Yes | | `session` | string | Yes | ### `setup_intents` **Topics:** `setup_intents` and `setup_intents_events`. **Event types in** `setup_intents_events`: every `setup_intent.*` event, currently: `setup_intent.canceled`, `setup_intent.created`, `setup_intent.requires_action`, `setup_intent.setup_failed`, `setup_intent.succeeded`. ### Setup Intents fields (29) | Field | Type | Optional | |----------------------------------------|---------|------------| | `allowed_payment_method_types` | string | Yes | | `application` | string | Yes | | `attach_to_self` | boolean | Yes | | `automatic_payment_methods` | string | Yes | | `cancellation_reason` | string | Yes | | `client_secret` | string | Yes | | `created` | long | Yes | | `customer` | string | Yes | | `customer_account` | string | Yes | | `description` | string | Yes | | `excluded_payment_method_types` | string | Yes | | `flow_directions` | string | Yes | | `id` | string | No | | `last_setup_error` | string | Yes | | `latest_attempt` | string | Yes | | `livemode` | boolean | Yes | | `managed_payments` | string | Yes | | `mandate` | string | Yes | | `metadata` | string | Yes | | `next_action` | string | Yes | | `object` | string | Yes | | `on_behalf_of` | string | Yes | | `payment_method` | string | Yes | | `payment_method_configuration_details` | string | Yes | | `payment_method_options` | string | Yes | | `payment_method_types` | string | Yes | | `single_use_mandate` | string | Yes | | `status` | string | Yes | | `usage` | string | Yes | ### `shipping_rates` **Topics:** `shipping_rates` only (no events topic). ### Shipping Rates fields (12) | Field | Type | Optional | |---------------------|---------|------------| | `active` | boolean | Yes | | `created` | long | Yes | | `delivery_estimate` | string | Yes | | `display_name` | string | Yes | | `fixed_amount` | string | Yes | | `id` | string | No | | `livemode` | boolean | Yes | | `metadata` | string | Yes | | `object` | string | Yes | | `tax_behavior` | string | Yes | | `tax_code` | string | Yes | | `type` | string | Yes | ### `subscription_schedules` **Topics:** `subscription_schedules` and `subscription_schedules_events`. **Event types in** `subscription_schedules_events`: every `subscription_schedule.*` event, currently: `subscription_schedule.aborted`, `subscription_schedule.canceled`, `subscription_schedule.completed`, `subscription_schedule.created`, `subscription_schedule.expiring`, `subscription_schedule.released`, `subscription_schedule.updated`. ### Subscription Schedules fields (22) | Field | Type | Optional | |-------------------------|---------|------------| | `application` | string | Yes | | `billing_mode` | string | Yes | | `canceled_at` | long | Yes | | `completed_at` | long | Yes | | `created` | long | Yes | | `current_phase` | string | Yes | | `customer` | string | Yes | | `customer_account` | string | Yes | | `default_settings` | string | Yes | | `end_behavior` | string | Yes | | `id` | string | No | | `livemode` | boolean | Yes | | `metadata` | string | Yes | | `object` | string | Yes | | `pause_schedules` | string | Yes | | `phases` | string | Yes | | `released_at` | long | Yes | | `released_subscription` | string | Yes | | `renewal_interval` | string | Yes | | `status` | string | Yes | | `subscription` | string | Yes | | `test_clock` | string | Yes | ### `subscriptions` Includes canceled subscriptions. **Topics:** `subscriptions` and `subscriptions_events`. **Event types in** `subscriptions_events`: every `customer.subscription.*` event, currently: `customer.subscription.created`, `customer.subscription.deleted`, `customer.subscription.paused`, `customer.subscription.pending_update_applied`, `customer.subscription.pending_update_expired`, `customer.subscription.resumed`, `customer.subscription.trial_will_end`, `customer.subscription.updated`. ### Subscriptions fields (54) | Field | Type | Optional | |-------------------------------------|---------|------------| | `application` | string | Yes | | `application_fee_percent` | double | Yes | | `automatic_tax` | string | Yes | | `billing_cycle_anchor` | long | Yes | | `billing_cycle_anchor_config` | string | Yes | | `billing_mode` | string | Yes | | `billing_schedules` | string | Yes | | `billing_thresholds` | string | Yes | | `cancel_at` | long | Yes | | `cancel_at_period_end` | boolean | Yes | | `canceled_at` | long | Yes | | `cancellation_details` | string | Yes | | `collection_method` | string | Yes | | `created` | long | Yes | | `currency` | string | Yes | | `current_period_end` | long | Yes | | `current_period_start` | long | Yes | | `customer` | string | Yes | | `customer_account` | string | Yes | | `days_until_due` | long | Yes | | `default_payment_method` | string | Yes | | `default_source` | string | Yes | | `default_tax_rates` | string | Yes | | `description` | string | Yes | | `discount` | string | Yes | | `discounts` | string | Yes | | `ended_at` | long | Yes | | `id` | string | No | | `invoice_settings` | string | Yes | | `items` | string | Yes | | `latest_invoice` | string | Yes | | `livemode` | boolean | Yes | | `managed_payments` | string | Yes | | `metadata` | string | Yes | | `next_pending_invoice_item_invoice` | long | Yes | | `object` | string | Yes | | `on_behalf_of` | string | Yes | | `pause_collection` | string | Yes | | `payment_settings` | string | Yes | | `pending_invoice_item_interval` | string | Yes | | `pending_setup_intent` | string | Yes | | `pending_update` | string | Yes | | `plan` | string | Yes | | `presentment_details` | string | Yes | | `quantity` | long | Yes | | `schedule` | string | Yes | | `start_date` | long | Yes | | `status` | string | Yes | | `status_details` | string | Yes | | `test_clock` | string | Yes | | `transfer_data` | string | Yes | | `trial_end` | long | Yes | | `trial_settings` | string | Yes | | `trial_start` | long | Yes | ### `topups` **Topics:** `topups` and `topups_events`. **Event types in** `topups_events`: every `topup.*` event, currently: `topup.canceled`, `topup.created`, `topup.failed`, `topup.reversed`, `topup.succeeded`. ### Top-ups fields (19) | Field | Type | Optional | |------------------------------|---------|------------| | `amount` | long | Yes | | `balance_transaction` | string | Yes | | `created` | long | Yes | | `currency` | string | Yes | | `description` | string | Yes | | `expected_availability_date` | long | Yes | | `failure_code` | string | Yes | | `failure_message` | string | Yes | | `id` | string | No | | `initiated_by` | string | Yes | | `livemode` | boolean | Yes | | `metadata` | string | Yes | | `object` | string | Yes | | `payment_method` | string | Yes | | `payment_method_options` | string | Yes | | `source` | string | Yes | | `statement_descriptor` | string | Yes | | `status` | string | Yes | | `transfer_group` | string | Yes | ### `transfers` **Topics:** `transfers` and `transfers_events`. **Event types in** `transfers_events`: every `transfer.*` event, currently: `transfer.created`, `transfer.reversed`, `transfer.updated`. ### Transfers fields (17) | Field | Type | Optional | |-----------------------|---------|------------| | `amount` | long | Yes | | `amount_reversed` | long | Yes | | `balance_transaction` | string | Yes | | `created` | long | Yes | | `currency` | string | Yes | | `description` | string | Yes | | `destination` | string | Yes | | `destination_payment` | string | Yes | | `id` | string | No | | `livemode` | boolean | Yes | | `metadata` | string | Yes | | `object` | string | Yes | | `reversals` | string | Yes | | `reversed` | boolean | Yes | | `source_transaction` | string | Yes | | `source_type` | string | Yes | | `transfer_group` | string | Yes |