Skip to content

Latest commit

 

History

History
880 lines (782 loc) · 264 KB

README.md

File metadata and controls

880 lines (782 loc) · 264 KB
Raw

Stripe Schema

For learning and inspiration, enjoy 👍

Slack

accounts

attribute type comment
id varchar Unique identifier for the object.
business_name varchar
business_url varchar
country varchar The account's country.
created timestamp Time at which the object was created. Measured in seconds since the Unix epoch.
debit_negative_balances boolean
default_currency varchar Three-letter ISO currency code representing the default currency for the account. This must be a currency that Stripe supports in the account's country.
details_submitted boolean Whether account details have been submitted. Standard accounts cannot receive payouts before this is true.
display_name varchar
email varchar The primary user's email address.
payout_statement_descriptor varchar
payouts_enabled boolean Whether Stripe can send payouts to this account.
charges_enabled boolean Whether the account can create live charges.
product_description varchar
statement_descriptor varchar
support_email varchar
support_phone varchar
timezone varchar
type varchar The type of the Stripe account. Can be express or custom.
decline_charge_on_cvc_failure boolean Whether Stripe automatically declines charges with an incorrect CVC. This setting only applies when a CVC is provided and it fails bank verification.
decline_charge_on_avs_failure boolean Whether Stripe automatically declines charges with an incorrect ZIP or postal code. This setting only applies when a ZIP or postal code is provided and they fail bank verification.
legal_entity_business_name varchar The company's legal name.
legal_entity_business_name_kana varchar The Kana variation of the company's legal name (Japan only).
legal_entity_business_name_kanji varchar The Kanji variation of the company's legal name (Japan only).
legal_entity_business_tax_id_provided boolean Whether the business ID number of the legal entity was provided.
legal_entity_business_vat_id_provided boolean Whether the business VAT number of the legal entity was provided.
legal_entity_first_name varchar The first name of the individual responsible for the account.
legal_entity_first_name_kana varchar The Kana variation of the first name of the individual responsible for the account (Japan only).
legal_entity_first_name_kanji varchar The Kanji variation of the first name of the individual responsible for the account (Japan only).
legal_entity_gender varchar The gender of the individual responsible for the account (International regulations require either "male" or "female").
legal_entity_last_name varchar The last name of the individual responsible for the account.
legal_entity_last_name_kana varchar The Kana varation of the last name of the individual responsible for the account (Japan only).
legal_entity_last_name_kanji varchar The Kanji varation of the last name of the individual responsible for the account (Japan only).
legal_entity_maiden_name varchar The maiden name of the individual responsible for the account.
legal_entity_personal_id_number_provided boolean Whether the personal ID number of the individual responsible for the account was provided.
legal_entity_phone_number varchar The company's phone number, used for verification.
legal_entity_ssn_last_4_provided boolean Whether the last 4 ssn digits of the individual responsible for the account have been provided.
legal_entity_tax_id_registrar varchar The jurisdiction in which the business_tax_id is registered (Germany-based companies only).
legal_entity_type varchar Either "individual" or "company", for what kind of legal entity the account owner is for.
legal_entity_address_city varchar City/District/Suburb/Town/Village.
legal_entity_address_country varchar 2-letter country code.
legal_entity_address_line1 varchar Address line 1 (Street address/PO Box/Company name).
legal_entity_address_line2 varchar Address line 2 (Apartment/Suite/Unit/Building).
legal_entity_address_postal_code varchar ZIP or postal code.
legal_entity_address_state varchar State/County/Province/Region.
legal_entity_address_kana_city varchar City/District/Suburb/Town/Village.
legal_entity_address_kana_country varchar 2-letter country code.
legal_entity_address_kana_line1 varchar Address line 1 (Street address/PO Box/Company name).
legal_entity_address_kana_line2 varchar Address line 2 (Apartment/Suite/Unit/Building).
legal_entity_address_kana_postal_code varchar ZIP or postal code.
legal_entity_address_kana_state varchar State/County/Province/Region.
legal_entity_address_kanji_city varchar City/District/Suburb/Town/Village.
legal_entity_address_kanji_country varchar 2-letter country code.
legal_entity_address_kanji_line1 varchar Address line 1 (Street address/PO Box/Company name).
legal_entity_address_kanji_line2 varchar Address line 2 (Apartment/Suite/Unit/Building).
legal_entity_address_kanji_postal_code varchar ZIP or postal code.
legal_entity_address_kanji_state varchar State/County/Province/Region.
legal_entity_dob_day bigint The day of birth, between 1 and 31.
legal_entity_dob_month bigint The month of birth, between 1 and 12.
legal_entity_dob_year bigint The four-digit year of birth.
legal_entity_personal_address_city varchar City/District/Suburb/Town/Village.
legal_entity_personal_address_country varchar 2-letter country code.
legal_entity_personal_address_line1 varchar Address line 1 (Street address/PO Box/Company name).
legal_entity_personal_address_line2 varchar Address line 2 (Apartment/Suite/Unit/Building).
legal_entity_personal_address_postal_code varchar ZIP or postal code.
legal_entity_personal_address_state varchar State/County/Province/Region.
legal_entity_personal_address_kana_city varchar City/District/Suburb/Town/Village.
legal_entity_personal_address_kana_country varchar 2-letter country code.
legal_entity_personal_address_kana_line1 varchar Address line 1 (Street address/PO Box/Company name).
legal_entity_personal_address_kana_line2 varchar Address line 2 (Apartment/Suite/Unit/Building).
legal_entity_personal_address_kana_postal_code varchar ZIP or postal code.
legal_entity_personal_address_kana_state varchar State/County/Province/Region.
legal_entity_personal_address_kanji_city varchar City/District/Suburb/Town/Village.
legal_entity_personal_address_kanji_country varchar 2-letter country code.
legal_entity_personal_address_kanji_line1 varchar Address line 1 (Street address/PO Box/Company name).
legal_entity_personal_address_kanji_line2 varchar Address line 2 (Apartment/Suite/Unit/Building).
legal_entity_personal_address_kanji_postal_code varchar ZIP or postal code.
legal_entity_personal_address_kanji_state varchar State/County/Province/Region.
legal_entity_verification_details varchar A user-displayable string describing the verification state for the person. For example, this may say "Provided identity information could not be verified".
legal_entity_verification_details_code varchar
legal_entity_verification_document_id varchar
legal_entity_verification_status varchar The state of verification for the person. Possible values are unverified, pending, or verified.
payout_schedule_delay_days bigint The number of days charges for the account will be held before being paid out.
payout_schedule_interval varchar How frequently funds will be paid out. One of manual (payouts only created via API call), daily, weekly, or monthly.
payout_schedule_monthly_anchor bigint The day of the month funds will be paid out. Only shown if interval is monthly. Payouts scheduled between the 29th and 31st of the month are sent on the last day of shorter months.
payout_schedule_weekly_anchor varchar The day of the week funds will be paid out, of the style 'monday', 'tuesday', etc. Only shown if interval is weekly.
tos_acceptance_date timestamp The Unix timestamp marking when the Stripe Services Agreement was accepted by the account representative
tos_acceptance_ip varchar The IP address from which the Stripe Services Agreement was accepted by the account representative
tos_acceptance_user_agent varchar The user agent of the browser from which the Stripe Services Agreement was accepted by the account representative
verification_fields_needed varchar
verification_due_by timestamp By what time the fields_needed must be provided. If this date is in the past, the account is already in bad standing, and providing fields_needed is necessary to re-enable payouts and prevent other consequences. If this date is in the future, fields_needed must be provided to ensure the account remains in good standing.
verification_disabled_reason varchar If the account is disabled, this string describes why the account can’t create charges or receive payouts. Can be rejected.fraud, rejected.terms_of_service, rejected.listed, rejected.other, fields_needed, listed, under_review, or other.

