Supermetrics brings all your marketing data into Google Sheets, Google Data Studio, Excel, BigQuery, Snowflake, Redshift, Azure
| Category | Field | Code | Type | Description |
|---|---|---|---|---|
| TIME | Year | year | dim | Year, e.g. 2017 |
| Quarter | quarter | dim | ||
| Year & month | yearmonth | dim | Year and month, e.g. 2017|06 | |
| Year & week (Sun-Sat) | yearweek | dim | Year and week for US weeks, e.g. 2017|08 | |
| Year & week (Mon-Sun) | yearweekiso | dim | Year and week for ISO weeks, e.g. 2017|08 | |
| Year of week (Sun-Sat) | yearofweek | dim | Year of week for US weeks, e.g. 2017 | |
| Year of week (Mon-Sun) | yearofweekiso | dim | Year of week for ISO weeks, e.g. 2017 | |
| Month | month | dim | Month, e.g. 6 | |
| Week (Sun-Sat) | week | dim | US week number, e.g. 51 | |
| Week (Mon-Sun) | weekiso | dim | ISO week number, e.g. 51 | |
| Day of week | dayofweek | dim | ||
| Day of week (Sun-Sat) | dayofweekname | dim | Day of week name for US weeks, e.g. 0 Sunday | |
| Day of week (Mon-Sun) | dayofweeknameiso | dim | Day of week name for ISO weeks, e.g. 1 Sunday | |
| Date | date | dim | Date, e.g. 2017-01-31 | |
| Day of month | dayofmonth | dim | Day of month, e.g. 2 | |
| Hour | hour | dim | ||
| Minute | minute | dim | ||
| ACCOUNT | Account ID | account_id | dim | |
| Account name | account_name | dim | ||
| CUSTOMER | Customer ID | customer_id | dim | Unique identifier for the object |
| Customer currency | customer_currency | dim | Three-letter ISO code for the currency the customer can be charged in for recurring billing purposes | |
| Customer email | customer_email | dim | The customer's email address | |
| Customer VAT ID | customer_vat_id | dim | Unique identifier for the object | |
| Customer is delinquent | customer_delinquent | dim | When the customer's latest invoice is billed by charging automatically, delinquent is true if the invoice's latest charge is failed. When the customer's latest invoice is billed by sending an invoice, delinquent is true if the invoice is not paid by its due date | |
| SOURCE | Source ID | source_id | dim | Unique identifier for the object |
| Source type | source_type | dim | The type of the source. The type is a payment method | |
| Source address line 1 | source_address_line_1 | dim | Address line 1 (Street address/PO Box/Company name) | |
| Source address line 2 | source_address_line_2 | dim | Address line 2 (Apartment/Suite/Unit/Building) | |
| Source address city | source_address_city | dim | City/District/Suburb/Town/Village | |
| Source address state | source_address_state | dim | State/County/Province/Region | |
| Source address country | source_address_country | dim | Billing address country, if provided when creating card | |
| Source address zip code | source_address_zip | dim | ZIP or postal code | |
| Source address zip code check | source_address_zip_check | dim | If address_zip was provided, results of the check: pass, fail, unavailable, or unchecked | |
| Source metadata | source_metadata | dim | Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format | |
| SOURCE CARD | Card brand | source_card_brand | dim | Card brand. Can be American Express, Diners Club, Discover, JCB, MasterCard, UnionPay, Visa, or Unknown |
| Card funding type | source_card_funding | dim | Card funding type. Can be credit, debit, prepaid, or unknown | |
| Card country code | source_card_country | dim | Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected | |
| Card holder name | source_card_name | dim | Cardholder name | |
| Card expiration month | source_card_exp_month | dim | Two digit number representing the card's expiration month | |
| Card expiration year | source_card_exp_year | dim | Four digit number representing the card's expiration year | |
| Card fingerprint | source_card_fingerprint | dim | Uniquely identifies this particular card number. You can use this attribute to check whether two customers who've signed up with you are using the same card number, for example | |
| Card tokenization method | source_card_tokenization | dim | If the card number is tokenized, this is the method that was used. Can be apple_pay or google_pay | |
| Card CVC check | source_card_cvc_check | dim | If a CVC was provided, results of the check: pass, fail, unavailable, or unchecked | |
| Card last 4 digits | source_card_last4 | dim | The last four digits of the card | |
| Card last 4 digits (dynamic) | source_card_last4_dynamic | dim | (For tokenized numbers only.) The last four digits of the device account number | |
| SHIPPING ADDRESS | Shipping carrier | shipping_carrier | dim | The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc. If multiple carriers were used for this purchase, please separate them with commas |
| Shipping tracking number | shipping_tracking_number | dim | The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas | |
| Shipping recipient name | shipping_recipient_name | dim | The name of the customer | |
| Shipping recipient phone | shipping_recipient_phone | dim | The recipient's phone number | |
| Shipping address line 1 | shipping_line_1 | dim | Address line 1 (Street address/PO Box/Company name) | |
| Shipping address line 2 | shipping_line_2 | dim | Address line 2 (Apartment/Suite/Unit/Building) | |
| Shipping zip code | shipping_address_zip | dim | ZIP or postal code | |
| Shipping city | shipping_address_city | dim | City/District/Suburb/Town/Village | |
| Shipping state | shipping_state | dim | State/County/Province/Region | |
| Shipping country | shipping_address_country | dim | Billing address country, if provided when creating card | |
| COUPON | Coupon ID | coupon_id | dim | Unique identifier for the object |
| Coupon duration | coupon_duration | dim | One of forever, once, and repeating. Describes how long a customer who applies this coupon will get the discount | |
| Coupon percent off | coupon_percent_off | dim | Percent that will be taken off the subtotal of any invoices for this customer for the duration of the coupon. For example, a coupon with percent_off of 50 will make a $100 invoice $50 instead | |
| Coupon redeem by date | coupon_redeem_by | dim | Date after which the coupon can no longer be redeemed | |
| Coupon is valid | coupon_valid | dim | Taking account of the above properties, whether this coupon can still be applied to a customer | |
| Coupon metadata | coupon_metadata | dim | A set of key-value pairs that you can attach to a coupon object. It can be useful for storing additional information about the coupon in a structured format | |
| APPLICATION | Application ID | app_id | dim | Unique identifier for the object |
| APPLICATION FEE | Application fee ID | app_fee_id | dim | Unique identifier for the object |
| Fee currency | app_fee_currency | dim | Three-letter ISO currency code, in lowercase | |
| Fee is refunded | app_fee_refunded | dim | Whether the fee has been fully refunded. If the fee is only partially refunded, this attribute will still be false | |
| Originating transaction ID | app_fee_orig_transaction | dim | ID of the corresponding charge on the platform account, if this fee was the result of a charge using the destinationparameter | |
| BALANCE | Balance type | balance_type | dim | String representing the object's type. Objects of the same type share the same value |
| Balance currency | balance_currency | dim | Three-letter ISO currency code, in lowercase | |
| BALANCE TRANSACTION | Transaction ID | transaction_id | dim | Unique identifier for the object |
| Transaction type | transaction_type | dim | Transaction type: adjustment, advance, advance_funding, application_fee, application_fee_refund, charge, connect_collection_transfer, issuing_authorization_hold, issuing_authorization_release, issuing_transaction, payment, payment_failure_refund, payment_refund, payout, payout_cancel, payout_failure, refund, refund_failure, reserve_transaction, reserved_funds, stripe_fee, stripe_fx_fee, tax_fee, topup, topup_reversal, transfer, transfer_cancel, transfer_failure, or transfer_refund | |
| Transaction status | transaction_status | dim | If the transaction's net funds are available in the Stripe balance yet. Either available or pending | |
| Transaction available date | transaction_available_date | dim | The date the transaction's net funds will become available in the Stripe balance | |
| Transaction currency | transaction_currency | dim | Three-letter ISO currency code, in lowercase | |
| Transaction description | transaction_description | dim | An arbitrary string attached to the object. Often useful for displaying to users | |
| First fee type | transaction_fee_type | dim | Type of the fee, one of: application_fee, stripe_fee or tax | |
| First fee description | transaction_fee_description | dim | An arbitrary string attached to the object. Often useful for displaying to users | |
| CHARGE | Charge ID | charge_id | dim | Unique identifier for the object |
| Charge type | charge_type | dim | String representing the object's type. Objects of the same type share the same value | |
| Charge status | charge_status | dim | The status of the payment is either succeeded, pending, or failed | |
| Charge currency | charge_currency | dim | The status of the payment is either succeeded, pending, or failed | |
| Charge description | charge_description | dim | An arbitrary string attached to the object. Often useful for displaying to users | |
| Charge on behalf of | charge_on_behalf_of | dim | The account (if any) the charge was made on behalf of without triggering an automatic transfer | |
| Charge is captured | charge_captured | dim | If the charge was created without capturing, this Boolean represents whether it is still uncaptured or has since been captured | |
| Charge is paid | charge_paid | dim | true if the charge succeeded, or was successfully authorized for later capture | |
| Charge is refunded | charge_refunded | dim | Whether the charge has been fully refunded. If the charge is only partially refunded, this attribute will still be false | |
| Charge statement descriptor | charge_statement | dim | Extra information about a charge. This will appear on your customer's credit card statement. It must contain at least one letter | |
| Charge failure code | charge_failure_code | dim | Error code explaining reason for charge failure if available | |
| Charge failure message | charge_failure_message | dim | Message to user further explaining reason for charge failure if available | |
| Charge receipt email | charge_receipt_email | dim | This is the email address that the receipt for this charge was sent to | |
| Charge receipt number | charge_receipt_number | dim | This is the transaction number that appears on email receipts sent for this charge. This attribute will be null until a receipt has been sent | |
| Charge transfer group | charge_transfer_group | dim | A string that identifies this transaction as part of a group. See the Connect documentation for details | |
| Charge metadata | charge_metadata | dim | Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format | |
| Outcome type | charge_outcome_type | dim | Possible values are authorized, manual_review, issuer_declined, blocked, and invalid | |
| Outcome network status | charge_outcome_network_status | dim | Possible values are approved_by_network, declined_by_network, not_sent_to_network, and reversed_after_approval. The value reversed_after_approval indicates the payment was blocked by Stripe after bank authorization, and may temporarily appear as "pending" on a cardholder's statement | |
| Outcome risk level | charge_outcome_risk_level | dim | Stripe's evaluation of the riskiness of the payment. Possible values for evaluated payments are normal, elevated, highest. For non-card payments, and card-based payments predating the public assignment of risk levels, this field will have the value not_assessed. In the event of an error in the evaluation, this field will have the value unknown | |
| Outcome reason | charge_outcome_reason | dim | An enumerated value providing a more detailed explanation of the outcome's type. Charges blocked by Radar's default block rule have the value highest_risk_level. Charges placed in review by Radar's default review rule have the value elevated_risk_level. Charges authorized, blocked, or placed in review by custom rules have the value rule | |
| Outcome seller message | charge_outcome_seller_message | dim | A human-readable description of the outcome type and reason, designed for you (the recipient of the payment), not your customer | |
| Fraud user report | charge_fraud_user_report | dim | Assessments reported by you. If set, possible values of are safe and fraudulent | |
| Fraud user details | charge_fraud_details | dim | Information on fraud assessments for the charge | |
| TRANSFER | Transfer ID | transfer_id | dim | Unique identifier for the object |
| Transfers currency | transfer_currency | dim | Three-letter ISO currency code, in lowercase | |
| Transfers description | transfer_description | dim | An arbitrary string attached to the object. Often useful for displaying to users | |
| Transfer is reversed | transfer_reversed | dim | Whether the transfer has been fully reversed. If the transfer is only partially reversed, this attribute will still be false | |
| Transfer source type | transfer_source_type | dim | The source balance this transfer came from. One of card, financing, bank_account, or alipay_account | |
| Transfer source transaction ID | transfer_source_transaction_id | dim | Unique identifier for the object | |
| Transfers destination payment ID | transfer_destination_payment_id | dim | Unique identifier for the object | |
| Transfer group ID | transfer_group_id | dim | Unique identifier for the object | |
| Transfer metadata | transfer_metadata | dim | A set of key-value pairs that you can attach to a transfer object. It can be useful for storing additional information about the transfer in a structured format | |
| DESTINATION ACCOUNT | Destination ID | destination_id | dim | Unique identifier for the object |
| INVOICE | Invoice ID | invoice_id | dim | The ID of the invoice this invoice item belongs to |
| Invoice currency | invoice_currency | dim | Three-letter ISO currency code, in lowercase | |
| Invoice description | invoice_description | dim | An arbitrary string attached to the object. Often useful for displaying to users. Referenced as 'memo' in the Dashboard | |
| Invoice period start time | invoice_period_start | dim | Start of the usage period during which invoice items were added to this invoice | |
| Invoice period end time | invoice_period_end | dim | End of the usage period during which invoice items were added to this invoice | |
| Invoice next payment attempt | invoice_next_payment_attempt | dim | The time at which payment will next be attempted. This value will be null for invoices where billing=send_invoice | |
| Invoice status | invoice_status | dim | The status of the invoice. Can have the values "draft", "open", "paid", "void", and "uncollectible" | |
| Invoice marked uncollectible | invoice_marked_uncollectible_at | dim | The time that the invoice was marked uncollectible | |
| Invoice metadata | invoice_metadata | dim | Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format | |
| Invoice receipt number | invoice_receipt_number | dim | This is the transaction number that appears on email receipts sent for this charge. This attribute will be null until a receipt has been sent | |
| Invoice statement descriptor | invoice_statement | dim | Extra information about a charge. This will appear on your customer's credit card statement. It must contain at least one letter | |
| TAX RATES | Tax rate id | tax_rate_id | dim | Unique identifier for the object |
| Tax rate description | tax_rate_description | dim | An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers | |
| Tax rate name | tax_rate_name | dim | The display name of the tax rates as it will appear to your customer on their receipt email, PDF, and the hosted invoice page | |
| Tax rate jurisdiction | tax_rate_jurisdiction | dim | The jurisdiction for the tax rate. You can use this label field for tax reporting purposes. It also appears on your customer’s invoice | |
| INVOICE ITEM | Invoice item ID | invoice_item_id | dim | Unique identifier for the object |
| Invoice item currency | invoice_item_currency | dim | Three-letter ISO currency code | |
| Invoice item description | invoice_item_description | dim | An arbitrary string attached to the object. Often useful for displaying to users | |
| ORDER | Order ID | order_id | dim | Unique identifier for the object |
| Order status | order_status | dim | Current order status. One of created, paid, canceled, fulfilled, or returned | |
| Order currency | order_currency | dim | Three-letter ISO currency code, in lowercase | |
| Order email | order_email | dim | The email address of the customer placing the order | |
| Order shipping method | order_shipping_method | dim | The shipping method to select for fulfilling this order. If specified, must be one of the ids of a shipping method in the shipping_methods | |
| Order paid time | order_paid_time | dim | ||
| Order fulfilled time | order_fulfilled_time | dim | ||
| Order cancelled time | order_cancelled_time | dim | ||
| Order returned time | order_returned_time | dim | ||
| Order updated time | order_updated_time | dim | ||
| Order metadata | order_metadata | dim | A set of key-value pairs that you can attach to a product object. It can be useful for storing additional information about the order in a structured format | |
| SUBSCRIPTION | Subscription ID | subscription_id | dim | Unique identifier for the object |
| Subscription status | subscription_status | dim | Possible values are trialing, active, past_due, canceled, or unpaid. A subscription still in its trial period is trialing and moves to active when the trial period is over. If subscription billing=charge_automatically it becomes past_due when payment to renew it fails and canceled or unpaid (depending on your subscriptions settings) when Stripe has exhausted all payment retry attempts. If subscription billing=send_invoice it becomes past_due when its invoice is not paid by the due date, and canceled or unpaid if it is still not paid by an additional deadline after that. Note that when a subscription has a status of unpaid, no subsequent invoices will be attempted (invoices will be created, but then immediately automatically closed.) | |
| Subscription start time | subscription_start_time | dim | Date of the last substantial change to this subscription. For example, a change to the items array, or a change of status, will reset this timestamp | |
| Subscription end time | subscription_end_time | dim | If the subscription has ended, the date the subscription ended | |
| Subscription cancel time | subscription_cancel_time | dim | If the subscription has been canceled, the date of that cancellation. If the subscription was canceled with cancel_at_period_end, canceled_atwill still reflect the date of the initial cancellation request, not the end of the subscription period when the subscription is automatically moved to a canceled state | |
| Cancel at period end | subscription_cancel_period_end | dim | Boolean indicating whether this subscription should cancel at the end of the current period | |
| Subscription trial start time | subscription_trial_start | dim | If the subscription has a trial, the beginning of that trial | |
| Subscription trial end time | subscription_trial_end | dim | Unix timestamp representing the end of the trial period the customer will get before being charged for the first time. This will always overwrite any trials that might apply via a subscribed plan | |
| Subscription period start time | subscription_period_start | dim | Start of the current period that the subscription has been invoiced for | |
| Subscription period end time | subscription_period_end | dim | End of the current period that the subscription has been invoiced for. At the end of this period, a new invoice will be created | |
| Subscription metadata | subscription_metadata | dim | A set of key-value pairs that you can attach to a Subscription object. It can be useful for storing additional information about the subscription in a structured format | |
| SUBSCRIPTION PLAN | Plan id | subscription_plan_id | dim | Unique identifier for the object |
| Product ID | product_id | dim | Unique identifier for the object | |
| Product name | subscription_product_name | dim | A brief description of the product | |
| Plan name | subscription_plan_name | dim | A brief description of the plan, hidden from customers | |
| Plan interval | subscription_plan_interval | dim | One of day, week, month or year. The frequency with which a subscription should be billed | |
| Plan statement descriptor | subscription_plan_statement | dim | ||
| Plan metadata | subscription_plan_metadata | dim | Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format | |
| SUBSCRIPTION ITEM | Subscription item ID | subscription_item_id | dim | Unique identifier for the object |
| Subscription item currency | subscription_item_currency | dim | Three-letter ISO currency code | |
| Subscription items description | subscription_item_description | dim | An arbitrary string attached to the object. Often useful for displaying to users | |
| PAYOUT | Payout ID | payout_id | dim | Unique identifier for the object |
| Payout type | payout_type | dim | Can be bank_account or card | |
| Payout status | payout_status | dim | Only return payouts that have the given status: pending, paid, failed, or canceled | |
| Payout currency | payout_currency | dim | Three-letter ISO currency code, in lowercase | |
| Payout arrival date | payout_arrival_date | dim | Date the payout is expected to arrive in the bank. This factors in delays like weekends or bank holidays | |
| Payout method | payout_method | dim | The method used to send this payout, which can be standard or instant | |
| Payout description | payout_description | dim | An arbitrary string attached to the object. Often useful for displaying to users | |
| Payout statement descriptor | payout_statement | dim | Extra information about a payout to be displayed on the user's bank statement | |
| Payout source type | payout_source_type | dim | The source balance to use for this transfer. One of card, financing, bank_account, or alipay_account. For most users, this will default to card | |
| Payout failure code | payout_failure_code | dim | Error code explaining reason for payout failure if available | |
| Payout failure message | payout_failure_message | dim | Message to user further explaining reason for payout failure if available | |
| Payout failure transaction ID | payout_failure_transaction_id | dim | Unique identifier for the object | |
| Payout metadata | payout_metadata | dim | Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format | |
| REFUND | Refund ID | refund_id | dim | Unique identifier for the object |
| Refund status | refund_status | dim | Status of the refund. For credit card refunds, this can be succeeded or failed. For other types of refunds, it can be pending, succeeded, failed, or canceled | |
| Refund currency | refund_currency | dim | Three-letter ISO currency code, in lowercase | |
| Refund reason | refund_reason | dim | Reason for the refund. If set, possible values are duplicate, fraudulent, and requested_by_customer | |
| Refund receipt number | refund_receipt_number | dim | This is the transaction number that appears on email receipts sent for this refund | |
| Refund metadata | refund_metadata | dim | Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format | |
| DISPUTE | Dispute ID | dispute_id | dim | Unique identifier for the object |
| Dispute status | dispute_status | dim | Current status of dispute. Possible values are warning_needs_response, warning_under_review, warning_closed, needs_response, under_review, charge_refunded, won, or lost | |
| Dispute reason | dispute_reason | dim | Reason given by cardholder for dispute. Possible values are duplicate, fraudulent, subscription_canceled, product_unacceptable, product_not_received, unrecognized, credit_not_processed, general, incorrect_account_details, insufficient_funds, bank_cannot_process, debit_not_authorized, or customer_initiated | |
| Dispute currency | dispute_currency | dim | Three-letter ISO currency code, in lowercase | |
| Dispute charge is refundable | dispute_charge_refundable | dim | If true, it is still possible to refund the disputed payment. Once the payment has been fully refunded, no further funds will be withdrawn from your Stripe account as a result of this dispute | |
| Dispute metadata | dispute_metadata | dim | Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format | |
| Has evidence | dispute_has_evidence | dim | Whether evidence has been staged for this dispute | |
| Evidence due by date | dispute_evidence_due_by | dim | Date by which evidence must be submitted in order to successfully challenge dispute. Will be null if the customer's bank or credit card company doesn't allow a response for this particular dispute | |
| Evidence is past due | dispute_evidence_past_due | dim | Whether the last evidence submission was submitted past the due date. Defaults to false if no evidence submissions have occurred. If true, then delivery of the latest evidence is not guaranteed | |
| REVIEW | Review ID | review_id | dim | Unique identifier for the object |
| DEPRECATED | Invoice is paid | invoice_paid | dim | Whether payment was successfully collected for this invoice. An invoice can be paid (most commonly) with a charge or with credit from the customer's account balance. Please note that this field will be removed on 2021-08-12 |
| Invoice is forgiven | invoice_forgiven | dim | Please note that this field will be removed on 2021-08-12 | |
| Invoice is closed | invoice_closed | dim | Please note that this field will be removed on 2021-08-12 | |
| BALANCE | Balance amount | balance_amount | met | Gross amount of the transaction, in cents |
| Card balance | balance_source_card | met | ||
| Bank account balance | balance_source_bank | met | Current balance, if any, being stored on the customer's account. If negative, the customer has credit to apply to the next invoice. If positive, the customer has an amount owed that will be added to the next invoice. The balance does not refer to any unpaid invoices; it solely takes into account amounts that have yet to be successfully applied to any invoice. This balance is only taken into account as invoices are finalized. Note that the balance does not include unpaid invoices | |
| Bitcoin receiver balance | balance_source_bitcoin | met | ||
| BALANCE TRANSACTION | Transaction amount | transaction_amount | met | Gross amount of the transaction, in cents |
| Transaction net | transaction_net | met | Net amount of the transaction, in cents | |
| Transaction fee | transaction_fee | met | Fees (in cents) paid for this transaction | |
| Transaction refund | transaction_refund | met | ||
| Transaction charge (%) | transaction_charge_percent | met | ||
| Transaction fee (%) | transaction_fee_percent | met | Fees (in cents) paid for this transaction | |
| Transaction refund (%) | transaction_refund_percent | met | ||
| Transaction average amount | transaction_average_amount | met | ||
| Transaction average net | transaction_average_net | met | ||
| Transaction average charge | transaction_average_charge | met | ||
| Transaction average refund | transaction_average_refund | met | ||
| Charge amount | transaction_charge_amount | met | Amount of the fee, in cents | |
| Charge net | transaction_charge_net | met | Net amount of the transaction, in cents | |
| Charge fee | transaction_charge_fee | met | Fees (in cents) paid for this transaction | |
| Charge fee (%) | charge_fee_percent | met | ||
| Charge average amount | charge_average_amount | met | ||
| Charge average net | charge_average_net | met | ||
| Charge average fee | charge_average_fee | met | ||
| Transactions | transactions | met | ||
| Charge transactions | transaction_charges | met | ||
| Fee transactions | transaction_fees | met | ||
| Refund transactions | transaction_refunds | met | ||
| CUSTOMER | Customer balance | customer_account_balance | met | An integer amount in JPY that represents the account balance for your customer. Account balances only affect invoices. A negative amount represents a credit that decreases the amount due on an invoice; a positive amount increases the amount due on an invoice |
| COUPON | Duration in months | coupon_duration_in_months | met | If duration is repeating, the number of months the coupon applies. Null if coupon duration is forever or once |
| Amount off | coupon_amount_off | met | Amount (in the currency specified) that will be taken off the subtotal of any invoices for this customer | |
| Max redeems | coupon_max_redeems | met | Maximum number of times this coupon can be redeemed, in total, across all customers, before it is no longer valid | |
| Times redeemed | coupon_times_redeemed | met | Number of times this coupon has been applied to a customer | |
| APPLICATION FEE | Fee amount | app_fee_amount | met | Amount earned, in cents |
| Fee refunded amount | app_fee_amount_refunded | met | Amount, in cents | |
| CHARGE | Charge amount | charge_amount | met | A positive integer in the smallest currency unit (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency) representing how much to charge. The minimum amount is $0.50 US or equivalent in charge currency |
| Charge refunded amount | charge_amount_refunded | met | Amount in cents refunded (can be less than the amount attribute on the charge if a partial refund was issued) | |
| Charge application fee | charge_app_fee | met | The application fee (if any) for the charge | |
| TRANSFER | Transfer amount | transfer_amount | met | Amount in cents to be transferred |
| Transfer reversed amount | transfer_amount_reversed | met | Amount in cents reversed (can be less than the amount attribute on the transfer if a partial reversal was issued) | |
| INVOICE | Invoice due amount | invoice_amount_due | met | Final amount due at this time for this invoice. If the invoice's total is smaller than the minimum charge amount, for example, or if there is account credit that can be applied to the invoice, the amount_due may be 0. If there is a positive starting_balance for the invoice (the customer owes money), the amount_due will also take that into account. The charge that gets generated for the invoice will be for the amount specified in amount_due |
| Invoice total | invoice_total | met | Total after discount | |
| Invoice subtotal | invoice_subtotal | met | Total of all subscriptions, invoice items, and prorations on the invoice before any discount is applied | |
| Invoice tax (%) | invoice_tax_percent | met | This percentage of the subtotal has been added to the total amount of the invoice, including invoice line items and discounts. This field is inherited from the subscription's tax_percent field, but can be changed before the invoice is paid | |
| Invoice tax | invoice_tax | met | The amount of tax included in the total, calculated from tax_percent and the subtotal. If no tax_percent is defined, this value will be null | |
| Invoice application fee | invoice_app_fee | met | The fee in cents that will be applied to the invoice and transferred to the application owner's Stripe account when the invoice is paid | |
| Invoice payment attempts | invoice_payment_attempts | met | Number of payment attempts made for this invoice, from the perspective of the payment retry schedule. Any payment attempt counts as the first attempt, and subsequently only automatic retries increment the attempt count. In other words, manual payment attempts after the first attempt do not affect the retry schedule | |
| Starting customer balance | invoice_amount_starting_balance | met | Starting customer balance before the invoice is finalized. If the invoice has not been finalized yet, this will be the current customer balance | |
| Ending customer balance | invoice_amount_ending_balance | met | Ending customer balance after the invoice is finalized. Invoices are finalized approximately an hour after successful webhook delivery or when payment collection is attempted for the invoice. If the invoice has not been finalized yet, this will be null | |
| INVOICE ITEM | Invoice item tax | invoice_item_tax | met | The amount of tax included for the item, calculated from tax_percent and the subtotal |
| Invoice item amount | invoice_item_amount | met | Amount (in the currency specified) of the invoice item | |
| ORDER | Order amount | order_amount | met | A positive integer in the smallest currency unit (that is, 100 cents for $1.00, or 1 for ¥1, Japanese Yen being a zero-decimal currency) representing the total amount for the order |
| Order returned amount | order_amount_returned | met | ||
| Order application fee | order_app_fee | met | ||
| SUBSCRIPTION | Subscription quantity | subscription_quantity | met | The quantity of the plan to which the customer is subscribed. For example, if your plan is $10/user/month, and your customer has 5 users, you could pass 5 as the quantity to have the customer charged $50 (5 x $10) monthly |
| Application fee (%) | subscription_appfee_percent | met | A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the application owner's Stripe account | |
| Subscription tax (%) | subscription_tax_percent | met | A non-negative decimal (with at most four decimal places) between 0 and 100. This represents the percentage of the subscription invoice subtotal that will be calculated and added as tax to the final amount in each billing period. For example, a plan which charges $10/month with a tax_percent of 20.0 will charge $12 per invoice. To unset a previously-set value, pass an empty string | |
| SUBSCRIPTION PLAN | Plan amount | subscription_plan_amount | met | A positive integer in cents (or 0 for a free plan) representing how much to charge on a recurring basis |
| Plan interval count | subscription_plan_intervals | met | The number of intervals between subscription billings. For example, interval=month and interval_count=3 bills every 3 months | |
| Plan trial days | subscription_plan_trial_days | met | Default number of trial days when subscribing a customer to this plan using trial_from_plan=true | |
| PAYOUT | Payout amount | payout_amount | met | Amount (in cents) to be transferred to your bank account or debit card |
| REFUND | Refund amount | refund_amount | met | Amount, in cents |
| DISPUTE | Dispute amount | dispute_amount | met | Disputed amount. Usually the amount of the disputed_transaction, but can differ (usually because of currency fluctuation or because only part of the order is disputed) |
| Evidence submissions | dispute_evidence_submissions | met | Evidence related to the dispute. This hash will contain exactly one non-null value, containing an evidence object that matches its reason |