Dimension list for Stripe

177 dimensions available

CategoryFieldCodeDescription
TIMEYearyearYear, e.g. 2017
Quarterquarter
Year & monthyearmonthYear and month, e.g. 2017|06
Year & week (Sun-Sat)yearweekYear and week for US weeks, e.g. 2017|08
Year & week (Mon-Sun)yearweekisoYear and week for ISO weeks, e.g. 2017|08
Year of week (Sun-Sat)yearofweekYear of week for US weeks, e.g. 2017
Year of week (Mon-Sun)yearofweekisoYear of week for ISO weeks, e.g. 2017
MonthmonthMonth, e.g. 6
Week (Sun-Sat)weekUS week number, e.g. 51
Week (Mon-Sun)weekisoISO week number, e.g. 51
Day of weekdayofweek
Day of week (Sun-Sat)dayofweeknameDay of week name for US weeks, e.g. 0 Sunday
Day of week (Mon-Sun)dayofweeknameisoDay of week name for ISO weeks, e.g. 1 Sunday
DatedateDate, e.g. 2017-01-31
Day of monthdayofmonthDay of month, e.g. 2
Hourhour
Minuteminute
ACCOUNTAccount IDaccount_id
Account nameaccount_name
CUSTOMERCustomer IDcustomer_idUnique identifier for the object.
Customer currencycustomer_currencyThree-letter ISO code for the currency the customer can be charged in for recurring billing purposes.
Customer emailcustomer_emailThe customer's email address.
Customer VAT IDcustomer_vat_idUnique identifier for the object.
Customer is delinquentcustomer_delinquentWhen 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.
SOURCESource IDsource_idUnique identifier for the object.
Source typesource_typeThe type of the source. The type is a payment method.
Source address line 1source_address_line_1Address line 1 (Street address/PO Box/Company name).
Source address line 2source_address_line_2Address line 2 (Apartment/Suite/Unit/Building).
Source address citysource_address_cityCity/District/Suburb/Town/Village.
Source address statesource_address_stateState/County/Province/Region.
Source address countrysource_address_countryBilling address country, if provided when creating card.
Source address zip codesource_address_zipZIP or postal code.
Source address zip code checksource_address_zip_checkIf address_zip was provided, results of the check: pass, fail, unavailable, or unchecked.
Source metadatasource_metadataSet 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 CARDCard brandsource_card_brandCard brand. Can be American Express, Diners Club, Discover, JCB, MasterCard, UnionPay, Visa, or Unknown.
Card funding typesource_card_fundingCard funding type. Can be credit, debit, prepaid, or unknown.
Card country codesource_card_countryTwo-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 namesource_card_nameCardholder name.
Card expiration monthsource_card_exp_monthTwo digit number representing the card's expiration month.
Card expiration yearsource_card_exp_yearFour digit number representing the card's expiration year.
Card fingerprintsource_card_fingerprintUniquely 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 methodsource_card_tokenizationIf the card number is tokenized, this is the method that was used. Can be apple_pay or google_pay.
Card CVC checksource_card_cvc_checkIf a CVC was provided, results of the check: pass, fail, unavailable, or unchecked.
Card last 4 digitssource_card_last4The last four digits of the card.
Card last 4 digits (dynamic)source_card_last4_dynamic(For tokenized numbers only.) The last four digits of the device account number.
SHIPPING ADDRESSShipping carriershipping_carrierThe 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 numbershipping_tracking_numberThe 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 nameshipping_recipient_nameThe name of the customer.
Shipping recipient phoneshipping_recipient_phoneThe recipient's phone number.
Shipping address line 1shipping_line_1Address line 1 (Street address/PO Box/Company name).
Shipping address line 2shipping_line_2Address line 2 (Apartment/Suite/Unit/Building).
Shipping zip codeshipping_address_zipZIP or postal code.
Shipping cityshipping_address_cityCity/District/Suburb/Town/Village.
Shipping stateshipping_stateState/County/Province/Region.
Shipping countryshipping_address_countryBilling address country, if provided when creating card.
COUPONCoupon IDcoupon_idUnique identifier for the object.
Coupon durationcoupon_durationOne of forever, once, and repeating. Describes how long a customer who applies this coupon will get the discount.
Coupon percent offcoupon_percent_offPercent 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 datecoupon_redeem_byDate after which the coupon can no longer be redeemed.
Coupon is validcoupon_validTaking account of the above properties, whether this coupon can still be applied to a customer.
Coupon metadatacoupon_metadataA 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
APPLICATIONApplication IDapp_idUnique identifier for the object.
APPLICATION FEEApplication fee IDapp_fee_idUnique identifier for the object.
Fee currencyapp_fee_currencyThree-letter ISO currency code, in lowercase.
Fee is refundedapp_fee_refundedWhether the fee has been fully refunded. If the fee is only partially refunded, this attribute will still be false.
Originating transaction IDapp_fee_orig_transactionID of the corresponding charge on the platform account, if this fee was the result of a charge using the destinationparameter.
BALANCEBalance typebalance_typeString representing the object's type. Objects of the same type share the same value.
Balance currencybalance_currencyThree-letter ISO currency code, in lowercase.
BALANCE TRANSACTIONTransaction IDtransaction_idUnique identifier for the object.
Transaction typetransaction_typeTransaction 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 statustransaction_statusIf the transaction's net funds are available in the Stripe balance yet. Either available or pending.
Transaction available datetransaction_available_dateThe date the transaction's net funds will become available in the Stripe balance.
Transaction currencytransaction_currencyThree-letter ISO currency code, in lowercase.
Transaction descriptiontransaction_descriptionAn arbitrary string attached to the object. Often useful for displaying to users.
First fee typetransaction_fee_typeType of the fee, one of: application_fee, stripe_fee or tax.
First fee descriptiontransaction_fee_descriptionAn arbitrary string attached to the object. Often useful for displaying to users.
CHARGECharge IDcharge_idUnique identifier for the object.
Charge typecharge_typeString representing the object's type. Objects of the same type share the same value.
Charge statuscharge_statusThe status of the payment is either succeeded, pending, or failed.
Charge currencycharge_currencyThe status of the payment is either succeeded, pending, or failed.
Charge descriptioncharge_descriptionAn arbitrary string attached to the object. Often useful for displaying to users.
Charge on behalf ofcharge_on_behalf_ofThe account (if any) the charge was made on behalf of without triggering an automatic transfer.
Charge is capturedcharge_capturedIf the charge was created without capturing, this Boolean represents whether it is still uncaptured or has since been captured.
Charge is paidcharge_paidtrue if the charge succeeded, or was successfully authorized for later capture.
Charge is refundedcharge_refundedWhether the charge has been fully refunded. If the charge is only partially refunded, this attribute will still be false.
Charge statement descriptorcharge_statementExtra information about a charge. This will appear on your customer's credit card statement. It must contain at least one letter.
Charge failure codecharge_failure_codeError code explaining reason for charge failure if available.
Charge failure messagecharge_failure_messageMessage to user further explaining reason for charge failure if available.
Charge receipt emailcharge_receipt_emailThis is the email address that the receipt for this charge was sent to.
Charge receipt numbercharge_receipt_numberThis 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 groupcharge_transfer_groupA string that identifies this transaction as part of a group. See the Connect documentation for details.
Charge metadatacharge_metadataSet 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 typecharge_outcome_typePossible values are authorized, manual_review, issuer_declined, blocked, and invalid.
Outcome network statuscharge_outcome_network_statusPossible 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 levelcharge_outcome_risk_levelStripe'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 reasoncharge_outcome_reasonAn 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 messagecharge_outcome_seller_messageA human-readable description of the outcome type and reason, designed for you (the recipient of the payment), not your customer.
Fraud user reportcharge_fraud_user_reportAssessments reported by you. If set, possible values of are safe and fraudulent
Fraud user detailscharge_fraud_detailsInformation on fraud assessments for the charge.
TRANSFERTransfer IDtransfer_idUnique identifier for the object.
Transfers currencytransfer_currencyThree-letter ISO currency code, in lowercase.
Transfers descriptiontransfer_descriptionAn arbitrary string attached to the object. Often useful for displaying to users.
Transfer is reversedtransfer_reversedWhether the transfer has been fully reversed. If the transfer is only partially reversed, this attribute will still be false.
Transfer source typetransfer_source_typeThe source balance this transfer came from. One of card, financing, bank_account, or alipay_account.
Transfer source transaction IDtransfer_source_transaction_idUnique identifier for the object.
Transfers destination payment IDtransfer_destination_payment_idUnique identifier for the object.
Transfer group IDtransfer_group_idUnique identifier for the object.
Transfer metadatatransfer_metadataA 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 ACCOUNTDestination IDdestination_idUnique identifier for the object.
INVOICEInvoice IDinvoice_idThe ID of the invoice this invoice item belongs to.
Invoice currencyinvoice_currencyThree-letter ISO currency code, in lowercase.
Invoice descriptioninvoice_descriptionAn arbitrary string attached to the object. Often useful for displaying to users. Referenced as 'memo' in the Dashboard.
Invoice period start timeinvoice_period_startStart of the usage period during which invoice items were added to this invoice.
Invoice period end timeinvoice_period_endEnd of the usage period during which invoice items were added to this invoice.
Invoice next payment attemptinvoice_next_payment_attemptThe time at which payment will next be attempted. This value will be null for invoices where billing=send_invoice.
Invoice is paidinvoice_paidWhether 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.
Invoice is closedinvoice_closed
Invoice is forgiveninvoice_forgiven
Invoice metadatainvoice_metadataSet 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 numberinvoice_receipt_numberThis 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 descriptorinvoice_statementExtra information about a charge. This will appear on your customer's credit card statement. It must contain at least one letter.
ORDEROrder IDorder_idUnique identifier for the object.
Order statusorder_statusCurrent order status. One of created, paid, canceled, fulfilled, or returned.
Order currencyorder_currencyThree-letter ISO currency code, in lowercase.
Order emailorder_emailThe email address of the customer placing the order.
Order shipping methodorder_shipping_methodThe 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 timeorder_paid_time
Order fulfilled timeorder_fulfilled_time
Order cancelled timeorder_cancelled_time
Order returned timeorder_returned_time
Order updated timeorder_updated_time
Order metadataorder_metadataA 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.
SUBSCRIPTIONSubscription IDsubscription_idUnique identifier for the object.
Subscription statussubscription_statusPossible 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 timesubscription_start_timeDate 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 timesubscription_end_timeIf the subscription has ended, the date the subscription ended.
Subscription cancel timesubscription_cancel_timeIf 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 endsubscription_cancel_period_endBoolean indicating whether this subscription should cancel at the end of the current period.
Subscription trial start timesubscription_trial_startIf the subscription has a trial, the beginning of that trial.
Subscription trial end timesubscription_trial_endUnix 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 timesubscription_period_startStart of the current period that the subscription has been invoiced for
Subscription period end timesubscription_period_endEnd of the current period that the subscription has been invoiced for. At the end of this period, a new invoice will be created
Subscription metadatasubscription_metadataA 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 PLANPlan idsubscription_plan_idUnique identifier for the object.
Plan namesubscription_plan_nameA brief description of the plan, hidden from customers.
Plan intervalsubscription_plan_intervalOne of day, week, month or year. The frequency with which a subscription should be billed.
Plan statement descriptorsubscription_plan_statement
Plan metadatasubscription_plan_metadataSet 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.
PAYOUTPayout IDpayout_idUnique identifier for the object.
Payout typepayout_typeCan be bank_account or card.
Payout statuspayout_statusOnly return payouts that have the given status: pending, paid, failed, or canceled.
Payout currencypayout_currencyThree-letter ISO currency code, in lowercase.
Payout arrival datepayout_arrival_dateDate the payout is expected to arrive in the bank. This factors in delays like weekends or bank holidays.
Payout methodpayout_methodThe method used to send this payout, which can be standard or instant.
Payout descriptionpayout_descriptionAn arbitrary string attached to the object. Often useful for displaying to users.
Payout statement descriptorpayout_statementExtra information about a payout to be displayed on the user's bank statement.
Payout source typepayout_source_typeThe 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 codepayout_failure_codeError code explaining reason for payout failure if available.
Payout failure messagepayout_failure_messageMessage to user further explaining reason for payout failure if available.
Payout failure transaction IDpayout_failure_transaction_idUnique identifier for the object.
Payout metadatapayout_metadataSet 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.
REFUNDRefund IDrefund_idUnique identifier for the object.
Refund statusrefund_statusStatus 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 currencyrefund_currencyThree-letter ISO currency code, in lowercase.
Refund reasonrefund_reasonReason for the refund. If set, possible values are duplicate, fraudulent, and requested_by_customer.
Refund receipt numberrefund_receipt_numberThis is the transaction number that appears on email receipts sent for this refund.
Refund metadatarefund_metadataSet 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.
DISPUTEDispute IDdispute_idUnique identifier for the object.
Dispute statusdispute_statusCurrent status of dispute. Possible values are warning_needs_response, warning_under_review, warning_closed, needs_response, under_review, charge_refunded, won, or lost.
Dispute reasondispute_reasonReason 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 currencydispute_currencyThree-letter ISO currency code, in lowercase.
Dispute charge is refundabledispute_charge_refundableIf 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 metadatadispute_metadataSet 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 evidencedispute_has_evidenceWhether evidence has been staged for this dispute.
Evidence due by datedispute_evidence_due_byDate 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 duedispute_evidence_past_dueWhether 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.
REVIEWReview IDreview_idUnique identifier for the object.