accounts_metadata

attribute type comment
account_id varchar The ID of the account that this metadata entry is associated with.
key varchar Name of the metadata key.
value varchar Value of the metadata.

external_account_bank_accounts

attribute type comment
account_id varchar
id varchar Unique identifier for the object.
account_holder_name varchar The name of the person or business that owns the bank account.
account_holder_type varchar The type of entity that holds the account. This can be either individual or company.
bank_name varchar Name of the bank associated with the routing number (e.g., WELLS FARGO).
country varchar Two-letter ISO code representing the country the bank account is located in.
currency varchar Three-letter ISO code for the currency paid out to the bank account.
default_for_currency boolean Whether this bank account is the default external account for its currency.
fingerprint varchar Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.
last4 varchar
routing_number varchar The routing transit number for the bank account.
status varchar For bank accounts, possible values are new, validated, verified, verification_failed, or errored. A bank account that hasn't had any activity or validation performed is new. If Stripe can determine that the bank account exists, its status will be validated. Note that there often isn’t enough information to know (e.g., for smaller credit unions), and the validation is not always run. If customer bank account verification has succeeded, the bank account status will be verified. If the verification failed for any reason, such as microdeposit failure, the status will be verification_failed. If a transfer sent to this bank account fails, we'll set the status to errored and will not continue to send transfers until the bank details are updated.

For external accounts, possible values are new and errored. Validations aren't run against external accounts because they're only used for payouts. This means the other statuses don't apply. If a transfer fails, the status is set to errored and transfers are stopped until account details are updated. |

external_account_cards

attribute type comment
account_id varchar
id varchar Unique identifier for the object.
address_city varchar City/District/Suburb/Town/Village.
address_country varchar Billing address country, if provided when creating card.
address_line1 varchar Address line 1 (Street address/PO Box/Company name).
address_line1_check varchar If address_line1 was provided, results of the check: pass, fail, unavailable, or unchecked.
address_line2 varchar Address line 2 (Apartment/Suite/Unit/Building).
address_state varchar State/County/Province/Region.
address_zip varchar ZIP or postal code.
address_zip_check varchar If address_zip was provided, results of the check: pass, fail, unavailable, or unchecked.
brand varchar Card brand. Can be American Express, Diners Club, Discover, JCB, MasterCard, UnionPay, Visa, or Unknown.
country varchar 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.
currency varchar Three-letter ISO code for currency. Only applicable on accounts (not customers or recipients). The card can be used as a transfer destination for funds in this currency.
customer_id varchar The customer that this card belongs to. This attribute will not be in the card object if the card belongs to an account or recipient instead.
cvc_check varchar If a CVC was provided, results of the check: pass, fail, unavailable, or unchecked.
default_for_currency boolean Whether this card is the default external account for its currency.
dynamic_last4 varchar (For tokenized numbers only.) The last four digits of the device account number.
exp_month bigint Two-digit number representing the card's expiration month.
exp_year bigint Four-digit number representing the card's expiration year.
fingerprint varchar 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.
funding varchar Card funding type. Can be credit, debit, prepaid, or unknown.
last4 varchar The last four digits of the card.
name varchar Cardholder name.
recipient_id varchar The recipient that this card belongs to. This attribute will not be in the card object if the card belongs to a customer or account instead.
tokenization_method varchar If the card number is tokenized, this is the method that was used. Can be apple_pay or google_pay.
iin varchar The Issuer Identification Number or Bank Identification Number (BIN) of the card being used to make the payment. It is the first six digits of the card number.

application_fees

attribute type comment
id varchar Unique identifier for the object.
account_id varchar ID of the Stripe account this fee was taken from.
amount bigint Amount earned, in cents.
amount_refunded bigint Amount in cents refunded (can be less than the amount attribute on the fee if a partial refund was issued)
application_id varchar ID of the Connect application that earned the fee.
balance_transaction_id varchar Balance transaction that describes the impact of this collected application fee on your account balance (not including refunds).
charge_id varchar ID of the charge that the application fee was taken from.
created timestamp Time at which the object was created. Measured in seconds since the Unix epoch.
currency varchar Three-letter ISO currency code, in lowercase. Must be a supported currency.
originating_transaction_id varchar ID of the corresponding charge on the platform account, if this fee was the result of a charge using the destination parameter.
refunded boolean Whether the fee has been fully refunded. If the fee is only partially refunded, this attribute will still be false.

balance_transactions

