Stripe Connector Objects
This Data Cloud connector is a beta service that is subject to the Beta Services Terms at Agreements - Salesforce.com or a written Unified Pilot Agreement if executed by Customer, and applicable terms in the Product Terms Directory. Use of this pilot or beta service is at the Customer's sole discretion.
Name | Description |
---|---|
Accounts | Create, update, delete, and query the Accounts you manage in Stripe. |
ApplicationFeeRefunds | Returns a list of application fees you've previously collected. |
ApplicationFees | Returns a list of file links. |
Authorizations | Returns a list of Issuing Authorization objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first. |
AvailableBalance | Query the Available Balance in Stripe. |
BalanceChangeFromActivitySummaryReport | Query the Balance change from activity summary report in Stripe. |
BalanceSummaryReport | Query the Balance Summary report in Stripe. |
BalanceTransactions | Query Balance History in Stripe. |
BankAccounts | Create, update, delete, and query the available Bank Accounts in Stripe. |
BankAccountTokens | Create and query the available Bank Account Tokens in Stripe. |
Cardholders | Returns a list of Issuing Cardholder objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first. |
Cards | Create, update, delete and query the available Cards in Stripe. |
CardTokens | Create and query the available Card Tokens in Stripe. |
CashBalance | Get the cash balance for the customer. |
CashBalanceTransactions | Query Cash Balance Transactions in Stripe. |
Charges | Create, update, and query the available Charges in Stripe. |
CheckoutSession | Creates and queries the customer's session as they pay for one-time purchases or subscriptions through Checkout or Payment Links. |
CheckoutSessionLineItems | Returns a list of Checkout Sessions. |
CountrySpecs | Query the available Country Specs in Stripe. |
Coupons | Get and delete the available discount of a Subscription. |
CreditNoteLineItems | Query the available Credit Note line items in Stripe. |
CreditNoteLineItemsDiscounts | Get the available discounts from Credit Note line items in Stripe. |
CreditNotePreviewLineItems | Query the available Credit Note preview line items in Stripe. |
CreditNotes | Creates, updates, and queries a credit note to adjust an invoice's amount after the invoice is finalized. |
CustomerBalanceTransactions | Returns a list of transactions that updated the customers balances. |
Customers | Create, update, delete, and query the available Customers in Stripe. |
CustomerSubscriptions | Get the available subscriptions of a Customer. |
Disputes | Query the available Disputes in Stripe. |
EarlyFraudWarning | Query an early fraud reported by the customer. |
EndingBalanceReconciliationSummaryReport | Query the Ending balance reconciliation summary report in Stripe. |
EndingBalanceReconciliationSummaryReportInternal | Query the Ending balance reconciliation summary report in Stripe. |
Events | Query the available events in Stripe. |
FileLinks | Returns a list of file links. |
Files | Retrieves a file hosted on Stripe's servers. |
InvoiceDiscounts | Get the available discounts of invoices in Stripe. |
InvoiceItemDiscounts | Get the available discounts from invoices items in Stripe. |
InvoiceItems | Create, update, delete, and query the available invoice items in Stripe. |
InvoiceLineItemDiscounts | Get the available discounts from invoices line items in Stripe. |
InvoiceLineItems | Query the available invoices line items in Stripe. |
Invoices | Create, update, delete, and query the available Invoices in Stripe. |
IssuingCards | Returns a list of Issuing Card objects. |
IssuingDisputes | Returns a list of Issuing Dispute objects. |
ItemizedBalanceChangeFromActivityReport | Query the Itemized balance change from Activity report in Stripe. |
ItemizedEndingBalanceReconciliationReport | Query the Itemized ending balance change from activity report in Stripe. |
ItemizedPayoutReconciliationReport | Query the Itemized payout reconciliation report in Stripe. |
ItemizedPayoutsReport | Query the Itemized payouts report in Stripe. |
ItemizedReconciliationForASinglePayoutReport | Query the Itemized reconciliation for a single payout report in Stripe. |
PaymentIntent | A PaymentIntent guides you through the process of collecting a payment from your customer. |
PaymentLinkLineItems | Query the available PaymentLink line items in Stripe. |
PaymentLinks | Create, update, and query the PaymentLinks in Stripe. |
PaymentMethodConfigurations | Create, update, and query Payment Method Configurations in Stripe. |
PaymentMethodDomains | Lists the details of existing payment method domains. |
PaymentMethods | Create, update and query the available PaymentMethods in Stripe. |
Payouts | Query the available Payouts in Stripe. |
PayoutsReconciliationSummaryForASinglePayoutReport | Payouts reconciliation summary for a single payout in Stripe. |
PayoutsReconciliationSummaryReport | Query the Payouts reconciliation summary report in Stripe. |
PayoutsSummaryReport | Query the Payouts summary report in Stripe. |
PendingBalance | Query the available balance in Stripe. |
Persons | Usage information for the operation Persons.rsd. |
Plans | Create, update, delete, and query the available Plans in Stripe. |
Prices | Create, update, and query the available prices in Stripe. |
Products | Query the available products in Stripe. |
PromotionCodes | Creates, updates, and retrieves a promotion code that represents a customer-redeemable code for a coupon. |
Quotes | Creates, updates, and queries the quotes available. |
Refunds | Create and query the available refunds in Stripe. |
Reports | To Create and Query the Report Run object, which represents an instance of a report type generated with specific run parameters. |
ReportTypes | To query the available report types. |
Reviews | Queries the reviews. |
SetupAttempts | Returns a list of SetupAttempts that associate with a provided SetupIntent. |
SetupIntents | Returns a list of SetupIntents. |
ShippingRates | Query the available Shipping rates in Stripe. |
SubscriptionItems | Create, update, delete, and query the available subscription items in Stripe. |
Subscriptions | Create, update, delete, and query the available Subscriptions in Stripe. |
SubscriptionSchedules | Retrieves the list of your subscription schedules. |
TaxCodes | Queries the tax codes which classify goods and services for tax purposes. |
TaxIds | Creates, deletes and queries the Tax Ids in Stripe. |
TaxRates | Creates, updates, and queries the tax rates that applies to Invoices, Subscriptions, and Checkout Sessions to collect tax. |
TestClocks | Create, delete, and query the available TestClocks in Stripe. |
TopUps | Creates, updates, and queries the top-up of the Stripe balance. |
Transactions | Returns a list of Issuing Transaction objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first. |
TransferReversals | Create, update, and query the available reversals belonging to a specific transfer. |
Transfers | Create, update, and query the available transfers in Stripe. |
UsageRecords | Creates and retrieves the customer usage and metrics to Stripe for metered billing for subscription prices. |
ValueListItems | Creates, deletes, and queries the Values list items. |
ValueLists | Creates, updates, deletes, and queries values in a list. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | String | True | No | The unique identifier for the account. | |
BusinessType | String | False | No | The business type of company | |
ChargesEnabled | Boolean | True | No | Whether or not the account can create live charges. | |
Country | String | False | No | The country of the account. | |
IsController | Boolean | True | No | Whether or not the Connect application retrieving the resource controls the account. | |
ControllerType | String | True | No | The controller type. | |
Created | Datetime | True | No | Time at which the account was connected. | |
DefaultCurrency | String | False | No | The currency this account has chosen to use as the default. | |
DetailsSubmitted | Boolean | True | No | Whether or not account details have been submitted yet. Standalone accounts cannot receive transfers before this is true. | |
String | False | No | The primary email address of the user. | ||
ExternalAccountsAggregate | String | True | No | External accounts (bank accounts and/or cards) currently attached to this account. | |
FutureRequirementsAggregate | String | True | No | Information about the upcoming new requirements for the account, including what information needs to be collected, and by when. | |
PayoutsEnabled | Boolean | True | No | Whether Stripe can send payouts to this account. | |
SettingsAggregate | String | True | No | Options for customizing how the account functions within Stripe. | |
BusinessProfileSupportEmail | String | False | No | The publicly shareable email address that can be reached for support for this account. | |
BusinessProfileSupportPhone | String | False | No | The publicly visible support phone number for the business. | |
BusinessProfileSupportAddressCity | String | False | No | City, district, suburb, town, or village. | |
BusinessProfileSupportAddressCountry | String | False | No | Two-letter country code. | |
BusinessProfileSupportAddressLine1 | String | False | No | Address line 1 (e.g., street, PO Box, or company name). | |
BusinessProfileSupportAddressLine2 | String | False | No | Address line 2 (e.g., apartment, suite, unit, or building). | |
BusinessProfileSupportAddressPostalCode | String | False | No | ZIP or postal code. | |
BusinessProfileSupportAddressState | String | False | No | State, county, province, or region. | |
BusinessProfileSupportUrl | String | False | No | The publicly shareable URL that can be reached for support for this account | |
BusinessProfileProductDescription | String | False | No | An internal-only description of the product or service provided. This is used by Stripe in the event the account gets flagged for potential fraud. | |
BusinessProfileMcc | String | False | No | The merchant category code for the account. | |
BusinessProfileMonthlyEstimatedRevenueAmount | Integer | False | No | A non-negative integer representing how much to charge in the smallest currency unit. | |
BusinessProfileMonthlyEstimatedRevenueCurrency | String | False | No | Three-letter ISO currency code, in lowercase. Must be a supported currency. | |
BusinessProfileName | String | False | No | The publicly visible name of the business. | |
BusinessProfileUrl | String | False | No | The publicly visible website of the business. | |
TosAcceptanceDate | Datetime | False | No | The Unix timestamp marking when the account representative accepted their service agreement. | |
TosAcceptanceIp | String | False | No | The IP address from which the account representative accepted their service agreement. | |
TosAcceptanceServiceAgreement | String | False | No | The user's service agreement type. | |
TosAcceptanceUserAgent | String | False | No | The user agent of the browser from which the account representative accepted their service agreement. | |
TransferSchedule | String | True | No | When payments collected are automatically paid out to the bank account of the account holder. | |
Type | String | False | No | A type value is required when creating accounts. The standard type replaces managed: false, and the custom type replaces managed: true. | |
RequirementsAggregate | String | True | No | The state of the information requests for the account, including what information is needed and by when it must be provided. | |
TransfersEnabled | Boolean | True | No | Whether or not Stripe will send automatic transfers for this account. | |
MetadataAggregate | String | False | No | The account metadata object. | |
Capabilities | String | True | No | In the Accounts API, the requested_capabilities property is now required at creation time for Custom accounts in all countries. See Account capabilities for more information. | |
CompanyAddressCity | String | False | No | City, district, suburb, town, or village. | |
CompanyAddressCountry | String | False | No | Two-letter country code. | |
CompanyAddressLine1 | String | False | No | Address line 1 (e.g., street, PO Box, or company name). | |
CompanyAddressLine2 | String | False | No | Address line 2 (e.g., apartment, suite, unit, or building). | |
CompanyAddressPostalCode | String | False | No | ZIP or postal code. | |
CompanyAddressState | String | False | No | State, county, province, or region. | |
CompanyDirectorsProvided | Boolean | False | No | Whether the company's directors have been provided. | |
CompanyExecutivesProvided | Boolean | False | No | Whether the company's executives have been provided. | |
CompanyExportLicenseId | String | False | No | The export license ID number of the company, also referred as Import Export Code (India only). | |
CompanyExportPurposeCode | String | False | No | The purpose code to use for export transactions (India only). | |
CompanyName | String | False | No | The company's legal name. | |
CompanyOwnersProvided | Boolean | False | No | Whether the company's owners have been provided. | |
CompanyOwnershipDeclarationDate | Datetime | False | No | The Unix timestamp marking when the beneficial owner attestation was made. | |
CompanyOwnershipDeclarationIp | String | False | No | The IP address from which the beneficial owner attestation was made. | |
CompanyOwnershipDeclarationUserAgent | String | False | No | The user agent string from the browser where the beneficial owner attestation was made. | |
CompanyPhone | String | False | No | The company's phone number | |
CompanyRegistrationNumber | String | False | No | The identification number given to a company when it is registered or incorporated, if distinct from the identification number used for filing taxes. | |
CompanyStructure | String | False | No | The category identifying the legal structure of the company or legal entity. | |
CompanyTaxId | String | False | No | The business ID number of the company, as appropriate for the company’s country. | |
CompanyVatId | String | False | No | The VAT number of the company. | |
CompanyTaxIdProvided | Boolean | True | No | Whether the company's business ID number was provided. | |
CompanyTaxIdRegistrar | String | False | No | The jurisdiction in which the tax_id is registered (Germany-based companies only). | |
CompanyVatIdProvided | Boolean | True | No | Whether the company's business VAT number was provided. | |
CompanyVerificationDocumentBack | String | False | No | A document for the company. The back of a document returned by a file upload with a purpose value of additional_verification. | |
CompanyVerificationDocumentFront | String | False | No | A document for the company. The front of a document returned by a file upload with a purpose value of additional_verification. | |
IndividualId | String | True | No | Unique identifier for the individual. | |
IndividualObject | String | False | No | String representing the object's type. | |
IndividualAccount | String | False | No | The account the individual is associated with. | |
IndividualAddressCity | String | False | No | City, district, suburb, town, or village. | |
IndividualAddressCountry | String | False | No | Two-letter country code. | |
IndividualAddressLine1 | String | False | No | Address line 1 (e.g., street, PO Box, or company name). | |
IndividualAddressLine2 | String | False | No | Address line 2 (e.g., apartment, suite, unit, or building). | |
IndividualAddressPostalCode | String | False | No | ZIP or postal code. | |
IndividualAddressState | String | False | No | State, county, province, or region. | |
IndividualDOBDay | Integer | False | No | The day of birth, between 1 and 31. | |
IndividualDOBMonth | Integer | False | No | The month of birth, between 1 and 12. | |
IndividualDOBYear | Integer | False | No | The four-digit year of birth. | |
IndividualEmail | String | False | No | The individual's email address. | |
IndividualFirstName | String | False | No | The individual's first name. | |
IndividualFullNameAliases | String | False | No | A list of alternate names or aliases that the individual is known by. | |
IndividualGender | String | False | No | The individual's gender. | |
IndividualIdNumber | String | False | No | The government-issued ID number of the individual, as appropriate for the representative’s country. | |
IndividualIdNumberSecondary | String | False | No | The government-issued secondary ID number of the individual, as appropriate for the representative’s country, will be used for enhanced verification checks. | |
IndividualLastName | String | False | No | The individual's last name. | |
IndividualMaidenName | String | False | No | The individual's maiden name. | |
IndividualMetadataAggregate | String | False | No | Metadata for the individual | |
IndividualNationality | String | False | No | The country where the person is a national. | |
IndividualPhone | String | False | No | The individual's phone number. | |
IndividualPoliticalExposure | String | False | No | Indicates if the person or any other closely related persons declares that they have held an important public job or function. | |
IndividualRegisteredAddressCity | String | False | No | City, district, suburb, town, or village. | |
IndividualRegisteredAddressCountry | String | False | No | Two-letter country code. | |
IndividualRegisteredAddressLine1 | String | False | No | Address line 1 (e.g., street, PO Box, or company name). | |
IndividualRegisteredAddressLine2 | String | False | No | Address line 2 (e.g., apartment, suite, unit, or building). | |
IndividualRegisteredAddressPostalCode | String | False | No | ZIP or postal code. | |
IndividualRegisteredAddressState | String | False | No | State, county, province, or region. | |
IndividualSSNLast4 | String | False | No | The last four digits of the individual's Social Security Number (U.S. only). | |
IndividualVerificationAdditionalDocumentBack | String | False | No | The individual's verification document information. The back of an ID returned by a file upload with a purpose value of identity_document. | |
IndividualVerificationAdditionalDocumentFront | String | False | No | The individual's verification document information. The front of an ID returned by a file upload with a purpose value of identity_document. | |
IndividualVerificationDocumentBack | String | False | No | The individual's verification document information. The back of an ID returned by a file upload with a purpose value of identity_document. | |
IndividualVerificationDocumentFront | String | False | No | The individual's verification document information. The front of an ID returned by a file upload with a purpose value of identity_document. | |
BusinessProfileAnnualRevenueAmount | Integer | False | No | A non-negative integer representing the amount in the smallest currency unit. | |
BusinessProfileAnnualRevenueCurrency | String | False | No | Three-letter ISO currency code, in lowercase. Must be a supported currency. | |
BusinessProfileAnnualRevenueFiscalYearEnd | Date | False | No | The close-out date of the preceding fiscal year in ISO 8601 format. E.g. 2023-12-31 for the 31st of December, 2023. | |
BusinessProfileEstimatedWorkerCount | Integer | False | No | An estimated upper bound of employees, contractors, vendors, etc. currently working for the business. | |
AccountId | String | False | Yes | The Id of the connected account | |
CapabilitiesTransfers | Boolean | False | Yes | In the Accounts API, the requested_capabilities property is now required at creation time for Custom accounts in all countries. See Account capabilities for more information.This is only for insert | |
CapabilitiesCardPayments | Boolean | False | Yes | In the Accounts API, the requested_capabilities property is now required at creation time for Custom accounts in all countries. See Account capabilities for more information. This is only for insert |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | String | True | No | The id of files. | |
ApplicationFeeId [KEY] | String | True | No | The Id of the application fee. | |
Amount | Integer | True | No | Amount, in cents. | |
BalanceTransaction | String | True | No | Balance transaction that describes the impact on your account balance. | |
Currency | String | True | No | Three-letter ISO currency code, in lowercase. Must be a supported currency. | |
Created | Datetime | True | No | Time at which the object was created. Measured in seconds since the Unix epoch. | |
MetadataAggregate | String | True | No | The set of key/value pairs that you can attach to a an object. | |
AccountId | String | False | Yes | The Id of the connected account to get files for. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | String | True | No | The id of files. | |
Amount | Integer | True | No | Amount, in cents. | |
AmountRefunded | Integer | True | No | Amount in cents refunded (can be less than the amount attribute on the fee if a partial refund was issued). | |
Application | String | True | No | ID of the Connect application that earned the fee. | |
BalanceTransaction | String | True | No | Balance transaction that describes the impact on your account balance. | |
Charge | String | True | No | ID of the charge that the application fee was taken from. | |
Currency | String | True | No | Three-letter ISO currency code, in lowercase. Must be a supported currency. | |
Created | Datetime | True | No | Time at which the object was created. Measured in seconds since the Unix epoch. | |
Livemode | Boolean | True | No | Has the value true if the object exists in live mode or the value false if the object exists in test mode. | |
OriginatingTransaction | String | True | No | ID of the corresponding charge on the platform account, if this fee was the result of a charge using the destination parameter. | |
Refunded | Boolean | True | No | Whether the fee has been fully refunded. If the fee is only partially refunded, this attribute will still be false. | |
Refunds | String | True | No | A list of refunds that have been applied to the fee. | |
AccountId | String | True | No | The Id of the connected account to get files for. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | String | True | No | Unique identifier for the object. | |
Amount | Integer | True | No | The total amount that was authorized or rejected. | |
AmountDetailsAtmFee | Integer | True | No | The fee charged by the ATM for the cash withdrawal. | |
AmountDetailsCashbackAmount | Integer | True | No | The amount of cash requested by the cardholder. | |
Approved | Boolean | True | No | Whether the authorization has been approved. | |
AuthorizationMethod | String | True | No | How the card details were provided. | |
BalanceTransactions | String | True | No | List of balance transactions associated with this authorization. | |
CardId | String | True | No | Unique identifier for the object. | |
CardObject | String | True | No | String representing the objects type. Objects of the same type share the same value. | |
CardBrand | String | True | No | The brand of the card. | |
CardCancellation_reason | String | True | No | The reason why the card was canceled. | |
CardCardholderId | String | True | No | Unique identifier for the object. | |
CardCardholderObject | String | True | No | String representing the objects type. Objects of the same type share the same value. | |
CardCardholderBillingAddressCity | String | True | No | City, district, suburb, town, or village. | |
CardCardholderBillingAddressCountry | String | True | No | Two-letter country code | |
CardCardholderBillingAddressLine1 | String | True | No | Address line 1 | |
CardCardholderBillingAddressLine2 | String | True | No | Address line 2 | |
CardCardholderBillingAddressPostalCode | String | True | No | ZIP or postal code. | |
CardCardholderBillingAddressState | String | True | No | State, county, province, or region. | |
CardCardholderCompanyTaxIdProvided | Boolean | True | No | Whether the companys business ID number was provided. | |
CardCardholderCreated | Datetime | True | No | Time at which the object was created. Measured in seconds since the Unix epoch. | |
CardCardholderEmail | String | True | No | The cardholders email address. | |
CardIssuingUserTermsAcceptanceDate | Datetime | True | No | The Unix timestamp marking when the cardholder accepted the Authorized User Terms. | |
CardIssuingUserTermsAcceptanceIP | String | True | No | The IP address from which the cardholder accepted the Authorized User Terms. | |
CardIssuingUserTermsAcceptanceUserAgent | String | True | No | The user agent of the browser from which the cardholder accepted the Authorized User Terms. | |
CardCardholderDOBDay | Integer | True | No | The day of birth, between 1 and 31. | |
CardCardholderDOBMonth | Integer | True | No | The month of birth, between 1 and 12. | |
CardCardholderDOBYear | Integer | True | No | The four-digit year of birth. | |
CardCardholderFirstName | String | True | No | The first name of this cardholder. | |
CardCardholderLastName | String | True | No | The last name of this cardholder. | |
CardCardholderVerficationDocBack | String | True | No | The back of a document returned by a file upload with a purpose value of identity_document. | |
CardCardholderVerficationDocFront | String | True | No | The front of a document returned by a file upload with a purpose value of identity_document. | |
CardCardholderLivemode | Boolean | True | No | Has the value true if the object exists in live mode or the value false if the object exists in test mode. | |
CardCardholderMetadataAggregate | String | True | No | The set of key/value pairs that you can attach to a an object. | |
CardCardholderName | String | True | No | The cardholders name. This will be printed on cards issued to them. | |
CardCardholderPhoneNumber | String | True | No | The cardholders phone number. This is required for all cardholders who will be creating EU cards. | |
CardCardholderPreferredLocales | String | True | No | The cardholders preferred locales (languages), ordered by preference. | |
CardCardholderRequirementsDisabledReason | String | True | No | If disabled_reason is present, all cards will decline authorizations with cardholder_verification_required reason. | |
CardCardholderRequirementsPastDue | String | True | No | Array of fields that need to be collected in order to verify and re-enable the cardholder. | |
CardCardholderSpendingControlsAllowedCategories | String | True | No | Array of strings containing categories of authorizations to allow. | |
CardCardholderSpendingControlsBlockedCategories | String | True | No | Array of strings containing categories of authorizations to decline. | |
CardCardholderSpendingControlsSpendingLimits | String | True | No | Limit spending with amount-based rules that apply across this cardholders cards. | |
CardCardholderSpendingControlsSpendingLimitsCurrency | String | True | No | Currency of the amounts within spending_limits. | |
CardCardholderStatus | String | True | No | Specifies whether to permit authorizations on this cardholder’s cards. | |
CardCardholderType | String | True | No | One of individual or company. | |
CardCreated | Datetime | True | No | Time at which the object was created. Measured in seconds since the Unix epoch. | |
CardCurrency | String | True | No | Three-letter ISO currency code, in lowercase. | |
CardCVC | String | True | No | The cards CVC. For security reasons, this is only available for virtual cards, and will be omitted unless you explicitly request it with the expand parameter. | |
CardExpMonth | Integer | True | No | The expiration month of the card. | |
CardExpYear | Integer | True | No | The expiration year of the card. | |
CardLast4 | String | True | No | The last 4 digits of the card number. | |
CardLivemode | Boolean | True | No | Has the value true if the object exists in live mode or the value false if the object exists in test mode. | |
CardMetadataAggregate | String | True | No | The set of key/value pairs that you can attach to a an object. | |
CardNumber | String | True | No | The full unredacted card number. | |
CardReplacedBy | String | True | No | The latest card that replaces this card, if any. | |
CardReplacementFor | String | True | No | The card this card replaces, if any. | |
CardReplacementReason | String | True | No | The reason why the previous card needed to be replaced. | |
CardShipping | String | True | No | Where and how the card will be shipped. | |
CardCardholderSpendingControlsAllowedMerchantCountries | String | True | No | Array of strings containing representing countries from which authorizations will be allowed. Authorizations from merchants in all other countries will be declined. Country codes should be ISO 3166 alpha-2 country codes (e.g. US). Cannot be set with blocked_merchant_countries. Provide an empty value to unset this control. | |
CardCardholderSpendingControlsBlockedMerchantCountries | String | True | No | Array of strings containing representing countries from which authorizations will be declined. Country codes should be ISO 3166 alpha-2 country codes (e.g. US). Cannot be set with allowed_merchant_countries. Provide an empty value to unset this control. | |
CardPersonalizationDesign | String | True | No | The personalization design object belonging to this card. | |
CardSpendingControlsAllowedCategories | String | True | No | Array of strings containing categories of authorizations to allow. All other categories will be blocked. Cannot be set with blocked_categories. | |
CardSpendingControlsAllowedMerchantCountries | String | True | No | Array of strings containing representing countries from which authorizations will be allowed. Authorizations from merchants in all other countries will be declined. Country codes should be ISO 3166 alpha-2 country codes (e.g. US). Cannot be set with blocked_merchant_countries. Provide an empty value to unset this control. | |
CardSpendingControlsBlockedCategories | String | True | No | Array of strings containing categories of authorizations to decline. All other categories will be allowed. Cannot be set with allowed_categories. | |
CardSpendingControlsBlockedMerchantCountries | String | True | No | Array of strings containing representing countries from which authorizations will be declined. Country codes should be ISO 3166 alpha-2 country codes (e.g. US). Cannot be set with allowed_merchant_countries. Provide an empty value to unset this control. | |
CardSpendingControlsSpendingLimits | String | True | No | Limit spending with amount-based rules that apply across any cards this card replaced (i.e., its replacement_for card and that card’s replacement_for card, up the chain). | |
CardSpendingControlsSpendingLimitsCurrency | String | True | No | Currency of the amounts within spending_limits. Always the same as the currency of the card. | |
CardType | String | True | No | The type of the card. Possible enum values: physical, virtual. | |
CardWalletsApplePayEligible | Boolean | True | No | Apple Pay Eligibility. | |
CardWalletsApplePayIneligibleReason | String | True | No | Reason the card is ineligible for Apple Pay. | |
CardWalletsGooglePayEligible | Boolean | True | No | Google Pay Eligibility. | |
CardWalletsGooglePayIneligibleReason | String | True | No | Reason the card is ineligible for Google Pay. | |
CardWalletsPrimaryAccountIdentifier | String | True | No | Unique identifier for a card used with digital wallets. | |
Cardholder | String | True | No | The cardholder to whom this authorization belongs. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Currency | String | False | No | The currency of the available balance. | |
Amount | Long | False | No | The available amount. | |
SourceTypesCard | Long | False | No | The source cards. | |
SourceTypesBankAccount | Long | False | No | Amount for bank account. | |
SourceTypesBitcoinReceiver | Long | False | No | Amount for Bitcoin Receiver. | |
Livemode | Boolean | False | No | Has the value true if the object exists in live mode or the value false if the object exists in test mode. | |
AccountId | String | False | Yes | The Id of the connected account to get available balance for |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Reporting_Category | String | True | No | Reporting Category is a new categorization of balance transactions, meant to improve on the current type field. | |
Currency | String | True | No | Three-letter ISO code for the currency in which gross, fee and net are defined. | |
Count | Int | True | No | The number of transactions associated with the reporting_category. | |
Gross | Decimal | True | No | Sum of the gross amounts of the transactions associated with the reporting_category. Expressed in major units of the currency (e.g. dollars for USD, yen for JPY). | |
Fee | Decimal | True | No | Sum of the fees paid for the transactions associated with the reporting_category. Expressed in major units of the currency (e.g. dollars for USD, yen for JPY). | |
Net | Decimal | True | No | Sum of the net amounts for the transactions associated with the reporting_category. Expressed in major units of the currency (e.g. dollars for USD, yen for JPY). | |
Id [KEY] | String | True | Reports.Id | No | Unique identifier for the reports run object. |
ParametersIntervalEnd | Datetime | True | No | Ending timestamp of data to be included in the report run (exclusive). | |
ParametersIntervalStart | Datetime | True | No | Starting timestamp of data to be included in the report run. | |
ParametersColumns | String | True | No | The set of output columns requested for inclusion in the report run. | |
ParametersCurrency | String | True | No | Currency of objects to be included in the report run. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Category | String | True | No | One of starting_balance, ending_balance, activity or payouts. | |
Description | String | True | No | One of Starting balance (YYYY-MM-DD) - the balance at the start of the period, Activity - the net amount of all transactions that affected your balance except for payouts, Less payouts - the amount of payouts to your bank account, or Ending balance (YYYY-MM-DD) - the balance left over at the end of the period after subtracting payouts from the Starting balance and Activity. | |
Net_Amount | Decimal | True | No | Net amount for the transactions associated with category. Expressed in major units of the currency (e.g. dollars for USD, yen for JPY). | |
Currency | String | True | No | Three-letter ISO code for the currency in which net_amount is defined. | |
Id [KEY] | String | True | Reports.Id | No | Unique identifier for the reports run object. |
ParametersIntervalEnd | Datetime | True | No | Ending timestamp of data to be included in the report run (exclusive). | |
ParametersIntervalStart | Datetime | True | No | Starting timestamp of data to be included in the report run. | |
ParametersColumns | String | True | No | The set of output columns requested for inclusion in the report run. | |
ParametersCurrency | String | True | No | Currency of objects to be included in the report run. | |
ParametersTimezone | String | True | No | Defaults to Etc/UTC. The output timezone for all timestamps in the report. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | String | False | No | The Id of the balance transaction. | |
Amount | Integer | False | No | Gross amount of the transaction, in cents. | |
AvailableOn | Datetime | False | No | The date the net funds of the transaction will become available in the Stripe balance. | |
Created | Datetime | False | No | The datetime of creation. | |
Currency | String | False | No | The currency of the transaction. | |
Description | String | False | No | The transaction description. | |
Fee | Integer | False | No | Fees (in cents) paid for this transaction. | |
FeeDetailsAggregate | String | False | No | The fee details. | |
Net | Integer | False | No | Net amount of the transaction, in cents. | |
Source | String | False | No | The Stripe object this transaction is related to. | |
Status | String | False | No | If the net funds of the transaction are available in the Stripe balance yet. Either available or pending. | |
Type | String | False | No | Transaction type. | |
ReportingCategory | String | False | No | reporting categories can help you understand balance transactions from an accounting perspective. | |
ExchangeRate | Decimal | False | No | The exchange rate used, if applicable, for this transaction. | |
Transfer | String | False | Yes | For automatic Stripe transfers only, only returns transactions that were transferred out on the specified transfer Id. | |
Payout | String | False | Yes | For automatic Stripe payouts only, only returns transactions that were payed out on the specified payout ID. | |
AccountId | String | False | Yes | The Id of the connected account to get balance history for |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | String | True | No | The Id for the bank account. | |
CustomerId [KEY] | String | False | No | The customer id this account belongs to. | |
Account | String | True | No | The account id. | |
AccountHolderName | String | False | No | The name of the person or business that owns the bank account. | |
AccountHolderType | String | False | No | The type of entity that holds the account. | |
AccountNumber | String | False | No | The type of entity that holds the account. | |
BankName | String | True | No | Name of the bank associated with the routing number. | |
Country | String | False | No | Two-letter ISO code representing the country the bank account is located in. | |
Currency | String | False | No | Three-letter ISO currency code representing the currency paid out to the bank account. | |
DefaultForCurrency | Boolean | True | No | This indicates whether or not this bank account is the default external account for its currency. | |
Fingerprint | String | True | No | Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. | |
Last4 | String | True | No | Last 4 digits of the bank account. | |
RoutingNumber | String | False | No | The routing transit number for the bank account. | |
Status | String | True | No | The status of the account. | |
AccountType | String | True | No | The bank account type. This can only be checking or savings in most countries. In Japan, this can only be futsu or toza. | |
MetadataAggregate | String | False | No | A list of up to 8 URLs of images for this product, meant to be displayable to the customer. | |
Object | String | False | No | String representing the object's type. Objects of the same type share the same value. | |
AvailablePayoutMethods | String | True | No | A set of available payout methods for this bank account. Only values from this set should be passed as the method when creating a payout. | |
Source | String | False | Yes | The token ID | |
AccountId | String | False | Yes | The Id of the connected account to get back accounts for |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | String | True | No | The Id of the token. | |
BankAccountId | String | True | No | The bank account this token will represent. | |
AccountHolderName | String | False | No | The name of the person or business that owns the bank account. | |
AccountHolderType | String | False | No | The type of entity that holds the account. | |
AccountType | String | False | No | The type of entity that holds the account type. | |
AccountNumber | String | False | No | The type of entity that holds the account number. | |
BankName | String | True | No | Name of the bank associated with the routing number. | |
Fingerprint | String | True | No | Uniquely identifier. | |
Last4 | String | True | No | The last 4 digits of the bank account number. | |
RoutingNumber | String | False | No | The routing transit number for the bank account. | |
Status | String | True | No | Status of the account. | |
Country | String | False | No | Two-letter ISO code representing the country the bank account/card is located in. | |
Currency | String | False | No | The currency of the card. | |
ClientIp | String | True | No | The IP address of the client that generated the token. | |
Created | Datetime | True | No | The datetime of the token. | |
Used | Boolean | True | No | Whether or not this token has already been used. | |
LiveMode | Boolean | True | No | Has the value true if the object exists in live mode or the value false if the object exists in test mode. | |
Type | String | True | No | Type of token. | |
CustomerId | String | False | Yes | The Id of the customer to create a token for. | |
AccountId | String | False | Yes | The Id of the connected account to get bank account tokens for |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | String | True | No | Unique identifier for the object. | |
BillingAddressCity | String | True | No | City, district, suburb, town, or village. | |
BillingAddressCountry | String | True | No | Two-letter country code | |
BillingAddressLine1 | String | True | No | Address line 1 | |
BillingAddressLine2 | String | True | No | Address line 2 | |
BillingAddressPostalCode | String | True | No | ZIP or postal code. | |
BillingAddressState | String | True | No | State, county, province, or region. | |
String | True | No | The cardholders email address. | ||
MetadataAggregate | String | True | No | The set of key/value pairs that you can attach to a an object. | |
Name | String | True | No | The cardholders name. This will be printed on cards issued to them. | |
IsCompanyTaxIdProvided | Boolean | True | No | The cardholders phone number. | |
Created | Datetime | True | No | Time at which the object was created. Measured in seconds since the Unix epoch. | |
Individual | String | True | No | Additional information about an individual cardholder. | |
Livemode | Boolean | True | No | Has the value true if the object exists in live mode or the value false if the object exists in test mode. | |
Object | String | True | No | String representing the objects type. Objects of the same type share the same value. | |
PhoneNumber | String | True | No | The cardholders phone number. | |
RequirementsDisabledReason | String | True | No | If disabled_reason is present, all cards will decline authorizations with cardholder_verification_required reason. | |
RequirementsPastDue | String | True | No | Array of fields that need to be collected in order to verify and re-enable the cardholder. | |
SpendingControlsAllowedCategories | String | True | No | Array of strings containing categories of authorizations to allow. | |
SpendingControlsBlockedCategories | String | True | No | Array of strings containing categories of authorizations to decline. | |
SpendingControlsSpendingLimits | String | True | No | Limit spending with amount-based rules that apply across this cardholders cards. | |
SpendingControlsSpendingLimitsCurrency | String | True | No | Currency of the amounts within spending_limits. | |
Status | String | True | No | Specifies whether to permit authorizations on this cardholders cards. | |
Type | String | True | No | One of individual or company. | |
PreferredLocales | String | True | No | The cardholder's preferred locales (languages), ordered by preference. Locales can be de, en, es, fr, or it. This changes the language of the 3D Secure flow and one-time password messages sent to the cardholder. | |
SpendingControlsAllowedMerchantCountries | String | True | No | Array of strings containing representing countries from which authorizations will be allowed. Authorizations from merchants in all other countries will be declined. Country codes should be ISO 3166 alpha-2 country codes (e.g. US). Cannot be set with blocked_merchant_countries. Provide an empty value to unset this control. | |
SpendingControlsBlockedMerchantCountries | String | True | No | Array of strings containing representing countries from which authorizations will be declined. Country codes should be ISO 3166 alpha-2 country codes (e.g. US). Cannot be set with allowed_merchant_countries. Provide an empty value to unset this control. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | String | True | No | The card Id. | |
CustomerId [KEY] | String | False | No | The customer Id this card belongs to. | |
ExpMonth | Integer | False | No | The card expiry month. | |
ExpYear | Integer | False | No | The card expiry year. | |
Currency | String | False | No | Only applicable on accounts (not customers or recipients). The card can be used as a transfer destination for funds in this currency. | |
Account | String | True | No | The account Id this card belongs to. | |
Token | String | False | No | The token Id. | |
AddressCity | String | False | No | The city address. | |
AddressCountry | String | False | No | Billing address country, if provided when creating card. | |
AddressLine1 | String | False | No | The address line 1. | |
AddressLine1Check | String | True | No | If AddressLine1 was provided. Possible values: pass, fail, unavailable, or unchecked. | |
AddressLine2 | String | False | No | The address line 2. | |
AddressState | String | False | No | The address state. | |
AddressZip | String | False | No | The address ZIP. | |
AddressZipCheck | String | True | No | If AddressZip was provided. Possible values: pass, fail, unavailable, or unchecked. | |
Brand | String | True | No | Card brand. | |
Country | String | True | No | 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 have collected. | |
CvcCheck | String | True | No | If a CVC was provided. Possible values: pass, fail, unavailable, or unchecked. | |
Cvc | String | False | No | Card security code. Highly recommended to always include this value, but it’s required only for accounts based in European countries. | |
DefaultForCurrency | Boolean | False | No | Only applicable on accounts (not customers or recipients). This indicates whether or not this card is the default external account for its currency. | |
Number | String | False | No | The card number. | |
Fingerprint | String | True | No | Uniquely identifies this particular card number. | |
Funding | String | True | No | Card funding type. | |
Last4 | String | True | No | Last 4 digits of the card. | |
Name | String | False | No | Cardholder name. | |
TokenizationMethod | String | True | No | If the card number is tokenized, this is the method that was used. | |
Metadata | String | False | No | 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. | |
Object | String | False | No | String representing the object's type. Objects of the same type share the same value. | |
AvailablePayoutMethods | String | True | No | A set of available payout methods for this card. Only values from this set should be passed as the method when creating a payout. | |
DynamicLast4 | String | True | No | (For tokenized numbers only.) The last four digits of the device account number. | |
WalletApplePay | String | True | No | If this is a apple_pay card wallet, this hash contains details about the wallet. | |
WalletType | String | True | No | The type of the card wallet, one of apple_pay. An additional hash is included on the Wallet subhash with a name matching this value. It contains additional information specific to the card wallet type. | |
AccountId | String | False | Yes | The Id of the connected account to get cards for. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | String | True | No | The Id of the token. | |
CardId | String | True | No | The Id of card (used in conjunction with a customer or recipient Id) | |
AddressCity | String | False | No | The city address of the card. | |
AddressCountry | String | False | No | The country address of the card. | |
AddressLine1 | String | False | No | The address line 1. | |
AddressLine1Check | String | True | No | If address_line1 was provided. | |
AddressLine2 | String | False | No | The address line 2. | |
AddressState | String | False | No | The address state. | |
AddressZip | String | False | No | The zip address. | |
AddressZipCheck | String | True | No | If address_zip was provided. | |
Brand | String | True | No | The card brand. | |
Country | String | True | No | Two-letter ISO code representing the country the bank account/card is located in. | |
Currency | String | False | No | The currency of the card. | |
CvcCheck | String | True | No | If a CVC was provided. | |
DynamicLast4 | String | True | No | The last four digits of the device account number. | |
ExpMonth | Integer | False | No | The card expiration month. | |
ExpYear | Integer | False | No | The card expiration year. | |
Last4 | String | True | No | Last4. | |
Fingerprint | String | True | No | Uniquely identifier. | |
Funding | String | True | No | Card funding type. | |
Name | String | False | No | Cardholder name. | |
MetadataAggregate | String | True | No | The card metadata object. | |
TokenizationMethod | String | True | No | If the card number is tokenized, this is the method that was used. | |
ClientIp | String | True | No | The IP address of the client that generated the token. | |
Created | Datetime | True | No | The datetime of the token. | |
Used | Boolean | True | No | Whether or not this token has already been used. | |
Number | String | False | No | The card number. | |
LiveMode | Boolean | True | No | Has the value true if the object exists in live mode or the value false if the object exists in test mode. | |
Type | String | True | No | Type of token. | |
CustomerId | String | False | Yes | The Id of the customer to create a token for. | |
AccountId | String | False | Yes | The Id of the connected account to get card tokens for. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
CustomerId [KEY] | String | True | No | The Id of the customer. | |
Available | String | True | No | A hash of all cash balances available to this customer. | |
Livemode | Boolean | True | No | true if the object is in live mode andfalse if in test mode. | |
object | String | True | No | String representing the object's type. | |
ReconciliationMode | String | True | No | The configuration for how funds that land in the customer cash balance are reconciled. | |
UsingMerchantDefault | Boolean | True | No | A flag to indicate if reconciliation mode returned is the user?s default or is specific to this customer cash balance. | |
AccountId | String | False | Yes | The Id of the connected account to get customer discounts for |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | String | True | No | The Id of the Cash Balance Transaction. | |
CustomerId [KEY] | String | True | Customers.Id | No | The customer whose available cash balance changed as a result of this transaction. |
AdjustedForOverdraftBalanceTransaction | String | True | No | If this is a type=adjusted_for_overdraft transaction, contains the Balance Transaction that corresponds to funds taken out of your Stripe balance. | |
AdjustedForOverdraftLinkedTransaction | String | True | No | If this is a type=adjusted_for_overdraft transaction, contains the Cash Balance Transaction that brought the customer balance negative, triggering the clawback of funds. | |
AppliedToPaymentPaymentIntent | String | True | No | If this is a type=applied_to_payment transaction, contains the Payment Intent that funds were applied to. | |
Created | Datetime | True | No | Time at which the object was created. Measured in seconds since the Unix epoch. | |
Currency | String | True | No | Three-letter ISO currency code, in lowercase. Must be a supported currency. | |
EndingBalance | Integer | True | No | The total available cash balance for the specified currency after this transaction was applied. Represented in the smallest currency unit. | |
FundedBankTransferEuBankTransferBic | String | True | No | If this is a type=funded transaction, and the bank transfer is an EU bank transfer which funded the customer's cash balance, contains the BIC of the bank of the sender of the funding. | |
FundedBankTransferEuBankTransferIbanLast4 | Integer | True | No | If this is a type=funded transaction, and the bank transfer is an EU bank transfer which funded the customer's cash balance, contains the last 4 digits of the IBAN of the sender of the funding. | |
FundedBankTransferEuBankTransferSenderName | String | True | No | If this is a type=funded transaction, and the bank transfer is an EU bank transfer which funded the customer's cash balance, contains the full name of the sender, as supplied by the sending bank. | |
FundedBankTransferGbBankTransferAccountNumberLast4 | Integer | True | No | If this is a type=funded transaction, and the bank transfer is a UK bank transfer which funded the customer's cash balance, contains the last 4 digits of the account number of the sender of the funding. | |
FundedBankTransferGbBankTransferSenderName | String | True | No | If this is a type=funded transaction, and the bank transfer is a UK bank transfer which funded the customer's cash balance, contains the full name of the sender, as supplied by the sending bank. | |
FundedBankTransferGbBankTransferSortCode | String | True | No | If this is a type=funded transaction, and the bank transfer is a UK bank transfer which funded the customer's cash balance, contains the sort code of the bank of the sender of the funding. | |
FundedBankTransferJpBankTransferSenderBank | String | True | No | If this is a type=funded transaction, and the bank transfer is a Japan bank transfer which funded the customer's cash balance, contains the name of the bank of the sender of the funding. | |
FundedBankTransferJpBankTransferSenderBranch | String | True | No | If this is a type=funded transaction, and the bank transfer is a Japan bank transfer which funded the customer's cash balance, contains the name of the bank branch of the sender of the funding. | |
FundedBankTransferJpBankTransferSenderName | String | True | No | If this is a type=funded transaction, and the bank transfer is a Japan bank transfer which funded the customer's cash balance, contains the full name of the sender, as supplied by the sending bank. | |
FundedBankTransferReference | String | True | No | If this is a type=funded transaction, contains the user-supplied reference field on the bank transfer. | |
FundedBankTransferType | String | True | No | If this is a type=funded transaction, contains the funding method type used to fund the customer balance. Permitted values include: eu_bank_transfer, gb_bank_transfer, jp_bank_transfer, mx_bank_transfer, or us_bank_transfer. | |
FundedBankTransferUsBankTransferNetwork | String | True | No | If this is a type=funded transaction, contains US-specific banking network used for this funding. | |
FundedBankTransferUsBankTransferSenderName | String | True | No | If this is a type=funded transaction, contains US-specific full name of the sender, as supplied by the sending bank. | |
Livemode | Boolean | True | No | Has the value true if the object exists in live mode or the value false if the object exists in test mode. | |
NetAmount | Integer | True | No | The amount by which the cash balance changed, represented in the smallest currency unit. A positive value represents funds being added to the cash balance, a negative value represents funds being removed from the cash balance. | |
RefundedFromPaymentRefund | String | True | No | If this is a type=refunded_from_payment transaction, contains the Refund that moved these funds into the customer’s cash balance. | |
TransferredToBalanceBalanceTransaction | String | True | No | If this is a type=transferred_to_balance transaction, contains the Balance Transaction that corresponds to funds transferred to your Stripe balance. | |
Type | String | True | No | The type of the cash balance transaction. New types may be added in future. | |
UnappliedFromPaymentPaymentIntent | String | True | No | If this is a type=unapplied_from_payment transaction, contains the Payment Intent that funds were unapplied from. | |
Object | String | True | No | String representing the object’s type. Objects of the same type share the same value. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | String | True | No | The Id of the charge. | |
Amount | Integer | False | No | The amount of the charge. | |
Currency | String | False | No | The currency of the charge. | |
CustomerId | String | False | No | The customer Id of the charge. | |
AmountRefunded | Integer | True | No | The amount in cents refunded. | |
ApplicationFee | String | True | No | The application fee (if any) for the charge. | |
ApplicationFeeAmount | Integer | False | No | The amount of the application fee (if any) for the charge. | |
BalanceTransaction | String | True | No | The Id of the balance transaction that describes the impact of this charge on your account balance . | |
BillingDetailsAddressCity | String | True | No | Billing information associated with the payment method at the time of the transaction. | |
BillingDetailsAddressCountry | String | True | No | Billing information associated with the payment method at the time of the transaction. | |
BillingDetailsAddressLine1 | String | True | No | Billing information associated with the payment method at the time of the transaction. | |
BillingDetailsAddressLine2 | String | True | No | Billing information associated with the payment method at the time of the transaction. | |
BillingDetailsAddressPostalCode | String | True | No | Billing information associated with the payment method at the time of the transaction. | |
BillingDetailsAddressState | String | True | No | Billing information associated with the payment method at the time of the transaction. | |
BillingDetailsEmail | String | True | No | Billing information associated with the payment method at the time of the transaction. | |
BillingDetailsName | String | True | No | Billing information associated with the payment method at the time of the transaction. | |
BillingDetailsPhone | String | True | No | Billing information associated with the payment method at the time of the transaction. | |
Captured | Boolean | False | No | Whether the charge was created without capturing. | |
CalculatedStatementDescriptor | String | True | No | The full statement descriptor that is passed to card networks, and that is displayed on your customers' credit card and bank statements. Allows you to see what the statement descriptor looks like after the static and dynamic portions are combined. | |
Created | Datetime | True | No | The datetime the charge was created. | |
Description | String | False | No | The description of the charge. | |
Disputed | Boolean | True | No | Whether the charge has been disputed. | |
DisputeId | String | True | No | The Id of the associated dispute. | |
FailureCode | String | True | No | The error code explaining the reason for the charge failure if available. | |
FailureMessage | String | True | No | The message to the user further explaining the reason for the charge failure if available. | |
FraudDetailsStripeReport | String | True | No | Information on fraud assessments for the charge. | |
FraudDetailsUserReport | String | False | No | Information on fraud assessments for the charge. | |
Invoice | String | True | No | The Id of the invoice this charge is for if one exists. | |
Livemode | Boolean | True | No | Whether the charge is in live mode. | |
MetadataAggregate | String | False | No | The charge metadata object. | |
Order | String | True | No | The Id of the order this charge is for if one exists. | |
OutcomeAggregate | String | True | No | Details about whether the payment was accepted, and why. See understanding declines for details. | |
Paid | Boolean | True | No | If the charge succeeded or was successfully authorized for later capture. | |
PaymentIntent | String | True | No | ID of the PaymentIntent associated with this charge, if one exists. | |
PaymentMethod | String | True | No | ID of the payment method used in this charge. | |
PaymentMethodDetailsAggregate | String | True | No | Details about the payment method at the time of the transaction. | |
ReceiptEmail | String | False | No | The email address that the receipt for this charge was sent to. | |
ReceiptNumber | String | True | No | The transaction number that appears on email receipts sent for this charge. | |
ReceiptURL | String | True | No | This is the URL to view the receipt for this charge. The receipt is kept up-to-date to the latest state of the charge, including any refunds. If the charge is for an Invoice, the receipt is stylized as an Invoice receipt. | |
Refunded | Boolean | True | No | Whether the charge has been fully refunded. If the charge is only partially refunded, this attribute will still be false. | |
RefundsAggregate | String | True | No | The list of refunds that have been applied to the charge. | |
Review | String | True | No | ID of the review associated with this charge if one exists. | |
ShippingAddressCity | String | False | No | Shipping information for the charge. Shipping address. City, district, suburb, town, or village. | |
ShippingAddressCountry | String | False | No | Shipping information for the charge. Shipping address. Two-letter country code (ISO 3166-1 alpha-2) | |
ShippingAddressLine1 | String | False | No | Shipping information for the charge. Shipping address. Address line 1 (e.g., street, PO Box, or company name). | |
ShippingAddressLine2 | String | False | No | Shipping information for the charge. Shipping address. Address line 2 (e.g., apartment, suite, unit, or building). | |
ShippingAddressPostalCode | String | False | No | Shipping information for the charge. Shipping address. ZIP or postal code. | |
ShippingAddressState | String | False | No | Shipping information for the charge. Shipping address. State, county, province, or region. | |
ShippingCarrier | String | False | No | Shipping information for the charge. The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc. | |
ShippingName | String | False | No | Shipping information for the charge. Recipient name. | |
ShippingPhone | String | False | No | Shipping information for the charge. Recipient phone (including extension). | |
ShippingTrackingNumber | String | False | No | Shipping information for the charge. 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. | |
SourceId | String | False | No | Source Id. The source of every charge is a credit or debit card. | |
SourceAddressCity | String | False | No | Source address city. | |
SourceAddressCountry | String | False | No | Source address country. | |
SourceAddressLine1 | String | False | No | Source address line1. | |
SourceAddressLine2 | String | False | No | Source address line2. | |
SourceAddressState | String | False | No | Source address state. | |
SourceAddressZip | String | False | No | Source address zip. | |
SourceAddressZipCheck | String | False | No | Source address zip check. | |
SourceBrand | String | False | No | Source brand. | |
SourceCountry | String | False | No | Source country. | |
SourceCustomer | String | False | No | Source customer. | |
SourceCvcCheck | String | False | No | Source cvc check. | |
SourceDynamicLast4 | String | False | No | Source dynamic last4. | |
SourceExpMonth | Integer | False | No | Source expiry month. | |
SourceExpYear | Integer | False | No | Source expiry year. | |
SourceFingerprint | String | False | No | Source fingerprint. | |
SourceFunding | String | False | No | Source funding. | |
SourceLast4 | Integer | False | No | Source last4. | |
SourceMetadata | String | False | No | Source metadata. | |
SourceName | String | False | No | Source name. | |
SourceObject | String | False | No | Source object. | |
SourceTokenizationMethod | String | False | No | Source tokenization method. | |
SourceWallet | String | False | No | Source wallet. | |
SourceTransfer | String | True | No | The transfer Id that created this charge. | |
StatementDescriptor | String | False | No | The extra information about a charge. | |
Status | String | True | No | The status of the payment is either succeeded, pending, or failed. | |
Transfer | String | True | No | The Id of the transfer to the destination account. | |
TransferDataAmount | Integer | False | No | An optional dictionary including the account to automatically transfer to as part of a destination charge. | |
TransferDataDestination | String | False | No | An optional dictionary including the account to automatically transfer to as part of a destination charge. | |
TransferGroup | String | False | No | A string that identifies this transaction as part of a group. | |
StatementDescriptorSuffix | String | False | No | Provides information about the charge that customers see on their statements. | |
Object | String | True | No | String representing the object's type. Objects of the same type share the same value. | |
AmountCaptured | Integer | True | No | Amount in cents captured | |
Application | String | True | No | ID of the Connect application that created the charge. | |
FailureBalanceTransaction | String | True | No | ID of the balance transaction that describes the reversal of the balance on your account due to payment failure. | |
OnBehalfOf | String | False | No | The account (if any) the charge was made on behalf of without triggering an automatic transfer. | |
RadarOptionsSession | String | False | No | Options to configure Radar. A Radar Session is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments. | |
AccountId | String | False | Yes | The Id of the connected account to get charges for |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | String | True | No | The Id of the Checkout session. | |
AfterExpirationRecoveryAllowPromotionCodes | Boolean | False | No | When set, provides configuration for actions to take if this Checkout Session expires. Enables user redeemable promotion codes on the recovered Checkout Sessions. Defaults to false | |
AfterExpirationRecoveryEnabled | Boolean | False | No | When set, provides configuration for actions to take if this Checkout Session expires. If true, a recovery url will be generated to recover this Checkout Session if it expires before a transaction is completed. It will be attached to the Checkout Session object upon expiration. | |
AfterExpirationRecoveryExpiresAt | Datetime | True | No | When set, provides configuration for actions to take if this Checkout Session expires. The timestamp at which the recovery URL will expire. | |
AfterExpirationRecoveryUrl | String | True | No | When set, provides configuration for actions to take if this Checkout Session expires. URL that creates a new Checkout Session when clicked that is a copy of this expired Checkout Session. | |
AllowPromotionCodes | Boolean | False | No | Enables user redeemable promotion codes. | |
AmountSubtotal | Integer | True | No | Total of all items before discounts or taxes are applied. | |
AmountTotal | Integer | True | No | Total of all items after discounts and taxes are applied. | |
AutomaticTaxEnabled | Boolean | False | No | Indicates whether automatic tax is enabled for the session. | |
AutomaticTaxStatus | String | True | No | The status of the most recent automated tax calculation for this session. | |
BillingAddressCollection | String | False | No | Describes whether Checkout should collect the customer's billing address. | |
CancelUrl | String | False | No | If set, Checkout displays a back button and customers are directed to this URL if they decide to cancel payment and return to your website. | |
ClientReferenceId | String | False | No | A unique string to reference the Checkout Session. This can be a customer Id, a cart Id, or something similar, and you can use it to reconcile the Session with your internal systems. | |
ClientSecret | String | True | No | Client secret to be used when initializing Stripe.js embedded checkout. | |
ConsentPromotions | String | True | No | Results of consent_collection for this session. If opt_in, the customer consents to receiving promotional communications from the merchant about this Checkout Session. | |
ConsentTermsOfService | String | True | No | Results of consent_collection for this session. If accepted, the customer in this Checkout Session has agreed to the merchant’s terms of service. | |
ConsentCollection | String | True | No | When set, provides configuration for the Checkout Session to gather active consent from customers. | |
Created | Datetime | True | No | The time at which the object was created. Measured in seconds since the Unix epoch. | |
Currency | String | False | No | A three-letter ISO currency code. | |
CurrencyConversion | String | True | No | Currency conversion details for automatic currency conversion sessions. | |
CustomFields | String | False | No | Collects additional information from your customer using custom fields. Up to two fields are supported. | |
CustomTextAfterSubmitMessage | String | False | No | Custom text that should be displayed after the payment confirmation button. | |
CustomTextShippingAddressMessage | String | False | No | Custom text that should be displayed alongside shipping address collection. | |
CustomTextSubmitMessage | String | False | No | Custom text that should be displayed alongside the payment confirmation button. | |
CustomTextTermsOfAcceptanceMessage | String | False | No | Custom text that should be displayed in place of the default terms of service agreement text. | |
CustomerId | String | False | No | The Id of the customer for this Session. | |
CustomerCreation | String | False | No | Configures whether a Checkout Session creates a Customer when the Checkout Session completes. | |
CustomerDetailsAddress | String | True | No | The customer's address after a completed Checkout Session. | |
CustomerDetailsEmail | String | True | No | The email associated with the Customer. | |
CustomerDetailsName | String | True | No | The customer's name after a completed Checkout Session. | |
CustomerDetailsPhone | String | True | No | The customer's phone number after a completed Checkout Session. | |
CustomerDetailsTaxExempt | String | True | No | The customer's tax exempt status after a completed Checkout Session. | |
CustomerDetailsTaxIds | String | True | No | The customer's tax Ids after a completed Checkout Session. | |
CustomerEmail | String | False | No | The email of the customer. | |
ExpiresAt | Datetime | False | No | The timestamp at which the Checkout Session expires. | |
InvoiceId | String | True | No | The Id of the invoice created by the Checkout Session. | |
InvoiceCreation | String | True | No | Details on the state of invoice creation for the Checkout Session. | |
Livemode | Boolean | True | No | true if the object is in live mode andfalse if in test mode. | |
Locale | String | False | No | The IETF language tag of the locale Checkout is displayed in. | |
Metadata | String | False | No | The set of key/value pairs that you can attach to a value list object. | |
Mode | String | False | No | The mode of the Checkout Session. | |
Object | String | True | No | String representing the object's type. Objects of the same type share the same value. | |
PaymentIntentId | String | True | No | The Id of the PaymentIntent for Checkout Sessions in payment mode. | |
PaymentLinkId | String | True | No | The Id of the Payment Link that created this Session. | |
PaymentMethodCollection | String | False | No | Configures whether a Checkout Session should collect a payment method. | |
PaymentMethodTypes | String | False | No | A list of the types of payment methods (e.g. card) this Checkout Session is allowed to accept. | |
PaymentMethodOptions | String | False | No | Payment-method-specific configuration for the PaymentIntent or SetupIntent of this CheckoutSession. | |
PaymentStatus | String | True | No | The payment status of the Checkout Session, one of paid, unpaid, or no_payment_required. | |
PhoneNumberCollectionEnabled | Boolean | False | No | Indicates whether phone number collection is enabled for the session. | |
RecoveredFrom | String | True | No | The Id of the original expired Checkout Session that triggered the recovery flow. | |
Redaction | String | True | No | Redactions for the session. | |
SetupIntent | String | False | No | The Id of the SetupIntent for Checkout Sessions in setup mode. | |
ShippingAddressCollectionAllowedCountries | String | False | No | When set, provides configuration for Checkout to collect a shipping address from a customer. | |
ShippingCost | String | True | No | The details of the customer cost of shipping, including the customer-chosen ShippingRate. | |
ShippingDetails | String | True | No | Shipping information for this Checkout Session. | |
ShippingOptions | String | True | No | The shipping rate options applied to this Session. | |
Status | String | True | No | The status of the Checkout Session, one of open, complete, or expired. | |
SubmitType | String | False | No | Describes the type of transaction being performed by Checkout in order to customize relevant text on the page, such as the submit button. submit_type can only be specified on Checkout Sessions in payment mode, but not Checkout Sessions in subscription or setup mode. | |
SubscriptionId | String | True | No | The Id of the subscription for Checkout Sessions in subscription mode. | |
SuccessUrl | String | False | No | The URL the customer is directed to after the payment or subscription creation is successful. | |
TotalDetails | String | True | No | Tax and discount details for the computed total amount. | |
UiMode | String | False | No | The UI mode of the Session. Can be hosted (default) or embedded. | |
Url | String | True | No | The URL to the Checkout Session. | |
ReturnUrl | String | False | No | The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method’s app or site. This parameter is required if ui_mode is embedded and redirect-based payment methods are enabled on the session. | |
LineItemsAggregate | String | False | No | The line items purchased by the customer. | |
AutomaticTaxLiabilityAccount | String | False | No | The connected account being referenced when type is account. | |
AutomaticTaxLiabilityType | String | False | No | Type of the account referenced. | |
RedirectOnCompletion | String | False | No | This parameter applies to ui_mode: embedded. Learn more about the redirect behavior of embedded sessions. Defaults to always. | |
AccountId | String | False | Yes | The Id of the connected account to get checkout session for. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | String | True | No | The Id of the Checkout Session line item. | |
CheckoutSessionId | String | True | No | The Id of the Checkout Session | |
Object | String | True | No | String representing the objects type. Objects of the same type share the same value. | |
AmountDiscount | Integer | True | No | Total discount amount applied. If no discounts were applied, defaults to 0. | |
AmountTax | Integer | True | No | Total tax amount applied. If no tax was applied, defaults to 0. | |
AmountSubtotal | Integer | True | No | Total before any discounts or taxes are applied. | |
AmountTotal | Integer | True | No | Total after discounts and taxes. | |
Currency | String | True | No | Three-letter ISO currency code, in lowercase. Must be a supported currency. | |
Description | String | True | No | An arbitrary string attached to the object. Often useful for displaying to users. Defaults to product name. | |
Discounts | String | True | No | The discounts applied to the line item. | |
PriceId | String | True | No | Unique identifier for the object. | |
PriceObject | String | True | No | String representing the object’s type. Objects of the same type share the same value. | |
PriceActive | Boolean | True | No | Whether the price can be used for new purchases. | |
PriceBillingScheme | String | True | No | Describes how to compute the price per period. | |
PriceCreated | Datetime | True | No | Time at which the object was created. Measured in seconds since the Unix epoch. | |
PriceCurrency | String | True | No | Three-letter ISO currency code, in lowercase. Must be a supported currency. | |
PriceCustomUnitAmountMaximum | Integer | True | No | The maximum unit amount the customer can specify for this item. | |
PriceCustomUnitAmountMinimum | Integer | True | No | The minimum unit amount the customer can specify for this item. | |
PriceCustomUnitAmountPreset | Integer | True | No | The starting unit amount which can be updated by the customer. | |
PriceLiveMode | Boolean | True | No | Has the value true if the object exists in live mode or the value false if the object exists in test mode. | |
PriceLookupKey | String | True | No | A lookup key used to retrieve prices dynamically from a static string. This may be up to 200 characters. | |
PriceMetadata | String | True | No | Set of key-value pairs that you can attach to an object. | |
PriceNickName | String | True | No | A brief description of the price, hidden from customers. | |
PriceProduct | String | True | No | The ID of the product this price is associated with. | |
PriceRecurringAggregateUsage | String | True | No | Specifies a usage aggregation strategy for prices of usage_type=metered. | |
PriceRecurringInterval | String | True | No | The frequency at which a subscription is billed. | |
PriceRecurringIntervalCount | Integer | True | No | The number of intervals | |
PriceRecurringUsageType | String | True | No | Configures how the quantity per period should be determined | |
PriceTaxBehaviour | String | True | No | Only required if a default tax behavior was not provided in the Stripe Tax settings. | |
PriceTiers | String | True | No | Each element represents a pricing tier. | |
PriceTiersMode | String | True | No | Defines if the tiering price should be graduated or volume based. | |
PriceTransformQuantityDivideBy | Integer | True | No | Divide usage by this number. | |
PriceTransformQuantityRound | String | True | No | After division, either round the result up or down. | |
PriceType | String | True | No | One of one_time or recurring depending on whether the price is for a one-time purchase or a recurring (subscription) purchase. | |
PriceUnitAmount | Integer | True | No | The unit amount in cents to be charged, represented as a whole integer if possible. | |
PriceUnitAmountDecimal | String | True | No | The unit amount in cents to be charged, represented as a decimal string with at most 12 decimal places. | |
Quantity | String | True | No | The quantity of products being purchased. | |
Taxes | String | True | No | The taxes applied to the line item. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | String | False | No | The ISO Country code for this country. | |
SupportedBankAccountCurrenciesAggregate | String | False | No | Currencies that can be accepted in the specific country. | |
SupportedPaymentCurrenciesAggregate | String | False | No | Currencies that can be accepted in the specified country. | |
SupportedPaymentMethodsAggregate | String | False | No | Payment methods available in the specified country. You will need to enable BitCoin and ACH payments on your account for those methods to appear in this list. | |
VerificationFieldsAggregate | String | False | No | Lists the types of verification data needed to keep an account open. Includes 'minimum' fields, which every account must eventually provide, as well as additional fields, which are only required for some merchants. | |
SupportedTransferCurrenciesAggregate | String | False | No | Countries that can accept transfers from the specified country. | |
DefaultCurrency | String | False | No | The default currency for this country. | |
AccountId | String | False | Yes | The Id of the connected account to get country specs for |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | String | False | No | The Id of the coupon. | |
CreatedAt | Datetime | True | No | The creation date. | |
Currency | String | False | No | If amount_off has been set, the three-letter ISO code for the currency of the amount to take off. | |
Duration | String | False | No | Describes how long a customer who applies this coupon will get the discount. One of forever, once, and repeating. | |
DurationInMonths | Integer | False | No | If duration is repeating, the number of months the coupon applies. Null if coupon duration is forever or once. | |
AmountOff | Integer | False | No | Amount (in the currency specified) that is taken off the subtotal of any invoices for this customer. | |
PercentOff | Decimal | False | No | 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 a percent_off of 50 will make a $100 invoice $50 instead. | |
Valid | Boolean | True | No | Taking account of the above properties, whether this coupon can still be applied to a customer. | |
MaxRedemptions | Integer | False | No | Maximum number of times this coupon can be redeemed, in total, before it is no longer valid. | |
RedeemBy | Datetime | False | No | Date after which the coupon can no longer be redeemed. | |
MetadataAggregate | String | False | No | The set of key/value pairs that you can attach to a coupon object. | |
TimesRedeemed | Integer | True | No | Number of times this coupon has been applied to a customer. | |
Object | String | True | No | String representing the object's type. Objects of the same type share the same value. | |
AppliesTo | String | False | No | Contains information about what this coupon applies to. This field is not included by default. To include it in the response, expand the applies_to field. | |
Livemode | Boolean | True | No | Has the value true if the object exists in live mode or the value false if the object exists in test mode. | |
Name | String | False | No | Name of the coupon displayed to customers on, for instance, invoices or receipts. | |
CurrencyOptions | String | False | Yes | Coupons defined in each available currency option (only supported if amount_off is passed). Each key must be a three-letter ISO currency code and a supported currency. | |
AccountId | String | False | Yes | The Id of the connected account to get coupons for. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | String | False | No | ID of Credit Note LineItem. | |
CreditNoteId | String | False | CreditNotes.Id | No | Credit Note Id. |
Amount | Integer | False | No | The integer amount in cents representing the gross amount being credited for this line item, excluding (exclusive) tax and discounts. | |
AmountExcludingTax | Integer | False | No | The integer amount in cents representing the amount being credited for this line item, excluding all tax and discounts. | |
Description | String | False | No | Description of the item being credited. | |
DiscountAmounts | String | False | No | The amount of discount calculated per discount for this line item. | |
InvoiceLineItem | String | False | No | ID of the invoice line item being credited. | |
Livemode | Boolean | False | No | Has the value true if the object exists in live mode or the value false if the object exists in test mode. | |
Quantity | Integer | False | No | The number of units of product being credited. | |
TaxAmounts | String | False | No | The amount of tax calculated per tax rate for this line item. | |
TaxRates | String | False | No | The tax rates which apply to the line item. | |
Type | String | False | No | The type of the credit note line item, one of invoice_line_item or custom_line_item. When the type is invoice_line_item there is an additional invoice_line_item property on the resource the value of which is the id of the credited line item on the invoice. | |
UnitAmount | Integer | False | No | The cost of each unit of product being credited. | |
UnitAmountDecimal | Decimal | False | No | Same as unit_amount, but contains a decimal value with at most 12 decimal places. | |
UnitAmountExcludingTax | Decimal | False | No | The amount in cents representing the unit amount being credited for this line item, excluding all tax and discounts. | |
AccountId | String | False | Yes | The Id of the connected account to get orders for. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | String | True | No | The Id of the discount object. | |
CreditNoteId | String | True | No | The Id of the credit note. | |
CustomerId | String | True | No | The Id of the customer. | |
Start | Datetime | True | No | Date that the coupon was applied. | |
End | Datetime | True | No | 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. | |
CouponId | String | True | No | The Id of the coupon. | |
CouponAmountOff | Integer | True | No | Amount (in the currency specified) that is taken off the subtotal of any invoices for this customer. | |
CouponCurrency | String | True | No | If amount_off has been set, the three-letter ISO code for the currency of the amount to take off. | |
CouponName | String | True | No | Name of the coupon displayed to customers on, for instance, invoices or receipts. | |
CouponCreatedAt | Datetime | True | No | The creation date. | |
CouponDuration | String | True | No | Describes how long a customer who applies this coupon will get the discount. One of forever, once, and repeating. | |
CouponDurationInMonths | Integer | True | No | If duration is repeating, the number of months the coupon applies. Null if coupon duration is forever or once. | |
CouponPercentOff | Decimal | True | No | 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 a percent_off of 50 will make a $100 invoice $50 instead. | |
CouponRedeemBy | Datetime | True | No | Date after which the coupon can no longer be redeemed. | |
CouponTimesRedeemed | Integer | True | No | Number of times this coupon has been applied to a customer. | |
CouponValid | Boolean | True | No | Taking account of the above properties, whether this coupon can still be applied to a customer. | |
CouponMaxRedemptions | Integer | True | No | Maximum number of times this coupon can be redeemed, in total, across all customers, before it is no longer valid. | |
PromotionCode | String | True | No | The promotion code applied to create this discount. | |
Subscription | String | True | No | The subscription that this coupon is applied to, if it is applied to a particular subscription. | |
Amount | Integer | True | No | The amount, in cents, of the discount. | |
AccountId | String | False | Yes | The Id of the connected account to get orders for. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | String | False | No | ID of the Credit Note Preview LineItem. | |
InvoiceId | String | False | Invoices.Id | No | ID of the invoice. |
Amount | Integer | False | No | The integer amount in cents representing the total amount of the credit note. | |
CreditAmount | Integer | False | No | The integer amount in cents representing the amount to credit the customer's balance, which will be automatically applied to their next invoice. | |
AmountShipping | Integer | False | No | Amount shipping. | |
Created | Datetime | False | No | Date of creation. | |
Currency | String | False | No | Currency name. | |
Customer | String | False | No | Customer Id. | |
CustomerBalanceTransaction | String | False | No | Customer balance transaction. | |
DiscountAmounts | String | False | No | Discount amounts. | |
EffectiveAt | Datetime | False | No | The date when this credit note is in effect. Same as created unless overwritten. When defined, this value replaces the system-generated Date of issue printed on the credit note PDF. | |
Lines | String | False | No | Line items that make up the credit note. | |
Livemode | Boolean | False | No | Boolean value of Livemode. | |
Memo | String | False | No | The credit note's memo appears on the credit note PDF. | |
Metadata | String | False | No | Set of key-value pairs that you can attach to an object. | |
Number | String | False | No | Number. | |
OutOfBandAmount | Integer | False | No | The integer amount in cents representing the amount that is credited outside of Stripe. | |
String | False | No | Pdf url. | ||
Reason | String | False | No | Reason for issuing this credit note, one of duplicate, fraudulent, order_change, or product_unsatisfactory. | |
Refund | String | False | No | ID of an existing refund to link this credit note to. | |
RefundAmount | Integer | False | No | The integer amount in cents representing the amount to refund. If set, a refund will be created for the charge associated with the invoice. | |
ShippingCost | String | False | No | When shipping_cost contains the shipping_rate from the invoice, the shipping_cost is included in the credit note. | |
Status | String | False | No | Status. | |
Subtotal | Integer | False | No | Subtotal. | |
SubtotalExcludingTax | Integer | False | No | Subtotal excluding tax. | |
TaxAmounts | String | False | No | Tax amounts. | |
Total | Integer | False | No | Total. | |
TotalExcludingTax | Integer | False | No | Total excluding tax. | |
Type | String | False | No | Type. | |
VoidedAt | Datetime | False | No | Voided at. | |
AccountId | String | False | Yes | The Id of the connected account to get orders for. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | String | True | No | The Id of the credit note. | |
Amount | Integer | False | No | The integer amount in cents representing the total amount of the credit note, including tax. | |
AmountShipping | Integer | True | No | The sum of all the shipping amounts. | |
Created | Datetime | True | No | The time at which the object was created. Measured in seconds since the Unix epoch. | |
Currency | String | True | No | A three-letter ISO currency code, in lowercase. | |
CustomerId | String | True | No | The Id of customer. | |
CustomerBalanceTransaction | String | True | No | The customer balance transaction related to this credit note. | |
DiscountAmounts | String | True | No | The aggregate amounts calculated per discount for all line items. | |
EffectiveAt | Datetime | False | No | The date when this credit note goes into effect. This is the same as created unless overwritten. | |
InvoiceId | String | False | No | The Id of invoice. | |
Lines | String | False | No | Line items that make up the credit note. | |
Livemode | Boolean | True | No | true if the object is in live mode andfalse if in test mode. | |
Memo | String | False | No | Customer-facing text that appears on the credit note PDF. | |
Metadata | String | False | No | The set of key/value pairs that you can attach to a value list object. | |
Number | String | True | No | A unique number that identifies this particular credit note and appears on the PDF of the credit note and its associated invoice. | |
OutOfBandAmount | Integer | False | No | Amount that was credited outside of Stripe. | |
String | True | No | The link to download the PDF of the credit note. | ||
Reason | String | False | No | The reason for issuing this credit note, one of duplicate, fraudulent, order_change, or product_unsatisfactory. | |
Refund | String | False | No | The refund related to this credit note. | |
ShippingCost | String | False | No | The details of the cost of shipping | |
Status | String | True | No | The status of this credit note, one of issued or void. | |
Subtotal | Integer | True | No | The integer amount in cents representing the amount of the credit note, excluding exclusive tax and invoice level discounts. | |
SubtotalExcludingTax | Integer | True | No | The integer amount in cents representing the amount of the credit note, excluding all tax and invoice level discounts. | |
TaxAmounts | String | True | No | The aggregate amounts calculated per tax rate for all line items. | |
Total | Integer | True | No | The integer amount in cents representing the total amount of the credit note, including tax and all discount. | |
TotalExcludingTax | Integer | True | No | The integer amount in cents representing the total amount of the credit note, excluding tax, but including discounts. | |
Type | String | True | No | The type of this credit note, either pre_payment or post_payment. | |
VoidedAt | Datetime | True | No | The time at which the credit note was voided. | |
CreditAmount | Integer | False | Yes | The integer amount in cents representing the amount to credit the customer’s balance, which will be automatically applied to their next invoice. | |
RefundAmount | Integer | False | Yes | The integer amount in cents representing the amount to refund. If set, a refund will be created for the charge associated with the invoice. | |
AccountId | String | False | Yes | The Id of the connected account to get credit notes for. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | String | True | No | Unique identifier for the object. | |
CustomerId [KEY] | String | True | No | The ID of the customer the transaction belongs to. | |
Amount | Integer | True | No | The amount of the transaction. | |
Currency | String | True | No | Three-letter ISO currency code, in lowercase. Must be a supported currency. | |
Created | Datetime | True | No | Time at which the object was created. Measured in seconds since the Unix epoch. | |
Description | String | True | No | An arbitrary string attached to the object. Often useful for displaying to users. | |
EndingBalance | Integer | True | No | The customer’s balance after the transaction was applied. | |
Type | String | True | No | Transaction type | |
CreditNote | String | True | No | The ID of the credit note (if any) related to the transaction. | |
Invoice | String | True | No | The ID of the invoice (if any) related to the transaction. | |
Livemode | Boolean | True | No | Has the value true if the object exists in live mode or the value false if the object exists in test mode. | |
MetadataAggregate | String | True | No | The set of key/value pairs that you can attach to a an object. | |
Object | String | True | No | The object’s type. Objects of the same type share the same value. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | String | True | No | The Id of the customer. | |
AddressAggregate | String | False | No | The customer's address. | |
Balance | Integer | False | No | The current balance of the customer. | |
Created | Datetime | True | No | The time of creation. | |
Currency | String | True | No | The currency the customer can be charged in for recurring billing purposes. | |
DefaultSource | String | False | No | The Id of the default source attached to this customer. | |
Delinquent | Boolean | True | No | Whether or not the latest charge for the latest invoice of the customer has failed. | |
CouponId | String | False | No | The Id of the discount coupon. | |
Description | String | False | No | The customer description.The description field on customer endpoints has a maximum character length limit of 350. | |
String | False | No | The email of the customer. | ||
Livemode | Boolean | True | No | Whether the customer is in live mode. | |
MetadataAggregate | String | False | No | The set of key/value pairs that you can attach to a customer object. | |
Name | String | False | No | The customer's full name or business name. | |
Phone | String | False | No | The customer's phone number. | |
ShippingAggregate | String | True | No | The shipping information associated with the customer. | |
TaxExempt | String | False | No | Describes the customer's tax exemption status. One of none, exempt, or reverse. When set to reverse, invoice and receipt PDFs include the text 'Reverse charge'. | |
InvoicePrefix | String | False | No | The prefix for the customer used to generate unique invoice numbers. | |
NextInvoiceSequence | Integer | False | No | The suffix of the customer's next invoice number, e.g., 0001. | |
TestClock | String | False | No | ID of the test clock this customer belongs to. | |
PreferredLocales | String | False | No | The customer's preferred locales (languages), ordered by preference. | |
InvoiceSettingsCustomFieldsAggregate | String | False | No | Default custom fields to be displayed on invoices for this customer. | |
InvoiceSettingsDefaultPaymentMethod | String | False | No | ID of a payment method that's attached to the customer, to be used as the customer's default payment method for subscriptions and invoices. | |
InvoiceSettingsFooter | String | False | No | Default footer to be displayed on invoices for this customer. | |
TaxIdsAggregate | String | False | No | The customer's tax IDs. | |
DiscountId | String | True | No | The Id of the discount. | |
DiscountCheckoutSession | String | True | No | The Checkout session that this coupon is applied to, if it is applied to a particular session in payment mode. Will not be present for subscription mode. | |
DiscountCustomer | String | True | No | The ID of the customer associated with this discount. | |
DiscountStart | Datetime | True | No | If the subscription has a trial, the beginning of that trial. | |
DiscountEnd | Datetime | True | No | If the subscription has a trial, the end of that trial. | |
DiscountInvoice | String | True | No | The invoice that the discount's coupon was applied to, if it was applied directly to a particular invoice. | |
DiscountInvoiceItem | String | True | No | The invoice line item id that the discount's coupon was applied to if it was applied directly to a invoice line item. | |
DiscountPromotionCode | String | True | No | The promotion code applied to create this discount.The promotion code applied to create this discount. | |
DiscountSubscription | String | True | No | The subscription that this coupon is applied to, if it is applied to a particular subscription. | |
DiscountCouponCreatedAt | Datetime | True | No | The creation date. | |
DiscountCouponCurrency | String | True | No | If amount_off has been set, the three-letter ISO code for the currency of the amount to take off. | |
DiscountCouponName | String | True | No | Name of the coupon displayed to customers on, for instance, invoices or receipts. | |
DiscountCouponDuration | String | True | No | One of forever, once, and repeating. Describes how long a customer who applies this coupon will get the discount. | |
DiscountCouponDurationInMonths | Integer | True | No | the number of months the coupon applies. | |
DiscountCouponAmountOff | Integer | True | No | Amount (in the currency specified) that is taken off the subtotal of any invoices for this customer. | |
DiscountCouponPercentOff | Integer | True | No | 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 a percent_off of 50 will make a $100 invoice $50 instead. | |
DiscountCouponValid | Boolean | True | No | Taking account of the above properties, whether this coupon can still be applied to a customer. | |
DiscountCouponMaxRedemptions | Integer | True | No | Maximum number of times this coupon can be redeemed, in total, before it is no longer valid. | |
DiscountCouponRedeemBy | Datetime | True | No | Date after which the coupon can no longer be redeemed. | |
DiscountCouponTimesRedeemed | Integer | True | No | Number of times this coupon has been applied to a customer. | |
DiscountCouponObject | String | True | No | String representing the object's type. Objects of the same type share the same value. | |
DiscountCouponLiveMode | Boolean | True | No | Has the value true if the object exists in live mode or the value false if the object exists in test mode. | |
DiscountCouponMetadataAggregate | String | True | No | Set of key-value pairs that you can attach to an object. | |
SourcesAggregate | String | True | No | The customer?s payment sources. | |
SubscriptionsAggregate | String | True | No | The customer’s current subscriptions, if any. | |
TaxAutomaticTax | String | True | No | Surfaces if automatic tax computation is possible given the current customer location information. | |
TaxIPAddress | String | False | No | A recent IP address of the customer used for tax reporting and tax location inference. | |
TaxCountry | String | True | No | The customer's country as identified by Stripe Tax. | |
TaxState | String | True | No | The customer's state, county, province, or region as identified by Stripe Tax. | |
TaxSource | String | True | No | The data source used to infer the customer?s location | |
InvoiceSettingsRenderingOptionsAmountTaxDisplay | String | False | No | How line-item prices and amounts will be displayed with respect to tax on invoice PDFs. | |
InvoiceSettingsRenderingOptionsTemplate | String | False | No | ID of the invoice rendering template to be used for this customer’s invoices. If set, the template will be used on all invoices for this customer unless a template is set directly on the invoice. | |
AccountId | String | False | Yes | The Id of the connected account to get customers for. | |
TaxValidateLocation | String | False | Yes | A flag that indicates when Stripe should validate the customer tax location. Defaults to deferred. Use only for INSERT and UPDATE. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | String | True | No | The Id of the Subscription object. | |
CustomerId | String | True | Customers.Id | No | The Id of the customer. |
PlanId | String | True | Plans.Id | No | The Id of the plan. |
ApplicationFeePercent | Decimal | True | No | A positive decimal that represents the fee percentage of the subscription invoice amount that will be transferred to the application of the Stripe account owner each billing period. | |
AutomaticTaxEnabled | Boolean | True | No | Automatic tax settings for this subscription. | |
BillingCycleAnchor | Datetime | True | No | Determines the date of the first full invoice, and, for plans with month or year intervals, the day of the month for subsequent invoices. | |
BillingThreshold | String | True | No | Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period | |
CanceledAt | Datetime | True | No | 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. | |
CurrentPeriodEnd | Datetime | True | No | End of the current period that the subscription has been invoiced for. At the end of this period, a new invoice will be created. | |
CurrentPeriodStart | Datetime | True | No | Start of the current period that the subscription has been invoiced for. | |
Currency | String | True | No | Three-letter ISO currency code, in lowercase. Must be a supported currency. | |
Description | String | True | No | The subscription's description. | |
DaysUntilDue | Integer | True | No | Number of days a customer has to pay invoices generated by this subscription. This value is null for subscriptions where collection_method=charge_automatically | |
DefaultSource | String | True | No | Id of the default payment source for the subscription. | |
DefaultTaxRates | String | True | No | The tax rates that will apply to any subscription item that does not have tax_rates set. Invoices created will have their default_tax_rates populated from the subscription. | |
EndedAt | Datetime | True | No | If the subscription has ended (either because it was canceled or because the customer was switched to a subscription to a new plan), the date the subscription ended. | |
Quantity | Double | True | No | The quantity of the plan to which the customer should be 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. | |
Schedule | String | True | No | The schedule attached to the subscription | |
TestClock | String | True | No | Id of the test clock this customer belongs to. | |
TransferData | String | True | No | The account (if any) the subscription's payments will be attributed to for tax reporting, and where funds from each payment will be transferred to for each of the subscription's invoices. | |
MetadataAggregate | String | True | No | The set of key/value pairs that you can attach to a subscription object. | |
LiveMode | Boolean | True | No | Has the value true if the object exists in live mode or the value false if the object exists in test mode. | |
LatestInvoice | String | True | No | Three-letter ISO currency code, in lowercase. Must be a supported currency. | |
NextPendingInvoiceItemInvoice | Datetime | True | No | Specifies the approximate timestamp on which any pending invoice items will be billed according to the schedule provided at pending_invoice_item_interval | |
PauseCollection | String | True | No | If specified, payment collection for this subscription will be paused. | |
PaymentSettings | String | True | No | Payment settings passed on to invoices created by the subscription. | |
PendingSetupIntent | String | True | No | You can use this SetupIntent to collect user authentication when creating a subscription without immediate payment or updating a subscription's payment method, allowing you to optimize for off-session payments. | |
PendingUpdate | String | True | No | If specified, pending updates that will be applied to the subscription once the latest_invoice has been paid. | |
AccountId | String | False | Yes | The Id of the connected account to get customer discounts for |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | String | True | No | The Id of the dispute. | |
Currency | String | True | No | Three-letter ISO currency code representing the currency of the amount that was disputed. | |
EvidenceAccessActivityLog | String | False | No | Any server or activity logs showing proof that the customer accessed or downloaded the purchased digital product. | |
EvidenceBillingAddress | String | False | No | The billing address provided by the customer. | |
EvidenceCancellationPolicy | String | False | No | Your subscription cancellation policy, as shown to the customer. | |
EvidenceCancellationPolicyDisclosure | String | False | No | An explanation of how and when the customer was shown your refund policy prior to purchase. | |
EvidenceCancellationRebuttal | String | False | No | A justification for why the customer's subscription was not canceled. | |
EvidenceCustomerCommunication | String | False | No | The (ID of a file upload) Any communication with the customer that you feel is relevant to your case (for example emails proving that they received the product or service, or demonstrating their use of or satisfaction with the product or service). | |
EvidenceCustomerEmailAddress | String | False | No | The email address of the customer. | |
EvidenceCustomerName | String | False | No | The name of the customer. | |
EvidenceCustomerPurchaseIp | String | False | No | The IP address that the customer used when making the purchase. | |
EvidenceCustomerSignature | String | False | No | The (ID of a file upload) A relevant document or contract showing the customer's signature. | |
EvidenceDuplicateChargeDocumentation | String | False | No | The (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. | |
EvidenceDuplicateChargeExplanation | String | False | No | The explanation of the difference between the disputed charge and the prior charge that appears to be a duplicate. | |
EvidenceDuplicateChargeId | String | False | No | The Stripe ID for the prior charge which appears to be a duplicate of the disputed charge. | |
EvidenceProductDescription | String | False | No | The description of the product or service which was sold. | |
EvidenceReceipt | String | False | No | The (ID of a file upload) Any receipt or message sent to the customer notifying them of the charge. | |
EvidenceRefundPolicy | String | False | No | The (ID of a file upload) Your refund policy, as shown to the customer. | |
EvidenceRefundPolicyDisclosure | String | False | No | The documentation demonstrating that the customer was shown your refund policy prior to purchase. | |
EvidenceRefundRefusalExplanation | String | False | No | The justification for why the customer is not entitled to a refund. | |
EvidenceServiceDate | String | False | No | The date on which the customer received or began receiving the purchased service, in a clear human-readable format. | |
EvidenceServiceDocumentation | String | False | No | The (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. | |
EvidenceShippingAddress | String | False | No | The address to which a physical product was shipped. You should try to include as much complete address information as possible. | |
EvidenceShippingCarrier | String | False | No | 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. | |
EvidenceShippingDate | String | False | No | The date on which a physical product began its route to the shipping address, in a clear human-readable format. | |
EvidenceShippingDocumentation | String | False | No | The (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, and should show the full shipping address of the customer, if possible. | |
EvidenceShippingTrackingNumber | String | False | No | 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. | |
EvidenceUncategorizedFile | String | False | No | The (ID of a file upload) Any additional evidence or statements. | |
EvidenceUncategorizedText | String | False | No | Any additional evidence or statements. | |
EvidenceDetailsDueBy | Datetime | True | No | Date by which evidence must be submitted in order to successfully challenge dispute. | |
EvidenceDetailsHasEvidence | Boolean | True | No | Whether or not evidence has been saved for this dispute. | |
EvidenceDetailsPastDue | Boolean | True | No | Whether or not the last evidence submission was submitted past. | |
EvidenceDetailsSubmissionCount | Integer | True | No | The number of times the evidence has been submitted. | |
Amount | Integer | True | No | The disputed amount. | |
BalanceTransactionsAggregate | String | True | No | List of zero, one, or two balance transactions that show funds withdrawn and reinstated to your Stripe account as a result of this dispute. | |
Charge | String | True | No | The Id of the charge that was disputed. | |
Created | Datetime | True | No | The Date dispute was opened. | |
IsChargeRefundable | Boolean | True | No | If true, it is still possible to refund the disputed payment. | |
Livemode | Boolean | True | No | Tells if the dispute is in livemode. | |
Reason | String | True | No | The reason given by cardholder for dispute. | |
Status | String | True | No | The current status of dispute. | |
MetadataAggregate | String | False | No | 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. | |
Transaction | String | True | No | The transaction being disputed. | |
Object | String | True | No | String representing the object's type. Objects of the same type share the same value. | |
PaymentIntent | String | True | No | ID of the PaymentIntent that was disputed. | |
PaymentMethodDetails | String | True | No | Additional dispute information specific to the payment method type. | |
AccountId | String | False | Yes | The Id of the connected account to get disputes for. | |
Submit | Boolean | False | Yes | Whether to immediately submit evidence to the bank. If false, evidence is staged on the dispute. Staged evidence is visible in the API and Dashboard, and can be submitted to the bank by making another request with this attribute set to true |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | String | True | No | The Id of fraud warning. | |
Actionable | Boolean | True | No | An EFW is actionable if it has not received a dispute and has not been fully refunded. | |
ChargeId | String | True | No | The Id of the charge. | |
Created | Datetime | True | No | Time at which the object was created. Measured in seconds since the Unix epoch. | |
FraudType | String | True | No | The type of fraud labelled by the issuer. Supported values are card_never_received, fraudulent_card_application, made_with_counterfeit_card, made_with_lost_card, made_with_stolen_card, misc, and unauthorized_use_of_card. | |
Livemode | Boolean | True | No | true if the object is in live mode andfalse if in test mode. | |
PaymentIntentId | String | True | No | The Id of the Payment Intent. | |
AccountId | String | False | Yes | The Id of the connected account to get fraud warning for. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Reporting_Category | String | True | No | Reporting Category is a new categorization of balance transactions, meant to improve on the current type field. | |
Currency | String | True | No | Three-letter ISO code for the currency in which gross, fee and net are defined. | |
Count | Int | True | No | The number of transactions associated with the reporting_category. | |
Gross | Decimal | True | No | Sum of the gross amounts of the transactions associated with the reporting_category. Expressed in major units of the currency (e.g. dollars for USD, yen for JPY). | |
Fee | Decimal | True | No | Sum of the fees paid for the transactions associated with the reporting_category. Expressed in major units of the currency (e.g. dollars for USD, yen for JPY). | |
Net | Decimal | True | No | Sum of the net amounts for the transactions associated with the reporting_category. Expressed in major units of the currency (e.g. dollars for USD, yen for JPY). | |
Id [KEY] | String | True | Reports.Id | No | Unique identifier for the reports run object. |
ParametersIntervalEnd | Datetime | True | No | Ending timestamp of data to be included in the report run (exclusive). | |
ParametersColumns | String | True | No | The set of output columns requested for inclusion in the report run. | |
ParametersCurrency | String | True | No | Currency of objects to be included in the report run. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Reporting_Category | String | True | No | Reporting Category is a new categorization of balance transactions, meant to improve on the current type field. | |
Currency | String | True | No | Three-letter ISO code for the currency in which gross, fee and net are defined. | |
Count | Int | True | No | The number of transactions associated with the reporting_category. | |
Gross | Decimal | True | No | Sum of the gross amounts of the transactions associated with the reporting_category. Expressed in major units of the currency (e.g. dollars for USD, yen for JPY). | |
Fee | Decimal | True | No | Sum of the fees paid for the transactions associated with the reporting_category. Expressed in major units of the currency (e.g. dollars for USD, yen for JPY). | |
Net | Decimal | True | No | Sum of the net amounts for the transactions associated with the reporting_category. Expressed in major units of the currency (e.g. dollars for USD, yen for JPY). | |
Id [KEY] | String | True | Reports.Id | No | Unique identifier for the reports run object. |
ParametersIntervalEnd | Datetime | True | No | Ending timestamp of data to be included in the report run (exclusive). | |
ParametersColumns | String | True | No | The set of output columns requested for inclusion in the report run. | |
ParametersCurrency | String | True | No | Currency of objects to be included in the report run. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | String | False | No | The Id of the event. | |
ApiVersion | String | False | No | The Stripe API version used to render data. | |
Created | Datetime | False | No | The datetime event was created. | |
ObjectId | String | False | No | The event Id. | |
ObjectName | String | False | No | The object name for which event occured. | |
Livemode | Boolean | False | No | Tells if the event is in livemode. | |
PendingWebhooks | Integer | False | No | The number of webhooks yet to be delivered successfully (return a 20x response) to the URLs you've specified. | |
RequestId | String | False | No | The Id of the API request that caused the event. | |
RequestIdempotencyKey | String | False | No | The idempotency key transmitted during the request, if any. Note: This property is populated only for events on or after May 23, 2017. | |
Type | String | False | No | The description of the event. | |
Description | String | False | No | An arbitrary string attached to the object. Often useful for displaying to users.The description field on invoice line items has a maximum character length limit of 500 | |
PreviousAttributes | String | False | No | Object containing the names of the attributes that have changed. | |
DataObject | String | False | No | Object containing the API resource relevant to the event. | |
DataObjectAmount | Integer | False | No | Data object amount. | |
DataObjectAmountCapturable | Integer | False | No | Data object capturable amount. | |
DataObjectAmountDetails | String | False | No | Data object amount details. | |
DataObjectAmountReceived | Integer | False | No | Data object received amount. | |
DataObjectApplication | String | False | No | Data object application. | |
DataObjectApplicationFeeAmount | String | False | No | Data object application fee amount. | |
DataObjectAutomaticPaymentMethods | String | False | No | Data object automatic payment methods. | |
DataObjectCanceledAt | Datetime | False | No | Canceled At. | |
DataObjectCancellationReason | String | False | No | Cancellation reason. | |
DataObjectCaptureMethod | String | False | No | Capture Method. | |
DataObjectClientSecret | String | False | No | Client secret. | |
DataObjectConfirmationMethod | String | False | No | Confirmation method. | |
DataObjectCreated | Datetime | False | No | Created timestamp. | |
DataObjectCurrency | String | False | No | Currency code. | |
DataObjectCustomer | String | False | No | Customer Id. | |
DataObjectDescription | String | False | No | Description. | |
DataObjectInvoice | String | False | No | Invoice Id of the data object. | |
DataObjectLastPaymentError | String | False | No | Last payment error. | |
DataObjectLatestCharge | String | False | No | Latest charge. | |
DataObjectLivemode | Boolean | False | No | Boolean value of livemode. | |
DataObjectMetadata | String | False | No | Metadata. | |
DataObjectNextAction | String | False | No | Next action details. | |
DataObjectOnBehalfOf | String | False | No | On behalf of. | |
DataObjectPaymentMethod | String | False | No | Payment method. | |
DataObjectPaymentMethodConfigurationDetails | String | False | No | Payment method configuration details. | |
DataObjectPaymentMethodOptions | String | False | No | Payment method options. | |
DataObjectPaymentMethodTypes | String | False | No | Payment method types. | |
DataObjectProcessing | String | False | No | Processing. | |
DataObjectReceiptEmail | String | False | No | Receipt email. | |
DataObjectReview | String | False | No | Review. | |
DataObjectSetupFutureUsage | String | False | No | Setup future usage. | |
DataObjectShipping | String | False | No | Shipping details. | |
DataObjectSource | String | False | No | Source. | |
DataObjectStatementDescriptor | String | False | No | Statement descriptor. | |
DataObjectStatementDescriptorSuffix | String | False | No | Statement descriptor suffix. | |
DataObjectStatus | String | False | No | Status. | |
DataObjectTransferData | String | False | No | Transfer data. | |
DataObjectTransferGroup | String | False | No | Transfer group. | |
AccountId | String | False | Yes | The Id of the connected account to get events for. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | String | True | No | The id of files. | |
Created | Datetime | True | No | Time at which the object was created. Measured in seconds since the Unix epoch. | |
ExpiresAt | Datetime | True | No | The time at which the file expires and is no longer available in epoch seconds. | |
Expired | Boolean | True | No | Returns true if the link is already expired. | |
File | String | True | No | The file object this link points to. | |
MetadataAggregate | String | True | No | The set of key/value pairs that you can attach to a an object. | |
Url | String | True | No | The URL from which the file can be downloaded using your live secret API key. | |
Livemode | Boolean | True | No | Has the value true if the object exists in live mode or the value false if the object exists in test mode. | |
AccountId | String | False | Yes | The Id of the connected account to get files for. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | String | True | No | The id of files. | |
Created | Datetime | True | No | Time at which the object was created. Measured in seconds since the Unix epoch. | |
ExpiresAt | Datetime | True | No | The time at which the file expires and is no longer available in epoch seconds. | |
Filename | String | True | No | A filename for the file, suitable for saving to a filesystem. | |
Links | String | True | No | A list of file links that point at this file. | |
Purpose | String | True | No | The purpose of the uploaded file. | |
Size | Integer | True | No | The size in bytes of the file object. | |
Title | String | True | No | A user friendly title for the document. | |
Type | String | True | No | The type of the file returned (e.g., csv, pdf, jpg, or png). | |
Url | String | True | No | The URL from which the file can be downloaded using your live secret API key. | |
AccountId | String | False | Yes | The Id of the connected account to get files for. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | String | True | No | The Id of the discount object. | |
InvoiceId | String | True | Invoices.Id | No | The Id of the Invoice, which the discount is attached to. |
Customer | String | False | No | The Id of the Customer. | |
Start | Datetime | False | No | Date that the coupon was applied. | |
End | Datetime | False | No | 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. | |
Coupon | String | False | No | The Id of the coupon. | |
CouponAmountOff | Integer | False | No | Amount (in the currency specified) that is taken off the subtotal of any invoices for this customer. | |
CouponCurrency | String | False | No | If amount_off has been set, the three-letter ISO code for the currency of the amount to take off. | |
CouponName | String | False | No | Name of the coupon displayed to customers on, for instance, invoices or receipts. | |
CouponCreatedAt | Datetime | True | No | The creation date. | |
CouponDuration | String | False | No | Describes how long a customer who applies this coupon will get the discount. One of forever, once, and repeating. | |
CouponDurationInMonths | Integer | False | No | If duration is repeating, the number of months the coupon applies. Null if coupon duration is forever or once. | |
CouponPercentOff | Decimal | False | No | 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 a percent_off of 50 will make a $100 invoice $50 instead. | |
CouponRedeemBy | Datetime | False | No | Date after which the coupon can no longer be redeemed. | |
CouponTimesRedeemed | Integer | False | No | Number of times this coupon has been applied to a customer. | |
CouponValid | Boolean | True | No | Taking account of the above properties, whether this coupon can still be applied to a customer. | |
CouponMaxRedemptions | Integer | False | No | Maximum number of times this coupon can be redeemed, in total, across all customers, before it is no longer valid. | |
PromotionCode | String | False | No | The promotion code applied to create this discount. | |
Subscription | String | False | No | The subscription that this coupon is applied to, if it is applied to a particular subscription. | |
AccountId | String | False | Yes | The Id of the connected account to get invoices for |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | String | True | No | The Id of the discount object. | |
InvoiceItemId | String | True | InvoiceItems.Id | No | The Id of the Invoice item, which the discount is attached to. |
Customer | String | False | No | The Id of the Customer. | |
Start | Datetime | False | No | Date that the coupon was applied. | |
End | Datetime | False | No | 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. | |
Coupon | String | False | No | The Id of the coupon. | |
CouponAmountOff | Integer | False | No | Amount (in the currency specified) that is taken off the subtotal of any invoices for this customer. | |
CouponCurrency | String | False | No | If amount_off has been set, the three-letter ISO code for the currency of the amount to take off. | |
CouponName | String | False | No | Name of the coupon displayed to customers on, for instance, invoices or receipts. | |
CouponCreatedAt | Datetime | True | No | The creation date. | |
CouponDuration | String | False | No | Describes how long a customer who applies this coupon will get the discount. One of forever, once, and repeating. | |
CouponDurationInMonths | Integer | False | No | If duration is repeating, the number of months the coupon applies. Null if coupon duration is forever or once. | |
CouponPercentOff | Decimal | False | No | 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 a percent_off of 50 will make a $100 invoice $50 instead. | |
CouponRedeemBy | Datetime | False | No | Date after which the coupon can no longer be redeemed. | |
CouponTimesRedeemed | Integer | False | No | Number of times this coupon has been applied to a customer. | |
CouponValid | Boolean | True | No | Taking account of the above properties, whether this coupon can still be applied to a customer. | |
CouponMaxRedemptions | Integer | False | No | Maximum number of times this coupon can be redeemed, in total, across all customers, before it is no longer valid. | |
PromotionCode | String | False | No | The promotion code applied to create this discount. | |
Subscription | String | False | No | The subscription that this coupon is applied to, if it is applied to a particular subscription. | |
AccountId | String | False | Yes | The Id of the connected account to get invoices for. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | String | True | No | The Id of the invoice item. | |
InvoiceId | String | False | Invoices.Id | No | The Id of the invoice. |
Amount | Int | False | No | The amount, in cents. | |
Customer | String | False | Customers.Id | No | The ID of the customer who will be billed when this invoice item is billed. |
Currency | String | False | No | Three-letter ISO currency code, in lowercase. Must be a supported currency. | |
Date | Datetime | False | No | Time at which the object was created. | |
Description | String | False | No | An arbitrary string attached to the object. Often useful for displaying to users. The description field on invoice line items has a maximum character length limit of 500. | |
Discountable | Boolean | False | No | If true, discounts will apply to this line item. This is always false for prorations. | |
LiveMode | Boolean | False | No | Has the value true if the object exists in live mode or the value false if the object exists in test mode. | |
PeriodStart | Datetime | False | No | The start of the period. | |
PeriodEnd | Datetime | False | No | The end of the period which must be greater than or equal to the start. | |
PlanId | String | False | No | Unique identifier for the plan. | |
PlanAggregate | String | True | No | The plan of the subscription, if the line item is a subscription or a proration. | |
PriceId | String | False | No | Unique identifier for the price. | |
PriceAggregate | String | True | No | The price of the invoice item. | |
Proration | Boolean | True | No | Whether this is a proration. | |
Quantity | Int | False | No | The quantity of the subscription, if the line item is a subscription or a proration. | |
Subscription | String | False | No | The Id of the subscription the item pertains to. | |
SubscriptionItems | String | False | No | The subscription item that this invoice item has been created for, if any. | |
TestClock | String | False | No | ID of the test clock this invoice item belongs to. | |
UnitAmount | Integer | False | No | Unit amount (in the currency specified) of the invoice item. | |
UnitAmountDecimal | Decimal | False | No | Decimal value of Unit amount (in the currency specified) of the invoice item. | |
MetadataAggregate | String | False | No | The metadata object. | |
DiscountsAggregate | String | False | No | The discounts which apply to the invoice item. | |
TaxRatesAggregate | String | False | No | The tax rates which apply to the invoice item. When set, the default_tax_rates on the invoice do not apply to this invoice item. | |
PriceDataProduct | String | False | Yes | The ID of the product that this price will belong to. This is a psuedo-column to support insert operations. | |
PriceDataCurrency | String | False | Yes | Three-letter ISO currency code, in lowercase. Must be a supported currency. This is a psuedo-column to support insert operations. | |
PriceDataTaxBehavior | String | False | Yes | Only required if a default tax behavior was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of inclusive, exclusive, or unspecified. Once specified as either inclusive or exclusive, it cannot be changed. This is a psuedo-column to support insert operations. | |
PriceDataUnitAmount | Int | False | Yes | A positive integer in cents (or 0 for a free price) representing how much to charge. This is a psuedo-column to support insert operations. | |
PriceDataUnitAmountDecimal | String | False | Yes | Same as unit_amount, but accepts a decimal value in cents with at most 12 decimal places. Only one of unit_amount and unit_amount_decimal can be set. This is a psuedo-column to support insert operations. | |
TaxBehavior | String | False | Yes | Only required if a default tax behavior was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of inclusive, exclusive, or unspecified. Once specified as either inclusive or exclusive, it cannot be changed. This is a psuedo-column to support insert operations. | |
TaxCode | String | False | Yes | A tax code ID. | |
AccountId | String | False | Yes | The Id of the connected account to get invoice line items for. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | String | True | No | The Id of the discount object. | |
InvoiceId | String | True | No | The Id of the invoice. | |
CustomerId | String | True | No | The Id of the customer. | |
Start | Datetime | True | No | Date that the coupon was applied. | |
End | Datetime | True | No | 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. | |
CouponId | String | True | No | The Id of the coupon. | |
CouponAmountOff | Integer | True | No | Amount (in the currency specified) that is taken off the subtotal of any invoices for this customer. | |
CouponCurrency | String | True | No | If amount_off has been set, the three-letter ISO code for the currency of the amount to take off. | |
CouponName | String | True | No | Name of the coupon displayed to customers on, for instance, invoices or receipts. | |
CouponCreatedAt | Datetime | True | No | The creation date. | |
CouponDuration | String | True | No | Describes how long a customer who applies this coupon will get the discount. One of forever, once, and repeating. | |
CouponDurationInMonths | Integer | True | No | If duration is repeating, the number of months the coupon applies. Null if coupon duration is forever or once. | |
CouponPercentOff | Decimal | True | No | 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 a percent_off of 50 will make a $100 invoice $50 instead. | |
CouponRedeemBy | Datetime | True | No | Date after which the coupon can no longer be redeemed. | |
CouponTimesRedeemed | Integer | True | No | Number of times this coupon has been applied to a customer. | |
CouponValid | Boolean | True | No | Taking account of the above properties, whether this coupon can still be applied to a customer. | |
CouponMaxRedemptions | Integer | True | No | Maximum number of times this coupon can be redeemed, in total, across all customers, before it is no longer valid. | |
PromotionCode | String | True | No | The promotion code applied to create this discount. | |
Subscription | String | True | No | The subscription that this coupon is applied to, if it is applied to a particular subscription. | |
AccountId | String | False | Yes | The Id of the connected account to get invoices for. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | String | True | No | Unique identifier for the object. | |
InvoiceId | String | True | No | The Id of the invoice. | |
Amount | Integer | True | No | The amount, in cents. | |
AmountExcludingTax | Integer | True | No | The integer amount in cents representing the amount for this line item, excluding all tax and discounts. | |
Currency | String | True | No | Three-letter ISO currency code, in lowercase. Must be a supported currency. | |
Description | String | True | No | An arbitrary string attached to the object. Often useful for displaying to users. | |
Discountable | Boolean | True | No | If true, discounts will apply to this line item. Always false for prorations. | |
InvoiceItem | String | True | No | The Id of the invoice item associated with this line item if any. | |
LiveMode | Boolean | True | No | Has the value true if the object exists in live mode or the value false if the object exists in test mode. | |
Metadata | String | True | No | The metadata object. | |
Object | String | True | No | String representing the object's type. Objects of the same type share the same value. | |
PeriodEnd | Datetime | True | No | The end of the period, which must be greater than or equal to the start. | |
PeriodStart | Datetime | True | No | The start of the period. | |
PriceId | String | True | No | Unique identifier for the price. | |
PriceObject | String | True | No | String representing the object's type. Objects of the same type share the same value. | |
PriceActive | Boolean | True | No | Whether the price can be used for new purchases. | |
PriceBillingScheme | String | True | No | Describes how to compute the price per period. | |
PriceCreated | Datetime | True | No | Time at which the object was created. Measured in seconds since the Unix epoch. | |
PriceCurrency | String | True | No | Three-letter ISO currency code, in lowercase. Must be a supported currency. | |
PriceCustomUnitAmount | String | True | No | When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links. | |
PriceLiveMode | Boolean | True | No | Has the value true if the object exists in live mode or the value false if the object exists in test mode. | |
PriceLookupKey | String | True | No | A lookup key used to retrieve prices dynamically from a static string. This may be up to 200 characters. | |
PriceMetadata | String | True | No | 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. | |
PriceNickname | String | True | No | A brief description of the price, hidden from customers. | |
PriceProduct | String | True | No | The Id of the product this price is associated with. | |
PriceRecurring | String | True | No | The recurring components of a price such as interval and usage_type. | |
PriceTaxBehavior | String | True | No | Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of inclusive, exclusive, or unspecified. Once specified as either inclusive or exclusive, it cannot be changed. | |
PriceTiersMode | String | True | No | Defines if the tiering price should be graduated or volume based. In volume-based tiering, the maximum quantity within a period determines the per unit price. In graduated tiering, pricing can change as the quantity grows. | |
PriceTransformQuantity | String | True | No | Apply a transformation to the reported usage or set quantity before computing the amount billed. Cannot be combined with tiers. | |
PriceType | String | True | No | One of one_time or recurring depending on whether the price is for a one-time purchase or a recurring (subscription) purchase. | |
PriceUnitAmount | Integer | True | No | The unit amount in cents to be charged, represented as a whole integer if possible. Only set if billing_scheme=per_unit. | |
PriceUnitAmountDecimal | Float | True | No | The unit amount in cents to be charged, represented as a decimal string with at most 12 decimal places. Only set if billing_scheme=per_unit. | |
Proration | Boolean | True | No | Whether this is a proration. | |
ProrationDetails | String | True | No | Additional details for proration line items. | |
Quantity | Integer | True | No | The quantity of the subscription, if the line item is a subscription or a proration. | |
Subscription | String | True | No | The subscription that the invoice item pertains to, if any. | |
SubscriptionItems | String | True | No | The subscription item that generated this invoice item. Left empty if the line item is not an explicit result of a subscription. | |
Type | String | True | No | A string identifying the type of the source of this line item, either an invoiceitem or a subscription. | |
UnitAmountExcludingTax | String | True | No | The amount in cents representing the unit amount for this line item, excluding all tax and discounts. | |
DiscountAmountsAggregate | String | True | No | The amount of discount calculated per discount for this line item. | |
TaxAmountsAggregate | String | True | No | The amount of tax calculated per tax rate for this line item. | |
TaxRatesAggregate | String | True | No | The tax rates which apply to the line item. | |
DiscountsAggregate | String | True | No | The discounts which apply to the invoice item. | |
PlanActive | Boolean | True | No | Active. | |
PlanAggregateUsage | String | True | No | Aggregate Usage. | |
PlanAmount | Integer | True | No | Amount. | |
PlanAmountDecimal | String | True | No | Amount in decimal. | |
PlanBillingScheme | String | True | No | Billing scheme. | |
PlanCreated | Datetime | True | No | Created timestamp. | |
PlanCurrency | String | True | No | Currency code. | |
PlanId | String | True | No | Id of the plan. | |
PlanInterval | String | True | No | Interval. | |
PlanIntervalCount | Integer | True | No | Interval count. | |
PlanLivemode | Boolean | True | No | Livemode. | |
PlanMetadata | String | True | No | Metadata of the Plan. | |
PlanMeter | String | True | No | Meter. | |
PlanNickname | String | True | No | Nickname. | |
PlanObject | String | True | No | Object. | |
PlanProduct | String | True | No | Product. | |
PlanTiersMode | String | True | No | Tiers mode. | |
PlanTransformUsage | String | True | No | Transform usage. | |
PlanTrialPeriodDays | Integer | True | No | Trial period days. | |
PlanUsageType | String | True | No | Usage type. | |
AccountId | String | False | Yes | The Id of the connected account to get invoice line items for. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | String | True | No | The Id of the invoice. | |
CustomerId | String | False | Customers.Id | No | The Id of the customer to be billed. |
AccountCountry | String | True | No | The country of the business associated with this invoice, most often the business creating the invoice. | |
AccountName | String | True | No | The name of the business associated with this invoice, most often the business creating the invoice. | |
AccountTaxRates | String | False | No | The account tax IDs associated with the invoice. | |
AmountDue | Int | True | No | Final amount due at this time for this invoice. | |
AmountPaid | Int | True | No | The amount, in cents, that was paid. | |
AmountRemaining | Int | True | No | The amount remaining, in cents, that is due. | |
Application | String | True | No | ID of the Connect Application that created the invoice. | |
ApplicationFeeAmount | Int | False | No | The fee in cents that is applied to the invoice and transferred to the application owner's Stripe account when the invoice is paid. | |
AttemptCount | Int | True | No | Number of payment attempts made for this invoice, from the perspective of the payment retry schedule. | |
Attempted | Boolean | True | No | Whether an attempt has been made to pay the invoice. | |
AutomaticTaxEnabled | Boolean | False | No | Whether Stripe automatically computes tax on this invoice. | |
AutomaticTaxStatus | String | True | No | The status of the most recent automated tax calculation for this invoice. | |
BillingReason | String | True | No | Indicates the reason why the invoice was created. | |
CollectionMethod | String | False | No | Either charge_automatically, or send_invoice. When charging automatically, Stripe will attempt to pay this invoice using the default source attached to the customer. When sending an invoice, Stripe will email this invoice to the customer with payment instructions. | |
Charge | String | True | No | ID of the latest charge generated for this invoice, if any. | |
AutoAdvance | Boolean | False | No | Controls whether Stripe will perform automatic collection of the invoice. When false, the invoice's state will not automatically advance without an explicit action. | |
Currency | String | False | No | Three-letter ISO currency code, in lowercase. | |
Created | Datetime | True | No | Time at which the object was created. Measured in seconds since the Unix epoch. | |
Description | String | False | No | An arbitrary string attached to the object. Often useful for displaying to users. Referenced as 'memo' in the Dashboard. | |
DefaultPaymentMethod | String | False | No | ID of the default payment method for the invoice. | |
DefaultSource | String | False | No | ID of the default payment source for the invoice. | |
DefaultTaxRates | String | False | No | The tax rates applied to this invoice. | |
DiscountName | String | True | No | Name of the coupon. | |
DiscountAmount | String | True | No | Amount (in the currency specified) that is taken off the subtotal of any invoices for this customer. | |
CouponId | String | True | No | Id of the coupon. | |
Discounts | String | False | No | The discounts applied to the invoice. | |
DueDate | Datetime | False | No | The date on which payment for this invoice is due. This value is null for invoices where collection_method=charge_automatically. | |
EndingBalance | Int | True | No | Ending customer balance after the invoice is finalized. | |
InvoicePdf | String | True | No | The link to download the PDF for the invoice. If the invoice has not been finalized yet, this is null. | |
Footer | String | False | No | Footer displayed on the invoice. | |
LastFinalizationError | String | True | No | The error encountered during the previous attempt to finalize the invoice. This field is cleared when the invoice is successfully finalized. | |
HostedInvoiceUrl | String | True | No | The URL for the hosted invoice page, which allows customers to view and pay an invoice. | |
Livemode | Boolean | True | No | Has the value true if the object exists in live mode or the value false if the object exists in test mode. | |
MetadataAggregate | String | False | No | The set of key/value pairs that you can attach to a subscription object. | |
CustomFieldsAggregate | String | False | No | Custom Fields object. | |
NextPaymentAttempt | Datetime | True | No | The time at which payment will next be attempted. | |
Number | String | True | No | A unique, identifying string that appears on emails sent to the customer for this invoice. | |
OnBehalfOf | String | False | No | The account (if any) for which the funds of the invoice payment are intended. | |
Paid | Boolean | True | No | 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. | |
PaidOutOfBand | Boolean | True | No | Returns true if the invoice was manually marked paid, returns false if the invoice hasn't been paid yet or was paid on Stripe. | |
PaymentIntent | String | True | No | The PaymentIntent associated with this invoice. | |
PaymentMethodOptions | String | True | No | Payment-method-specific configuration to provide to the invoice's PaymentIntent. | |
PaymentMethodTypes | String | False | No | The list of payment method types (e.g. card) to provide to the invoice's PaymentIntent. | |
PostPaymentCreditNotesAmount | Int | True | No | Total amount of all post-payment credit notes issued for this invoice. | |
PrePaymentCreditNotesAmount | Int | True | No | Total amount of all pre-payment credit notes issued for this invoice. | |
Quote | String | True | No | The quote Id this invoice was generated from. | |
PeriodEnd | Datetime | True | No | End of the usage period during which invoice items were added to this invoice. | |
PeriodStart | Datetime | True | No | Start of the usage period during which invoice items were added to this invoice. | |
ReceiptNumber | String | True | No | This is the transaction number that appears on email receipts sent for this invoice. | |
StartingBalance | Int | True | No | Starting customer balance before the invoice is finalized. If the invoice has not been finalized yet, this will be the current customer balance. | |
StatementDescriptor | String | False | No | If provided, each invoice created by this subscription will apply the tax rate, increasing the amount billed to the customer. | |
Status | String | True | No | The status of the invoice, one of draft, open, paid, uncollectible, or void. Instead of checking the forgiven field on an invoice, check for the uncollectible status. Instead of setting the forgiven field on an invoice, mark it as uncollectible. | |
Subscription | String | False | No | The subscription that this invoice was prepared for, if any. | |
StatusTransitionsFinalizedAt | Datetime | True | No | The time that the invoice draft was finalized. | |
StatusTransitionsMarkedUncollectibleAt | Datetime | True | No | The time that the invoice was marked uncollectible. | |
StatusTransitionsPaidAt | Datetime | True | No | The time that the invoice was paid. | |
StatusTransitionsVoidedAt | Datetime | True | No | The time that the invoice was voided. | |
Subtotal | Int | True | No | Total of all subscriptions, invoice items, and prorations on the invoice before any invoice level discount or tax is applied. | |
Tax | Int | True | No | The amount of tax on this invoice. This is the sum of all the tax amounts on this invoice. | |
TestClock | String | True | No | ID of the test clock this invoice item belongs to. | |
Total | Int | True | No | Total after discounts and taxes. | |
TotalDiscountAmounts | String | True | No | The aggregate amounts calculated per discount across all line items. | |
TotalTaxAmounts | String | True | No | The aggregate amounts calculated per tax rate for all line items. | |
TransferDataAmount | Int | False | No | The amount that will be transferred to the destination account when the invoice is paid. | |
TransferDataDestination | String | False | No | The account where funds from the payment will be transferred to upon payment success. | |
WebhooksDeliveredAt | Datetime | True | No | Invoices are automatically paid or sent 1 hour after webhooks are delivered, or until all webhook delivery attempts have been exhausted. | |
AmountShipping | Int | True | No | This is the sum of all the shipping amounts. | |
ShippingDetails | String | True | No | Shipping details for the invoice. The Invoice PDF will use the shipping_details value if it is set, otherwise the PDF will render the shipping address from the customer. | |
ShippingCost | String | False | No | The details of the cost of shipping, including the ShippingRate applied on the invoice. | |
CustomerAddress | String | True | No | The customer's address. | |
CustomerEmail | String | True | No | The customer's email. | |
CustomerName | String | True | No | The customer's name. | |
CustomerPhone | String | True | No | The customer's phone number. | |
CustomerShipping | String | True | No | The customer's shipping information. | |
CustomerTaxExempt | String | True | No | The customer's tax exempt status. | |
CustomerTaxIds | String | True | No | The customer's tax Ids. | |
EffectiveAt | Datetime | False | No | The date when this invoice is in effect. When defined, this value replaces the system-generated 'Date of issue' printed on the invoice PDF and receipt. | |
Lines | String | False | No | The individual line items that make up the invoice. | |
AutomaticTaxLiabilityAccount | String | False | No | The connected account being referenced when type is account. | |
AutomaticTaxLiabilityType | String | False | No | Type of the account referenced. | |
FromInvoiceAction | String | False | No | The relation between this invoice and the cloned invoice. | |
FromInvoiceInvoice | String | False | No | The invoice that was cloned. For insertion use the id of the invoice that will be cloned. | |
IssuerAccount | String | False | No | The connected account being referenced when IssuerType is account. | |
IssuerType | String | False | No | Type of the account referenced. | |
RenderingAmountTaxDisplay | String | False | No | How line-item prices and amounts will be displayed with respect to tax on invoice PDFs. | |
RenderingPdfPageSize | String | False | No | Page size of invoice pdf. Options include a4, letter, and auto. If set to auto, page size will be switched to a4 or letter based on customer locale. | |
RenderingTemplate | String | False | No | ID of the rendering template that the invoice is formatted by. | |
RenderingTemplateVersion | Integer | False | No | Version of the rendering template that the invoice is using. | |
RenderingOptions | String | True | No | The rendering options of the invoice. | |
SubscriptionDetailsMetadata | String | True | No | Set of key-value pairs defined as subscription metadata when an invoice is created. Becomes an immutable snapshot of the subscription metadata at the time of invoice finalization. Note: This attribute is populated only for invoices created on or after June 29, 2023. | |
PaymentSettingsDefaultMandate | String | False | No | ID of the mandate to be used for this invoice. It must correspond to the payment method used to pay the invoice, including the invoice’s default_payment_method or default_source, if set. | |
SubtotalExcludingTax | Integer | True | No | The integer amount in cents representing the subtotal of the invoice before any invoice level discount or tax is applied. Item discounts are already incorporated. | |
TotalExcludingTax | Integer | True | No | The integer amount in cents representing the total amount of the invoice including all discounts but excluding all tax. | |
LatestRevision | String | True | No | The ID of the most recent non-draft revision of this invoice. | |
PendingInvoiceItemsBehavior | String | False | Yes | For Insert this column is required | |
Upcoming | Boolean | False | Yes | Determines if the select is for upcoming invoices. | |
DaysUntilDue | Int | False | Yes | The number of days from which the invoice is created until it is due. Only valid for invoices where billing=send_invoice. | |
Forgive | Boolean | False | Yes | Determines if invoice should be forgiven if source has insufficient funds to fully pay the invoice. | |
Source | String | False | Yes | A payment source to be charged. The source must be the ID of a source belonging to the customer associated with the invoice being paid. | |
AccountId | String | False | Yes | The Id of the connected account to get invoices for |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | String | True | No | The id of files. | |
CancellationReason | String | True | No | The reason why the card was canceled. | |
Currency | String | True | No | Three-letter ISO currency code, in lowercase. Must be a supported currency. | |
Created | Datetime | True | No | Time at which the object was created. Measured in seconds since the Unix epoch. | |
CardholderId | String | True | No | Unique identifier for the object. | |
CardholderObject | String | True | No | String representing the objects type. Objects of the same type share the same value. | |
CardholderBillingAddress | String | True | No | The cardholders billing address. | |
CardholderIsCompanyTaxIdProvided | Boolean | True | No | Whether the companys business ID number was provided. | |
CardholderCreated | Datetime | True | No | Time at which the object was created. Measured in seconds since the Unix epoch. | |
CardholderEmail | String | True | No | The cardholders email address. | |
CardholderIndividual | String | True | No | Additional information about an individual cardholder. | |
CardholderName | String | True | No | The cardholders name. This will be printed on cards issued to them. | |
CardholderPhoneNumber | String | True | No | The cardholders phone number. This is required for all cardholders who will be creating EU cards. See the 3D Secure documentation for more details. | |
CardholderPreferredLocales | String | True | No | The cardholders preferred locales (languages), ordered by preference. | |
CardholderRequirementsDisabledReason | String | True | No | If disabled_reason is present, all cards will decline authorizations with cardholder_verification_required reason. | |
CardholderRequirementsPastDue | String | True | No | Array of fields that need to be collected in order to verify and re-enable the cardholder. | |
CardholderSpendingControlsAllowedCategories | String | True | No | Array of strings containing categories of authorizations to allow. All other categories will be blocked. Cannot be set with blocked_categories. | |
CardholderSpendingControlsBlockedCategories | String | True | No | Array of strings containing categories of authorizations to decline. All other categories will be allowed. Cannot be set with allowed_categories. | |
CardholderSpendingControlsSpendingLimits | String | True | No | Limit spending with amount-based rules that apply across this cardholders cards. | |
CardholderSpendingControlsSpendingLimitsCurrency | String | True | No | Currency of the amounts within spending_limits. | |
CardholderStatus | String | True | No | Specifies whether to permit authorizations on this cardholders cards. | |
CardholderType | String | True | No | One of individual or company. See Choose a cardholder type for more details. | |
ExpMonth | Integer | True | No | The expiration month of the card. | |
ExpYear | Integer | True | No | The expiration year of the card. | |
Last4 | String | True | No | The last 4 digits of the card number. | |
MetadataAggregate | String | True | No | The set of key/value pairs that you can attach to a an object. | |
Status | String | True | No | Whether authorizations can be approved on this card. May be blocked from activating cards depending on past-due Cardholder requirements. Defaults to inactive. | |
Type | String | True | No | The type of the card. | |
Object | String | True | No | String representing the objects type. Objects of the same type share the same value. | |
Brand | String | True | No | The brand of the card. | |
CVC | String | True | No | The cards CVC. For security reasons, this is only available for virtual cards. | |
Livemode | Boolean | True | No | Has the value true if the object exists in live mode or the value false if the object exists in test mode. | |
Number | String | True | No | The full unredacted card number. | |
ReplacedBy | String | True | No | The latest card that replaces this card, if any. | |
ReplacementFor | String | True | No | The card this card replaces, if any. | |
ReplacementReason | String | True | No | The reason why the previous card needed to be replaced. | |
ShippingAddress | String | True | No | Shipping address. | |
ShippingCarrier | String | True | No | The delivery company that shipped a card. | |
ShippingCustoms | String | True | No | Additional information that may be required for clearing customs. | |
ShippingETA | String | True | No | A unix timestamp representing a best estimate of when the card will be delivered. | |
ShippingName | String | True | No | Recipient name. | |
ShippingPhoneNumber | String | True | No | The phone number of the receiver of the shipment | |
ShippingRequireSignature | Boolean | True | No | Whether a signature is required for card delivery. | |
ShippingService | String | True | No | Shipment service, such as standard or express. | |
ShippingStatus | String | True | No | The delivery status of the card. | |
ShippingTrackingNumber | String | True | No | A tracking number for a card shipment. | |
ShippingTrackingURL | String | True | No | A link to the shipping carriers site where you can view detailed information about a card shipment. | |
ShippingType | String | True | No | Packaging options. | |
SpendingControlsAllowedCategories | String | True | No | ||
SpendingControlsBlockedCategories | String | True | No | ||
SpendingControlsSpendingLimits | String | True | No | ||
SpendingControlsSpendingLimitsCurrency | String | True | No | ||
WalletsApplePay | String | True | No | ||
WalletsGooglePay | String | True | No | ||
WalletsPrimaryAccountIdentifier | String | True | No | ||
CardholderSpendingControlsAllowedMerchantCountries | String | True | No | Array of strings containing representing countries from which authorizations will be allowed. Authorizations from merchants in all other countries will be declined. Country codes should be ISO 3166 alpha-2 country codes (e.g. US). Cannot be set with blocked_merchant_countries. Provide an empty value to unset this control. | |
CardholderSpendingControlsBlockedMerchantCountries | String | True | No | Array of strings containing representing countries from which authorizations will be declined. Country codes should be ISO 3166 alpha-2 country codes (e.g. US). Cannot be set with allowed_merchant_countries. Provide an empty value to unset this control. | |
SpendingControlsAllowedMerchantCountries | String | True | No | Array of strings containing representing countries from which authorizations will be allowed. Authorizations from merchants in all other countries will be declined. Country codes should be ISO 3166 alpha-2 country codes (e.g. US). Cannot be set with blocked_merchant_countries. Provide an empty value to unset this control. | |
SpendingControlsBlockedMerchantCountries | String | True | No | Array of strings containing representing countries from which authorizations will be declined. Country codes should be ISO 3166 alpha-2 country codes (e.g. US). Cannot be set with allowed_merchant_countries. Provide an empty value to unset this control. | |
PersonalizationDesign | String | True | No | The personalization design object belonging to this card. | |
AccountId | String | False | Yes | The Id of the connected account to get files for. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | String | True | No | The id of files. | |
Amount | Integer | True | No | Disputed amount in the cards currency and in the smallest currency unit. Usually the amount of the transaction. | |
BalanceTransactions | String | True | No | List of balance transactions associated with the dispute. | |
Currency | String | True | No | The currency the transaction was made in. | |
Created | Datetime | True | No | Time at which the object was created. Measured in seconds since the Unix epoch. | |
EvidenceCanceled | String | True | No | Evidence provided when reason is canceled. | |
EvidenceDuplicate | String | True | No | Evidence provided when reason is duplicate. | |
EvidenceFraudulent | String | True | No | Evidence provided when reason is fraudulent. | |
EvidenceMerchandiseNotAsDescribed | String | True | No | Evidence provided when reason is merchandise_not_as_described. | |
EvidenceNotReceived | String | True | No | Evidence provided when reason is not_received. | |
EvidenceOther | String | True | No | Evidence provided when reason is other. | |
EvidenceReason | String | True | No | The reason for filing the dispute. Its value will match the field containing the evidence. | |
EvidenceServiceNotAsDescribed | String | True | No | The service was not as described. | |
MetadataAggregate | String | True | No | The set of key/value pairs that you can attach to a an object. | |
Status | String | True | No | Current status of the dispute. | |
Transaction | String | True | No | The transaction being disputed. | |
Object | String | True | No | Object. | |
Livemode | Boolean | True | No | LiveMode. | |
AccountId | String | False | Yes | Account Id. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Automatic_Payout_Id | String | True | No | ID of the automatically created payout associated with this balance transaction (only set if your account is on an automatic payout schedule). | |
Automatic_Payout_Effective_At | Datetime | True | No | The date we expect this automatic payout to arrive in your bank account, in the requested timezone, or UTC if not provided. This is also when the paid-out funds are deducted from your Stripe balance. | |
Balance_Transaction_Id | String | True | No | Unique identifier for the balance transaction. | |
Created_UTC | Datetime | True | No | Time at which the balance transaction was created. Dates in UTC. | |
Created | Datetime | True | No | Time at which the balance transaction was created. Dates in the requested timezone, or UTC if not provided. | |
Available_On_UTC | Datetime | True | No | The date the balance transactions net funds will become available in the Stripe balance. Dates in UTC. | |
Available_On | Datetime | True | No | The date the balance transactions net funds will become available in the Stripe balance. Dates in the requested timezone, or UTC if not provided. | |
Currency | String | True | No | Three-letter ISO code for the currency in which gross, fee and net are defined. | |
Gross | Decimal | True | No | Gross amount of the transaction. Expressed in major units of the currency (e.g. dollars for USD, yen for JPY). | |
Fee | Decimal | True | No | Fees paid for this transaction. Expressed in major units of the currency (e.g. dollars for USD, yen for JPY). | |
Net | Decimal | True | No | Net amount of the transaction. Expressed in major units of the currency (e.g. dollars for USD, yen for JPY). | |
Reporting_Category | String | True | No | Reporting Category is a new categorization of balance transactions, meant to improve on the current type field. | |
Source_Id | String | True | No | The Stripe object to which this transaction is related. | |
Description | String | True | No | An arbitrary string attached to the balance transaction. Often useful for displaying to users. | |
Customer_Facing_Amount | Decimal | True | No | For transactions associated with charges or refunds, the amount of the original charge or refund. | |
Customer_Facing_Currency | String | True | No | For transactions associated with charges or refunds, the three-letter ISO code for the currency for customer_facing_amount. | |
Automatic_Payout_Effective_At_UTC | Datetime | True | No | The date we expect this automatic payout to arrive in your bank account, in UTC. This is also when the paid-out funds are deducted from your Stripe balance. | |
Customer_Id | String | True | No | The unique ID of the related customer, if any. | |
Customer_Email | String | True | No | Email address of the customer, if any, associated with this balance transaction. | |
Customer_Name | String | True | No | Name of the customer, if any, associated with this balance transaction. | |
Customer_Description | String | True | No | Description provided when creating the customer, often used to store the customer name. | |
Shipping_Address_Line1 | String | True | No | First line of the shipping address associated with this charge, if any | |
Shipping_Address_Line2 | String | True | No | Second line of the shipping address associated with this charge, if any | |
Shipping_Address_City | String | True | No | City of the shipping address associated with this charge, if any | |
Shipping_Address_State | String | True | No | State of the shipping address associated with this charge, if any | |
Shipping_Address_Postal_Code | String | True | No | Postal code of the shipping address associated with this charge, if any | |
Shipping_Address_Country | String | True | No | Country of the shipping address associated with this charge, if any | |
Charge_Id | String | True | No | Unique identifier for the original charge associated with this balance transaction. Available for charges, refunds and disputes. | |
Payment_Intent_Id | String | True | No | The unique ID of the related Payment Intent, if any. | |
Charge_Created_UTC | Datetime | True | No | Creation time of the original charge associated with this balance transaction. Available for charges, refunds and disputes. For charges that were separately authorized and captured, this is the authorization time. Dates in UTC. | |
Charge_Created | Datetime | True | No | Creation time of the original charge associated with this balance transaction. Available for charges, refunds and disputes. For charges that were separately authorized and captured, this is the authorization time. Dates in the requested timezone, or UTC if not provided. | |
Invoice_Id | String | True | No | Unique ID for the invoice associated with this balance transaction. Available for charges, refunds, and disputes made in connection with a Stripe Billing invoice. | |
Subscription_Id | String | True | No | Unique ID for the subscription associated with this balance transaction. Available for charges, refunds, and disputes made in connection with a Stripe Billing subscription. | |
Payment_Method_Type | String | True | No | The type of payment method used in the related payment. | |
Card_Brand | String | True | No | Card brand, if applicable. | |
Card_Funding | String | True | No | Card funding type, if applicable. | |
Card_Country | String | True | No | Two-letter ISO code representing the country of the card. | |
Statement_Descriptor | String | True | No | The dynamic statement descriptor or suffix specified when the related charge was created. | |
Dispute_Reason | String | True | No | Reason given by cardholder for dispute. | |
Connected_Account_Id | String | True | No | For Stripe Connect activity related to a connected account, the unique ID for the account. | |
Connected_Account_Name | String | True | No | For Stripe Connect activity related to a connected account, the name of the account. | |
Connected_Account_Country | String | True | No | For Stripe Connect activity related to a connected account, the two-letter ISO code representing the country of the account. | |
Regulatory_Tag | String | True | No | ??An identifier reflecting the classification of this transaction according to local regulations, if applicable. Accounts with automatic payouts enabled receive a separate payout for each regulatory tag. ??This column is only populated for Brazilian accounts. | |
Payment_Metadata | String | True | No | Metadata associated with the related PaymentIntent, if any. If no PaymentIntent metadata exists, metadata from any related charge object will be returned. API requests including this column must specify a metadata key in brackets. This column can be specified multiple times to retrieve data from additional metadata keys. | |
Refund_Metadata | String | True | No | Metadata associated with the related refund object, if any. API requests including this column must specify a metadata key in brackets. This column can be specified multiple times to retrieve data from additional metadata keys. | |
Transfer_Metadata | String | True | No | Metadata associated with the related transfer object, if any. API requests including this column must specify a metadata key in brackets. This column can be specified multiple times to retrieve data from additional metadata keys. | |
Id [KEY] | String | True | Reports.Id | No | Unique identifier for the reports run object. |
ParametersIntervalEnd | Datetime | True | No | Ending timestamp of data to be included in the report run (exclusive). | |
ParametersIntervalStart | Datetime | True | No | Starting timestamp of data to be included in the report run. | |
ParametersColumns | String | True | No | The set of output columns requested for inclusion in the report run. | |
ParametersCurrency | String | True | No | Currency of objects to be included in the report run. | |
ParametersReportingCategory | String | True | No | Category of balance transactions to be included in the report run. | |
ParametersTimezone | String | True | No | Defaults to Etc/UTC. The output timezone for all timestamps in the report. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Balance_Transaction_Id | String | True | No | Unique identifier for the balance transaction. | |
Created_UTC | Datetime | True | No | Time at which the balance transaction was created. Dates in UTC. | |
Created | Datetime | True | No | Time at which the balance transaction was created. Dates in the requested timezone, or UTC if not provided. | |
Available_On_UTC | Datetime | True | No | The date the balance transactions net funds will become available in the Stripe balance. Dates in UTC. | |
Available_On | Datetime | True | No | The date the balance transactions net funds will become available in the Stripe balance. Dates in the requested timezone, or UTC if not provided. | |
Currency | String | True | No | Three-letter ISO code for the currency in which gross, fee and net are defined. | |
Gross | Decimal | True | No | Gross amount of the transaction. Expressed in major units of the currency (e.g. dollars for USD, yen for JPY). | |
Fee | Decimal | True | No | Fees paid for this transaction. Expressed in major units of the currency (e.g. dollars for USD, yen for JPY). | |
Net | Decimal | True | No | Net amount of the transaction. Expressed in major units of the currency (e.g. dollars for USD, yen for JPY). | |
Reporting_Category | String | True | No | Reporting Category is a new categorization of balance transactions, meant to improve on the current type field. | |
Source_Id | String | True | No | The Stripe object to which this transaction is related. | |
Description | String | True | No | An arbitrary string attached to the balance transaction. Often useful for displaying to users. | |
Customer_Facing_Amount | Decimal | True | No | For transactions associated with charges or refunds, the amount of the original charge or refund. | |
Customer_Facing_Currency | String | True | No | For transactions associated with charges or refunds, the three-letter ISO code for the currency for customer_facing_amount. | |
Automatic_Payout_Id | String | True | No | ID of the automatically created payout associated with this balance transaction (only set if your account is on an automatic payout schedule). | |
Automatic_Payout_Effective_At_UTC | Datetime | True | No | The date we expect this automatic payout to arrive in your bank account, in UTC. This is also when the paid-out funds are deducted from your Stripe balance. | |
Automatic_Payout_Effective_At | Datetime | True | No | The date we expect this automatic payout to arrive in your bank account, in the requested timezone, or UTC if not provided. This is also when the paid-out funds are deducted from your Stripe balance. | |
Customer_Id | String | True | No | The unique ID of the related customer, if any. | |
Customer_Email | String | True | No | Email address of the customer, if any, associated with this balance transaction. | |
Customer_Name | String | True | No | Name of the customer, if any, associated with this balance transaction. | |
Customer_Description | String | True | No | Description provided when creating the customer, often used to store the customer name. | |
Shipping_Address_Line1 | String | True | No | First line of the shipping address associated with this charge, if any | |
Shipping_Address_Line2 | String | True | No | Second line of the shipping address associated with this charge, if any | |
Shipping_Address_City | String | True | No | City of the shipping address associated with this charge, if any | |
Shipping_Address_State | String | True | No | State of the shipping address associated with this charge, if any | |
Shipping_Address_Postal_Code | String | True | No | Postal code of the shipping address associated with this charge, if any | |
Shipping_Address_Country | String | True | No | Country of the shipping address associated with this charge, if any | |
Charge_Id | String | True | No | Unique identifier for the original charge associated with this balance transaction. Available for charges, refunds and disputes. | |
Payment_Intent_Id | String | True | No | The unique ID of the related Payment Intent, if any. | |
Charge_Created_UTC | Datetime | True | No | Creation time of the original charge associated with this balance transaction. Available for charges, refunds and disputes. For charges that were separately authorized and captured, this is the authorization time. Dates in UTC. | |
Charge_Created | Datetime | True | No | Creation time of the original charge associated with this balance transaction. Available for charges, refunds and disputes. For charges that were separately authorized and captured, this is the authorization time. Dates in the requested timezone, or UTC if not provided. | |
Invoice_Id | String | True | No | Unique ID for the invoice associated with this balance transaction. Available for charges, refunds, and disputes made in connection with a Stripe Billing invoice. | |
Subscription_Id | String | True | No | Unique ID for the subscription associated with this balance transaction. Available for charges, refunds, and disputes made in connection with a Stripe Billing subscription. | |
Payment_Method_Type | String | True | No | The type of payment method used in the related payment. | |
Card_Brand | String | True | No | Card brand, if applicable. | |
Card_Funding | String | True | No | Card funding type, if applicable. | |
Card_Country | String | True | No | Two-letter ISO code representing the country of the card. | |
Statement_Descriptor | String | True | No | The dynamic statement descriptor or suffix specified when the related charge was created. | |
Dispute_Reason | String | True | No | Reason given by cardholder for dispute. | |
Connected_Account_Id | String | True | No | For Stripe Connect activity related to a connected account, the unique ID for the account. | |
Connected_Account_Name | String | True | No | For Stripe Connect activity related to a connected account, the name of the account. | |
Connected_Account_Country | String | True | No | For Stripe Connect activity related to a connected account, the two-letter ISO code representing the country of the account. | |
Regulatory_Tag | String | True | No | ??An identifier reflecting the classification of this transaction according to local regulations, if applicable. Accounts with automatic payouts enabled receive a separate payout for each regulatory tag. ??This column is only populated for Brazilian accounts. | |
Payment_Metadata | String | True | No | Metadata associated with the related PaymentIntent, if any. If no PaymentIntent metadata exists, metadata from any related charge object will be returned. API requests including this column must specify a metadata key in brackets. This column can be specified multiple times to retrieve data from additional metadata keys. | |
Refund_Metadata | String | True | No | Metadata associated with the related refund object, if any. API requests including this column must specify a metadata key in brackets. This column can be specified multiple times to retrieve data from additional metadata keys. | |
Transfer_Metadata | String | True | No | Metadata associated with the related transfer object, if any. API requests including this column must specify a metadata key in brackets. This column can be specified multiple times to retrieve data from additional metadata keys. | |
Id [KEY] | String | True | Reports.Id | No | Unique identifier for the reports run object. |
ParametersIntervalEnd | Datetime | True | No | Ending timestamp of data to be included in the report run (exclusive). | |
ParametersColumns | String | True | No | The set of output columns requested for inclusion in the report run. | |
ParametersCurrency | String | True | No | Currency of objects to be included in the report run. | |
ParametersReportingCategory | String | True | No | Category of balance transactions to be included in the report run. | |
ParametersTimezone | String | True | No | Defaults to Etc/UTC. The output timezone for all timestamps in the report. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Balance_Transaction_Id [KEY] | String | True | No | Unique identifier for the balance transaction. | |
Created_UTC | Datetime | True | No | Time at which the balance transaction was created. Dates in UTC. | |
Created | Datetime | True | No | Time at which the balance transaction was created. Dates in the requested timezone, or UTC if not provided. | |
Available_On_UTC | Datetime | True | No | The date the balance transactions net funds will become available in the Stripe balance. Dates in UTC. | |
Available_On | Datetime | True | No | The date the balance transactions net funds will become available in the Stripe balance. Dates in the requested timezone, or UTC if not provided. | |
Currency | String | True | No | Three-letter ISO code for the currency in which gross, fee and net are defined. | |
Gross | Decimal | True | No | Gross amount of the transaction. Expressed in major units of the currency (e.g. dollars for USD, yen for JPY). | |
Fee | Decimal | True | No | Fees paid for this transaction. Expressed in major units of the currency (e.g. dollars for USD, yen for JPY). | |
Net | Decimal | True | No | Net amount of the transaction. Expressed in major units of the currency (e.g. dollars for USD, yen for JPY). | |
Reporting_Category | String | True | No | Reporting Category is a new categorization of balance transactions, meant to improve on the current type field. | |
Source_Id | String | True | No | The Stripe object to which this transaction is related. | |
Description | String | True | No | An arbitrary string attached to the balance transaction. Often useful for displaying to users. | |
Customer_Facing_Amount | Decimal | True | No | For transactions associated with charges or refunds, the amount of the original charge or refund. | |
Customer_Facing_Currency | String | True | No | For transactions associated with charges or refunds, the three-letter ISO code for the currency for customer_facing_amount. | |
Automatic_Payout_Id | String | True | No | ID of the automatically created payout associated with this balance transaction (only set if your account is on an automatic payout schedule). | |
Automatic_Payout_Effective_At_UTC | Datetime | True | No | The date we expect this automatic payout to arrive in your bank account, in UTC. This is also when the paid-out funds are deducted from your Stripe balance. | |
Automatic_Payout_Effective_At | Datetime | True | No | The date we expect this automatic payout to arrive in your bank account, in the requested timezone, or UTC if not provided. This is also when the paid-out funds are deducted from your Stripe balance. | |
Customer_Id | String | True | No | The unique ID of the related customer, if any. | |
Customer_Email | String | True | No | Email address of the customer, if any, associated with this balance transaction. | |
Customer_Name | String | True | No | Name of the customer, if any, associated with this balance transaction. | |
Customer_Description | String | True | No | Description provided when creating the customer, often used to store the customer name. | |
Shipping_Address_Line1 | String | True | No | First line of the shipping address associated with this charge, if any | |
Shipping_Address_Line2 | String | True | No | Second line of the shipping address associated with this charge, if any | |
Shipping_Address_City | String | True | No | City of the shipping address associated with this charge, if any | |
Shipping_Address_State | String | True | No | State of the shipping address associated with this charge, if any | |
Shipping_Address_Postal_Code | String | True | No | Postal code of the shipping address associated with this charge, if any | |
Shipping_Address_Country | String | True | No | Country of the shipping address associated with this charge, if any | |
Charge_Id | String | True | No | Unique identifier for the original charge associated with this balance transaction. Available for charges, refunds and disputes. | |
Payment_Intent_Id | String | True | No | The unique ID of the related Payment Intent, if any. | |
Charge_Created_UTC | Datetime | True | No | Creation time of the original charge associated with this balance transaction. Available for charges, refunds and disputes. For charges that were separately authorized and captured, this is the authorization time. Dates in UTC. | |
Charge_Created | Datetime | True | No | Creation time of the original charge associated with this balance transaction. Available for charges, refunds and disputes. For charges that were separately authorized and captured, this is the authorization time. Dates in the requested timezone, or UTC if not provided. | |
Invoice_Id | String | True | No | Unique ID for the invoice associated with this balance transaction. Available for charges, refunds, and disputes made in connection with a Stripe Billing invoice. | |
Subscription_Id | String | True | No | Unique ID for the subscription associated with this balance transaction. Available for charges, refunds, and disputes made in connection with a Stripe Billing subscription. | |
Payment_Method_Type | String | True | No | The type of payment method used in the related payment. | |
Card_Brand | String | True | No | Card brand, if applicable. | |
Card_Funding | String | True | No | Card funding type, if applicable. | |
Card_Country | String | True | No | Two-letter ISO code representing the country of the card. | |
Statement_Descriptor | String | True | No | The dynamic statement descriptor or suffix specified when the related charge was created. | |
Dispute_Reason | String | True | No | Reason given by cardholder for dispute. | |
Connected_Account_Id | String | True | No | For Stripe Connect activity related to a connected account, the unique ID for the account. | |
Connected_Account_Name | String | True | No | For Stripe Connect activity related to a connected account, the name of the account. | |
Connected_Account_Country | String | True | No | For Stripe Connect activity related to a connected account, the two-letter ISO code representing the country of the account. | |
Regulatory_Tag | String | True | No | ??An identifier reflecting the classification of this transaction according to local regulations, if applicable. Accounts with automatic payouts enabled receive a separate payout for each regulatory tag. ??This column is only populated for Brazilian accounts. | |
Payment_Metadata | String | True | No | Metadata associated with the related PaymentIntent, if any. If no PaymentIntent metadata exists, metadata from any related charge object will be returned. API requests including this column must specify a metadata key in brackets. This column can be specified multiple times to retrieve data from additional metadata keys. | |
Refund_Metadata | String | True | No | Metadata associated with the related refund object, if any. API requests including this column must specify a metadata key in brackets. This column can be specified multiple times to retrieve data from additional metadata keys. | |
Transfer_Metadata | String | True | No | Metadata associated with the related transfer object, if any. API requests including this column must specify a metadata key in brackets. This column can be specified multiple times to retrieve data from additional metadata keys. | |
Id [KEY] | String | True | Reports.Id | No | Unique identifier for the reports run object. |
ParametersIntervalEnd | Datetime | True | No | Ending timestamp of data to be included in the report run (exclusive). | |
ParametersIntervalStart | Datetime | True | No | Starting timestamp of data to be included in the report run. | |
ParametersColumns | String | True | No | The set of output columns requested for inclusion in the report run. | |
ParametersCurrency | String | True | No | Currency of objects to be included in the report run. | |
ParametersReportingCategory | String | True | No | Category of balance transactions to be included in the report run. | |
ParametersTimezone | String | True | No | Defaults to Etc/UTC. The output timezone for all timestamps in the report. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Payout_Id [KEY] | String | True | No | The Stripe object to which this transaction is related. | |
Effective_At_UTC | Datetime | True | No | For automatic payouts, this is the date we expect funds to arrive in your bank account. For manual payouts, this is the date the payout was initiated. In both cases, its the date the paid-out funds are deducted from your Stripe balance. All dates in UTC. | |
Effective_At | Datetime | True | No | For automatic payouts, this is the date we expect funds to arrive in your bank account. For manual payouts, this is the date the payout was initiated. In both cases, its the date the paid-out funds are deducted from your Stripe balance. All dates in the requested timezone, or UTC if not provided. | |
Currency | String | True | No | Three-letter ISO code for the currency in which gross, fee and net are defined. | |
Gross | Decimal | True | No | Gross amount of the transaction. Expressed in major units of the currency (e.g. dollars for USD, yen for JPY). | |
Fee | Decimal | True | No | Fees paid for this transaction. Expressed in major units of the currency (e.g. dollars for USD, yen for JPY). | |
Net | Decimal | True | No | Net amount of the transaction. Expressed in major units of the currency (e.g. dollars for USD, yen for JPY). | |
Reporting_Category | String | True | No | Reporting Category is a new categorization of balance transactions, meant to improve on the current type field. | |
Balance_Transaction_Id | String | True | No | Unique identifier for the balance transaction. | |
Description | String | True | No | An arbitrary string attached to the balance transaction. Often useful for displaying to users. | |
Payout_Expected_Arrival_Date | Datetime | True | No | Date the payout is scheduled to arrive in the bank. This factors in delays like weekends or bank holidays. | |
Payout_Status | String | True | No | Current status of the payout (paid, pending, in_transit, canceled or failed). A payout 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. | |
Payout_Reversed_At_UTC | Datetime | True | No | Typically this field will be empty. However, if the payouts status is canceled or failed, this field will reflect the time at which it entered that status. Times in UTC. | |
Payout_Reversed_At | Datetime | True | No | Typically this field will be empty. However, if the payouts status is canceled or failed, this field will reflect the time at which it entered that status. Times in the requested timezone, or UTC if not provided. | |
Payout_Type | String | True | No | Can be bank_account or card. | |
Payout_Description | String | True | No | An arbitrary string attached to the payout. Often useful for displaying to users. | |
Payout_Destination_Id | String | True | No | ID of the bank account or card the payout was sent to. | |
Regulatory_Tag | String | True | No | ??An identifier reflecting the classification of this transaction according to local regulations, if applicable. Accounts with automatic payouts enabled receive a separate payout for each regulatory tag. ??This column is only populated for Brazilian accounts. | |
Id [KEY] | String | True | Reports.Id | No | Unique identifier for the reports run object. |
ParametersIntervalEnd | Datetime | True | No | Ending timestamp of data to be included in the report run (exclusive). | |
ParametersIntervalStart | Datetime | True | No | Starting timestamp of data to be included in the report run. | |
ParametersColumns | String | True | No | The set of output columns requested for inclusion in the report run. | |
ParametersCurrency | String | True | No | Currency of objects to be included in the report run. | |
ParametersReportingCategory | String | True | No | Category of balance transactions to be included in the report run. | |
ParametersTimezone | String | True | No | Defaults to Etc/UTC. The output timezone for all timestamps in the report. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Balance_Transaction_Id | String | True | No | Unique identifier for the balance transaction. | |
Created_UTC | Datetime | True | No | Time at which the balance transaction was created. Dates in UTC. | |
Created | Datetime | True | No | Time at which the balance transaction was created. Dates in the requested timezone, or UTC if not provided. | |
Available_On_UTC | Datetime | True | No | The date the balance transactions net funds will become available in the Stripe balance. Dates in UTC. | |
Available_On | Datetime | True | No | The date the balance transactions net funds will become available in the Stripe balance. Dates in the requested timezone, or UTC if not provided. | |
Currency | String | True | No | Three-letter ISO code for the currency in which gross, fee and net are defined. | |
Gross | Decimal | True | No | Gross amount of the transaction. Expressed in major units of the currency (e.g. dollars for USD, yen for JPY). | |
Fee | Decimal | True | No | Fees paid for this transaction. Expressed in major units of the currency (e.g. dollars for USD, yen for JPY). | |
Net | Decimal | True | No | Net amount of the transaction. Expressed in major units of the currency (e.g. dollars for USD, yen for JPY). | |
Reporting_Category | String | True | No | Reporting Category is a new categorization of balance transactions, meant to improve on the current type field. | |
Source_Id | String | True | No | The Stripe object to which this transaction is related. | |
Description | String | True | No | An arbitrary string attached to the balance transaction. Often useful for displaying to users. | |
Customer_Facing_Amount | Decimal | True | No | For transactions associated with charges or refunds, the amount of the original charge or refund. | |
Customer_Facing_Currency | String | True | No | For transactions associated with charges or refunds, the three-letter ISO code for the currency for customer_facing_amount. | |
Automatic_Payout_Id | String | True | No | ID of the automatically created payout associated with this balance transaction (only set if your account is on an automatic payout schedule). | |
Automatic_Payout_Effective_At_UTC | Datetime | True | No | The date we expect this automatic payout to arrive in your bank account, in UTC. This is also when the paid-out funds are deducted from your Stripe balance. | |
Automatic_Payout_Effective_At | Datetime | True | No | The date we expect this automatic payout to arrive in your bank account, in the requested timezone, or UTC if not provided. This is also when the paid-out funds are deducted from your Stripe balance. | |
Customer_Id | String | True | No | The unique ID of the related customer, if any. | |
Customer_Email | String | True | No | Email address of the customer, if any, associated with this balance transaction. | |
Customer_Name | String | True | No | Name of the customer, if any, associated with this balance transaction. | |
Customer_Description | String | True | No | Description provided when creating the customer, often used to store the customer name. | |
Shipping_Address_Line1 | String | True | No | First line of the shipping address associated with this charge, if any | |
Shipping_Address_Line2 | String | True | No | Second line of the shipping address associated with this charge, if any | |
Shipping_Address_City | String | True | No | City of the shipping address associated with this charge, if any | |
Shipping_Address_State | String | True | No | State of the shipping address associated with this charge, if any | |
Shipping_Address_Postal_Code | String | True | No | Postal code of the shipping address associated with this charge, if any | |
Shipping_Address_Country | String | True | No | Country of the shipping address associated with this charge, if any | |
Charge_Id | String | True | No | Unique identifier for the original charge associated with this balance transaction. Available for charges, refunds and disputes. | |
Payment_Intent_Id | String | True | No | The unique ID of the related Payment Intent, if any. | |
Charge_Created_UTC | Datetime | True | No | Creation time of the original charge associated with this balance transaction. Available for charges, refunds and disputes. For charges that were separately authorized and captured, this is the authorization time. Dates in UTC. | |
Charge_Created | Datetime | True | No | Creation time of the original charge associated with this balance transaction. Available for charges, refunds and disputes. For charges that were separately authorized and captured, this is the authorization time. Dates in the requested timezone, or UTC if not provided. | |
Invoice_Id | String | True | No | Unique ID for the invoice associated with this balance transaction. Available for charges, refunds, and disputes made in connection with a Stripe Billing invoice. | |
Subscription_Id | String | True | No | Unique ID for the subscription associated with this balance transaction. Available for charges, refunds, and disputes made in connection with a Stripe Billing subscription. | |
Payment_Method_Type | String | True | No | The type of payment method used in the related payment. | |
Card_Brand | String | True | No | Card brand, if applicable. | |
Card_Funding | String | True | No | Card funding type, if applicable. | |
Card_Country | String | True | No | Two-letter ISO code representing the country of the card. | |
Statement_Descriptor | String | True | No | The dynamic statement descriptor or suffix specified when the related charge was created. | |
Dispute_Reason | String | True | No | Reason given by cardholder for dispute. | |
Connected_Account_Id | String | True | No | For Stripe Connect activity related to a connected account, the unique ID for the account. | |
Connected_Account_Name | String | True | No | For Stripe Connect activity related to a connected account, the name of the account. | |
Connected_Account_Country | String | True | No | For Stripe Connect activity related to a connected account, the two-letter ISO code representing the country of the account. | |
Id [KEY] | String | True | Reports.Id | No | Unique identifier for the reports run object. |
ParametersColumns | String | True | No | The set of output columns requested for inclusion in the report run. | |
ParametersPayout | String | True | Payouts.Id | No | Payout ID by which to filter the report run. |
ParametersReportingCategory | String | True | No | Category of balance transactions to be included in the report run. | |
ParametersTimezone | String | True | No | Defaults to Etc/UTC. The output timezone for all timestamps in the report. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | String | True | No | Unique identifier for the object. | |
Amount | Integer | False | No | Amount intended to be collected by this PaymentIntent. | |
AmountDetailsTip | String | True | No | Amount Details Tip | |
AmountCapturable | Integer | True | No | Amount that can be captured from this PaymentIntent. | |
AmountReceived | Integer | True | No | Amount that was collected by this PaymentIntent. | |
ApplicationFeeAmount | Integer | False | No | The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owners Stripe account. | |
AutomaticPaymentMethodsEnabled | Boolean | False | No | Automatically calculates compatible payment methods | |
AutomaticPaymentMethodsAllowRedirects | String | False | No | Controls whether this PaymentIntent will accept redirect-based payment methods. | |
CanceledAt | Datetime | True | No | Populated when status is canceled, this is the time at which the PaymentIntent was canceled. | |
CancellationReason | String | True | No | Reason for cancellation of this PaymentIntent, either user-provided (duplicate, fraudulent, requested_by_customer, or abandoned) or generated by Stripe internally (failed_invoice, void_invoice, or automatic). | |
CaptureMethod | String | False | No | Controls when the funds will be captured from the customers account. | |
ClientSecret | String | True | No | The client secret of this PaymentIntent. Used for client-side retrieval using a publishable key. | |
ConfirmationMethod | String | False | No | Possible enum values-automatic, manual | |
Created | Datetime | True | No | Time at which the object was created. Measured in seconds since the Unix epoch. | |
Currency | String | False | No | Three-letter ISO currency code, in lowercase. | |
Application | String | True | No | ID of the Connect application that created the PaymentIntent. | |
Customer | String | False | No | ID of the Customer this PaymentIntent belongs to, if one exists. | |
LatestCharge | String | True | No | The latest charge created by this payment intent. | |
PaymentMethod | String | False | No | ID of the payment method used in this PaymentIntent. | |
TransferDataDestination | String | False | No | The account (if any) the payment will be attributed to for tax reporting, and where funds from the payment will be transferred to upon payment success. | |
OnBehalfOf | String | False | No | The account (if any) for which the funds of the PaymentIntent are intended. | |
Invoice | String | True | No | ID of the invoice that created this PaymentIntent, if it exists. | |
Review | String | True | No | ID of the review associated with this PaymentIntent, if any. | |
Description | String | False | No | An arbitrary string attached to the object. Often useful for displaying to users. | |
LastPaymentErrorCharge | String | True | No | For card errors, the ID of the failed charge. | |
LastPaymentErrorCode | String | True | No | For some errors that could be handled programmatically, a short string indicating the error code reported. | |
LastPaymentErrorDeclineCode | String | True | No | For some errors that could be handled programmatically, a short string indicating the error code reported. | |
LastPaymentErrorDocURL | String | True | No | A URL to more information about the error code reported. | |
LastPaymentErrorMessage | String | True | No | A human-readable message providing more details about the error. For card errors, these messages can be shown to your users. | |
LastPaymentErrorParam | String | True | No | If the error is parameter-specific, the parameter related to the error. For example, you can use this to display a message near the correct form field. | |
LastPaymentErrorPaymentMethod | String | True | No | The PaymentMethod object for errors returned on a request involving a PaymentMethod. | |
LastPaymentErrorPaymentMethodType | String | True | No | If the error is specific to the type of payment method, the payment method type that had a problem. This field is only populated for invoice-related errors. | |
LastPaymentErrorType | String | True | No | The type of error returned. One of api_error, card_error, idempotency_error, or invalid_request_error | |
LiveMode | Boolean | True | No | Has the value true if the object exists in live mode or the value true if the object exists in test mode. | |
NextAction | String | True | No | If present, this property tells you what actions you need to take in order for your customer to fulfill a payment using the provided source. | |
Object | String | True | No | String representing the objects type. Objects of the same type share the same value. | |
PaymentMethodOptions | String | False | No | Payment-method-specific configuration for this PaymentIntent. | |
PaymentMethodTypes | String | False | No | The list of payment method types (e.g. card) that this PaymentIntent is allowed to use. | |
PaymentMethodConfigurationDetailsId | String | False | No | ID of the payment method configuration used. | |
PaymentMethodConfigurationDetailsParent | String | False | No | ID of the parent payment method configuration used. | |
ProcessingCard | String | True | No | If the PaymentIntents payment_method_types includes card, this hash contains the details on the processing state of the payment. | |
ProcessingType | String | True | No | Type of the payment method for which payment is in processing state, one of card. | |
ReceiptEmail | String | False | No | Set of key-value pairs that you can attach to an object. | |
MetadataAggregate | String | False | No | 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. | |
SetupFutureUsage | String | False | No | Indicates that you intend to make future payments with this PaymentIntents payment method. | |
ShippingAddressCity | String | False | No | City, district, suburb, town, or village.. | |
ShippingAddressCountry | String | False | No | Two-letter country code | |
ShippingAddressline1 | String | False | No | Address line 1 | |
ShippingAddressline2 | String | False | No | Address line 2 | |
ShippingAddressPostalCode | String | False | No | ZIP or postal code. | |
ShippingAddressState | String | False | No | State, county, province, or region. | |
ShippingCarrier | String | False | No | The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc. | |
ShippingName | String | False | No | Recipient name. | |
ShippingPhone | String | False | No | Recipient phone (including extension). | |
ShippingTrackingNumber | String | False | No | The tracking number for a physical product, obtained from the delivery service. | |
StatementDescriptor | String | False | No | For non-card charges, you can use this value as the complete description that appears on your customers statements. | |
StatementDescriptorSuffix | String | False | No | Provides information about a card payment that customers see on their statements. | |
Status | String | True | No | Status of this PaymentIntent, one of requires_payment_method, requires_confirmation, requires_action, processing, requires_capture, canceled, or succeeded. Read more about each PaymentIntent status. | |
TransferDataAmount | Integer | False | No | Amount intended to be collected by this PaymentIntent. | |
TransferGroup | String | False | No | A string that identifies the resulting payment as part of a group. See the PaymentIntents use case for connected accounts for details. | |
Confirm | Boolean | False | Yes | Set to true to attempt to confirm this PaymentIntent immediately. This column is supported in INSERT. | |
OffSession | Boolean | False | Yes | Set to true to indicate that the customer isn�t in your checkout flow during this payment attempt and can�t authenticate. This parameter can only be used with confirm=true. This column is supported in INSERT. | |
ErrorOnRequiresAction | Boolean | False | Yes | Set to true to fail the payment attempt if the PaymentIntent transitions into requires_action. Use this parameter for simpler integrations that don�t handle customer actions, such as saving cards without authentication. This parameter can only be used with confirm=true. This column is supported in INSERT. | |
Mandate | String | False | Yes | ID of the mandate that�s used for this payment. This parameter can only be used with confirm=true. This column is supported in INSERT. | |
MandateDataCustomerAcceptanceType | String | False | Yes | The type of customer acceptance information included with the Mandate. One of online or offline. This parameter can only be used with confirm=true. This column is supported in INSERT. | |
MandateDataCustomerAcceptanceAcceptedAt | Datetime | False | Yes | The time at which the customer accepted the Mandate. This parameter can only be used with confirm=true. This column is supported in INSERT. | |
MandateDataCustomerAcceptanceOffline | String | False | Yes | If this is a Mandate accepted offline, this hash contains details about the offline acceptance. This parameter can only be used with confirm=true. This column is supported in INSERT. | |
MandateDataCustomerAcceptanceOnlineIPAddress | String | False | Yes | The IP address from which the Mandate was accepted by the customer. This parameter can only be used with confirm=true. This column is supported in INSERT. | |
MandateDataCustomerAcceptanceOnlineUserAgent | String | False | Yes | The user agent of the browser from which the Mandate was accepted by the customer. This parameter can only be used with confirm=true. This column is supported in INSERT. | |
RadarOptionsSession | String | False | Yes | A Radar Session is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments. This column is supported in INSERT. | |
ReturnURL | String | False | Yes | The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method�s app or site. This parameter can only be used with confirm=true. This column is supported in INSERT. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | String | True | No | Id of the PaymentLinkLineItems. | |
PaymentLinkId | String | True | PaymentLinks.Id | No | Payment Links Id. |
AmountDiscount | Integer | True | No | Total discount amount applied. If no discounts were applied, defaults to 0. | |
AmountSubtotal | Integer | True | No | Total before any discounts or taxes are applied. | |
AmountTax | Integer | True | No | Total tax amount applied. If no tax was applied, defaults to 0. | |
AmountTotal | Integer | True | No | Total after discounts and taxes. | |
Currency | String | True | No | Three-letter ISO currency code, in lowercase. Must be a supported currency. | |
Description | String | True | No | An arbitrary string attached to the object. Often useful for displaying to users. Defaults to product name. | |
Object | String | True | No | Name of the Object. | |
PriceActive | Boolean | True | No | Whether the price can be used for new purchases. | |
PriceBillingScheme | String | True | No | How to compute the price per period. Either per_unit or tiered. per_unit indicates that the fixed amount (specified in unit_amount or unit_amount_decimal) will be charged per unit in quantity (for prices with usage_type=licensed), or per unit of total usage (for prices with usage_type=metered). tiered indicates that the unit pricing will be computed using a tiering strategy as defined using the tiers and tiers_mode attributes. | |
PriceCreated | Datetime | True | No | Time at which the object was created. Measured in seconds since the Unix epoch. | |
PriceCurrency | String | True | No | Three-letter ISO currency code, in lowercase. Must be a supported currency. | |
PriceCustomUnitAmount | String | True | No | When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links. | |
PriceId | String | True | No | Id of the price. | |
PriceLivemode | Boolean | True | No | True if the object exists in live mode. False if the object exists in test mode. | |
PriceLookupKey | String | True | No | A lookup key used to retrieve prices dynamically from a static string. This may be up to 200 characters. | |
PriceNickname | String | True | No | A brief description of the price, hidden from customers. | |
PriceObject | String | True | No | The object name for the price. | |
PriceProduct | String | True | No | The ID of the product this price is associated with. | |
PriceRecurring | String | True | No | The recurring components of a price such as interval and usage_type. | |
PriceTaxBehavior | String | True | No | Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of inclusive, exclusive, or unspecified. Once specified as either inclusive or exclusive, it cannot be changed. | |
PriceTiersMode | String | True | No | Each element represents a pricing tier. This parameter requires billing_scheme to be set to tiered. See also the documentation for billing_scheme. This field is not included by default. To include it in the response, expand the tiers field. | |
PriceTransformQuantity | String | True | No | Apply a transformation to the reported usage or set quantity before computing the amount billed. Cannot be combined with tiers. | |
PriceType | String | True | No | One of one_time or recurring depending on whether the price is for a one-time purchase or a recurring (subscription) purchase. | |
PriceUnitAmount | Integer | True | No | The unit amount in paise to be charged, represented as a whole integer if possible. Only set if billing_scheme=per_unit. | |
PriceUnitAmountDecimal | Decimal | True | No | The unit amount in paise to be charged, represented as a decimal string with at most 12 decimal places. Only set if billing_scheme=per_unit. | |
Quantity | Integer | True | No | The quantity of the products being purchased. | |
AdjustableQuantityEnabled | Boolean | False | Yes | Set to true if the quantity can be adjusted to any non-negative Integer. | |
AdjustableQuantityMinimum | Integer | False | Yes | The maximum quantity the customer can purchase. By default this value is 99. You can specify a value up to 999. | |
AdjustableQuantityMaximum | Integer | False | Yes | The minimum quantity the customer can purchase. By default this value is 0. If there is only one item in the cart then that item quantity cannot go down to 0. | |
AccountId | String | False | Yes | The Id of the connected account. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | String | True | No | The Id of the Payment Link. | |
Active | Boolean | False | No | Only return payment links that are active or inactive. | |
AfterCompletionHostedConfirmationCustomMessage | String | False | No | A custom message to display to the customer after the purchase is complete. | |
AfterCompletionType | String | False | No | The specified behavior after the purchase is complete. | |
AfterCompletionRedirectURL | String | False | No | The specified behavior after the purchase is complete. | |
AllowPromotionCodes | Boolean | False | No | Enables user redeemable promotion codes. | |
ApplicationFeeAmount | Integer | False | No | The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner Stripe account. Can only be applied when there are no line items with recurring prices. | |
ApplicationFeePercent | Decimal | False | No | 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 Stripe account. | |
AutomaticTaxEnabled | Boolean | False | No | If it is set to true, tax will be calculated automatically using the customer location. | |
BillingAddressCollection | String | False | No | Configuration for collecting the customers billing address. | |
ConsentCollectionPromotions | String | False | No | Configure fields to gather active consent from customers. If set to auto, enables the collection of customer consent for promotional communications. Possible values are auto and none. | |
ConsentCollectionTermsOfService | String | False | No | Configure fields to gather active consent from customers. If set to required, it requires customers to check a terms of service checkbox before being able to pay. Possible values are required and none. | |
ConsentCollectionPaymentMethodResuseAgreementPosition | String | False | No | Determines the position and visibility of the payment method reuse agreement in the UI. When set to auto, Stripe’s defaults will be used. When set to hidden, the payment method reuse agreement text will always be hidden in the UI. | |
Currency | String | False | No | Three-letter ISO currency code, in lowercase. | |
CustomTextShippingAddressMessage | String | False | No | Custom text that should be displayed alongside shipping address collection. | |
CustomTextSubmitMessage | String | False | No | Custom text that should be displayed alongside the payment confirmation button. | |
CustomTextAfterSubmitMessage | String | False | No | Custom text that should be displayed after the payment confirmation button. | |
CustomTextTermsOfServiceAcceptanceMessage | String | False | No | Custom text that should be displayed in place of the default terms of service agreement text. | |
CustomerCreation | String | False | No | Configures whether checkout sessions created by this payment link create a Customer. Possible values are if_required and always. | |
Livemode | Boolean | True | No | Has the value true if the object exists in live mode or the value false if the object exists in test mode. | |
Object | String | True | No | String representing the object type. | |
OnBehalfOf | String | False | No | The account on behalf of which to charge. | |
MetadataAggregate | String | False | No | 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. | |
PaymentIntentDataCaptureMethod | String | False | No | Controls when the funds will be captured from the customer account. Possible values are automatic and manual. | |
PaymentIntentDataSetupFutureUsage | String | False | No | Indicates that you intend to make future payments with the payment method collected by this Checkout Session. Possible values are on_session and off_session. | |
PaymentMethodCollection | String | False | No | Configuration for collecting a payment method during checkout. Possible values are always and if_required. | |
PaymentMethodTypes | String | False | No | The list of payment method types that customers can use. Possible values are card, affirm, promptpay, bacs_debit, bancontact, blik, boleto, eps, fpx, giropay, grabpay, ideal, klarna, konbini, oxxo, p24, paynow, pix, afterpay_clearpay, alipay, au_becs_debit, sepa_debit, sofort, us_bank_account, wechat_pay. | |
PhoneNumberberCollectionEnabled | Boolean | False | No | If true, a phone number will be collected during checkout. | |
ShippingAddressCollectionAllowedCountries | String | False | No | An array of two-letter ISO country codes representing which countries Checkout should provide as options for shipping locations. | |
ShippingOptions | String | False | ShippingRates.Id | No | The shipping rate options applied to the session. |
SubmitType | String | False | No | Indicates the type of transaction being performed which customizes relevant text on the page, such as the submit button. | |
SubscriptionDataDescription | String | False | No | The subscription description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription. | |
SubscriptionDataTrialPeriodDays | Integer | False | No | Integer representing the number of trial period days before the customer is charged for the first time. Has to be at least 1. | |
TaxIdCollectionEnabled | Boolean | False | No | Details on the state of tax ID collection for the payment link. | |
TransferDataDestination | String | False | No | The account (if any) the payments will be attributed to for tax reporting, and where funds from each payment will be transferred to. | |
TransferDataAmount | Int | False | No | The amount that will be transferred automatically when a charge succeeds. | |
Url | String | True | No | The public URL that can be shared with customers. | |
LineItems | String | False | No | The line items representing what is being sold. Each line item represents an item being sold. | |
CustomFieldsAggregate | String | False | No | Custom Fields object. | |
AutomaticTaxLiabilityType | String | False | No | Type of the account referenced in the request. | |
AutomaticTaxLiabilityAccount | String | False | No | The connected account being referenced when type is account. | |
InactiveMessage | String | False | No | The custom message to be displayed to a customer when a payment link is no longer active. | |
InvoiceCreationEnabled | Boolean | False | No | Enable creating an invoice on successful payment for payment mode payment links. | |
InvoiceCreationInvoiceDataAccountTaxIds | String | False | No | The account tax IDs associated with the invoice. Default invoice values will be used if unspecified. | |
InvoiceCreationInvoiceDataCustomFields | String | False | No | A list of up to 4 custom fields to be displayed on the invoice. | |
InvoiceCreationInvoiceDataDescription | String | False | No | An arbitrary string attached to the object. Often useful for displaying to users. | |
InvoiceCreationInvoiceDataFooter | String | False | No | Footer to be displayed on the invoice. | |
InvoiceCreationInvoiceDataIssuerAccount | String | False | No | The connected account being referenced when invoice data issuer type is account. | |
InvoiceCreationInvoiceDataIssuerType | String | False | No | Type of the account referenced. | |
InvoiceCreationInvoiceDataMetadata | String | False | No | 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. | |
InvoiceCreationInvoiceDataRenderingOptionsAmountTaxDisplay | String | False | No | How line-item prices and amounts will be displayed with respect to tax on invoice PDFs. One of exclude_tax or include_inclusive_tax. include_inclusive_tax will include inclusive tax (and exclude exclusive tax) in invoice PDF amounts. exclude_tax will exclude all tax (inclusive and exclusive alike) from invoice PDF amounts. | |
RestrictionsCompletedSessionsCount | Integer | True | No | The current number of checkout sessions that have been completed on the payment link which count towards the completed_sessions restriction to be met. | |
RestrictionsCompletedSessionsLimit | Integer | False | No | The maximum number of checkout sessions that can be completed for the completed_sessions restriction to be met. | |
AccountId | String | False | Yes | The Id of the connected account. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | String | True | No | The Id of the Payment Method Configuration. | |
Active | Boolean | False | No | Whether the configuration can be used for new payments. | |
Application | String | True | No | For child configs, the Connect application associated with the configuration. | |
IsDefault | Boolean | True | No | The default configuration is used whenever a payment method configuration is not specified. | |
Name | String | False | No | The configuration's name. | |
Parent | String | False | No | For child configs, the configuration's parent configuration. | |
Livemode | Boolean | True | No | Has the value true if the object exists in live mode or the value false if the object exists in test mode. | |
Object | String | True | No | String representing the object's type. Objects of the same type share the same value. | |
AcssDebitAvailable | Boolean | True | No | Whether this payment method may be offered at checkout. True if display_preference is on and the payment method’s capability is active. | |
AcssDebitDisplayPreferenceOverridable | Boolean | True | No | For child configs, whether or not the account’s preference will be observed. If false, the parent configuration’s default is used. | |
AcssDebitDisplayPreferencePreference | String | False | No | The account's display preference. | |
AcssDebitDisplayPreferenceValue | String | True | No | The effective display preference value. | |
AffirmAvailable | Boolean | True | No | Whether this payment method may be offered at checkout. True if display_preference is on and the payment method’s capability is active. | |
AffirmDisplayPreferenceOverridable | Boolean | True | No | For child configs, whether or not the account’s preference will be observed. If false, the parent configuration’s default is used. | |
AffirmDisplayPreferencePreference | String | False | No | The account's display preference. | |
AffirmDisplayPreferenceValue | String | True | No | The effective display preference value. | |
AfterpayClearpayAvailable | Boolean | True | No | Whether this payment method may be offered at checkout. True if display_preference is on and the payment method’s capability is active. | |
AfterpayClearpayDisplayPreferenceOverridable | Boolean | True | No | For child configs, whether or not the account’s preference will be observed. If false, the parent configuration’s default is used. | |
AfterpayClearpayDisplayPreferencePreference | String | False | No | The account's display preference. | |
AfterpayClearpayDisplayPreferenceValue | String | True | No | The effective display preference value. | |
AlipayAvailable | Boolean | True | No | Whether this payment method may be offered at checkout. True if display_preference is on and the payment method’s capability is active. | |
AlipayDisplayPreferenceOverridable | Boolean | True | No | For child configs, whether or not the account’s preference will be observed. If false, the parent configuration’s default is used. | |
AlipayDisplayPreferencePreference | String | False | No | The account's display preference. | |
AlipayDisplayPreferenceValue | String | True | No | The effective display preference value. | |
AmazonPayAvailable | Boolean | True | No | Whether this payment method may be offered at checkout. True if display_preference is on and the payment method’s capability is active. | |
AmazonPayDisplayPreferenceOverridable | Boolean | True | No | For child configs, whether or not the account’s preference will be observed. If false, the parent configuration’s default is used. | |
AmazonPayDisplayPreferencePreference | String | False | No | The account's display preference. | |
AmazonPayDisplayPreferenceValue | String | True | No | The effective display preference value. | |
ApplePayAvailable | Boolean | True | No | Whether this payment method may be offered at checkout. True if display_preference is on and the payment method’s capability is active. | |
ApplePayDisplayPreferenceOverridable | Boolean | True | No | For child configs, whether or not the account’s preference will be observed. If false, the parent configuration’s default is used. | |
ApplePayDisplayPreferencePreference | String | False | No | The account's display preference. | |
ApplePayDisplayPreferenceValue | String | True | No | The effective display preference value. | |
AuBecsDebitAvailable | Boolean | True | No | Whether this payment method may be offered at checkout. True if display_preference is on and the payment method’s capability is active. | |
AuBecsDebitDisplayPreferenceOverridable | Boolean | True | No | For child configs, whether or not the account’s preference will be observed. If false, the parent configuration’s default is used. | |
AuBecsDebitDisplayPreferencePreference | String | False | No | The account's display preference. | |
AuBecsDebitDisplayPreferenceValue | String | True | No | The effective display preference value. | |
BacsDebitAvailable | Boolean | True | No | Whether this payment method may be offered at checkout. True if display_preference is on and the payment method’s capability is active. | |
BacsDebitDisplayPreferenceOverridable | Boolean | True | No | For child configs, whether or not the account’s preference will be observed. If false, the parent configuration’s default is used. | |
BacsDebitDisplayPreferencePreference | String | False | No | The account's display preference. | |
BacsDebitDisplayPreferenceValue | String | True | No | The effective display preference value. | |
BancontactAvailable | Boolean | True | No | Whether this payment method may be offered at checkout. True if display_preference is on and the payment method’s capability is active. | |
BancontactDisplayPreferenceOverridable | Boolean | True | No | For child configs, whether or not the account’s preference will be observed. If false, the parent configuration’s default is used. | |
BancontactDisplayPreferencePreference | String | False | No | The account's display preference. | |
BancontactDisplayPreferenceValue | String | True | No | The effective display preference value. | |
BlikAvailable | Boolean | True | No | Whether this payment method may be offered at checkout. True if display_preference is on and the payment method’s capability is active. | |
BlikDisplayPreferenceOverridable | Boolean | True | No | For child configs, whether or not the account’s preference will be observed. If false, the parent configuration’s default is used. | |
BlikDisplayPreferencePreference | String | False | No | The account's display preference. | |
BlikDisplayPreferenceValue | String | True | No | The effective display preference value. | |
BoletoAvailable | Boolean | True | No | Whether this payment method may be offered at checkout. True if display_preference is on and the payment method’s capability is active. | |
BoletoDisplayPreferenceOverridable | Boolean | True | No | For child configs, whether or not the account’s preference will be observed. If false, the parent configuration’s default is used. | |
BoletoDisplayPreferencePreference | String | False | No | The account's display preference. | |
BoletoDisplayPreferenceValue | String | True | No | The effective display preference value. | |
CardAvailable | Boolean | True | No | Whether this payment method may be offered at checkout. True if display_preference is on and the payment method’s capability is active. | |
CardDisplayPreferenceOverridable | Boolean | True | No | For child configs, whether or not the account’s preference will be observed. If false, the parent configuration’s default is used. | |
CardDisplayPreferencePreference | String | False | No | The account's display preference. | |
CardDisplayPreferenceValue | String | True | No | The effective display preference value. | |
CartesBancairesAvailable | Boolean | True | No | Whether this payment method may be offered at checkout. True if display_preference is on and the payment method’s capability is active. | |
CartesBancairesDisplayPreferenceOverridable | Boolean | True | No | For child configs, whether or not the account’s preference will be observed. If false, the parent configuration’s default is used. | |
CartesBancairesDisplayPreferencePreference | String | False | No | The account's display preference. | |
CartesBancairesDisplayPreferenceValue | String | True | No | The effective display preference value. | |
CashappAvailable | Boolean | True | No | Whether this payment method may be offered at checkout. True if display_preference is on and the payment method’s capability is active. | |
CashappDisplayPreferenceOverridable | Boolean | True | No | For child configs, whether or not the account’s preference will be observed. If false, the parent configuration’s default is used. | |
CashappDisplayPreferencePreference | String | False | No | The account's display preference. | |
CashappDisplayPreferenceValue | String | True | No | The effective display preference value. | |
CustomerBalanceAvailable | Boolean | True | No | Whether this payment method may be offered at checkout. True if display_preference is on and the payment method’s capability is active. | |
CustomerBalanceDisplayPreferenceOverridable | Boolean | True | No | For child configs, whether or not the account’s preference will be observed. If false, the parent configuration’s default is used. | |
CustomerBalanceDisplayPreferencePreference | String | False | No | The account's display preference. | |
CustomerBalanceDisplayPreferenceValue | String | True | No | The effective display preference value. | |
EpsAvailable | Boolean | True | No | Whether this payment method may be offered at checkout. True if display_preference is on and the payment method’s capability is active. | |
EpsDisplayPreferenceOverridable | Boolean | True | No | For child configs, whether or not the account’s preference will be observed. If false, the parent configuration’s default is used. | |
EpsDisplayPreferencePreference | String | False | No | The account's display preference. | |
EpsDisplayPreferenceValue | String | True | No | The effective display preference value. | |
FpxAvailable | Boolean | True | No | Whether this payment method may be offered at checkout. True if display_preference is on and the payment method’s capability is active. | |
FpxDisplayPreferenceOverridable | Boolean | True | No | For child configs, whether or not the account’s preference will be observed. If false, the parent configuration’s default is used. | |
FpxDisplayPreferencePreference | String | False | No | The account's display preference. | |
FpxDisplayPreferenceValue | String | True | No | The effective display preference value. | |
GiropayAvailable | Boolean | True | No | Whether this payment method may be offered at checkout. True if display_preference is on and the payment method’s capability is active. | |
GiropayDisplayPreferenceOverridable | Boolean | True | No | For child configs, whether or not the account’s preference will be observed. If false, the parent configuration’s default is used. | |
GiropayDisplayPreferencePreference | String | False | No | The account's display preference. | |
GiropayDisplayPreferenceValue | String | True | No | The effective display preference value. | |
GooglePayAvailable | Boolean | True | No | Whether this payment method may be offered at checkout. True if display_preference is on and the payment method’s capability is active. | |
GooglePayDisplayPreferenceOverridable | Boolean | True | No | For child configs, whether or not the account’s preference will be observed. If false, the parent configuration’s default is used. | |
GooglePayDisplayPreferencePreference | String | False | No | The account's display preference. | |
GooglePayDisplayPreferenceValue | String | True | No | The effective display preference value. | |
GrabpayAvailable | Boolean | True | No | Whether this payment method may be offered at checkout. True if display_preference is on and the payment method’s capability is active. | |
GrabpayDisplayPreferenceOverridable | Boolean | True | No | For child configs, whether or not the account’s preference will be observed. If false, the parent configuration’s default is used. | |
GrabpayDisplayPreferencePreference | String | False | No | The account's display preference. | |
GrabpayDisplayPreferenceValue | String | True | No | The effective display preference value. | |
IdealAvailable | Boolean | True | No | Whether this payment method may be offered at checkout. True if display_preference is on and the payment method’s capability is active. | |
IdealDisplayPreferenceOverridable | Boolean | True | No | For child configs, whether or not the account’s preference will be observed. If false, the parent configuration’s default is used. | |
IdealDisplayPreferencePreference | String | False | No | The account's display preference. | |
IdealDisplayPreferenceValue | String | True | No | The effective display preference value. | |
JcbAvailable | Boolean | True | No | Whether this payment method may be offered at checkout. True if display_preference is on and the payment method’s capability is active. | |
JcbDisplayPreferenceOverridable | Boolean | True | No | For child configs, whether or not the account’s preference will be observed. If false, the parent configuration’s default is used. | |
JcbDisplayPreferencePreference | String | False | No | The account's display preference. | |
JcbDisplayPreferenceValue | String | True | No | The effective display preference value. | |
KlarnaAvailable | Boolean | True | No | Whether this payment method may be offered at checkout. True if display_preference is on and the payment method’s capability is active. | |
KlarnaDisplayPreferenceOverridable | Boolean | True | No | For child configs, whether or not the account’s preference will be observed. If false, the parent configuration’s default is used. | |
KlarnaDisplayPreferencePreference | String | False | No | The account's display preference. | |
KlarnaDisplayPreferenceValue | String | True | No | The effective display preference value. | |
KonbiniAvailable | Boolean | True | No | Whether this payment method may be offered at checkout. True if display_preference is on and the payment method’s capability is active. | |
KonbiniDisplayPreferenceOverridable | Boolean | True | No | For child configs, whether or not the account’s preference will be observed. If false, the parent configuration’s default is used. | |
KonbiniDisplayPreferencePreference | String | False | No | The account's display preference. | |
KonbiniDisplayPreferenceValue | String | True | No | The effective display preference value. | |
LinkAvailable | Boolean | True | No | Whether this payment method may be offered at checkout. True if display_preference is on and the payment method’s capability is active. | |
LinkDisplayPreferenceOverridable | Boolean | True | No | For child configs, whether or not the account’s preference will be observed. If false, the parent configuration’s default is used. | |
LinkDisplayPreferencePreference | String | False | No | The account's display preference. | |
LinkDisplayPreferenceValue | String | True | No | The effective display preference value. | |
MobilepayAvailable | Boolean | True | No | Whether this payment method may be offered at checkout. True if display_preference is on and the payment method’s capability is active. | |
MobilepayDisplayPreferenceOverridable | Boolean | True | No | For child configs, whether or not the account’s preference will be observed. If false, the parent configuration’s default is used. | |
MobilepayDisplayPreferencePreference | String | False | No | The account's display preference. | |
MobilepayDisplayPreferenceValue | String | True | No | The effective display preference value. | |
MultibancoAvailable | Boolean | True | No | Whether this payment method may be offered at checkout. True if display_preference is on and the payment method’s capability is active. | |
MultibancoDisplayPreferenceOverridable | Boolean | True | No | For child configs, whether or not the account’s preference will be observed. If false, the parent configuration’s default is used. | |
MultibancoDisplayPreferencePreference | String | False | No | The account's display preference. | |
MultibancoDisplayPreferenceValue | String | True | No | The effective display preference value. | |
OxxoAvailable | Boolean | True | No | Whether this payment method may be offered at checkout. True if display_preference is on and the payment method’s capability is active. | |
OxxoDisplayPreferenceOverridable | Boolean | True | No | For child configs, whether or not the account’s preference will be observed. If false, the parent configuration’s default is used. | |
OxxoDisplayPreferencePreference | String | False | No | The account's display preference. | |
OxxoDisplayPreferenceValue | String | True | No | The effective display preference value. | |
P24Available | Boolean | True | No | Whether this payment method may be offered at checkout. True if display_preference is on and the payment method’s capability is active. | |
P24DisplayPreferenceOverridable | Boolean | True | No | For child configs, whether or not the account’s preference will be observed. If false, the parent configuration’s default is used. | |
P24DisplayPreferencePreference | String | False | No | The account's display preference. | |
P24DisplayPreferenceValue | String | True | No | The effective display preference value. | |
PaynowAvailable | Boolean | True | No | Whether this payment method may be offered at checkout. True if display_preference is on and the payment method’s capability is active. | |
PaynowDisplayPreferenceOverridable | Boolean | True | No | For child configs, whether or not the account’s preference will be observed. If false, the parent configuration’s default is used. | |
PaynowDisplayPreferencePreference | String | False | No | The account's display preference. | |
PaynowDisplayPreferenceValue | String | True | No | The effective display preference value. | |
PaypalAvailable | Boolean | True | No | Whether this payment method may be offered at checkout. True if display_preference is on and the payment method’s capability is active. | |
PaypalDisplayPreferenceOverridable | Boolean | True | No | For child configs, whether or not the account’s preference will be observed. If false, the parent configuration’s default is used. | |
PaypalDisplayPreferencePreference | String | False | No | The account's display preference. | |
PaypalDisplayPreferenceValue | String | True | No | The effective display preference value. | |
PromptpayAvailable | Boolean | True | No | Whether this payment method may be offered at checkout. True if display_preference is on and the payment method’s capability is active. | |
PromptpayDisplayPreferenceOverridable | Boolean | True | No | For child configs, whether or not the account’s preference will be observed. If false, the parent configuration’s default is used. | |
PromptpayDisplayPreferencePreference | String | False | No | The account's display preference. | |
PromptpayDisplayPreferenceValue | String | True | No | The effective display preference value. | |
RevolutPayAvailable | Boolean | True | No | Whether this payment method may be offered at checkout. True if display_preference is on and the payment method’s capability is active. | |
RevolutPayDisplayPreferenceOverridable | Boolean | True | No | For child configs, whether or not the account’s preference will be observed. If false, the parent configuration’s default is used. | |
RevolutPayDisplayPreferencePreference | String | False | No | The account's display preference. | |
RevolutPayDisplayPreferenceValue | String | True | No | The effective display preference value. | |
SepaDebitAvailable | Boolean | True | No | Whether this payment method may be offered at checkout. True if display_preference is on and the payment method’s capability is active. | |
SepaDebitDisplayPreferenceOverridable | Boolean | True | No | For child configs, whether or not the account’s preference will be observed. If false, the parent configuration’s default is used. | |
SepaDebitDisplayPreferencePreference | String | False | No | The account's display preference. | |
SepaDebitDisplayPreferenceValue | String | True | No | The effective display preference value. | |
SofortAvailable | Boolean | True | No | Whether this payment method may be offered at checkout. True if display_preference is on and the payment method’s capability is active. | |
SofortDisplayPreferenceOverridable | Boolean | True | No | For child configs, whether or not the account’s preference will be observed. If false, the parent configuration’s default is used. | |
SofortDisplayPreferencePreference | String | False | No | The account's display preference. | |
SofortDisplayPreferenceValue | String | True | No | The effective display preference value. | |
SwishAvailable | Boolean | True | No | Whether this payment method may be offered at checkout. True if display_preference is on and the payment method’s capability is active. | |
SwishDisplayPreferenceOverridable | Boolean | True | No | For child configs, whether or not the account’s preference will be observed. If false, the parent configuration’s default is used. | |
SwishDisplayPreferencePreference | String | False | No | The account's display preference. | |
SwishDisplayPreferenceValue | String | True | No | The effective display preference value. | |
TwintAvailable | Boolean | True | No | Whether this payment method may be offered at checkout. True if display_preference is on and the payment method’s capability is active. | |
TwintDisplayPreferenceOverridable | Boolean | True | No | For child configs, whether or not the account’s preference will be observed. If false, the parent configuration’s default is used. | |
TwintDisplayPreferencePreference | String | False | No | The account's display preference. | |
TwintDisplayPreferenceValue | String | True | No | The effective display preference value. | |
UsBankAccountAvailable | Boolean | True | No | Whether this payment method may be offered at checkout. True if display_preference is on and the payment method’s capability is active. | |
UsBankAccountDisplayPreferenceOverridable | Boolean | True | No | For child configs, whether or not the account’s preference will be observed. If false, the parent configuration’s default is used. | |
UsBankAccountDisplayPreferencePreference | String | False | No | The account's display preference. | |
UsBankAccountDisplayPreferenceValue | String | True | No | The effective display preference value. | |
WechatPayAvailable | Boolean | True | No | Whether this payment method may be offered at checkout. True if display_preference is on and the payment method’s capability is active. | |
WechatPayDisplayPreferenceOverridable | Boolean | True | No | For child configs, whether or not the account’s preference will be observed. If false, the parent configuration’s default is used. | |
WechatPayDisplayPreferencePreference | String | False | No | The account's display preference. | |
WechatPayDisplayPreferenceValue | String | True | No | The effective display preference value. | |
ZipAvailable | Boolean | True | No | Whether this payment method may be offered at checkout. True if display_preference is on and the payment method’s capability is active. | |
ZipDisplayPreferenceOverridable | Boolean | True | No | For child configs, whether or not the account’s preference will be observed. If false, the parent configuration’s default is used. | |
ZipDisplayPreferencePreference | String | False | No | The account's display preference. | |
ZipDisplayPreferenceValue | String | True | No | The effective display preference value. | |
ApplePayLaterDisplayPreferencePreference | String | False | Yes | The account’s preference for whether or not to display this payment method. Used only in INSERT and UPDATE operations. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | String | True | No | Unique identifier for the object. | |
DomainName | String | True | No | The domain name that this payment method domain object represents. | |
Enabled | Boolean | True | No | Whether this payment method domain is enabled. | |
ApplePayStatus | String | True | No | The status of the payment method on the domain. | |
ApplePayStatusDetailsErrorMessage | String | True | No | The error message associated with the status of the payment method on the domain. | |
Created | Datetime | True | No | Time at which the object was created. Measured in seconds since the Unix epoch. | |
GooglePayStatus | String | True | No | The status of the payment method on the domain. | |
GooglePayStatusDetailsErrorMessage | String | True | No | The error message associated with the status of the payment method on the domain. | |
LinkStatus | String | True | No | The status of the payment method on the domain. | |
LinkStatusDetailsErrorMessage | String | True | No | The error message associated with the status of the payment method on the domain. | |
Livemode | Boolean | True | No | Has the value true if the object exists in live mode or the value false if the object exists in test mode. | |
Object | String | True | No | Has the value true if the object exists in live mode or the value false if the object exists in test mode. | |
PaypalStatus | String | True | No | The status of the payment method on the domain. | |
PaypalStatusDetailsErrorMessage | String | True | No | The error message associated with the status of the payment method on the domain. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | String | True | No | The Id of the Payment Method. | |
CustomerId | String | True | No | The Id of the Customer. | |
BillingDetailsAddressCity | String | False | No | City, district, suburb, town, or village name for Billing Address. | |
BillingDetailsAddressCountry | String | False | No | 2-letter country code for Billing Address. | |
BillingDetailsAddressLine1 | String | False | No | Address line 1 for Billing Address. | |
BillingDetailsAddressLine2 | String | False | No | Address line 2 for Billing Address. | |
BillingDetailsAddressPostalCode | String | False | No | ZIP or postal code for Billing Address. | |
BillingDetailsAddressState | String | False | No | State, county, province, or region for Billing Address. | |
BillingDetailsEmail | String | False | No | Email address for Billing Address. | |
BillingDetailsName | String | False | No | Full name for Billing Address. | |
BillingDetailsPhone | String | False | No | Billing phone number (including extension). | |
MetadataAggregate | String | False | No | Set of key-value pairs that you can attach to an object. | |
Type | String | False | No | The type of the PaymentMethod. The type of PaymentMethods supported are: acss_debit, affirm, afterpay_clearpay, alipay, au_becs_debit, bacs_debit, bancontact, blik, boleto, card, customer_balance, eps, fps, giropay, grabpay, ideal, klarna, konbini, oxxo, p24, paynow, pix, promptpay, sepa_debit, sofort, us_bank_account, wechat_pay, zip. | |
Object | String | True | No | String representing the object type. Objects of the same type share the same value. | |
AcssDebitBankName | String | True | No | Bank name for the payment method type acss_debit. | |
AcssDebitFingerprint | String | True | No | Uniquely identifies this particular bank account for the payment method type acss_debit. | |
AcssDebitInstitutionNumber | String | False | No | Institution number of the customer bank. | |
AcssDebitLast4 | String | True | No | Last four digits of the bank account number for the payment method type acss_debit. | |
AcssDebitTransitNumber | String | False | No | Transit number of the customer bank. | |
Affirm | String | False | No | This hash contains details about the Affirm payment method. | |
AfterpayClearpay | String | False | No | This hash contains details about the AfterpayClearpay payment method. | |
Alipay | String | False | No | This hash contains details about the Alipay payment method. | |
AuBecsDebitBsbNumber | String | False | No | Six-digit number identifying bank and branch associated with this bank account. | |
AuBecsDebitFingerprint | String | True | No | Uniquely identifies this particular bank account for the payment method type au_becs_debit. | |
AuBecsDebitLast4 | String | True | No | Last four digits of the bank account number for the payment method type au_becs_debit. | |
BacsDebitSortCode | String | False | No | Sort code of the bank account(e.g., 10-20-30). for the payment method type bacs_debit. | |
BacsDebitLast4 | String | True | No | Uniquely identifies this particular bank account for the payment method type bacs_debit. | |
BacsDebitFingerprint | String | True | No | Last four digits of the bank account number for the payment method type bacs_debit. | |
Bancontact | String | False | No | This hash contains details about the Bancontact payment method. | |
Blik | String | False | No | This hash contains details about the blik payment method. | |
CardBrand | String | True | No | Card brand. Can be amex, diners, discover, jcb, mastercard, unionpay, visa, or unknown. | |
CardChecksAddressLine1Check | String | True | No | If a address line1 was provided, results of the check, one of pass, fail, unavailable, or unchecked. | |
CardChecksAddressPostalCodeCheck | String | True | No | If a address postal code was provided, results of the check, one of pass, fail, unavailable, or unchecked. | |
CardChecksCvcCheck | String | True | No | If a CVC was provided, results of the check, one of pass, fail, unavailable, or unchecked. | |
CardCountry | String | True | No | Two-letter ISO code representing the country of the card. | |
CardExpMonth | Integer | False | No | Two-digit number representing the card expiration month. | |
CardExpYear | Integer | False | No | Four-digit number representing the card expiration year. | |
CardFingerprint | String | True | No | Uniquely identifies this particular card number. | |
CardFunding | String | True | No | Card funding type. Can be credit, debit, prepaid, or unknown. | |
CardGeneratedFrom | String | True | No | Details of the original PaymentMethod that created this object. | |
CardLast4 | String | True | No | The last four digits of the card. | |
CardNetworksAvailable | String | True | No | All available networks for the card. | |
CardNetworksPreferred | String | True | No | The preferred network for the card. | |
CardThreeDSecureUsageSupported | Boolean | True | No | Whether 3D Secure is supported on this card. | |
CardWallet | String | True | No | If this Card is part of a card wallet, this contains the details of the card wallet. | |
CashAppBuyerId | String | True | No | A unique and immutable identifier assigned by Cash App to every buyer. | |
CashAppCashTag | String | True | No | A public identifier for buyers using Cash App. | |
CustomerBalance | String | False | No | This hash contains details about the CustomerBalance payment method. | |
EpsBank | String | False | No | The customer bank. EPS is an Austria-based bank redirect payment method. | |
FpxAccountHolderType | String | True | No | Account holder type for FPX bank. FPX is a Malaysia-based bank redirect payment method. | |
FpxBank | String | False | No | The customer bank name and it should be Malaysia-based bank. | |
GIROPAY | String | False | No | This hash contains details about the Giropay payment method. | |
Grabpay | String | False | No | This hash contains details about the grabpay payment method. | |
IdealBank | String | False | No | The customer bank name and it is a Netherlands-based bank redirect payment method. | |
IdealBic | String | True | No | Bank Identifier code for Ideal Bank. | |
Konbini | String | False | No | This hash contains details about the konbini payment method. | |
Link | String | False | No | This hash contains details about the link payment method. | |
Oxxo | String | False | No | This hash contains details about the oxxo payment method. | |
P24Bank | String | False | No | The customer bank. P24 stands for Przelewy24 is a bank redirect payment method used in Poland. | |
Paynow | String | False | No | This hash contains details about the paynow payment method. | |
Paypal | String | False | No | This hash contains details about the paypal payment method. | |
Pix | String | False | No | This hash contains details about the pix payment method. | |
Promptpay | String | False | No | This hash contains details about the promptpay payment method. | |
RevolutPay | String | False | No | This hash contains details about the RevolutPay payment method. | |
SepaDebitBankCode | String | True | No | Bank Code for SepaDebit. | |
SepaDebitBranchCode | String | True | No | Branch Code for SepaDebit. | |
SepaDebitCountry | String | True | No | Country for SepaDebit. | |
SepaDebitFingerprint | String | True | No | Fingerprint for SepaDebit. | |
SepaDebitGeneratedFromCharge | String | True | No | SepaDebit generated from Charge. | |
SepaDebitGeneratedFromSetupAttempt | String | True | No | SepaDebit generated from setup attempt. | |
SepaDebitLast4 | String | True | No | Last 4 digits of IBAN of the Bank Account. | |
SofortCountry | String | False | No | Two-letter ISO code representing the country the bank account is located in. Sofort is a bank redirect payment method used in Europe. | |
UsBankAccountAccountHolderType | String | False | No | Account holder type: individual or company. | |
UsBankAccountAccountType | String | False | No | Account type: checkings or savings. Defaults to checking if omitted. | |
UsBankAccountBankName | String | True | No | Bank name. | |
UsBankAccountFinancialConnectionsAccount | String | False | No | The ID of a Financial Connections Account to use as a payment method. | |
UsBankAccountFingerprint | String | True | No | Fingerprint of UsBank Account. | |
UsBankAccountLast4 | String | True | No | Last4 digits of the UsBank Account number. | |
UsBankAccountNetworksPreferred | String | True | No | Contains information about US bank account networks that can be used. The preferred network. | |
UsBankAccountNetworksSupported | String | True | No | Contains information about US bank account networks that can be used. All supported networks. | |
UsBankAccountRoutingNumber | String | False | No | Routing number of the bank account. | |
UsBankAccountStatusDetails | String | True | No | Contains information about the future reusability of this PaymentMethod. | |
WechatPay | String | False | No | This hash contains details about the WechatPay payment method. | |
Zip | String | False | No | This hash contains details about the Zip payment method. | |
Created | Timestamp | True | No | Time at which the object was created. | |
Livemode | Boolean | True | No | Has the value true if the object exists in live mode or the value false if the object exists in test mode. | |
PaypalPayerId | String | True | No | PayPal account PayerID. PayPal account PayerID. | |
PaypalPayerEmail | String | True | No | Owner's email. Values are provided by PayPal directly (if supported) at the time of authorization or settlement. | |
RadarOptionsSession | String | False | No | A Radar Session is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments. | |
CardDisplayBrand | String | True | No | The brand to use when displaying the card, this accounts for customer’s brand choice on dual-branded cards. Can be american_express, cartes_bancaires, diners_club, discover, eftpos_australia, interac, jcb, mastercard, union_pay, visa, or other and may contain more values in the future. | |
CardNumber | String | False | Yes | Card Number. | |
CardCVC | String | False | Yes | Card CVC number. | |
AcssDebitAccountNumber | String | False | Yes | Customer bank account number. Pre-authorized debit payments are used to debit Canadian bank accounts through the Automated Clearing Settlement System (ACSS). | |
AuBecsDebitAccountNumber | String | False | Yes | The account number for the bank account. BECS Direct Debit is used to debit Australian bank accounts through the Bulk Electronic Clearing System (BECS). | |
BacsDebitAccountNumber | String | False | Yes | Account number of the bank account that the funds will be debited from. Bacs Direct Debit is used to debit UK bank accounts. | |
BoletoTaxId | String | False | Yes | The tax ID of the customer. Boleto is a voucher-based payment method used in Brazil. | |
KlarnaDobDay | String | False | Yes | The day of birth, between 1 and 31 of Customer for paymentmethod type klarna. | |
KlarnaDobMonth | String | False | Yes | The month of birth, between 1 and 12 of Customer for paymentmethod type klarna. | |
KlarnaDobYear | String | False | Yes | The four-digit year of birth of Customer for paymentmethod type klarna. | |
SepaDebitIban | String | False | Yes | IBAN of the bank account. SEPA Direct Debit is used to debit bank accounts within the Single Euro Payments Area (SEPA) region. | |
UsBankAccountAccountNumber | String | False | Yes | Account number of the bank account. ACH Direct Debit is used to debit US bank accounts through the Automated Clearing House (ACH) payments system. | |
AccountId | String | False | Yes | The Id of the connected account. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | String | True | No | The Id of the payout. | |
Object | String | True | No | String representing the type of the object. | |
Amount | Integer | False | No | Amount (in cents) to be transferred to the bank account or debit card. | |
ArrivalDate | Datetime | True | No | Date the payout is expected to arrive in the bank. . | |
BalanceTransaction | String | True | BalanceTransactions.Id | No | The Id of the balance transaction that describes the impact of this payout on the account balance. |
Created | Datetime | True | No | Time of creation. | |
Currency | String | False | No | Three-letter ISO currency code. | |
Description | String | False | No | The payout description. | |
Destination | String | False | Accounts.Id | No | The Id of the bank account or card the payout was sent to. |
FailureBalanceTransaction | String | True | No | If the payout failed or was canceled, this will be the ID of the balance transaction that reversed the initial balance transaction. | |
FailureCode | String | True | No | Error code explaining reason for payout failure if available. | |
FailureMessage | String | True | No | Error code explaining reason for payout failure if available. | |
Metadata | String | False | No | Set of key/value pairs that you can attach to an object. | |
Method | String | False | No | TThe method used to send this payout. instant is only supported for payouts to debit cards. | |
SourceType | String | False | No | The source balance this payout came from. | |
StatementDescriptor | String | False | No | Extra information about a payout to be displayed on the bank statement. | |
Status | String | True | No | Current status of the payout. | |
Type | String | True | No | Can be bank_account or card. | |
Automatic | Boolean | True | No | Returns true if the payout was created by an automated payout schedule, and false if it was requested manually. | |
Livemode | Boolean | True | No | Has the value true if the object exists in live mode or the value false if the object exists in test mode. | |
OriginalPayout | String | True | No | If the payout reverses another, this is the ID of the original payout. | |
ReversedBy | String | True | No | If the payout was reversed, this is the ID of the payout that reverses this payout. | |
ReconciliationStatus | String | True | No | If completed, you can use the Balance Transactions API to list all balance transactions that are paid out in this payout. | |
AccountId | String | False | Yes | The Id of the connected account to get payouts for |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Reporting_Category | String | True | No | Reporting Category is a new categorization of balance transactions, meant to improve on the current type field. | |
Currency | String | True | No | Three-letter ISO code for the currency in which gross, fee and net are defined. | |
Count | Int | True | No | The number of transactions associated with the reporting_category. | |
Gross | Decimal | True | No | Sum of the gross amounts of the transactions associated with the reporting_category. Expressed in major units of the currency (e.g. dollars for USD, yen for JPY). | |
Fee | Decimal | True | No | Sum of the fees paid for the transactions associated with the reporting_category. Expressed in major units of the currency (e.g. dollars for USD, yen for JPY). | |
Net | Decimal | True | No | Sum of the net amounts for the transactions associated with the reporting_category. Expressed in major units of the currency (e.g. dollars for USD, yen for JPY). | |
Id | String | True | Reports.Id | No | Unique identifier for the reports run object. |
ParametersColumns | String | True | No | The set of output columns requested for inclusion in the report run. | |
ParametersPayout | String | True | Payouts.Id | No | Payout ID by which to filter the report run. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Reporting_Category | String | True | No | Reporting Category is a new categorization of balance transactions, meant to improve on the current type field. | |
Currency | String | True | No | Three-letter ISO code for the currency in which gross, fee and net are defined. | |
Count | Int | True | No | The number of transactions associated with the reporting_category. | |
Gross | Decimal | True | No | Sum of the gross amounts of the transactions associated with the reporting_category. Expressed in major units of the currency (e.g. dollars for USD, yen for JPY). | |
Fee | Decimal | True | No | Sum of the fees paid for the transactions associated with the reporting_category. Expressed in major units of the currency (e.g. dollars for USD, yen for JPY). | |
Net | Decimal | True | No | Sum of the net amounts for the transactions associated with the reporting_category. Expressed in major units of the currency (e.g. dollars for USD, yen for JPY). | |
Id | String | True | Reports.Id | No | Unique identifier for the reports run object. |
ParametersIntervalEnd | Datetime | True | No | Ending timestamp of data to be included in the report run (exclusive). | |
ParametersIntervalStart | Datetime | True | No | Starting timestamp of data to be included in the report run. | |
ParametersColumns | String | True | No | The set of output columns requested for inclusion in the report run. | |
ParametersCurrency | String | True | No | Currency of objects to be included in the report run. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Reporting_Category | String | True | No | Reporting Category is a new categorization of balance transactions, meant to improve on the current type field. | |
Currency | String | True | No | Three-letter ISO code for the currency in which gross, fee and net are defined. | |
Count | Int | True | No | The number of transactions associated with the reporting_category. | |
Gross | Decimal | True | No | Sum of the gross amounts of the transactions associated with the reporting_category. Expressed in major units of the currency (e.g. dollars for USD, yen for JPY). | |
Fee | Decimal | True | No | Sum of the fees paid for the transactions associated with the reporting_category. Expressed in major units of the currency (e.g. dollars for USD, yen for JPY). | |
Net | Decimal | True | No | Sum of the net amounts for the transactions associated with the reporting_category. Expressed in major units of the currency (e.g. dollars for USD, yen for JPY). | |
Id | String | True | Reports.Id | No | Unique identifier for the reports run object. |
ParametersIntervalEnd | Datetime | True | No | Ending timestamp of data to be included in the report run (exclusive). | |
ParametersIntervalStart | Datetime | True | No | Starting timestamp of data to be included in the report run. | |
ParametersColumns | String | True | No | The set of output columns requested for inclusion in the report run. | |
ParametersCurrency | String | True | No | Currency of objects to be included in the report run. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Currency | String | False | No | The currency of the balance. | |
Amount | Integer | False | No | The pending amount. | |
SourceTypesAggregate | String | False | No | The source cards. | |
SourceTypesCard | Integer | False | No | The source cards. | |
SourceTypesBankAccount | Integer | False | No | The source Bank Account. | |
SourceTypesBitcoinReceiver | Integer | False | No | The source Bitcoin Receiver. | |
Livemode | Boolean | False | No | Has the value true if the object exists in live mode or the value false if the object exists in test mode. | |
AccountId | String | False | Yes | The Id of the connected account to get pending balance for. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | String | True | No | The Id of the person. | |
Account [KEY] | String | True | No | The mode of the Checkout Session. | |
Created | Datetime | True | No | The time at which the object was created. Measured in seconds since the Unix epoch. | |
DobDay | Integer | False | No | The day of birth, between 1 and 31. | |
DobMonth | Integer | False | No | The month of birth, between 1 and 12. | |
DobYear | Integer | False | No | The four-digit year of birth. | |
String | False | No | The person's email address. | ||
FirstName | String | False | No | The person's first name. | |
LastName | String | False | No | The person's last name. | |
MaidenName | String | False | No | The person’s maiden name. | |
FutureRequirementsAlternatives | String | True | No | Fields that are due and can be satisfied by providing the corresponding alternative fields instead. | |
FutureRequirementsCurrentlyDue | String | True | No | Fields that need to be collected to keep the person's account enabled. | |
FutureRequirementsErrors | String | True | No | Fields that are currently_due and need to be collected again because validation or verification failed. | |
FutureRequirementsEventuallyDue | String | True | No | Fields that need to be collected, assuming all volume thresholds are reached. | |
FutureRequirementsPastDue | String | True | No | Fields that were not collected by the account's requirements.current_deadline. | |
FutureRequirementsPendingVerification | String | True | No | Fields that may become required, depending on the results of verification or review. | |
IdNumber | String | False | No | The Id number. | |
IdNumberProvided | Boolean | True | No | Whether the person's id_number was provided. | |
IdNumberSecondaryProvided | Boolean | True | No | Whether the person’s id_number_secondary was provided. | |
Metadata | String | False | No | The set of key/value pairs that you can attach to a value list object. | |
RelationshipDirector | Boolean | False | No | Whether the person is a director of the account's legal entity. | |
RelationshipExecutive | Boolean | False | No | Whether the person has significant responsibility to control, manage, or direct the organization. | |
RelationshipLegalGuardian | Boolean | False | No | Whether the person is the legal guardian of the account’s representative. | |
RelationshipOwner | Boolean | False | No | Whether the person is an owner of the account's legal entity. | |
RelationshipPercentOwnership | Double | False | No | The percent owned by the person of the account's legal entity. | |
RelationshipRepresentative | Boolean | False | No | Whether the person is authorized as the primary representative of the account. | |
RelationshipTitle | String | False | No | The person's title | |
RequirementsAlternatives | String | True | No | Fields that are due and can be satisfied by providing the corresponding alternative fields instead. | |
RequirementsCurrentlyDue | String | True | No | Fields that need to be collected to keep the person's account enabled. | |
RequirementsErrors | String | True | No | Fields that are currently_due and need to be collected again because validation or verification failed. | |
RequirementsEventuallyDue | String | True | No | Fields that need to be collected assuming all volume thresholds are reached. | |
RequirementsPastDue | String | True | No | Fields that were not collected by the account's requirements.current_deadline. | |
RequirementsPendingVerification | String | True | No | Fields that may become required depending on the results of verification or review. If verification fails, these fields move to eventually_due or currently_due. | |
SsnLas4 | String | False | No | The last 4 digits of the person's Social Security Number. | |
SsnLas4Provided | Boolean | True | No | Whether the last four digits of the person's Social Security Number have been provided (U.S. only). | |
VerificationAdditionalDocumentBack | String | False | No | The back of an Id returned by a file upload with a purpose value of identity_document. | |
VerificationAdditionalDocumentDetails | String | True | No | A user-displayable string describing the verification state of this document. | |
VerificationAdditionalDocumentDetailsCode | String | True | No | A machine-readable code specifying the verification state for this document. | |
VerificationAdditionalDocumentFront | String | False | No | The front of an Id returned by a file upload with a purpose value of identity_document. | |
VerificationDetails | String | True | No | A user-displayable string describing the verification state for the person. | |
VerificationDetailsCode | String | True | No | A machine-readable code specifying the verification state for the person. | |
VerificationDocumentBack | String | False | No | The back of an Id returned by a file upload with a purpose value of identity_document. | |
VerificationDocumentDetails | String | True | No | A user-displayable string describing the verification state of this document. | |
VerificationDocumentDetailsCode | String | True | No | A machine-readable code specifying the verification state for this document. | |
VerificationDocumentFront | String | False | No | The front of an Id returned by a file upload with a purpose value of identity_document. | |
VerificationStatus | String | True | No | The state of verification for the person. Possible values are unverified, pending, or verified. | |
AddressCity | String | False | No | The City of the person. | |
AddressCountry | String | False | No | The Country of the person. | |
AddressLine1 | String | False | No | The Address line 1. | |
AddressLine2 | String | False | No | The Address line 2. | |
AddressPostalCode | String | False | No | The Postal code of the person. | |
AddressState | String | False | No | The State of the person. | |
Phone | String | False | No | The person’s phone number. | |
AdditionalTosAcceptancesAccountDate | Datetime | False | No | Details on the legal guardian’s acceptance of the required Stripe agreements. The Unix timestamp marking when the account representative accepted the service agreement. | |
AdditionalTosAcceptancesAccountIp | String | False | No | Details on the legal guardian’s acceptance of the required Stripe agreements. The IP address from which the account representative accepted the service agreement. | |
AdditionalTosAcceptancesAccountUserAgent | String | False | No | Details on the legal guardian’s acceptance of the required Stripe agreements. The user agent of the browser from which the account representative accepted the service agreement. | |
Gender | String | False | No | The person’s gender (International regulations require either “male” or “female”). | |
Nationality | String | False | No | The country where the person is a national. | |
PoliticalExposure | String | False | No | Indicates if the person or any of their representatives, family members, or other closely related persons, declares that they hold or have held an important public job or function, in any jurisdiction. | |
RegisteredAddressCity | String | False | No | The person’s registered address. The City of the person. | |
RegisteredAddressCountry | String | False | No | The person’s registered address. The Country of the person. | |
RegisteredAddressLine1 | String | False | No | The person’s registered address. The Address line 1. | |
RegisteredAddressLine2 | String | False | No | The person’s registered address. The Address line 2. | |
RegisteredAddressPostalCode | String | False | No | The person’s registered address. The Postal code of the person. | |
RegisteredAddressState | String | False | No | The person’s registered address. The State of the person. | |
DocumentsCompanyAuthorizationFiles | String | False | Yes | Documents that may be submitted to satisfy various informational requests. One or more documents that demonstrate proof that this person is authorized to represent the company. | |
DocumentsPassportFiles | String | False | Yes | Documents that may be submitted to satisfy various informational requests. One or more documents showing the person’s passport page with photo and personal data. | |
DocumentsVisaFiles | String | False | Yes | Documents that may be submitted to satisfy various informational requests. One or more documents showing the person’s visa required for living in the country where they are residing. | |
FullNameAliases | String | False | Yes | A list of alternate names or aliases that the person is known by. | |
IdNumberSecondary | String | False | Yes | The person’s secondary ID number, as appropriate for their country, will be used for enhanced verification checks. | |
PersonToken | String | False | Yes | A person token, used to securely provide details to the person. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | String | False | No | The Id of the plan. | |
Active | Boolean | False | No | Whether the plan can be used for new purchases. | |
Amount | Integer | False | No | The amount in cents to be charged on the interval specified. | |
AmountDecimal | Decimal | False | No | The decimal value of amount in cents to be charged on the interval specified. | |
UnitAmount | Decimal | True | No | The amount in cents to be charged on the interval specified. | |
AggregateUsage | String | False | No | Specifies a usage aggregation strategy for plans of usage_type=metered. | |
BillingScheme | String | False | No | Describes how to compute the price per period. Either per_unit or tiered. | |
Created | Datetime | True | No | The creation date. | |
Currency | String | False | No | Currency in which subscription will be charged. | |
Nickname | String | False | No | A brief description of the plan, hidden from customers. | |
ProductId | String | False | No | The product whose pricing this plan determines. | |
ProductName | String | False | No | The product whose pricing this plan determines. The product’s name, meant to be displayable to the customer. | |
ProductActive | Boolean | False | No | The product whose pricing this plan determines. Whether the product is currently available for purchase. Defaults to true. | |
ProductMetadata | String | False | No | The product whose pricing this plan determines. Set of key-value pairs that you can attach to an object. | |
ProductStatementDescriptor | String | False | No | The product whose pricing this plan determines. An arbitrary string to be displayed on your customer’s credit card or bank statement. | |
ProductTaxCode | String | False | No | The product whose pricing this plan determines. A tax code ID. | |
ProductUnitLabel | String | False | No | The product whose pricing this plan determines. A label that represents units of this product. | |
LiveMode | Boolean | True | No | Has the value true if the object exists in live mode or the value false if the object exists in test mode. | |
Interval | String | False | No | One of day, week, month or year. The frequency with which a subscription should be billed. | |
IntervalCount | Integer | False | No | The number of intervals (specified in the interval property) between each subscription billing. For example, interval=month and interval_count=3 bills every 3 months. | |
TrialPeriodDays | Integer | False | No | Number of trial period days granted when subscribing a customer to this plan. Null if the plan has no trial period. | |
MetadataAggregate | String | False | No | Number of trial period days granted when subscribing a customer to this plan. Null if the plan has no trial period. | |
TiersAggregate | String | False | No | Each element represents a pricing tier. | |
TiersMode | String | False | No | Defines if the tiering price should be graduated or volume based. | |
TransformUsageDivideBy | Integer | False | No | Divide usage by this number. | |
TransformUsageRound | String | False | No | After division, either round the result up or down. | |
UsageType | String | False | No | Configures how the quantity per period should be determined. Can be either metered or licensed. | |
ProductDefaultPrice | String | True | No | The product whose pricing this plan determines. The ID of the Price object that is the default price for this product. | |
ProductDescription | String | True | No | The product whose pricing this plan determines. The product’s description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes. | |
ProductObject | String | True | No | The product whose pricing this plan determines. String representing the object’s type. Objects of the same type share the same value. | |
ProductCreated | Datetime | True | No | The product whose pricing this plan determines. String representing the object’s type. Time at which the object was created. | |
ProductImages | String | True | No | The product whose pricing this plan determines. A list of up to 8 URLs of images for this product, meant to be displayable to the customer. | |
ProductLivemode | Boolean | True | No | The product whose pricing this plan determines. Has the value true if the object exists in live mode or the value false if the object exists in test mode. | |
ProductMarketingFeatures | String | True | No | The product whose pricing this plan determines. A list of up to 15 marketing features for this product. These are displayed in pricing tables. | |
ProductPackageDimensionsHeight | Double | True | No | The product whose pricing this plan determines. Height, in inches. | |
ProductPackageDimensionsLength | Double | True | No | The product whose pricing this plan determines. Length, in inches. | |
ProductPackageDimensionsWeight | Double | True | No | The product whose pricing this plan determines. Weight, in inches. | |
ProductPackageDimensionsWidth | Double | True | No | The product whose pricing this plan determines. Width, in inches. | |
ProductShippable | Boolean | True | No | The product whose pricing this plan determines. Whether this product is shipped (i.e., physical goods). | |
ProductUpdated | Datetime | True | No | The product whose pricing this plan determines. Time at which the object was last updated. | |
ProductUrl | String | True | No | The product whose pricing this plan determines. A URL of a publicly-accessible webpage for this product. | |
AccountId | String | False | Yes | The Id of the connected account to get plans for. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | String | True | No | The Id of the price. | |
Active | Boolean | False | No | Whether the price can be used for new purchases. | |
BillingScheme | String | False | No | Describes how to compute the price per period. | |
Created | Datetime | True | No | The creation date. | |
Currency | String | False | No | Currency in which subscription will be charged. | |
CustomUnitAmountEnabled | Boolean | False | No | Pass in true to enable custom_unit_amount, otherwise omit custom_unit_amount. | |
CustomUnitAmountMaximum | Integer | False | No | The maximum unit amount the customer can specify for this item. | |
CustomUnitAmountMinimum | Integer | False | No | The minimum unit amount the customer can specify for this item. Must be at least the minimum charge amount. | |
CustomUnitAmountPreset | Integer | False | No | The starting unit amount which can be updated by the customer. | |
LookupKey | String | False | No | A lookup key used to retrieve prices dynamically from a static string. | |
MetadataAggregate | String | False | No | Set of key-value pairs that you can attach to an object. | |
Nickname | String | False | No | A brief description of the plan, hidden from customers. | |
Product | String | False | Products.Id | No | The Id of the product this price is associated with. |
ProductDataName | String | False | No | These fields can be used to create a new product that this price will belong to. The product's name, meant to be displayable to the customer. | |
ProductDataActive | Boolean | False | No | These fields can be used to create a new product that this price will belong to. Whether the product is currently available for purchase. Defaults to true. | |
ProductDataMetadata | String | False | No | These fields can be used to create a new product that this price will belong to. Set of key-value pairs that you can attach to an object. | |
ProductDataStatementDescriptor | String | False | No | These fields can be used to create a new product that this price will belong to. An arbitrary string to be displayed on your customer's credit card or bank statement. | |
ProductDataTaxCode | String | False | No | These fields can be used to create a new product that this price will belong to. A tax code ID. | |
ProductDataUnitLabel | String | False | No | These fields can be used to create a new product that this price will belong to. A label that represents units of this product. When set, this will be included in customers' receipts, invoices, Checkout, and the customer portal. | |
RecurringInterval | String | False | No | The frequency at which a subscription is billed. One of day, week, month or year. | |
RecurringAggregateUsage | String | False | No | Specifies a usage aggregation strategy for prices of usage_type=metered. | |
RecurringIntervalCount | Integer | False | No | The number of intervals (specified in the interval attribute) between subscription billings. For example, interval=month and interval_count=3 bills every 3 months. | |
RecurringUsageType | String | False | No | Configures how the quantity per period should be determined. Can be either metered or licensed. Defaults to licensed. | |
Type | String | True | No | Value is either 'one_time' or 'recurring' depending on whether the price is for a one-time purchase or a recurring (subscription) purchase. | |
TiersAggregate | String | False | No | Array of elements representing a pricing tier. | |
TiersMode | String | False | No | Defines if the tiering price should be graduated or volume based. | |
TransformQuantityDivideBy | Integer | False | No | Apply a transformation to the reported usage or set quantity before computing the billed price. Cannot be combined with tiers. Divide usage by this number. | |
TransformQuantityRound | String | False | No | Apply a transformation to the reported usage or set quantity before computing the billed price. Cannot be combined with tiers. After division, either round the result up or down. | |
UnitAmount | Integer | False | No | The unit amount in paise to be charged, represented as a whole integer if possible. | |
UnitAmountDecimal | String | False | No | The unit amount in paise to be charged, represented as a decimal string | |
Object | String | True | No | String representing the object's type. Objects of the same type share the same value. | |
Livemode | Boolean | True | No | Has the value true if the object exists in live mode or the value false if the object exists in test mode. | |
TaxBehavior | String | False | No | Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of inclusive, exclusive, or unspecified. Once specified as either inclusive or exclusive, it cannot be changed. | |
ProductDataDefaultPrice | String | True | No | These fields can be used to view the fields of the product that this price will belong to. The ID of the Price object that is the default price for this product. | |
ProductDataDescription | String | True | No | These fields can be used to view the fields of the product that this price will belong to. The product’s description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes. | |
ProductDataObject | String | True | No | These fields can be used to view the fields of the product that this price will belong to. String representing the object’s type. Objects of the same type share the same value. | |
ProductDataCreated | Datetime | True | No | These fields can be used to view the fields of the product that this price will belong to. String representing the object’s type. Time at which the object was created. | |
ProductDataImages | String | True | No | These fields can be used to view the fields of the product that this price will belong to. A list of up to 8 URLs of images for this product, meant to be displayable to the customer. | |
ProductDataLivemode | Boolean | True | No | These fields can be used to view the fields of the product that this price will belong to. Has the value true if the object exists in live mode or the value false if the object exists in test mode. | |
ProductDataMarketingFeatures | String | True | No | These fields can be used to view the fields of the product that this price will belong to. A list of up to 15 marketing features for this product. These are displayed in pricing tables. | |
ProductDataPackageDimensionsHeight | Double | True | No | These fields can be used to view the fields of the product that this price will belong to. Height, in inches. | |
ProductDataPackageDimensionsLength | Double | True | No | These fields can be used to view the fields of the product that this price will belong to. Length, in inches. | |
ProductDataPackageDimensionsWeight | Double | True | No | These fields can be used to view the fields of the product that this price will belong to. Weight, in inches. | |
ProductDataPackageDimensionsWidth | Double | True | No | These fields can be used to view the fields of the product that this price will belong to. Width, in inches. | |
ProductDataShippable | Boolean | True | No | These fields can be used to view the fields of the product that this price will belong to. Whether this product is shipped (i.e., physical goods). | |
ProductDataUpdated | Datetime | True | No | These fields can be used to view the fields of the product that this price will belong to. Time at which the object was last updated. | |
ProductDataUrl | String | True | No | These fields can be used to view the fields of the product that this price will belong to. A URL of a publicly-accessible webpage for this product. | |
AccountId | String | False | Yes | The Id of the connected account to get prices for. | |
TransferLookupKey | Boolean | False | Yes | If set to true, will atomically remove the lookup key from the existing price, and assign it to this price. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | String | False | No | ID of product. | |
Active | Boolean | False | No | Whether or not the product is currently available for purchase. afterwards stripe | |
FeaturesAggregate | String | False | No | A list of up to 5 attributes that each SKU can provide value. | |
Created | Datetime | True | No | The time when product is created. | |
DefaultPrice | String | False | No | The ID of the Price object that is the default price for this product. Can be used in Update. | |
Description | String | False | No | The product's description, meant to be displayable to the customer. | |
Name | String | False | No | The product's name, meant to be displayable to the customer.maximum character length limit of 250 | |
PackageDimensionsHeight | Double | False | No | The height dimension of this product for shipping purposes. | |
PackageDimensionsLength | Double | False | No | The length dimension of this product for shipping purposes. | |
PackageDimensionsWeight | Double | False | No | The weight dimension of this product for shipping purposes. | |
PackageDimensionsWidth | Double | False | No | The width dimension of this product for shipping purposes. | |
Shippable | Boolean | False | No | Whether this product is a shipped good. | |
StatementDescriptor | String | False | No | Extra information about a charge for the credit card statement of the customer. | |
Updated | Datetime | True | No | The last updated time. | |
Type | String | True | No | The type of the product. | |
Url | String | False | No | The URL of a publicly-accessible webpage for this product. | |
TaxCode | String | False | No | A tax code ID. | |
Livemode | Boolean | True | No | Tells if the dispute is in livemode. | |
MetadataAggregate | String | False | No | Set of key-value pairs | |
Object | String | True | No | String representing the object's type. Objects of the same type share the same value. | |
UnitLabel | String | False | No | A label that represents units of this product in Stripe and on customers receipts and invoices. When set, this will be included in associated invoice line item descriptions. | |
Images | String | False | No | A list of up to 8 URLs of images for this product, meant to be displayable to the customer. | |
AccountId | String | False | Yes | The Id of the connected account to get products for. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | String | True | No | The Id of the promotion code. | |
Active | Boolean | False | No | Whether the promotion code is currently active. A promotion code is only active if the coupon is also valid. | |
Code | String | False | No | The customer-facing code. | |
CouponAmountOff | Integer | True | No | The amount (in the currency specified) that is taken off the subtotal of any invoices for this customer. | |
CouponCreated | Datetime | True | No | The time at which the coupon was created. | |
CouponCurrency | String | True | No | If amount_off has been set, the three-letter ISO code for the currency of the amount to take off. | |
CouponDuration | String | True | No | One of forever, once, and repeating. | |
CouponDurationInMonths | Integer | True | No | If duration is repeating, the number of months the coupon applies. The value is Null if coupon duration is forever or once. | |
CouponId | String | False | No | The Id of the coupon. | |
CouponLivemode | Boolean | True | No | true if the object is in live mode andfalse if in test mode. | |
CouponMaxRedemptions | Integer | True | No | The maximum number of times this coupon can be redeemed, in total, across all customers, before it is no longer valid. | |
CouponMetadata | String | True | No | The set of key-value pairs that you can attach to a coupon. | |
CouponName | String | True | No | Name of the coupon displayed to customers. | |
CouponPercentOff | Double | True | No | The percent to be taken off the subtotal of any invoices for this customer for the duration of the coupon. | |
CouponRedeemBy | Datetime | True | No | The date after which the coupon can no longer be redeemed. | |
CouponTimesRedeemed | Integer | True | No | The number of times this coupon has been applied to a customer. | |
CouponAppliesToProducts | Integer | True | No | Contains information about what this coupon applies to. A list of product IDs this coupon applies to. | |
CouponValid | Boolean | True | No | Whether this coupon can still be applied to a customer, taking the above properties into account . | |
Created | Datetime | True | No | The time at which the object was created. Measured in seconds since the Unix epoch. | |
Customer | String | False | No | The customer that this promotion code can be used by. | |
ExpiresAt | Datetime | False | No | The date at which the promotion code can no longer be redeemed. | |
Livemode | Boolean | True | No | true if the object is in live mode andfalse if in test mode. | |
MaxRedemptions | Integer | False | No | The maximum number of times this promotion code can be redeemed. | |
Metadata | String | False | No | The set of key/value pairs that you can attach to a value list object. | |
RestrictionsCurrencyOptions | String | False | No | Promotion codes defined in each available currency option. Each key must be a three-letter ISO currency code and a supported currency. | |
RestrictionsFirstTimeTransaction | Boolean | False | No | A Boolean indicating if the Promotion Code should only be redeemed for Customers without any successful payments or invoices. | |
RestrictionsMinimumAmount | Integer | False | No | The minimum amount required to redeem this Promotion Code into a Coupon. | |
RestrictionsMinimumAmountCurrency | String | False | No | A three-letter ISO code for minimum_amount. | |
TimesRedeemed | Integer | True | No | The number of times this promotion code has been used. | |
AccountId | String | False | Yes | The Id of the connected account to get promotion code for. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | String | True | No | The Id of the quotes. | |
AmountSubtotal | Integer | True | No | The total before any discounts or taxes are applied. | |
AmountTotal | Integer | True | No | The total after discounts and taxes are applied. | |
Application | String | True | No | The Id of the Connect Application that created the quote. | |
ApplicationFeeAmount | Integer | False | No | The amount of the application fee. | |
ApplicationFeePercent | Double | False | No | A non-negative decimal between 0 and 100, with at most two decimal places. | |
AutomaticTaxEnabled | Boolean | False | No | Automatically calculates taxes. | |
AutomaticTaxStatus | String | True | No | The status of the most recent automated tax calculation for this quote. | |
CollectionMethod | String | False | No | The method to collect charge money, either charge_automatically or send_invoice. | |
ComputedRecurring | String | True | No | The definitive totals and line items the customer is charged on a recurring basis. | |
ComputedUpfrontAmountSubtotal | Integer | True | No | The total before any discounts or taxes are applied. | |
ComputedUpfrontAmountTotal | Integer | True | No | The total after discounts and taxes are applied. | |
ComputedUpfrontTotalDetailsAmountDiscount | Integer | True | No | The sum of all the discounts. | |
ComputedUpfrontTotalDetailsAmountShipping | Integer | True | No | The sum of all the shipping amounts. | |
ComputedUpfrontTotalDetailsAmountTax | Integer | True | No | The sum of all the tax amounts. | |
Created | Datetime | True | No | The time at which the object was created. Measured in seconds since the Unix epoch. | |
Currency | String | True | No | A three-letter ISO currency code, in lowercase. | |
CustomerId | String | False | No | The Id of the customer. | |
DefaultTaxRates | String | False | No | The tax rates applied to this quote. | |
Description | String | False | No | A description that is displayed on the quote PDF. | |
Discounts | String | False | No | The discounts applied to this quote. | |
ExpiresAt | Datetime | False | No | The date on which the quote is canceled if in open or draft status. | |
Footer | String | False | No | A footer that is displayed on the quote PDF. | |
FromQuote | String | False | No | Details of the quote that was cloned. | |
Header | String | False | No | A header that is displayed on the quote PDF. | |
InvoiceId | String | True | No | The Id of the invoice that was created from this quote. | |
InvoiceSettingsDaysUntilDue | Integer | False | No | The number of days within which a customer must pay invoices generated by this quote. | |
Livemode | Boolean | True | No | true if the object is in live mode andfalse if in test mode. | |
LineItems | String | False | No | The line items representing what is being sold. Each line item represents an item being sold. | |
Metadata | String | False | No | The set of key/value pairs that you can attach to a value list object. | |
Number | String | True | No | A unique number that identifies this particular quote. | |
OnBehalfOf | String | False | No | The account on behalf of which to charge. | |
Status | String | True | No | The status of the quote. | |
StatusTransitionsAcceptedAt | Datetime | True | No | The time that the quote was accepted. | |
StatusTransitionsCanceledAt | Datetime | True | No | The time that the quote was canceled. | |
StatusTransitionsFinalizedAt | Datetime | True | No | The time that the quote was finalized. | |
Subscription | String | True | No | The subscription that was created or updated from this quote. | |
SubscriptionDataDescription | String | False | No | The subscription's description, meant to be displayable to the customer. | |
SubscriptionDataEffectiveDate | Datetime | False | No | When creating a new subscription, the date of which the subscription schedule starts after the quote is accepted. | |
SubscriptionDataTrialPeriodDays | Integer | False | No | An integer representing the number of trial period days before the customer is charged for the first time. | |
SubscriptionSchedule | String | True | No | The subscription schedule that was created or updated from this quote. | |
TestClock | String | False | No | The Id of the test clock this quote belongs to. | |
TotalDetailsAmountDiscount | Integer | True | No | The sum of all the discounts. | |
TotalDetailsAmountShipping | Integer | True | No | The sum of all the shipping amounts. | |
TotalDetailsAmountTax | Integer | True | No | The sum of all the tax amounts. | |
TransferData | String | False | No | The account (if any) the payments are attributed to for tax reporting, and where funds from each payment are transferred to for each of the invoices. | |
AutomaticTaxLiabilityAccount | String | False | No | The connected account being referenced when type is account. | |
AutomaticTaxLiabilityType | String | False | No | Type of the account referenced. | |
InvoiceSettingsIssuerAccount | String | False | No | The connected account being referenced when type is account. | |
InvoiceSettingsIssuerType | String | False | No | Type of the account referenced. | |
SubscriptionDataMetadata | String | False | No | Set of key-value pairs that will set metadata on the subscription or subscription schedule when the quote is accepted. If a recurring price is included in line_items, this field will be passed to the resulting subscription’s metadata field. If subscription_data.effective_date is used, this field will be passed to the resulting subscription schedule’s phases.metadata field. Unlike object-level metadata, this field is declarative. Updates will clear prior values. | |
AccountId | String | False | Yes | The Id of the connected account for which to get a quote. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | String | True | No | The Id of the refund. | |
Charge | String | False | No | The Id of the charge that was refunded. | |
Amount | Integer | False | No | The Amount, in cents. | |
Status | String | True | No | The status of the refund. | |
BalanceTransaction | String | True | No | The balance transaction that describes the impact on your account balance. | |
Created | Datetime | True | No | The refund datetime. | |
Currency | String | True | No | Three-letter ISO code representing the currency. | |
Reason | String | False | No | The reason for the refund. | |
ReceiptNumber | String | True | No | This is the transaction number that appears on email receipts sent for this refund. | |
MetadataAggregate | String | False | No | The refund metadata object. | |
Description | String | True | No | An arbitrary string attached to the object. Often useful for displaying to users. | |
PaymentIntent | String | False | No | ID of the PaymentIntent that was refunded. | |
Object | String | True | No | String representing the object's type. Objects of the same type share the same value. | |
FailureBalanceTransaction | String | True | No | If the refund failed, this balance transaction describes the adjustment made on your account balance that reverses the initial balance transaction. | |
FailureReason | String | True | No | If the refund failed, the reason for refund failure if known. | |
NextAction | String | True | No | This property will describe what the refund needs in order to continue processing. | |
SourceTransferReversal | String | True | No | The transfer reversal that is associated with the refund. Only present if the charge came from another Stripe account. See the Connect documentation for details. | |
TransferReversal | String | True | No | If the accompanying transfer was reversed, the transfer reversal object. Only applicable if the charge was created using the destination parameter. | |
InstructionsEmail | String | True | No | For payment methods without native refund support (for example, Konbini, PromptPay), provide an email address for the customer to receive refund instructions. | |
DestinationDetailsAffirm | String | True | No | If this is a affirm refund, this hash contains the transaction specific details of the affirm refund method. | |
DestinationDetailsAfterpayClearpay | String | True | No | If this is a afterpay_clearpay refund, this hash contains the transaction specific details of the afterpay_clearpay refund method. | |
DestinationDetailsAlipay | String | True | No | If this is a alipay refund, this hash contains the transaction specific details of the alipay refund method. | |
DestinationDetailsAmazonPay | String | True | No | If this is a amazon_pay refund, this hash contains the transaction specific details of the amazon_pay refund method. | |
DestinationDetailsAuBankTransfer | String | True | No | If this is a au_bank_transfer refund, this hash contains the transaction specific details of the au_bank_transfer refund method. | |
DestinationDetailsBlikReference | String | True | No | If this is a blik refund, this contains the reference assigned to the refund. | |
DestinationDetailsBlikReferenceStatus | String | True | No | If this is a blik refund, this contains the status of the reference on the refund. This can be pending, available or unavailable. | |
DestinationDetailsBrBankTransferReference | String | True | No | If this is a br_bank_transfer refund, this contains the reference assigned to the refund. | |
DestinationDetailsBrBankTransferReferenceStatus | String | True | No | If this is a br_bank_transfer refund, this contains the status of the reference on the refund. This can be pending, available or unavailable. | |
DestinationDetailsCardReference | String | True | No | If this is a card refund, this contains the value of the reference number assigned to the refund. | |
DestinationDetailsCardReferenceStatus | String | True | No | If this is a card refund, this contains the status of the reference number on the refund. This can be pending, available or unavailable. | |
DestinationDetailsCardReferenceType | String | True | No | If this is a card refund, this contains the type of the reference number assigned to the refund. | |
DestinationDetailsCardType | String | True | No | If this is a card refund, this contains the type of refund. This can be refund, reversal, or pending. | |
DestinationDetailsCashapp | String | True | No | If this is a cashapp refund, this hash contains the transaction specific details of the cashapp refund method. | |
DestinationDetailsCustomerCashBalance | String | True | No | If this is a customer_cash_balance refund, this hash contains the transaction specific details of the customer_cash_balance refund method. | |
DestinationDetailsEps | String | True | No | If this is a eps refund, this hash contains the transaction specific details of the eps refund method. | |
DestinationDetailsEuBankTransferReference | String | True | No | If this is a eu_bank_transfer refund, this contains the reference assigned to the refund. | |
DestinationDetailsEuBankTransferReferenceStatus | String | True | No | If this is a eu_bank_transfer refund, this contains the status of the reference on the refund. This can be pending, available or unavailable. | |
DestinationDetailsGbBankTransferReference | String | True | No | If this is a gb_bank_transfer refund, this contains the reference assigned to the refund. | |
DestinationDetailsGbBankTransferReferenceStatus | String | True | No | If this is a gb_bank_transfer refund, this contains the status of the reference on the refund. This can be pending, available or unavailable. | |
DestinationDetailsGiropay | String | True | No | If this is a giropay refund, this hash contains the transaction specific details of the giropay refund method. | |
DestinationDetailsGrabpay | String | True | No | If this is a grabpay refund, this hash contains the transaction specific details of the grabpay refund method. | |
DestinationDetailsJpBankTransferReference | String | True | No | If this is a jp_bank_transfer refund, this contains the reference assigned to the refund. | |
DestinationDetailsJpBankTransferReferenceStatus | String | True | No | If this is a jp_bank_transfer refund, this contains the status of the reference on the refund. This can be pending, available or unavailable. | |
DestinationDetailsKlarna | String | True | No | If this is a klarna refund, this hash contains the transaction specific details of the klarna refund method. | |
DestinationDetailsMultibancoReference | String | True | No | If this is a multibanco refund, this contains the reference assigned to the refund. | |
DestinationDetailsMultibancoReferenceStatus | String | True | No | If this is a multibanco refund, this contains the status of the reference on the refund. This can be pending, available or unavailable. | |
DestinationDetailsMxBankTransferReference | String | True | No | If this is a mx_bank_transfer refund, this contains the reference assigned to the refund. | |
DestinationDetailsMxBankTransferReferenceStatus | String | True | No | If this is a mx_bank_transfer refund, this contains the status of the reference on the refund. This can be pending, available or unavailable. | |
DestinationDetailsP24Reference | String | True | No | If this is a p24 refund, this contains the reference assigned to the refund. | |
DestinationDetailsP24ReferenceStatus | String | True | No | If this is a p24 refund, this contains the status of the reference on the refund. This can be pending, available or unavailable. | |
DestinationDetailsPaynow | String | True | No | If this is a paynow refund, this hash contains the transaction specific details of the paynow refund method. | |
DestinationDetailsPaypal | String | True | No | If this is a paypal refund, this hash contains the transaction specific details of the paypal refund method. | |
DestinationDetailsPix | String | True | No | If this is a pix refund, this hash contains the transaction specific details of the pix refund method. | |
DestinationDetailsRevolut | String | True | No | If this is a revolut refund, this hash contains the transaction specific details of the revolut refund method. | |
DestinationDetailsSofort | String | True | No | If this is a sofort refund, this hash contains the transaction specific details of the sofort refund method. | |
DestinationDetailsSwishReference | String | True | No | If this is a swish refund, this contains the reference assigned to the refund. | |
DestinationDetailsSwishReferenceStatus | String | True | No | If this is a swish refund, this contains the status of the reference on the refund. This can be pending, available or unavailable. | |
DestinationDetailsThBankTransferReference | String | True | No | If this is a th_bank_transfer refund, this contains the reference assigned to the refund. | |
DestinationDetailsThBankTransferReferenceStatus | String | True | No | If this is a th_bank_transfer refund, this contains the status of the reference on the refund. This can be pending, available or unavailable. | |
DestinationDetailsType | String | True | No | The type of transaction-specific details of the payment method used in the refund (e.g., card). An additional hash is included on destination_details with a name matching this value. It contains information specific to the refund transaction. | |
DestinationDetailsUsBankTransferReference | String | True | No | If this is a us_bank_transfer refund, this contains the reference assigned to the refund. | |
DestinationDetailsUsBankTransferReferenceStatus | String | True | No | If this is a us_bank_transfer refund, this contains the status of the reference on the refund. This can be pending, available or unavailable. | |
DestinationDetailsWechatPay | String | True | No | If this is a wechat_pay refund, this hash contains the transaction specific details of the wechat_pay refund method. | |
DestinationDetailsZip | String | True | No | If this is a zip refund, this hash contains the transaction specific details of the zip refund method. | |
AccountId | String | False | Yes | The Id of the connected account to get refunds for. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | String | True | No | Unique identifier for the object. | |
Created | Datetime | True | No | Time at which the object was created. Measured in seconds since the Unix epoch. | |
Error | String | True | No | If something should go wrong during the run, a message about the failure (populated when status=failed). | |
Livemode | Boolean | True | No | Always true: reports can only be run on live-mode data | |
Object | String | True | No | String representing the objects type. Objects of the same type share the same value. | |
ParametersIntervalEnd | Datetime | True | No | Ending timestamp of data to be included in the report run (exclusive). | |
ParametersIntervalStart | Datetime | True | No | Starting timestamp of data to be included in the report run. | |
ParametersColumns | String | True | No | The set of output columns requested for inclusion in the report run. | |
ParametersConnectedAccount | String | True | No | Connected account ID by which to filter the report run. | |
ParametersCurrency | String | True | No | Currency of objects to be included in the report run. | |
ParametersPayout | String | True | Payouts.Id | No | Payout ID by which to filter the report run. |
ParametersReportingCategory | String | True | No | Category of balance transactions to be included in the report run. | |
ParametersTimezone | String | True | No | Defaults to Etc/UTC. The output timezone for all timestamps in the report. | |
Report_type | String | True | No | The ID of the report type to run, such as balance.summary.1 | |
ResultCreated | Datetime | True | No | Time at which the object was created. Measured in seconds since the Unix epoch. | |
ResultExpiresAt | Datetime | True | No | The time at which the file expires and is no longer available in epoch seconds. | |
ResultFilename | String | True | No | A filename for the file, suitable for saving to a filesystem. | |
ResultId | String | True | No | Unique identifier for the object. | |
ResultLinksHas_more | Boolean | True | No | True if this list has another page of items after this one that can be fetched. | |
ResultLinksObject | String | True | No | String representing the objects type. Objects of the same type share the same value. Always has the value list. | |
ResultLinksUrl | String | True | No | The URL where this list can be accessed. | |
ResultObject | String | True | No | String representing the objects type. Objects of the same type share the same value. | |
ResultPurpose | String | True | No | The purpose of the uploaded file. | |
ResultSize | Integer | True | No | The size in bytes of the file object. | |
ResultTitle | String | True | No | A user friendly title for the document. | |
ResultType | String | True | No | The type of the file returned (e.g., csv, pdf, jpg, or png). | |
ResultUrl | String | True | No | The URL from which the file can be downloaded using your live secret API key. | |
Status | String | True | No | Status of this report run. This will be pending when the run is initially created. When the run finishes, this will be set to succeeded and the result field will be populated. Rarely, we may encounter an error, at which point this will be set to failed and the error field will be populated. | |
Succeeded_at | Timestamp | True | No | Timestamp at which this run successfully finished (populated when status=succeeded). Measured in seconds since the Unix epoch. | |
ResultLinksDataAggregate | String | True | No | Details about each object of Result Links. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | String | True | No | The ID of the Report Type, such as balance.summary.1. | |
Object | String | True | No | String representing the object's type. Objects of the same type share the same value. | |
DataAvailableEnd | Datetime | True | No | Most recent time for which this Report Type is available. Measured in seconds since the Unix epoch. | |
DataAvailableStart | Datetime | True | No | Earliest time for which this Report Type is available. Measured in seconds since the Unix epoch. | |
DefaultColumns | String | True | No | List of column names that are included by default when this Report Type gets run. (If the Report Type doesn't support the columns parameter, this will be null.) | |
Livemode | Boolean | True | No | Has the value true if the object exists in live mode or the value false if the object exists in test mode. | |
Name | String | True | No | Human-readable name of the Report Type. | |
Updated | Datetime | True | No | When this Report Type was latest updated. Measured in seconds since the Unix epoch. | |
Version | Integer | True | No | Version of the Report Type. Different versions report with the same ID will have the same purpose, but may take different run parameters or have different result schemas. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | String | True | No | The Id of the reviews. | |
BillingZip | String | True | No | The ZIP or postal code of the card used, if applicable. | |
Charge | String | True | No | The charge associated with this review. | |
ClosedReason | String | True | No | The reason the review was closed, or null if it has not yet been closed. | |
Created | Datetime | True | No | Time at which the object was created. Measured in seconds since the Unix epoch. | |
IpAddress | String | True | No | The IP address where the payment originated. | |
IpAddressLocation | String | True | No | Information related to the location of the payment. | |
Livemode | Boolean | True | No | true if the object exists in live mode andfalse if in test mode. | |
Open | Boolean | True | No | If true, the review needs action. | |
OpenedReason | String | True | No | The reason the review was opened. Either rule or manual. | |
PaymentIntent | String | True | No | The PaymentIntent ID associated with this review, if one exists. | |
Reason | String | True | No | The reason the review is currently open or closed. Possible values are rule, manual, approved, refunded, refunded_as_fraud, disputed, or redacted. | |
Session | String | True | No | Information related to the browsing session of the user who initiated the payment. | |
AccountId | String | False | Yes | The Id of the connected account to be reviewed. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | String | True | No | Unique identifier for the object. | |
Object | String | True | No | String representing the objects type. Objects of the same type share the same value. | |
Application | String | True | No | The value of application on the SetupIntent at the time of this confirmation. | |
AttachToSelf | Boolean | True | No | If present, the SetupIntents payment method will be attached to the in-context Stripe Account. | |
Created | Datetime | True | No | Time at which the object was created. Measured in seconds since the Unix epoch. | |
Customer | String | True | No | The value of customer on the SetupIntent at the time of this confirmation. | |
FlowDirections | String | True | No | Indicates the directions of money movement for which this payment method is intended to be used. | |
Livemode | Boolean | True | No | Has the value true if the object exists in live mode or the value false if the object exists in test mode. | |
OnBehalfOf | String | True | No | The value of on_behalf_of on the SetupIntent at the time of this confirmation. | |
PaymentMethod | String | True | No | ID of the payment method used with this SetupAttempt. | |
PaymentMethodDetailsAcssDebit | String | True | No | If this is a acss_debit payment method, this hash contains confirmation-specific information for the acss_debit payment method. | |
PaymentMethodDetailsAuBecsDebit | String | True | No | If this is a au_becs_debit payment method, this hash contains confirmation-specific information for the au_becs_debit payment method. | |
PaymentMethodDetailsBacsDebit | String | True | No | If this is a bacs_debit payment method, this hash contains confirmation-specific information for the bacs_debit payment method. | |
PaymentMethodDetailsBanContactBankCode | String | True | No | Bank code of bank associated with the bank account. | |
PaymentMethodDetailsBanContactBankName | String | True | No | Name of the bank associated with the bank account. | |
PaymentMethodDetailsBanContactBIC | String | True | No | Bank Identifier Code of the bank associated with the bank account. | |
PaymentMethodDetailsBanContactGeneratedSepaDebit | String | True | No | The ID of the SEPA Direct Debit PaymentMethod which was generated by this SetupAttempt. | |
PaymentMethodDetailsBanContactGeneratedSepaDebitMandate | String | True | No | The mandate for the SEPA Direct Debit PaymentMethod which was generated by this SetupAttempt. | |
PaymentMethodDetailsBanContactIBanLast4 | String | True | No | Last four characters of the IBAN. | |
PaymentMethodDetailsBanContactPreferredLanguage | String | True | No | Preferred language of the Bancontact authorization page that the customer is redirected to | |
PaymentMethodDetailsBanContactVerifiedName | String | True | No | Owners verified full name. | |
PaymentMethodDetailsBoleto | String | True | No | If this is a boleto payment method, this hash contains confirmation-specific information for the boleto payment method. | |
PaymentMethodDetailsCardBrand | String | True | No | Card brand. | |
PaymentMethodDetailsCardChecks | String | True | No | Check results by Card networks on Card address and CVC at the time of authorization | |
PaymentMethodDetailsCardCountry | String | True | No | Two-letter ISO code representing the country of the card. | |
PaymentMethodDetailsCardExpMonth | String | True | No | Two-digit number representing the cards expiration month. | |
PaymentMethodDetailsCardExpYear | String | True | No | Four-digit number representing the cards expiration year. | |
PaymentMethodDetailsCardFingerprint | String | True | No | Uniquely identifies this particular card number. | |
PaymentMethodDetailsCardFunding | String | True | No | Card funding type. | |
PaymentMethodDetailsCardLast4 | String | True | No | The last four digits of the card. | |
PaymentMethodDetailsCardNetwork | String | True | No | Identifies which network this charge was processed on. | |
PaymentMethodDetailsCardThreeDSecure | String | True | No | Populated if this authorization used 3D Secure authentication. | |
PaymentMethodDetailsCardWallet | String | True | No | If this Card is part of a card wallet, this contains the details of the card wallet. | |
PaymentMethodDetailsCardPresent | String | True | No | If this is a card_present payment method, this hash contains confirmation-specific information for the card_present payment method. | |
PaymentMethodDetailsCashApp | String | True | No | If this is a cashapp payment method, this hash contains confirmation-specific information for the cashapp payment method. | |
PaymentMethodDetailsIdealBank | String | True | No | The customers bank. | |
PaymentMethodDetailsIdealBIC | String | True | No | The Bank Identifier Code of the customers bank. | |
PaymentMethodDetailsIdealGeneratedSepaDebit | String | True | No | The ID of the SEPA Direct Debit PaymentMethod which was generated by this SetupAttempt. | |
PaymentMethodDetailsIdealGeneratedSepaDebitMandate | String | True | No | The mandate for the SEPA Direct Debit PaymentMethod which was generated by this SetupAttempt. | |
PaymentMethodDetailsIdealIBanLast4 | String | True | No | Last four characters of the IBAN. | |
PaymentMethodDetailsIdealVerifiedName | String | True | No | Owners verified full name. | |
PaymentMethodDetailsKlarna | String | True | No | If this is a klarna payment method, this hash contains confirmation-specific information for the klarna payment method. | |
PaymentMethodDetailsLink | String | True | No | If this is a link payment method, this hash contains confirmation-specific information for the link payment method | |
PaymentMethodDetailsPaypal | String | True | No | If this is a paypal payment method, this hash contains confirmation-specific information for the paypal payment method. | |
PaymentMethodDetailsSepaDebit | String | True | No | If this is a sepa_debit payment method, this hash contains confirmation-specific information for the sepa_debit payment method. | |
PaymentMethodDetailsSoFortBankCode | String | True | No | Bank code of bank associated with the bank account. | |
PaymentMethodDetailsSoFortBankName | String | True | No | Name of the bank associated with the bank account. | |
PaymentMethodDetailsSoFortBIC | String | True | No | Bank Identifier Code of the bank associated with the bank account. | |
PaymentMethodDetailsSoFortGeneratedSepaDebit | String | True | No | The ID of the SEPA Direct Debit PaymentMethod which was generated by this SetupAttempt. | |
PaymentMethodDetailsSoFortGeneratedSepaDebitMandate | String | True | No | The mandate for the SEPA Direct Debit PaymentMethod which was generated by this SetupAttempt. | |
PaymentMethodDetailsSoFortIBanLast4 | String | True | No | Last four characters of the IBAN. | |
PaymentMethodDetailsSoFortPreferredLanguage | String | True | No | Preferred language of the Sofort authorization page that the customer is redirected to. | |
PaymentMethodDetailsSoFortVerifiedName | String | True | No | Owners verified full name. | |
PaymentMethodDetailsType | String | True | No | The type of the payment method used in the SetupIntent | |
PaymentMethodDetailsUsBankAccount | String | True | No | If this is a us_bank_account payment method, this hash contains confirmation-specific information for the us_bank_account payment method. | |
SetupErrorCode | String | True | No | For some errors that could be handled programmatically, a short string indicating the error code reported. | |
SetupErrorDeclineCode | String | True | No | For card errors resulting from a card issuer decline, a short string indicating the card issuers reason for the decline if they provide one. | |
SetupErrorDocURL | String | True | No | A URL to more information about the error code reported. | |
SetupErrorMessage | String | True | No | A human-readable message providing more details about the error. | |
SetupErrorParam | String | True | No | If the error is parameter-specific, the parameter related to the error. | |
SetupErrorPaymentMethod | String | True | No | The PaymentMethod object for errors returned on a request involving a PaymentMethod. | |
SetupErrorPaymentMethodType | String | True | No | If the error is specific to the type of payment method, the payment method type that had a problem. | |
SetupErrorType | String | True | No | The type of error returned. | |
SetupIntent | String | True | No | ID of the SetupIntent that this attempt belongs to. | |
Status | String | True | No | Status of this SetupAttempt | |
Usage | String | True | No | The value of usage on the SetupIntent at the time of this confirmation |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | String | True | No | Unique identifier for the object. | |
AutomaticPaymentMethodsAllowRedirects | String | True | No | Controls whether this SetupIntent will accept redirect-based payment methods. | |
AutomaticPaymentMethodsEnabled | Boolean | True | No | Automatically calculates compatible payment methods | |
Application | String | True | No | ID of the Connect application that created the SetupIntent. | |
AttachToSelf | Boolean | True | No | If present, the SetupIntent’s payment method will be attached to the in-context Stripe Account. | |
CancellationReason | String | True | No | Reason for cancellation of this SetupIntent | |
ClientSecret | String | True | No | The client secret of this SetupIntent. Used for client-side retrieval using a publishable key. | |
Created | Integer | True | No | Time at which the object was created. Measured in seconds since the Unix epoch. | |
Customer | String | True | No | ID of the Customer this SetupIntent belongs to | |
Description | String | True | No | An arbitrary string attached to the object. Often useful for displaying to users. | |
FlowDirections | String | True | No | Indicates the directions of money movement for which this payment method is intended to be used. | |
LastSetupErrorCode | String | True | No | For some errors that could be handled programmatically, a short string indicating the error code reported. | |
LastSetupErrorDeclineCode | String | True | No | For card errors resulting from a card issuer decline, a short string indicating the card issuer’s reason for the decline if they provide one. | |
LastSetupErrorDocURL | String | True | No | A URL to more information about the error code reported. | |
LastSetupErrorMessage | String | True | No | A human-readable message providing more details about the error. For card errors, these messages can be shown to your users. | |
LastSetupErrorParam | String | True | No | If the error is parameter-specific, the parameter related to the error. | |
LastSetupErrorPaymentMethod | String | True | No | The PaymentMethod object for errors returned on a request involving a PaymentMethod. | |
LastSetupErrorPaymentMethodType | String | True | No | If the error is specific to the type of payment method, the payment method type that had a problem. | |
LastSetupErrorType | String | True | No | The type of error returned. | |
MetadataAggregate | String | True | No | The set of key/value pairs that you can attach to a an object. | |
LatestAttempt | String | True | No | The most recent SetupAttempt for this SetupIntent. | |
Livemode | Boolean | True | No | Has the value true if the object exists in live mode or the value false if the object exists in test mode. | |
Mandate | String | True | No | ID of the multi use Mandate generated by the SetupIntent. | |
NextAction | String | True | No | If present, this property tells you what actions you need to take in order for your customer to continue payment setup. | |
PaymentMethod | String | True | No | ID of the payment method used with this SetupIntent. | |
Status | String | True | No | Status of this SetupIntent | |
Usage | String | True | No | Indicates how the payment method is intended to be used in the future. | |
Object | String | True | No | String representing the objects type. Objects of the same type share the same value. | |
OnBehalfOf | String | True | No | The account (if any) for which the setup is intended. | |
PaymentMethodConfigurationDetailsId | String | True | No | ID of the payment method configuration used. | |
PaymentMethodConfigurationDetailsParent | String | True | No | ID of the parent payment method configuration used. | |
PaymentmethodOptions | String | True | No | Payment method-specific configuration for this SetupIntent. | |
PaymentMethodTypes | String | True | No | The list of payment method types (e.g. card) that this SetupIntent is allowed to set up. | |
SingleUseMandate | String | True | No | ID of the single_use Mandate generated by the SetupIntent. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | String | True | No | The Id of the Shipping Rates. | |
Active | Boolean | False | No | Whether the shipping rate can be used for new purchases. Its default value is true. | |
Created | Timestamp | True | No | Time at which the object was created. Measured in seconds since the Unix epoch. | |
DeliveryEstimateMaximumUnit | String | False | No | A unit of time. | |
DeliveryEstimateMaximumValue | Integer | False | No | Must be greater than 0. | |
DeliveryEstimateMinimumUnit | String | False | No | A unit of time. | |
DeliveryEstimateMinimumValue | Integer | False | No | Must be greater than 0. | |
DisplayName | String | False | No | The name of the shipping rate, meant to be displayable to the customer. | |
FixedAmountAmount | Integer | False | No | A non-negative integer in cents representing how much to charge. | |
FixedAmountCurrency | String | False | No | Three-letter ISO currency code, in lowercase. Must be a supported currency. | |
Livemode | Boolean | True | No | Has the value true if the object exists in live mode or the value false if the object exists in test mode. | |
MetadataAggregate | String | False | No | Set of key-value pairs | |
Object | String | True | No | The Object type. | |
TaxBehavior | String | False | No | Whether the rate is considered inclusive of taxes or exclusive of taxes. | |
TaxCode | String | False | No | Tax code Id. | |
Type | String | False | No | The type of calculation to use on the shipping rate. | |
AccountId | String | False | Yes | The Id of the connected account. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | String | True | No | The Id of the subscription item. | |
SubscriptionId | String | False | Subscriptions.Id | No | The Id of the subscription. |
PlanId | String | False | Plans.Id | No | The Id of the plan. |
PlanActive | Boolean | True | No | Whether the plan can be used for new purchases. | |
PlanAggregateUsage | String | True | No | Specifies a usage aggregation strategy for plans of usage_type=metered. | |
PlanAmount | Integer | True | No | The unit amount in cents to be charged, represented as a whole integer if possible. | |
PlanAmountDecimal | String | True | No | The unit amount in cents to be charged, represented as a decimal string with at most 12 decimal places. | |
PlanBillingScheme | String | True | No | Describes how to compute the price per period. | |
PlanCreated | Datetime | True | No | Time at which the object was created. Measured in seconds since the Unix epoch. | |
PlanCurrency | String | True | No | Three-letter ISO currency code, in lowercase. Must be a supported currency. | |
PlanInterval | String | True | No | The frequency at which a subscription is billed. One of day, week, month or year. | |
PlanIntervalCount | Integer | True | No | The number of intervals (specified in the interval attribute) between subscription billings. | |
PlanLivemode | Boolean | True | No | Has the value true if the object exists in live mode or the value false if the object exists in test mode. | |
PlanMetadata | String | True | No | Set of key-value pairs that you can attach to an object. | |
PlanMeter | String | True | No | The meter tracking the usage of a metered price. | |
PlanNickname | String | True | No | A brief description of the plan, hidden from customers. | |
PlanObject | String | True | No | String representing the object's type. Objects of the same type share the same value. | |
PlanProduct | String | True | No | The product whose pricing this plan determines. | |
PlanTiersMode | String | True | No | Defines if the tiering price should be graduated or volume based. | |
PlanTransformUsage | String | True | No | Apply a transformation to the reported usage or set quantity before computing the amount billed. | |
PlanTrialPeriodDays | Integer | True | No | Default number of trial days when subscribing a customer to this plan using trial_from_plan=true. | |
PlanUsageType | String | True | No | Configures how the quantity per period should be determined. | |
Quantity | Double | False | No | The quantity of the plan to which the customer should be subscribed. | |
Created | Datetime | True | No | Creation date. | |
MetadataAggregate | String | False | No | 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. | |
PriceId | String | False | Prices.Id | No | Unique identifier for the price. |
PriceActive | Boolean | True | No | Whether the price can be used for new purchases. | |
PriceBillingScheme | String | True | No | Describes how to compute the price per period. | |
PriceCreated | Datetime | True | No | The creation date. | |
PriceCurrency | String | True | No | Currency in which subscription will be charged. | |
PriceCustomUnitAmount | String | True | No | Price custom unit amount. | |
PriceLivemode | Boolean | True | No | Has the value true if the object exists in live mode or the value false if the object exists in test mode. | |
PriceLookupKey | String | True | No | A lookup key used to retrieve prices dynamically from a static string. | |
PriceMetadata | String | True | No | Set of key-value pairs that you can attach to an object. | |
PriceNickname | String | True | No | A brief description of the plan, hidden from customers. | |
PriceObject | String | True | No | String representing the object's type. Objects of the same type share the same value. | |
PriceProduct | String | True | No | The Id of the product this price is associated with. | |
PriceRecurringAggregateUsage | String | True | No | Price recurring aggregate usage. | |
PriceRecurringInterval | String | True | No | Price recurring interval. | |
PriceRecurringIntervalCount | Integer | True | No | Price recurring interval count. | |
PriceRecurringMeter | String | True | No | Price recurring meter. | |
PriceRecurringTrialPeriodDays | Integer | True | No | Price recurring trial period days. | |
PriceRecurringUsageType | String | True | No | Price recurring usage type. | |
PriceTaxBehaviour | String | True | No | Price tax behaviour. | |
PriceTiersMode | String | True | No | Price tiers mode. | |
PriceTransformQuantity | String | True | No | Price transform quantity. | |
PriceType | String | True | No | Price type. | |
PriceUnitAmount | Integer | True | No | Price unit amount. | |
PriceUnitAmountDecimal | String | True | No | Price unit amount decimal. | |
Object | String | True | No | String representing the object's type. Objects of the same type share the same value. | |
BillingThresholdsUsageGte | Integer | False | No | Usage threshold that triggers the subscription to create an invoice | |
TaxRatesAggregate | String | False | No | The tax rates which apply to this subscription_item. When set, the default_tax_rates on the subscription do not apply to this subscription_item. | |
Discounts | String | False | No | The coupons to redeem into discounts for the subscription item. | |
IsProrate | Boolean | False | Yes | Flag indicating whether to prorate switching plans during a billing cycle. | |
ProrationDate | Date | False | Yes | If set, the proration will be calculated as though the subscription was updated at the given time. | |
PaymentBehavior | String | False | Yes | Payment Behavior. Valid for INSERT, DELETE and UPDATE. | |
ProrationBehavior | String | False | Yes | Determines how to handle prorations when the billing cycle changes. Valid for INSERT, DELETE and UPDATE. | |
AccountId | String | False | Yes | The Id of the connected account to get subscription items for |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | String | True | No | The Id of the subscription. | |
CustomerId | String | False | Customers.Id | No | The Id of the customer who owns the subscription. |
PlanId | String | False | Plans.Id | No | The Id of the plan. |
PlanActive | Boolean | True | No | Whether the plan can be used for new purchases. | |
PlanAggregateUsage | String | True | No | Specifies a usage aggregation strategy for plans of usage_type=metered. | |
PlanAmount | Integer | True | No | The unit amount in cents to be charged, represented as a whole integer if possible. | |
PlanAmountDecimal | String | True | No | The unit amount in cents to be charged, represented as a decimal string with at most 12 decimal places. | |
PlanBillingScheme | String | True | No | Describes how to compute the price per period. | |
PlanCreated | Datetime | True | No | Time at which the object was created. Measured in seconds since the Unix epoch. | |
PlanCurrency | String | True | No | Three-letter ISO currency code, in lowercase. Must be a supported currency. | |
PlanInterval | String | True | No | The frequency at which a subscription is billed. One of day, week, month or year. | |
PlanIntervalCount | Integer | True | No | The number of intervals (specified in the interval attribute) between subscription billings. | |
PlanLivemode | Boolean | True | No | Has the value true if the object exists in live mode or the value false if the object exists in test mode. | |
PlanMetadata | String | True | No | Set of key-value pairs that you can attach to an object. | |
PlanMeter | String | True | No | The meter tracking the usage of a metered price. | |
PlanNickname | String | True | No | A brief description of the plan, hidden from customers. | |
PlanObject | String | True | No | String representing the object's type. Objects of the same type share the same value. | |
PlanProduct | String | True | No | The product whose pricing this plan determines. | |
PlanTiersMode | String | True | No | Defines if the tiering price should be graduated or volume based. | |
PlanTransformUsage | String | True | No | Apply a transformation to the reported usage or set quantity before computing the amount billed. | |
PlanTrialPeriodDays | Integer | True | No | Default number of trial days when subscribing a customer to this plan using trial_from_plan=true. | |
PlanUsageType | String | True | No | Configures how the quantity per period should be determined. | |
ApplicationFeePercent | Decimal | False | No | A positive decimal that represents the fee percentage of the subscription invoice amount that will be transferred to the application of the Stripe account owner each billing period. | |
CancelAtPeriodEnd | Boolean | False | No | 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. | |
CanceledAt | Datetime | True | No | 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. | |
CreatedAt | Datetime | True | No | The creation date. | |
CurrentPeriodEnd | Datetime | True | No | End of the current period that the subscription has been invoiced for. At the end of this period, a new invoice will be created. | |
CurrentPeriodStart | Datetime | True | No | Start of the current period that the subscription has been invoiced for. | |
CouponId | String | False | No | The id of the discount coupon. | |
EndedAt | Datetime | True | No | If the subscription has ended (either because it was canceled or because the customer was switched to a subscription to a new plan), the date the subscription ended. | |
Quantity | Double | True | No | The quantity of the plan to which the customer should be 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. | |
StartDate | Datetime | True | No | Date the most recent update to this subscription started. | |
Status | String | True | No | The status of the subscription | |
TaxPercent | Decimal | True | No | If provided, each invoice created by this subscription will apply the tax rate, increasing the amount billed to the customer. | |
TrialEnd | Datetime | False | No | If the subscription has a trial, the end of that trial. | |
TrialStart | Datetime | True | No | If the subscription has a trial, the beginning of that trial. | |
MetadataAggregate | String | False | No | The set of key/value pairs that you can attach to a subscription object. | |
BillingCycleAnchor | Datetime | False | No | Determines the date of the first full invoice, and, for plans with month or year intervals, the day of the month for subsequent invoices. | |
DefaultPaymentMethod | String | False | No | ID of the default payment method for the subscription | |
ItemsAggregate | String | False | No | List of subscription items, each with an attached price. | |
LatestInvoice | String | True | No | The ID of the most recent invoice this subscription has generated. | |
PendingSetupIntent | String | True | No | You can use this SetupIntent to collect user authentication when creating a subscription without immediate payment or updating a subscription's payment method, allowing you to optimize for off-session payments. | |
PendingUpdate | String | True | No | If specified, pending updates that will be applied to the subscription once the latest_invoice has been paid. | |
BillingThresholds | String | False | No | Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period | |
AutomaticTaxEnabled | Boolean | False | No | Automatic tax settings for this subscription. | |
AutomaticTaxLiabilityAccount | String | False | No | The connected account being referenced when type is account. | |
AutomaticTaxLiabilityType | String | False | No | Type of the account referenced. | |
CollectionMethod | String | False | No | Either charge_automatically, or send_invoice. When charging automatically, Stripe will attempt to pay this subscription at the end of the cycle using the default source attached to the customer. | |
DaysUntilDue | Integer | False | No | Number of days a customer has to pay invoices generated by this subscription. This value is null for subscriptions where collection_method=charge_automatically | |
DefaultSource | String | False | No | ID of the default payment source for the subscription. | |
DefaultTaxRates | String | False | No | The tax rates that will apply to any subscription item that does not have tax_rates set. Invoices created will have their default_tax_rates populated from the subscription. | |
LiveMode | Boolean | True | No | Has the value true if the object exists in live mode or the value false if the object exists in test mode. | |
NextPendingInvoiceItemInvoice | Datetime | True | No | Specifies the approximate timestamp on which any pending invoice items will be billed according to the schedule provided at pending_invoice_item_interval | |
PauseCollectionBehavior | String | False | No | If specified, payment collection for this subscription will be paused. The payment collection behavior for this subscription while paused. One of keep_as_draft, mark_uncollectible, or void. | |
PauseCollectionResumesAt | Datetime | False | No | If specified, payment collection for this subscription will be paused. The time after which the subscription will resume collecting payments. | |
PaymentSettings | String | False | No | Payment settings passed on to invoices created by the subscription. | |
PendingInvoiceItemInterval | String | False | No | Specifies an interval for how often to bill for any pending invoice items. It is analogous to calling Create an invoice for the given subscription at the specified interval. Specifies invoicing frequency. Either day, week, month or year. | |
PendingInvoiceItemIntervalCount | Integer | False | No | Specifies an interval for how often to bill for any pending invoice items. It is analogous to calling Create an invoice for the given subscription at the specified interval. The number of intervals between invoices. | |
Schedule | String | True | No | The schedule attached to the subscription | |
TestClock | String | True | No | ID of the test clock this customer belongs to. | |
TransferData | String | False | No | The account (if any) the subscription's payments will be attributed to for tax reporting, and where funds from each payment will be transferred to for each of the subscription's invoices. | |
CancelAt | Datetime | False | No | A date in the future at which the subscription will automatically get canceled. | |
Description | String | False | No | The subscription's description. | |
CancellationDetailsComment | String | False | No | Details about why this subscription was cancelled. Additional comments about why the user canceled the subscription, if the subscription was canceled explicitly by the user. | |
CancellationDetailsFeedback | String | False | No | Details about why this subscription was cancelled. The customer submitted reason for why they canceled, if the subscription was canceled explicitly by the user. | |
CancellationDetailsReason | String | False | No | Details about why this subscription was cancelled. The reason why this subscription was cancelled. | |
Currency | String | False | No | Three-letter ISO currency code, in lowercase. Must be a supported currency. | |
TrialSettingsEndBehaviorPaymentMethod | String | False | No | Settings related to subscription trials. Indicates how the subscription should change when the trial ends if the user did not provide a payment method. | |
OnBehalfOf | String | False | No | The account on behalf of which to charge, for each of the subscription?s invoices. | |
DiscountId | String | True | No | The Id of the discount. | |
DiscountCheckoutSession | String | True | No | The Checkout session that this coupon is applied to, if it is applied to a particular session in payment mode. Will not be present for subscription mode. | |
DiscountCustomer | String | True | No | The ID of the customer associated with this discount. | |
DiscountStart | Datetime | True | No | If the subscription has a trial, the beginning of that trial. | |
DiscountEnd | Datetime | True | No | If the subscription has a trial, the end of that trial. | |
DiscountInvoice | String | True | No | The invoice that the discount's coupon was applied to, if it was applied directly to a particular invoice. | |
DiscountInvoiceItem | String | True | No | The invoice line item id that the discount's coupon was applied to if it was applied directly to a invoice line item. | |
DiscountPromotionCode | String | True | No | The promotion code applied to create this discount.The promotion code applied to create this discount. | |
DiscountSubscription | String | True | No | The subscription that this coupon is applied to, if it is applied to a particular subscription. | |
DiscountCouponCreatedAt | Datetime | True | No | The creation date. | |
DiscountCouponCurrency | String | True | No | If amount_off has been set, the three-letter ISO code for the currency of the amount to take off. | |
DiscountCouponName | String | True | No | Name of the coupon displayed to customers on, for instance, invoices or receipts. | |
DiscountCouponDuration | String | True | No | One of forever, once, and repeating. Describes how long a customer who applies this coupon will get the discount. | |
DiscountCouponDurationInMonths | Integer | True | No | the number of months the coupon applies. | |
DiscountCouponAmountOff | Integer | True | No | Amount (in the currency specified) that is taken off the subtotal of any invoices for this customer. | |
DiscountCouponPercentOff | Integer | True | No | 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 a percent_off of 50 will make a $100 invoice $50 instead. | |
DiscountCouponValid | Boolean | True | No | Taking account of the above properties, whether this coupon can still be applied to a customer. | |
DiscountCouponMaxRedemptions | Integer | True | No | Maximum number of times this coupon can be redeemed, in total, before it is no longer valid. | |
DiscountCouponRedeemBy | Datetime | True | No | Date after which the coupon can no longer be redeemed. | |
DiscountCouponTimesRedeemed | Integer | True | No | Number of times this coupon has been applied to a customer. | |
DiscountCouponObject | String | True | No | String representing the object's type. Objects of the same type share the same value. | |
DiscountCouponLiveMode | Boolean | True | No | Has the value true if the object exists in live mode or the value false if the object exists in test mode. | |
DiscountCouponMetadataAggregate | String | True | No | Set of key-value pairs that you can attach to an object. | |
Application | String | True | No | ID of the Connect Application that created the subscription. | |
BillingCycleAnchorConfigDayofMonth | Integer | False | No | The day of the month of the billing_cycle_anchor. | |
BillingCycleAnchorConfigHour | Integer | False | No | The hour of the day of the billing_cycle_anchor. | |
BillingCycleAnchorConfigminute | Integer | False | No | The minute of the hour of the billing_cycle_anchor. | |
BillingCycleAnchorConfigmonth | Integer | False | No | The month to start full cycle billing periods. | |
BillingCycleAnchorConfigsecond | Integer | False | No | The second of the minute of the billing_cycle_anchor. | |
InvoiceSettingsAccountTaxIds | String | False | No | Invoice settings account tax ids. | |
InvoiceSettingsIssuerType | String | False | No | Invoice settings issuer type. | |
InvoiceSettingsIssuerAccount | String | False | No | The connected account being referenced when InvoiceSettingsIssuerType is account. | |
IsProrate | Boolean | False | Yes | Flag indicating whether to prorate switching plans during a billing cycle. | |
ProrationDate | Date | False | Yes | If set, the proration will be calculated as though the subscription was updated at the given time. It can also be used to implement custom proration logic, such as prorating by day instead of by second, by providing the time that you wish to use for proration calculations. | |
PaymentBehavior | String | False | Yes | Use allow_incomplete to transition the subscription to status=past_due if a payment is required but cannot be paid. This allows you to manage scenarios where additional user actions are needed to pay a subscription?s invoice. | |
ProrationBehavior | String | False | Yes | Determines how to handle prorations when the billing cycle changes (e.g., when switching plans, resetting billing_cycle_anchor=now, or starting a trial), or if an item?s quantity changes. The default value is create_prorations. | |
TrialPeriodDays | Integer | False | Yes | The number of trial period days before the customer is charged for the first time. If set, trial_period_days overrides the default trial period days of the plan the customer is being subscribed to. TrialPeriodDays only works for the INSERT operation. | |
AccountId | String | False | Yes | The Id of the connected account to get subscriptions for. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | String | True | No | Unique identifier for the object. | |
Application | String | True | No | ID of the Connect Application that created the schedule. | |
CanceledAt | Datetime | True | No | Time at which the subscription schedule was canceled. Measured in seconds since the Unix epoch. | |
CompletedAt | Datetime | True | No | Time at which the subscription schedule was completed. Measured in seconds since the Unix epoch. | |
Created | Datetime | True | No | Time at which the object was created. Measured in seconds since the Unix epoch. | |
CurrentPhaseEndDate | Datetime | True | No | The end of this phase of the subscription schedule. | |
CurrentPhaseStartDate | Datetime | True | No | The start of this phase of the subscription schedule. | |
Customer | String | True | No | ID of the customer who owns the subscription schedule. | |
MetadataAggregate | String | True | No | The set of key/value pairs that you can attach to a an object. | |
Phases | String | True | No | Configuration for the subscription schedules phases. | |
Status | String | True | No | The present status of the subscription schedule. | |
Subscription | String | True | No | ID of the subscription managed by the subscription schedule. | |
Object | String | True | No | String representing the objects type. Objects of the same type share the same value. | |
DefaultSettingsApplicationFeePercent | Decimal | True | No | A non-negative decimal between 0 and 100, with at most two decimal places. | |
DefaultSettingsAutomaticTaxEnabled | Boolean | True | No | Whether Stripe automatically computes tax on invoices created during this phase. | |
DefaultSettingsAutomaticTaxLiability | String | True | No | The account thats liable for tax. | |
DefaultSettingsBillingCycleAnchor | String | True | No | Possible values are phase_start or automatic. | |
DefaultSettingsBillingThresholds | String | True | No | Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period | |
DefaultSettingsCollectionMethod | String | True | No | Either charge_automatically, or send_invoice. | |
DefaultSettingsDefaultPaymentMethod | String | True | No | ID of the default payment method for the subscription schedule. | |
DefaultSettingsDescription | String | True | No | Subscription description, meant to be displayable to the customer. | |
DefaultSettingsInvoiceSettings | String | True | No | The subscription schedules default invoice settings. | |
DefaultSettingsOnBehalfOf | String | True | No | The account (if any) the charge was made on behalf of for charges associated with the schedules subscription. | |
DefaultSettingsTransferData | String | True | No | The account (if any) the associated subscriptions payments will be attributed to for tax reporting, and where funds from each payment will be transferred to for each of the subscriptions invoices. | |
EndBehavior | String | True | No | Behavior of the subscription schedule and underlying subscription when it ends. | |
Livemode | Boolean | True | No | Has the value true if the object exists in live mode or the value false if the object exists in test mode. | |
ReleasedAt | Datetime | True | No | Time at which the subscription schedule was released. Measured in seconds since the Unix epoch. | |
ReleasedSubscription | String | True | No | ID of the subscription once managed by the subscription schedule (if it is released). | |
TestClock | String | True | No | ID of the test clock this subscription schedule belongs to. | |
RenewalInterval | String | True | No | The renewal interval of the subscription schedule. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | String | True | No | The Id of the tax codes. | |
Description | String | True | No | A detailed description of which types of products the tax code represents. | |
Name | String | True | No | A short name for the tax code. | |
Object | String | True | No | String representing the object’s type. Objects of the same type share the same value. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | String | True | No | The Id of the tax codes. | |
Country | String | True | No | Two-letter ISO code representing the country of the tax ID. | |
Customer | String | True | No | ID of the customer. | |
Type | String | False | No | Type of the tax ID, one of ad_nrt, ae_trn, ar_cuit, au_abn, au_arn, bg_uic, bh_vat, bo_tin, br_cnpj, br_cpf, ca_bn, ca_gst_hst, ca_pst_bc, ca_pst_mb, ca_pst_sk, ca_qst, ch_uid, ch_vat, cl_tin, cn_tin, co_nit, cr_tin, de_stn, do_rcn, ec_ruc, eg_tin, es_cif, eu_oss_vat, eu_vat, gb_vat, ge_vat, hk_br, hr_oib, hu_tin, id_npwp, il_vat, in_gst, is_vat, jp_cn, jp_rn, jp_trn, ke_pin, kr_brn, kz_bin, li_uid, mx_rfc, my_frp, my_itn, my_sst, ng_tin, no_vat, no_voec, nz_gst, om_vat, pe_ruc, ph_tin, ro_tin, rs_pib, ru_inn, ru_kpp, sa_vat, sg_gst, sg_uen, si_tin, sv_nit, th_vat, tr_tin, tw_vat, ua_vat, us_ein, uy_ruc, ve_rif, vn_tin, or za_vat. Note that some legacy tax IDs have type unknown. | |
Value | String | False | No | Value of the tax ID. | |
Created | Datetime | True | No | Time at which the object was created. Measured in seconds since the Unix epoch. | |
Livemode | Boolean | True | No | Has the value true if the object exists in live mode or the value false if the object exists in test mode. | |
OwnerType | String | False | No | Type of owner referenced. The default value is 'self'. | |
OwnerAccount | String | False | No | The account being referenced when type is account. | |
OwnerCustomer | String | False | No | The customer being referenced when type is customer. | |
OwnerApplication | String | True | No | The Connect Application being referenced when type is application. | |
VerificationStatus | String | True | No | Tax ID verification status, one of pending, verified, unverified, or unavailable. | |
VerificationVerifiedAddress | String | True | No | Tax ID Verified address. | |
VerificationVerifiedName | String | True | No | Tax ID Verified name. | |
Object | String | True | No | String representing the object’s type. Objects of the same type share the same value. | |
AccountId | String | False | Yes | The Id of the connected account. Required when OwnerType = 'Application'. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | String | True | No | The Id of the tax rates | |
Active | Boolean | False | No | Defaults to true. When set to false, this tax rate cannot be used with new applications or Checkout Sessions, but still works for subscriptions and invoices that already have it set. | |
Country | String | False | No | A two-letter country code. | |
Created | Datetime | True | No | The time at which the object was created. Measured in seconds since the Unix epoch. | |
Description | String | False | No | An arbitrary string attached to the tax rate for your internal use only. It is not visible to your customers. | |
DisplayName | String | False | No | The display name of the tax rates as it appears to your customer on their receipt email, PDF, and the hosted invoice page. | |
EffectivePercentage | Double | True | No | The actual/effective tax rate percentage out of 100. | |
Inclusive | Boolean | False | No | Specifies if the tax rate is inclusive or exclusive. | |
Jurisdiction | String | False | No | The jurisdiction for the tax rate. You can use this label field for tax reporting purposes. | |
Livemode | Boolean | True | No | true if the object is in live mode andfalse if in test mode. | |
Metadata | String | False | No | The set of key/value pairs that you can attach to a value list object. | |
Percentage | Double | False | No | The tax rate percentage out of 100. | |
State | String | False | No | An ISO 3166-2 subdivision code, without country prefix. | |
TaxType | String | False | No | The high-level tax type, such as vat or sales_tax. | |
JurisdictionLevel | String | True | No | The level of the jurisdiction that imposes this tax rate. Will be null for manually defined tax rates. | |
AccountId | String | False | Yes | The Id of the connected account to get topups for. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | String | True | No | The unique identifier for the object. | |
Name | String | False | No | The custom name supplied at creation. | |
Status | String | True | No | The status of the Test Clock. | |
Created | Datetime | True | No | The time at which the object was created, measured in seconds since the Unix epoch. | |
DeletesAfter | Datetime | True | No | The time at which this clock is scheduled to auto delete. | |
FrozenTime | Datetime | False | No | The initial frozen time for this test clock. | |
Livemode | Boolean | True | No | Has the value true if the object exists in live mode or the value false if the object exists in test mode. | |
AccountId | String | False | Yes | The Id of the connected account to get coupons for. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | String | True | No | The Id of the top-ups. | |
Amount | Integer | False | No | The amount transferred. | |
BalanceTransaction | String | True | No | The Id of the balance transaction. | |
Created | Datetime | True | No | The time at which the object was created. Measured in seconds since the Unix epoch. | |
Currency | String | False | No | A three-letter ISO currency code, in lowercase. | |
Description | String | False | No | The top-up description. | |
ExpectedAvailabilityDate | Datetime | True | No | The date the funds are expected to arrive in the Stripe account for payouts. | |
FailureCode | String | True | No | An error code explaining reason for top-up failure if available. | |
FailureMessage | String | True | No | A message to the user that further explains reason for top-up failure if available. | |
Livemode | Boolean | True | No | true if the object exists in live mode and false if in test mode. | |
Metadata | String | False | No | The set of key/value pairs that you can attach to a value list object. | |
Source | String | True | No | The source details of the Stripe user. | |
StatementDescriptor | String | False | No | Extra information about a top-up. | |
Status | String | True | No | The status of the top-up is either canceled, failed, pending, reversed, or succeeded. | |
TransferGroup | String | False | No | A string that identifies this top-up as part of a group. | |
SourceId | String | False | Yes | The ID of a source to transfer funds from. It is a psuedo column only supported for insert. | |
AccountId | String | False | Yes | The Id of the connected account to get topups for. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | String | True | No | Unique identifier for the object. | |
Amount | Integer | True | No | The transaction amount, which will be reflected in your balance. | |
AmountDetailsAtmFee | Integer | True | No | The fee charged by the ATM for the cash withdrawal. | |
AmountDetailsCashbackAmount | Integer | True | No | The amount of cash requested by the cardholder. | |
Authorization | String | True | No | The Authorization object that led to this transaction. | |
BalanceTransaction | String | True | No | Balance transaction that describes the impact on your account balance. | |
Card | String | True | No | The card used to make this transaction. | |
Cardholder | String | True | No | The cardholder to whom this transaction belongs. | |
Currency | String | True | No | Three-letter ISO currency code, in lowercase. Must be a supported currency. | |
MetadataAggregate | String | True | No | The set of key/value pairs that you can attach to a an object. | |
Type | String | True | No | The nature of the transaction. | |
Created | Datetime | True | No | Time at which the object was created. Measured in seconds since the Unix epoch. | |
Dispute | String | True | No | If youve disputed the transaction, the ID of the dispute. | |
Livemode | Boolean | True | No | Has the value true if the object exists in live mode or the value false if the object exists in test mode. | |
MerchantAmount | Integer | True | No | The amount that the merchant will receive, denominated in merchant_currency and in the smallest currency unit | |
MerchantCurrency | String | True | No | The currency with which the merchant is taking payment. | |
MerchantDataCategory | String | True | No | A categorization of the seller’s type of business. | |
MerchantDataCategoryCode | String | True | No | The merchant category code for the sellers business | |
MerchantDataCity | String | True | No | City where the seller is located | |
MerchantDataCountry | String | True | No | Country where the seller is located | |
MerchantDataName | String | True | No | Name of the seller | |
MerchantDataNetworkId | String | True | No | Identifier assigned to the seller by the card network. | |
MerchantDataPostalCode | String | True | No | Postal code where the seller is located | |
MerchantDataState | String | True | No | State where the seller is located | |
MerchantDataTerminalId | String | True | No | An ID assigned by the seller to the location of the sale. | |
MerchantDataURL | String | True | No | URL provided by the merchant on a 3DS request | |
NetworkDataAuthorizationCode | String | True | No | A code created by Stripe which is shared with the merchant to validate the authorization. | |
NetworkDataProcessingDate | String | True | No | The date the transaction was processed by the card network. | |
NetworkDataTransactionId | String | True | No | Unique identifier for the authorization assigned by the card network used to match subsequent messages, disputes, and transactions. | |
PurchaseDetailsFlight | String | True | No | Information about the flight that was purchased with this transaction. | |
PurchaseDetailsFuel | String | True | No | Information about fuel that was purchased with this transaction. | |
PurchaseDetailsLodging | String | True | No | Information about lodging that was purchased with this transaction. | |
PurchaseDetailsReceipt | String | True | No | The line items in the purchase. | |
PurchaseDetailsReference | String | True | No | A merchant-specific order number. | |
Token | String | True | No | Token object used for this transaction. | |
Wallet | String | True | No | The digital wallet used for this transaction. | |
AccountId | String | False | Yes | The Id of the connected account to get files for. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | String | True | No | The Id of the reversal. | |
Transfer [KEY] | String | False | No | The Id of the transfer that was reversed. | |
Amount | Integer | False | No | A positive integer in cents representing how much of this transfer to reverse. | |
RefundApplicationFee | Boolean | False | No | Boolean indicating whether the application fee should be refunded when reversing this transfer. | |
Currency | String | True | No | The currency. | |
Metadata | String | False | No | 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. | |
Object | String | True | No | String representing the object's type. Objects of the same type share the same value. | |
BalanceTransaction | String | True | No | Balance transaction that describes the impact on your account balance. | |
DestinationPaymentRefund | String | True | No | Linked payment refund for the transfer reversal. | |
Created | Datetime | True | No | Time at which the object was created. Measured in seconds since the Unix epoch. | |
SourceRefund | String | True | No | ID of the refund responsible for the transfer reversal. | |
Description | String | False | Yes | An arbitrary string which you can attach to a reversal object. It is displayed alongside the reversal in the dashboard. This will be unset if you POST an empty value. | |
AccountId | String | False | Yes | The Id of the connected account to get Transfer reversals for. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | String | True | No | The Id of the transfer. | |
Currency | String | False | No | The currency. | |
Amount | Integer | False | No | Amount (in cents) to be transferred to your bank account. | |
AmountReversed | Integer | True | No | Amount in cents reversed (can be less than the amount attribute on the transfer if a partial reversal was issued). | |
ApplicationFee | String | True | No | The application fee. | |
BalanceTransaction | String | True | No | Balance transaction that describes the impact of this transfer on your account balance. | |
Created | Datetime | True | No | Time that this record of the transfer was first created. | |
Date | Datetime | True | No | Date the transfer is scheduled to arrive in the bank. This doesn't factor in delays like weekends or bank holidays. | |
Description | String | False | No | Internal-only description of the transfer. | |
Destination | String | False | No | The Id of the bank account, card, or Stripe account the transfer was sent to. | |
DestinationPayment | String | True | No | If the destination is a Stripe account, this will be the Id of the payment that the destination account received for the transfer. | |
FailureCode | String | True | No | Error code explaining reason for transfer failure if available. | |
FailureMessage | String | True | No | Message to user further explaining reason for transfer failure if available. | |
Reversed | Boolean | True | No | Whether or not the transfer has been fully reversed. If the transfer is only partially reversed, this attribute will still be false. | |
SourceTransaction | String | False | No | The Id of the charge (or other transaction) that was used to fund the transfer. If null, the transfer was funded from the available balance. | |
SourceType | String | False | No | The source balance this transfer came from. | |
StatementDescriptor | String | True | No | Extra information about a transfer to be displayed on the user's bank statement. | |
Status | String | True | No | Current status of the transfer. | |
Type | String | True | No | The type of the transfer which can be card, bank_account, or stripe_account. | |
MetadataAggregate | String | False | No | The transfer metadata object. | |
Object | String | True | No | String representing the object's type. Objects of the same type share the same value. | |
Livemode | Boolean | True | No | Has the value true if the object exists in live mode or the value false if the object exists in test mode. | |
ReversalsAggregate | String | True | No | A list of reversals that have been applied to the transfer. | |
TransferGroup | String | False | No | A string that identifies this transaction as part of a group. | |
AccountId | String | False | Yes | The Id of the connected account to get transfers for. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | String | True | No | The Id of the usage record. | |
Invoice | String | True | No | The Id of the invoice. | |
Livemode | Boolean | True | No | true if the object is in live mode andfalse if in test mode. | |
PeriodEnd | Datetime | True | No | The time of the period end. | |
PeriodStart | Datetime | True | No | The time of the period start. | |
SubscriptionItem | String | False | No | The Id of the subscription item. | |
Timestamp | Datetime | False | No | The timestamp for the usage event. | |
TotalUsage | Integer | True | No | The total usage. | |
AccountId | String | False | Yes | The Id of the connected account to get value list for. | |
Quantity | Integer | False | Yes | The usage quantity for the specified date. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | String | True | No | The Id of the value list items. | |
Created | Datetime | True | No | The time at which the object was created. Measured in seconds since the Unix epoch. | |
CreatedBy | String | True | No | The name or email address of the user who created this value list. | |
Livemode | Boolean | True | No | true if the object exists in live mode and false if in test mode. | |
Value | String | False | No | The value of the item. | |
ValueList | String | False | No | The Id of the value list. | |
AccountId | String | False | Yes | The Id of the connected account to get value list for. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | String | True | No | The Id of the value list. | |
Alias | String | False | No | The name of the value list for use in rules. | |
Created | Datetime | True | No | Time at which the object was created. Measured in seconds since the Unix epoch. | |
CreatedBy | String | True | No | The name or email address of the user who created this value list. | |
ItemType | String | False | No | The type of items in the value list. Possible values are card_fingerprint, card_bin, email, ip_address, country, string, case_sensitive_string, or customer_id. | |
ListItemsUrl | String | True | No | The URL where this list can be accessed. | |
Livemode | Boolean | True | No | true if the object is in live mode andfalse if in test mode. | |
Name | String | False | No | The name of the value list. | |
Metadata | String | False | No | The set of key/value pairs that you can attach to a value list object. | |
AccountId | String | False | Yes | The Id of the connected account to get value list for. |