attribute type comment
id varchar Unique identifier for the object.
amount bigint Gross amount of the transaction, in cents.
available_on timestamp The date the transaction's net funds will become available in the Stripe balance.
created timestamp Time at which the object was created. Measured in seconds since the Unix epoch.
currency varchar Three-letter ISO currency code, in lowercase. Must be a supported currency.
description varchar An arbitrary string attached to the object. Often useful for displaying to users.
fee bigint Fees (in cents) paid for this transaction.
net bigint Net amount of the transaction, in cents.
status varchar If the transaction's net funds are available in the Stripe balance yet. Either available or pending.
type varchar 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. Learn more about balance transaction types and what they represent.
source_id varchar The Stripe object to which this transaction is related.
automatic_transfer_id varchar ID of the automatically created transfer associated with this balance transaction (only set if your account is on an automatic payout schedule).
reporting_category varchar (Beta, subject to change) A new categorization of balance transactions, meant to improve on the current type field. Learn more. Please let us know what would be most helpful using the Feedback link at the bottom of this page.

balance_transaction_fee_details

attribute type comment
balance_transaction_id varchar
id varchar
amount bigint Amount of the fee, in cents.
application varchar
currency varchar Three-letter ISO currency code, in lowercase. Must be a supported currency.
description varchar An arbitrary string attached to the object. Often useful for displaying to users.
type varchar Type of the fee, one of: application_fee, stripe_fee or tax.

charges

attribute type comment
id varchar Unique identifier for the object.
amount bigint A positive integer representing how much to charge in the smallest currency unit (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The minimum amount is $0.50 US or equivalent in charge currency. The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99).
amount_refunded bigint Amount in cents refunded (can be less than the amount attribute on the charge if a partial refund was issued).
application_fee_id varchar The application fee (if any) for the charge. See the Connect documentation for details.
balance_transaction_id varchar ID of the balance transaction that describes the impact of this charge on your account balance (not including refunds or disputes).
captured boolean If the charge was created without capturing, this Boolean represents whether it is still uncaptured or has since been captured.
created timestamp Time at which the object was created. Measured in seconds since the Unix epoch.
currency varchar Three-letter ISO currency code, in lowercase. Must be a supported currency.
customer_id varchar ID of the customer this charge is for if one exists.
description varchar An arbitrary string attached to the object. Often useful for displaying to users.
destination_id varchar
dispute_id varchar Details about the dispute if the charge has been disputed.
failure_code varchar Error code explaining reason for charge failure if available (see the errors section for a list of codes).
failure_message varchar Message to user further explaining reason for charge failure if available.
invoice_id varchar ID of the invoice this charge is for if one exists.
order_id varchar ID of the order this charge is for if one exists.
paid boolean true if the charge succeeded, or was successfully authorized for later capture.
receipt_email varchar This is the email address that the receipt for this charge was sent to.
receipt_number varchar 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.
refunded boolean Whether the charge has been fully refunded. If the charge is only partially refunded, this attribute will still be false.
statement_descriptor varchar For card charges, use statement_descriptor_suffix instead. Otherwise, you can use this value as the complete description of a charge on your customers’ statements. Must contain at least one letter, maximum 22 characters.
status varchar The status of the payment is either succeeded, pending, or failed.
source_transfer_id varchar The transfer ID which created this charge. Only present if the charge came from another Stripe account. See the Connect documentation for details.
transfer_id varchar ID of the transfer to the destination account (only applicable if the charge was created using the destination parameter).
transfer_group varchar A string that identifies this transaction as part of a group. See the Connect documentation for details.
application_id varchar ID of the Connect application that created the charge.
source_id varchar
card_id varchar Unique identifier for the object.
card_address_city varchar City/District/Suburb/Town/Village.
card_address_country varchar Billing address country, if provided when creating card.
card_address_line1 varchar Address line 1 (Street address/PO Box/Company name).
card_address_line1_check varchar If address_line1 was provided, results of the check: pass, fail, unavailable, or unchecked.
card_address_line2 varchar Address line 2 (Apartment/Suite/Unit/Building).
card_address_state varchar State/County/Province/Region.
card_address_zip varchar ZIP or postal code.
card_address_zip_check varchar If address_zip was provided, results of the check: pass, fail, unavailable, or unchecked.
card_brand varchar Card brand. Can be American Express, Diners Club, Discover, JCB, MasterCard, UnionPay, Visa, or Unknown.
card_country varchar 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_currency varchar Three-letter ISO code for currency. Only applicable on accounts (not customers or recipients). The card can be used as a transfer destination for funds in this currency.
card_customer_id varchar The customer that this card belongs to. This attribute will not be in the card object if the card belongs to an account or recipient instead.
card_cvc_check varchar If a CVC was provided, results of the check: pass, fail, unavailable, or unchecked.
card_dynamic_last4 varchar (For tokenized numbers only.) The last four digits of the device account number.
card_exp_month bigint Two-digit number representing the card's expiration month.
card_exp_year bigint Four-digit number representing the card's expiration year.
card_fingerprint varchar 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_funding varchar Card funding type. Can be credit, debit, prepaid, or unknown.
card_last4 varchar The last four digits of the card.
card_name varchar Cardholder name.
card_recipient_id varchar The recipient that this card belongs to. This attribute will not be in the card object if the card belongs to a customer or account instead.
card_tokenization_method varchar If the card number is tokenized, this is the method that was used. Can be apple_pay or google_pay.
card_iin varchar The Issuer Identification Number or Bank Identification Number (BIN) of the card being used to make the payment. It is the first six digits of the card number.
card_default_for_currency boolean Only applicable on payout external account card belonging to merchant (not as payment source customer card in charge).
outcome_network_status varchar 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_reason varchar 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. See understanding declines for more details.
outcome_rule_id varchar The ID of the Radar rule that matched the payment, if applicable.
outcome_type varchar Possible values are authorized, manual_review, issuer_declined, blocked, and invalid. See understanding declines and Radar reviews for details.
outcome_seller_message varchar A human-readable description of the outcome type and reason, designed for you (the recipient of the payment), not your customer.
outcome_risk_level varchar 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_risk_score bigint Stripe's evaluation of the riskiness of the payment. Possible values for evaluated payments are between 0 and 100. For non-card payments, card-based payments predating the public assignment of risk scores, or in the event of an error during evaluation, this field will not be present. This field is only available with Radar for Fraud Teams.

charges_metadata

attribute type comment
charge_id varchar The ID of the charge that this metadata entry is associated with.
key varchar Name of the metadata key.
value varchar Value of the metadata.

coupons

attribute type comment
id varchar Unique identifier for the object.
amount_off bigint Amount (in the currency specified) that will be taken off the subtotal of any invoices for this customer.
created timestamp Time at which the object was created. Measured in seconds since the Unix epoch.
currency varchar If amount_off has been set, the three-letter ISO code for the currency of the amount to take off.
duration varchar One of forever, once, and repeating. Describes how long a customer who applies this coupon will get the discount.
duration_in_months bigint If duration is repeating, the number of months the coupon applies. Null if coupon duration is forever or once.
max_redemptions bigint Maximum number of times this coupon can be redeemed, in total, across all customers, before it is no longer valid.
percent_off double 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.
redeem_by timestamp Date after which the coupon can no longer be redeemed.
times_redeemed bigint Number of times this coupon has been applied to a customer.
valid boolean Taking account of the above properties, whether this coupon can still be applied to a customer.

coupons_metadata

attribute type comment
coupon_id varchar The ID of the coupon that this metadata entry is associated with.
key varchar Name of the metadata key.
value varchar Value of the metadata.

credit_notes

attribute type comment
id varchar Unique identifier for the object.
amount bigint The integer amount in cents representing the total amount of the credit note, including tax.
created timestamp Time at which the object was created. Measured in seconds since the Unix epoch.
currency varchar Three-letter ISO currency code, in lowercase. Must be a supported currency.
customer_id varchar ID of the customer.
invoice_id varchar ID of the invoice.
memo varchar Customer-facing text that appears on the credit note PDF.
number varchar A unique number that identifies this particular credit note and appears on the PDF of the credit note and its associated invoice.
reason varchar Reason for issuing this credit note, one of duplicate, fraudulent, order_change, or product_unsatisfactory
refund_id varchar Refund related to this credit note.
status varchar Status of this credit note, one of issued or void. Learn more about voiding credit notes.
type varchar Type of this credit note, one of post_payment or pre_payment. A pre_payment credit note means it was issued when the invoice was open. A post_payment credit note means it was issued when the invoice was paid.

credit_notes_metadata

attribute type comment
credit_note_id varchar The ID of the credit_note that this metadata entry is associated with.
key varchar Name of the metadata key.
value varchar Value of the metadata.

credit_note_line_items

attribute type comment
id varchar Unique identifier for the object.
credit_note_id varchar
amount bigint The integer amount in cents representing the gross amount being credited for this line item, excluding (exclusive) tax and discounts.
discount bigint The integer amount in cents representing the discount being credited for this line item.
description varchar Description of the item being credited.
quantity bigint The number of units of product being credited.
unit_amount bigint The cost of each unit of product being credited.

credit_note_line_item_tax_amounts

attribute type comment
credit_note_line_item_id varchar
id varchar
amount bigint The amount, in cents, of the tax.
inclusive boolean Whether this tax amount is inclusive or exclusive.
tax_rate_id varchar The tax rate that was applied to get this tax amount.

customers

attribute type comment
id varchar Unique identifier for the object.
account_balance bigint This field has been renamed to balance and will be removed in a future API version.
business_vat_id varchar
created timestamp Time at which the object was created. Measured in seconds since the Unix epoch.
currency varchar Three-letter ISO code for the currency the customer can be charged in for recurring billing purposes.
delinquent boolean 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.
description varchar An arbitrary string attached to the object. Often useful for displaying to users.
email varchar The customer's email address.
default_source_id varchar ID of the default payment source for the customer.
deleted boolean
shipping_name varchar Customer name.
shipping_phone varchar Customer phone (including extension).
shipping_address_city varchar City/District/Suburb/Town/Village.
shipping_address_country varchar 2-letter country code.
shipping_address_line1 varchar Address line 1 (Street address/PO Box/Company name).
shipping_address_line2 varchar Address line 2 (Apartment/Suite/Unit/Building).
shipping_address_postal_code varchar ZIP or postal code.
shipping_address_state varchar State/County/Province/Region.
discount_coupon_id varchar Hash describing the coupon applied to create this discount.
discount_customer_id varchar
discount_end timestamp If the coupon has a duration of repeating, the date that this discount will end. If the coupon has a duration of once or forever, this attribute will be null.
discount_start timestamp Date that the coupon was applied.
discount_subscription varchar The subscription that this coupon is applied to, if it is applied to a particular subscription.
tax_info_tax_id varchar The customer's tax ID number.
tax_info_type varchar The type of ID number.

customers_metadata

attribute type comment
customer_id varchar The ID of the customer that this metadata entry is associated with.
key varchar Name of the metadata key.
value varchar Value of the metadata.

disputes

attribute type comment
id varchar Unique identifier for the object.
amount bigint Disputed amount. Usually the amount of the charge, but can differ (usually because of currency fluctuation or because only part of the order is disputed).
charge_id varchar ID of the charge that was disputed.
created timestamp Time at which the object was created. Measured in seconds since the Unix epoch.
currency varchar Three-letter ISO currency code, in lowercase. Must be a supported currency.
is_charge_refundable boolean 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.
reason varchar Reason given by cardholder for dispute. Possible values are bank_cannot_process, check_returned, credit_not_processed, customer_initiated, debit_not_authorized, duplicate, fraudulent, general, incorrect_account_details, insufficient_funds, product_not_received, product_unacceptable, subscription_canceled, or unrecognized. Read more about dispute reasons.
status varchar Current status of dispute. Possible values are warning_needs_response, warning_under_review, warning_closed, needs_response, under_review, charge_refunded, won, or lost.
evidence_access_activity_log varchar Any server or activity logs showing proof that the customer accessed or downloaded the purchased digital product. This information should include IP addresses, corresponding timestamps, and any detailed recorded activity.
evidence_billing_address varchar The billing address provided by the customer.
evidence_cancellation_policy_id varchar (ID of a file upload) Your subscription cancellation policy, as shown to the customer.
evidence_cancellation_policy_disclosure varchar An explanation of how and when the customer was shown your refund policy prior to purchase.
evidence_cancellation_rebuttal varchar A justification for why the customer's subscription was not canceled.
evidence_customer_communication_id varchar (ID of a file upload) Any communication with the customer that you feel is relevant to your case. Examples include emails proving that the customer received the product or service, or demonstrating their use of or satisfaction with the product or service.
evidence_customer_email_address varchar The email address of the customer.
evidence_customer_name varchar The name of the customer.
evidence_customer_purchase_ip varchar The IP address that the customer used when making the purchase.
evidence_customer_signature_id varchar (ID of a file upload) A relevant document or contract showing the customer's signature.
evidence_duplicate_charge_documentation_id varchar (ID of a file upload) Documentation for the prior charge that can uniquely identify the charge, such as a receipt, shipping label, work order, etc. This document should be paired with a similar document from the disputed payment that proves the two payments are separate.
evidence_duplicate_charge_id varchar The Stripe ID for the prior charge which appears to be a duplicate of the disputed charge.
evidence_product_description varchar A description of the product or service that was sold.
evidence_receipt_id varchar (ID of a file upload) Any receipt or message sent to the customer notifying them of the charge.
evidence_refund_policy_id varchar (ID of a file upload) Your refund policy, as shown to the customer.
evidence_refund_policy_disclosure varchar Documentation demonstrating that the customer was shown your refund policy prior to purchase.
evidence_refund_refusal_explanation varchar A justification for why the customer is not entitled to a refund.
evidence_service_date varchar The date on which the customer received or began receiving the purchased service, in a clear human-readable format.
evidence_service_documentation_id varchar (ID of a file upload) Documentation showing proof that a service was provided to the customer. This could include a copy of a signed contract, work order, or other form of written agreement.
evidence_shipping_address varchar The address to which a physical product was shipped. You should try to include as complete address information as possible.
evidence_shipping_carrier varchar 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.
evidence_shipping_date varchar The date on which a physical product began its route to the shipping address, in a clear human-readable format.
evidence_shipping_documentation_id varchar (ID of a file upload) Documentation showing proof that a product was shipped to the customer at the same address the customer provided to you. This could include a copy of the shipment receipt, shipping label, etc. It should show the customer's full shipping address, if possible.
evidence_shipping_tracking_number varchar 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.
evidence_uncategorized_file_id varchar (ID of a file upload) Any additional evidence or statements.
evidence_uncategorized_text varchar Any additional evidence or statements.
evidence_details_due_by timestamp 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_details_has_evidence boolean Whether evidence has been staged for this dispute.
evidence_details_past_due boolean 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.
evidence_details_submission_count bigint The number of times evidence has been submitted. Typically, you may only submit evidence once.

disputes_metadata

attribute type comment
dispute_id varchar The ID of the dispute that this metadata entry is associated with.
key varchar Name of the metadata key.
value varchar Value of the metadata.

early_fraud_warnings

attribute type comment
id varchar Unique identifier for the object.
created timestamp Time at which the object was created. Measured in seconds since the Unix epoch.
charge_id varchar ID of the charge this early fraud warning is for, optionally expanded.
fraud_type varchar The type of fraud labelled by the issuer. One of card_never_received, fraudulent_card_application, made_with_counterfeit_card, made_with_lost_card, made_with_stolen_card, misc, unauthorized_use_of_card.
actionable boolean An EFW is actionable if it has not received a dispute and has not been fully refunded. You may wish to proactively refund a charge that receives an EFW, in order to avoid receiving a dispute later.

application_fee_refunds

attribute type comment
id varchar Unique identifier for the object.
amount bigint Amount, in cents.
created timestamp Time at which the object was created. Measured in seconds since the Unix epoch.
currency varchar Three-letter ISO currency code, in lowercase. Must be a supported currency.
fee_id varchar ID of the application fee that was refunded.
balance_transaction_id varchar Balance transaction that describes the impact on your account balance.

application_fee_refunds_metadata

attribute type comment
application_fee_refund_id varchar The ID of the application_fee_refund that this metadata entry is associated with.
key varchar Name of the metadata key.
value varchar Value of the metadata.

invoices

attribute type comment
id varchar Unique identifier for the object.
amount_due bigint 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.
application_fee bigint
attempt_count bigint 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.
attempted boolean Whether an attempt has been made to pay the invoice. An invoice is not attempted until 1 hour after the invoice.created webhook, for example, so you might not want to display that invoice as unpaid to your users.
auto_advance boolean Controls whether Stripe will perform automatic collection of the invoice. When false, the invoice's state will not automatically advance without an explicit action.
charge_id varchar ID of the latest charge generated for this invoice, if any.
currency varchar Three-letter ISO currency code, in lowercase. Must be a supported currency.
customer_id varchar
date timestamp
description varchar An arbitrary string attached to the object. Often useful for displaying to users. Referenced as 'memo' in the Dashboard.
ending_balance bigint 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.
next_payment_attempt timestamp The time at which payment will next be attempted. This value will be null for invoices where collection_method=send_invoice.
number varchar A unique, identifying string that appears on emails sent to the customer for this invoice. This starts with the customer's unique invoice_prefix if it is specified.
paid boolean 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.
period_end timestamp End of the usage period during which invoice items were added to this invoice.
period_start timestamp Start of the usage period during which invoice items were added to this invoice.
receipt_number varchar This is the transaction number that appears on email receipts sent for this invoice.
starting_balance bigint Starting customer balance before the invoice is finalized. If the invoice has not been finalized yet, this will be the current customer balance.
statement_descriptor varchar Extra information about an invoice for the customer's credit card statement.
status varchar The status of the invoice, one of draft, open, paid, uncollectible, or void. Learn more
subscription_id varchar The subscription that this invoice was prepared for, if any.
subscription_proration_date timestamp Only set for upcoming invoices that preview prorations. The time used to calculate prorations.
subtotal bigint Total of all subscriptions, invoice items, and prorations on the invoice before any discount or tax is applied.
tax bigint The amount of tax on this invoice. This is the sum of all the tax amounts on this invoice.
tax_percent double
total bigint Total after discounts and taxes.
webhooks_delivered_at timestamp The time at which webhooks for this invoice were successfully delivered (if the invoice had no webhooks to deliver, this will match created). Invoice payment is delayed until webhooks are delivered, or until all webhook delivery attempts have been exhausted.
discount_coupon_id varchar Hash describing the coupon applied to create this discount.
discount_customer_id varchar
discount_end timestamp If the coupon has a duration of repeating, the date that this discount will end. If the coupon has a duration of once or forever, this attribute will be null.
discount_start timestamp Date that the coupon was applied.
discount_subscription varchar The subscription that this coupon is applied to, if it is applied to a particular subscription.
status_transitions_finalized_at timestamp The time that the invoice draft was finalized.
status_transitions_marked_uncollectible_at timestamp The time that the invoice was marked uncollectible.
status_transitions_paid_at timestamp The time that the invoice was paid.
status_transitions_voided_at timestamp The time that the invoice was voided.

invoices_metadata

attribute type comment
invoice_id varchar The ID of the invoice that this metadata entry is associated with.
key varchar Name of the metadata key.
value varchar Value of the metadata.

invoice_line_items

attribute type comment
invoice_id varchar
source_id varchar Unique identifier for the object.
amount bigint The amount, in cents.
currency varchar Three-letter ISO currency code, in lowercase. Must be a supported currency.
description varchar An arbitrary string attached to the object. Often useful for displaying to users.
discountable boolean If true, discounts will apply to this line item. Always false for prorations.
plan_id varchar The plan of the subscription, if the line item is a subscription or a proration.
proration boolean Whether this is a proration.
quantity bigint The quantity of the subscription, if the line item is a subscription or a proration.
subscription varchar The subscription that the invoice item pertains to, if any.
source_type varchar A string identifying the type of the source of this line item, either an invoiceitem or a subscription.
period_start timestamp Start of the line item's billing period
period_end timestamp End of the line item's billing period

invoice_items

attribute type comment
id varchar Unique identifier for the object.
amount bigint Amount (in the currency specified) of the invoice item. This should always be equal to unit_amount * quantity.
currency varchar Three-letter ISO currency code, in lowercase. Must be a supported currency.
customer_id varchar The ID of the customer who will be billed when this invoice item is billed.
date timestamp Time at which the object was created. Measured in seconds since the Unix epoch.
description varchar An arbitrary string attached to the object. Often useful for displaying to users.
discountable boolean If true, discounts will apply to this invoice item. Always false for prorations.
invoice_id varchar The ID of the invoice this invoice item belongs to.
plan_id varchar If the invoice item is a proration, the plan of the subscription that the proration was computed for.
proration boolean Whether the invoice item was created automatically as a proration adjustment when the customer switched plans.
quantity bigint Quantity of units for the invoice item. If the invoice item is a proration, the quantity of the subscription that the proration was computed for.
subscription_id varchar The subscription that this invoice item has been created for, if any.
unit_amount bigint Unit Amount (in the currency specified) of the invoice item.
period_start timestamp Start of the line item's billing period
period_end timestamp End of the line item's billing period

invoice_items_metadata

attribute type comment
invoice_item_id varchar The ID of the invoice_item that this metadata entry is associated with.
key varchar Name of the metadata key.
value varchar Value of the metadata.

transfers

attribute type comment
id varchar Unique identifier for the object.
amount bigint Amount (in cents) to be transferred to your bank account.
amount_reversed bigint Amount in cents reversed (can be less than the amount attribute on the transfer if a partial reversal was issued).
application_fee_id varchar
automatic boolean Returns true if the payout was created by an automated payout schedule, and false if it was requested manually.
balance_transaction_id varchar Balance transaction that describes the impact of this transfer on your account balance.
created timestamp Time at which the object was created. Measured in seconds since the Unix epoch.
currency varchar Three-letter ISO currency code, in lowercase. Must be a supported currency.
date timestamp Date the transfer is scheduled to arrive in the bank. This factors in delays like weekends or bank holidays.
description varchar Internal-only description of the transfer.
destination_id varchar ID of the bank account, card, or Stripe account the transfer was sent to.
destination_payment_id varchar If the destination is a Stripe account, this will be the ID of the payment that the destination account received for the transfer.
failure_code varchar Error code explaining reason for transfer failure if available. See Types of transfer failures for a list of failure codes.
failure_message varchar Message to user further explaining reason for transfer failure if available.
reversed boolean Whether the transfer has been fully reversed. If the transfer is only partially reversed, this attribute will still be false.
source_transaction_id varchar ID of the charge (or other transaction) that was used to fund the transfer. If null, the transfer was funded from the available balance.
source_type varchar The source balance this transfer came from. One of card or bank_account.
statement_descriptor varchar Extra information about a transfer to be displayed on the user's bank statement.
status varchar Current status of the transfer (paid, pending, in_transit, canceled or failed). A transfer will be pending until it is submitted to the bank, at which point it becomes in_transit. It will then change to paid if the transaction goes through. If it does not go through successfully, its status will change to failed or canceled.
transfer_group varchar A string that identifies this transaction as part of a group. See the Connect documentation for details.
type varchar Can be card, bank_account, or stripe_account.

transfers_metadata

attribute type comment
transfer_id varchar The ID of the transfer that this metadata entry is associated with.
key varchar Name of the metadata key.
value varchar Value of the metadata.

plans

attribute type comment
id varchar Unique identifier for the object.
amount bigint The amount in cents to be charged on the interval specified.
created timestamp Time at which the object was created. Measured in seconds since the Unix epoch.
currency varchar Three-letter ISO currency code, in lowercase. Must be a supported currency.
interval varchar One of day, week, month or year. The frequency with which a subscription should be billed.
interval_count bigint The number of intervals (specified in the interval property) between subscription billings. For example, interval=month and interval_count=3 bills every 3 months.
nickname varchar A brief description of the plan, hidden from customers.
product_id varchar The product whose pricing this plan determines.
trial_period_days bigint Default number of trial days when subscribing a customer to this plan using trial_from_plan=true.

plans_metadata

attribute type comment
plan_id varchar The ID of the plan that this metadata entry is associated with.
key varchar Name of the metadata key.
value varchar Value of the metadata.

products

attribute type comment
id varchar Unique identifier for the object.
active boolean Whether the product is currently available for purchase.
caption varchar A short one-line description of the product, meant to be displayable to the customer. Only applicable to products of type=good.
created timestamp Time at which the object was created. Measured in seconds since the Unix epoch.
deactivate_on varchar An array of connect application identifiers that cannot purchase this product. Only applicable to products of type=good.
description varchar The product's description, meant to be displayable to the customer. Only applicable to products of type=good.
name varchar The product's name, meant to be displayable to the customer. Applicable to both service and good types.
shippable boolean Whether this product is a shipped good. Only applicable to products of type=good.
statement_descriptor varchar Extra information about a product which will appear on your customer's credit card statement. In the case that multiple products are billed at once, the first statement descriptor will be used. Only available on products of type=service.
type varchar The type of the product. The product is either of type good, which is eligible for use with Orders and SKUs, or service, which is eligible for use with Subscriptions and Plans.
unit_label varchar A label that represents units of this product, such as seat(s), in Stripe and on customers’ receipts and invoices. Only available on products of type=service.
url varchar A URL of a publicly-accessible webpage for this product. Only applicable to products of type=good.

products_metadata

attribute type comment
product_id varchar The ID of the product that this metadata entry is associated with.
key varchar Name of the metadata key.
value varchar Value of the metadata.

refunds

attribute type comment
id varchar Unique identifier for the object.
amount bigint Amount, in cents.
balance_transaction_id varchar Balance transaction that describes the impact on your account balance.
charge_id varchar ID of the charge that was refunded.
created timestamp Time at which the object was created. Measured in seconds since the Unix epoch.
currency varchar Three-letter ISO currency code, in lowercase. Must be a supported currency.
reason varchar Reason for the refund. If set, possible values are duplicate, fraudulent, and requested_by_customer.
receipt_number varchar This is the transaction number that appears on email receipts sent for this refund.
status varchar Status of the refund. For credit card refunds, this can be pending, succeeded, or failed. For other types of refunds, it can be pending, succeeded, failed, or canceled. Refer to our refunds documentation for more details.
failure_reason varchar If the refund failed, the reason for refund failure if known. Possible values are lost_or_stolen_card, expired_or_canceled_card, or unknown.
acquirer_reference_number varchar

refunds_metadata

attribute type comment
refund_id varchar The ID of the refund that this metadata entry is associated with.
key varchar Name of the metadata key.
value varchar Value of the metadata.

sources

attribute type comment
id varchar Unique identifier for the object.
amount bigint 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 associated with the source. This is the amount for which the source will be chargeable once ready. Required for single_use sources.
client_secret varchar The client secret of the source. Used for client-side retrieval using a publishable key.
created timestamp Time at which the object was created. Measured in seconds since the Unix epoch.
currency varchar Three-letter ISO code for the currency associated with the source. This is the currency for which the source will be chargeable once ready. Required for single_use sources.
flow varchar The authentication flow of the source. flow is one of redirect, receiver, code_verification, none.
status varchar The status of the source, one of canceled, chargeable, consumed, failed, or pending. Only chargeable sources can be used to create a charge.
type varchar The type of the source. The type is a payment method, one of ach_credit_transfer, ach_debit, alipay, bancontact, card, card_present, eps, giropay, ideal, multibanco, klarna, p24, sepa_debit, sofort, three_d_secure, or wechat. An additional hash is included on the source with a name matching this value. It contains additional information specific to the payment method used.
usage varchar Either reusable or single_use. Whether this source should be reusable or not. Some source types may or may not be reusable by construction, while others may leave the option at creation. If an incompatible value is passed, an error will be returned.
code_verification_attempts_remaining bigint The number of attempts remaining to authenticate the source object with a verification code.
code_verification_status varchar The status of the code verification, either pending (awaiting verification, attempts_remaining should be greater than 0), succeeded (successful verification) or failed (failed verification, cannot be verified anymore as attempts_remaining should be 0).
owner_email varchar Owner's email address.
owner_name varchar Owner's full name.
owner_phone varchar Owner's phone number (including extension).
owner_verified_email varchar Verified owner's email address. Verified values are verified or provided by the payment method directly (and if supported) at the time of authorization or settlement. They cannot be set or mutated.
owner_verified_name varchar Verified owner's full name. Verified values are verified or provided by the payment method directly (and if supported) at the time of authorization or settlement. They cannot be set or mutated.
owner_verified_phone varchar Verified owner's phone number (including extension). Verified values are verified or provided by the payment method directly (and if supported) at the time of authorization or settlement. They cannot be set or mutated.
owner_address_city varchar City/District/Suburb/Town/Village.
owner_address_country varchar 2-letter country code.
owner_address_line1 varchar Address line 1 (Street address/PO Box/Company name).
owner_address_line2 varchar Address line 2 (Apartment/Suite/Unit/Building).
owner_address_postal_code varchar ZIP or postal code.
owner_address_state varchar State/County/Province/Region.
owner_verified_address_city varchar City/District/Suburb/Town/Village.
owner_verified_address_country varchar 2-letter country code.
owner_verified_address_line1 varchar Address line 1 (Street address/PO Box/Company name).
owner_verified_address_line2 varchar Address line 2 (Apartment/Suite/Unit/Building).
owner_verified_address_postal_code varchar ZIP or postal code.
owner_verified_address_state varchar State/County/Province/Region.
receiver_address varchar The address of the receiver source. This is the value that should be communicated to the customer to send their funds to.
receiver_amount_charged bigint The total amount that was charged by you. The amount charged is expressed in the source's currency.
receiver_amount_received bigint The total amount received by the receiver source. amount_received = amount_returned + amount_charged is true at all time. The amount received is expressed in the source's currency.
receiver_amount_returned bigint The total amount that was returned to the customer. The amount returned is expressed in the source's currency.
redirect_return_url varchar The URL you provide to redirect the customer to after they authenticated their payment.
redirect_status varchar The status of the redirect, either pending (ready to be used by your customer to authenticate the transaction), succeeded (succesful authentication, cannot be reused) or not_required (redirect should not be used) or failed (failed authentication, cannot be reused).
redirect_url varchar The URL provided to you to redirect a customer to as part of a redirect authentication flow.
redirect_failure_reason varchar The failure reason for the redirect, either user_abort (the customer aborted or dropped out of the redirect flow), declined (the authentication failed or the transaction was declined), or processing_error (the redirect failed due to a technical error). Present only if the redirect status is failed.

sources_metadata

attribute type comment
source_id varchar The ID of the source that this metadata entry is associated with.
key varchar Name of the metadata key.
value varchar Value of the metadata.

subscriptions

attribute type comment
id varchar Unique identifier for the object.
application_fee_percent double 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.
billing varchar This field has been renamed to collection_method and will be removed in a future API version.
billing_cycle_anchor timestamp Determines the date of the first full invoice, and, for plans with month or year intervals, the day of the month for subsequent invoices.
cancel_at_period_end boolean If the subscription has been canceled with the at_period_end flag set to true, cancel_at_period_end on the subscription will be true. You can use this attribute to determine whether a subscription that has a status of active is scheduled to be canceled at the end of the current period.
canceled_at timestamp If the subscription has been canceled, the date of that cancellation. If the subscription was canceled with cancel_at_period_end, canceled_at will 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.
created timestamp Time at which the object was created. Measured in seconds since the Unix epoch.
current_period_end timestamp End of the current period that the subscription has been invoiced for. At the end of this period, a new invoice will be created.
current_period_start timestamp Start of the current period that the subscription has been invoiced for.
customer_id varchar ID of the customer who owns the subscription.
days_until_due bigint Number of days a customer has to pay invoices generated by this subscription. This value will be null for subscriptions where collection_method=charge_automatically.
default_source_id varchar ID of the default payment source for the subscription. It must belong to the customer associated with the subscription and be in a chargeable state. If not set, defaults to the customer's default source.
ended_at timestamp If the subscription has ended, the date the subscription ended.
plan_id varchar Reference to the plan the customer is subscribed to. Only set if the subscription contains a single plan.
quantity bigint 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. Only set if the subscription contains a single plan.
start timestamp 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.
status varchar Possible values are incomplete, incomplete_expired, trialing, active, past_due, canceled, or unpaid.

For collection_method=charge_automatically a subscription moves into incomplete if the initial payment attempt fails. A subscription in this state can only have metadata and default_source updated. Once the first invoice is paid, the subscription moves into an active state. If the first invoice is not paid within 23 hours, the subscription transitions to incomplete_expired. This is a terminal state, the open invoice will be voided and no further invoices will be generated.

A subscription that is currently in a trial period is trialing and moves to active when the trial period is over.

If subscription collection_method=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 collection_method=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). After receiving updated payment information from a customer, you may choose to reopen and pay their closed invoices. | | tax_percent | double | | | trial_end | timestamp | If the subscription has a trial, the end of that trial. | | trial_start | timestamp | If the subscription has a trial, the beginning of that trial. | | billing_thresholds_amount_gte | bigint | Monetary threshold that triggers the subscription to create an invoice | | billing_thresholds_reset_billing_cycle_anchor | boolean | Indicates if the billing_cycle_anchor should be reset when a threshold is reached. If true, billing_cycle_anchor will be updated to the date/time the threshold was last reached; otherwise, the value will remain unchanged. This value may not be true if the subscription contains items with plans that have aggregate_usage=last_ever. | | discount_coupon_id | varchar | Hash describing the coupon applied to create this discount. | | discount_customer_id | varchar | | | discount_end | timestamp | If the coupon has a duration of repeating, the date that this discount will end. If the coupon has a duration of once or forever, this attribute will be null. | | discount_start | timestamp | Date that the coupon was applied. | | discount_subscription | varchar | The subscription that this coupon is applied to, if it is applied to a particular subscription. |

subscriptions_metadata

attribute type comment
subscription_id varchar The ID of the subscription that this metadata entry is associated with.
key varchar Name of the metadata key.
value varchar Value of the metadata.

subscription_items

attribute type comment
subscription_id varchar
id varchar Unique identifier for the object.
created bigint Time at which the object was created. Measured in seconds since the Unix epoch.
subscription varchar The subscription this subscription_item belongs to.
quantity bigint The quantity of the plan to which the customer should be subscribed.
plan_id varchar Unique identifier for the object.
plan_amount bigint The amount in cents to be charged on the interval specified.
plan_created timestamp Time at which the object was created. Measured in seconds since the Unix epoch.
plan_currency varchar Three-letter ISO currency code, in lowercase. Must be a supported currency.
plan_interval varchar One of day, week, month or year. The frequency with which a subscription should be billed.
plan_interval_count bigint The number of intervals (specified in the interval property) between subscription billings. For example, interval=month and interval_count=3 bills every 3 months.
plan_nickname varchar A brief description of the plan, hidden from customers.
plan_product_id varchar The product whose pricing this plan determines.
plan_trial_period_days bigint Default number of trial days when subscribing a customer to this plan using trial_from_plan=true.
billing_thresholds_usage_gte bigint Usage threshold that triggers the subscription to create an invoice

tax_rates

attribute type comment
id varchar Unique identifier for the object.
active boolean Defaults to true. When set to false, this tax rate cannot be applied to objects in the API, but will still be applied to subscriptions and invoices that already have it set.
created timestamp Time at which the object was created. Measured in seconds since the Unix epoch.
display_name varchar The display name of the tax rates as it will appear to your customer on their receipt email, PDF, and the hosted invoice page.
inclusive boolean This specifies if the tax rate is inclusive or exclusive.
jurisdiction varchar The jurisdiction for the tax rate.
percentage double This represents the tax rate percent out of 100.

tax_rates_metadata

attribute type comment
tax_rate_id varchar The ID of the tax_rate that this metadata entry is associated with.
key varchar Name of the metadata key.
value varchar Value of the metadata.

transfer_reversals

attribute type comment
id varchar Unique identifier for the object.
amount bigint Amount, in cents.
balance_transaction_id varchar Balance transaction that describes the impact on your account balance.
created timestamp Time at which the object was created. Measured in seconds since the Unix epoch.
currency varchar Three-letter ISO currency code, in lowercase. Must be a supported currency.
transfer_id varchar ID of the transfer that was reversed.

transfer_reversals_metadata

attribute type comment
transfer_reversal_id varchar The ID of the transfer_reversal that this metadata entry is associated with.
key varchar Name of the metadata key.
value varchar Value of the metadata.

usage_records

attribute type comment
id varchar Unique identifier for the object.
quantity bigint The usage quantity for the specified date.
timestamp timestamp The timestamp when this usage occurred.
subscription_item varchar The ID of the subscription item this usage record contains data for.