From b2dc275bf3265d92ce4e3fd0b0a9bd87934f13ca Mon Sep 17 00:00:00 2001 From: ayeshLK Date: Fri, 17 Nov 2023 14:54:43 +0530 Subject: [PATCH 1/6] Update open-api spec --- openapi/stripe/openapi.yaml | 138 ++++++++++++++++++++++++++++++++++++ 1 file changed, 138 insertions(+) diff --git a/openapi/stripe/openapi.yaml b/openapi/stripe/openapi.yaml index b5ca38338..45a31fce5 100644 --- a/openapi/stripe/openapi.yaml +++ b/openapi/stripe/openapi.yaml @@ -24614,6 +24614,144 @@ paths: "$ref": "#/components/schemas/error" description: Error response. "/v1/customers": + get: + description: "

Returns a list of your customers. The customers are returned sorted by creation date, with the most recent customers appearing first.

" + operationId: listCustomers + parameters: + - explode: true + in: query + name: created + required: false + schema: + anyOf: + - properties: + gt: + description: Minimum value to filter by (exclusive) + type: integer + gte: + description: Minimum value to filter by (inclusive) + type: integer + lt: + description: Maximum value to filter by (exclusive) + type: integer + lte: + description: Maximum value to filter by (inclusive) + type: integer + title: range_query_specs + type: object + - type: integer + style: deepObject + - description: >- + A case-sensitive filter on the list based on the customer's `email` + field. The value must be a string. + in: query + name: email + required: false + schema: + maxLength: 512 + type: string + style: form + - description: >- + A cursor for use in pagination. `ending_before` is an object ID that + defines your place in the list. For instance, if you make a list + request and receive 100 objects, starting with `obj_bar`, your + subsequent call can include `ending_before=obj_bar` in order to + fetch the previous page of the list. + in: query + name: ending_before + required: false + schema: + maxLength: 5000 + type: string + style: form + - description: Specifies which fields in the response should be expanded. + explode: true + in: query + name: expand + required: false + schema: + items: + maxLength: 5000 + type: string + type: array + style: deepObject + - description: >- + A limit on the number of objects to be returned. Limit can range + between 1 and 100, and the default is 10. + in: query + name: limit + required: false + schema: + type: integer + style: form + - description: >- + A cursor for use in pagination. `starting_after` is an object ID + that defines your place in the list. For instance, if you make a + list request and receive 100 objects, ending with `obj_foo`, your + subsequent call can include `starting_after=obj_foo` in order to + fetch the next page of the list. + in: query + name: starting_after + required: false + schema: + maxLength: 5000 + type: string + style: form + - description: >- + Provides a list of customers that are associated with the specified + test clock. The response will not include customers with test clocks + if this parameter is not set. + in: query + name: test_clock + required: false + schema: + maxLength: 5000 + type: string + style: form + responses: + '200': + content: + application/json: + schema: + description: '' + properties: + data: + items: + $ref: '#/components/schemas/customer' + type: array + has_more: + description: >- + True if this list has another page of items after this one + that can be fetched. + type: boolean + object: + description: >- + String representing the object's type. Objects of the same + type share the same value. Always has the value `list`. + enum: + - list + type: string + url: + description: The URL where this list can be accessed. + maxLength: 5000 + pattern: ^/v1/customers + type: string + required: + - data + - has_more + - object + - url + title: CustomerResourceCustomerList + type: object + x-expandableFields: + - data + description: Successful response. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/error' + description: Error response. post: description: "

Creates a new customer object.

" operationId: createCustomer From a8d3ea2e4c578a6ec18d73fab44dbb53c0526d32 Mon Sep 17 00:00:00 2001 From: ayeshLK Date: Fri, 17 Nov 2023 15:01:00 +0530 Subject: [PATCH 2/6] Add list-customer action to the stripe client --- openapi/stripe/client.bal | 21 +- openapi/stripe/types.bal | 5189 +++++++++++++++++++++++++------------ 2 files changed, 3479 insertions(+), 1731 deletions(-) diff --git a/openapi/stripe/client.bal b/openapi/stripe/client.bal index adf25ab1e..58ae87360 100644 --- a/openapi/stripe/client.bal +++ b/openapi/stripe/client.bal @@ -93,6 +93,23 @@ public isolated client class Client { Coupon response = check self.clientEp->get(resourcePath); return response; } + #

Returns a list of your customers. The customers are returned sorted by creation date, with the most recent customers appearing first.

+ # + # + email - A case-sensitive filter on the list based on the customer's `email` field. The value must be a string. + # + endingBefore - A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. + # + expand - Specifies which fields in the response should be expanded. + # + 'limit - A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. + # + startingAfter - A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. + # + testClock - Provides a list of customers that are associated with the specified test clock. The response will not include customers with test clocks if this parameter is not set. + # + return - Successful response. + remote isolated function listCustomers(Created? created = (), string? email = (), string? endingBefore = (), string[]? expand = (), int? 'limit = (), string? startingAfter = (), string? testClock = ()) returns CustomerResourceCustomerList|error { + string resourcePath = string `/v1/customers`; + map queryParam = {"created": created, "email": email, "ending_before": endingBefore, "expand": expand, "limit": 'limit, "starting_after": startingAfter, "test_clock": testClock}; + map queryParamEncoding = {"created": {style: DEEPOBJECT, explode: true}, "expand": {style: DEEPOBJECT, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + CustomerResourceCustomerList response = check self.clientEp->get(resourcePath); + return response; + } #

Creates a new customer object.

# # + payload - Customer details @@ -157,7 +174,7 @@ public isolated client class Client { # + status - The status of the invoice, one of `draft`, `open`, `paid`, `uncollectible`, or `void`. [Learn more](https://stripe.com/docs/billing/invoices/workflow#workflow-overview) # + subscription - Only return invoices for the subscription specified by this subscription ID. # + return - Successful response. - remote isolated function listInvoices(string? collectionMethod = (), Created? created = (), string? customer = (), DueDate? dueDate = (), string? endingBefore = (), string[]? expand = (), int? 'limit = (), string? startingAfter = (), string? status = (), string? subscription = ()) returns InvoicesList|error { + remote isolated function listInvoices(string? collectionMethod = (), Created1? created = (), string? customer = (), DueDate? dueDate = (), string? endingBefore = (), string[]? expand = (), int? 'limit = (), string? startingAfter = (), string? status = (), string? subscription = ()) returns InvoicesList|error { string resourcePath = string `/v1/invoices`; map queryParam = {"collection_method": collectionMethod, "created": created, "customer": customer, "due_date": dueDate, "ending_before": endingBefore, "expand": expand, "limit": 'limit, "starting_after": startingAfter, "status": status, "subscription": subscription}; map queryParamEncoding = {"created": {style: DEEPOBJECT, explode: true}, "due_date": {style: DEEPOBJECT, explode: true}, "expand": {style: DEEPOBJECT, explode: true}}; @@ -556,7 +573,7 @@ public isolated client class Client { # + startingAfter - A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. # + status - The status of the subscriptions to retrieve. Passing in a value of `canceled` will return all canceled subscriptions, including those belonging to deleted customers. Pass `ended` to find subscriptions that are canceled and subscriptions that are expired due to [incomplete payment](https://stripe.com/docs/billing/subscriptions/overview#subscription-statuses). Passing in a value of `all` will return subscriptions of all statuses. If no value is supplied, all subscriptions that have not been canceled are returned. # + return - Successful response. - remote isolated function listSubscriptions(string? collectionMethod = (), Created1? created = (), CurrentPeriodEnd? currentPeriodEnd = (), CurrentPeriodStart? currentPeriodStart = (), string? customer = (), string? endingBefore = (), string[]? expand = (), int? 'limit = (), string? price = (), string? startingAfter = (), string? status = ()) returns InlineResponse2002|error { + remote isolated function listSubscriptions(string? collectionMethod = (), Created2? created = (), CurrentPeriodEnd? currentPeriodEnd = (), CurrentPeriodStart? currentPeriodStart = (), string? customer = (), string? endingBefore = (), string[]? expand = (), int? 'limit = (), string? price = (), string? startingAfter = (), string? status = ()) returns InlineResponse2002|error { string resourcePath = string `/v1/subscriptions`; map queryParam = {"collection_method": collectionMethod, "created": created, "current_period_end": currentPeriodEnd, "current_period_start": currentPeriodStart, "customer": customer, "ending_before": endingBefore, "expand": expand, "limit": 'limit, "price": price, "starting_after": startingAfter, "status": status}; map queryParamEncoding = {"created": {style: DEEPOBJECT, explode: true}, "current_period_end": {style: DEEPOBJECT, explode: true}, "current_period_start": {style: DEEPOBJECT, explode: true}, "expand": {style: DEEPOBJECT, explode: true}}; diff --git a/openapi/stripe/types.bal b/openapi/stripe/types.bal index 7c75e750c..c5e5d754d 100644 --- a/openapi/stripe/types.bal +++ b/openapi/stripe/types.bal @@ -14,6 +14,13 @@ // specific language governing permissions and limitations // under the License. +public type NotificationEventRequest record { + # ID of the API request that caused the event. If null, the event was automatic (e.g., Stripe's automatic subscription handling). Request logs are available in the [dashboard](https://dashboard.stripe.com/logs), but currently not in the API. + string? id?; + # The idempotency key transmitted during the request, if any. *Note: This property is populated only for events on or after May 23, 2017*. + string? idempotency_key?; +}; + public type IssuingTransactionFlightDataLeg record { # The three-letter IATA airport code of the flight's destination. string? arrival_airport_code?; @@ -39,9 +46,9 @@ public type Customer record { # The customer's address. Address? address?; # Current balance, if any, being stored on the customer. If negative, the customer has credit to apply to their next invoice. If positive, the customer has an amount owed that will be added to their next invoice. The balance does not refer to any unpaid invoices; it solely takes into account amounts that have yet to be successfully applied to any invoice. This balance is only taken into account as invoices are finalized. - int? balance?; + int balance?; # Time at which the object was created. Measured in seconds since the Unix epoch. - int? created; + int created; # Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) the customer can be charged in for recurring billing purposes. string? currency?; # ID of the default payment source for the customer. @@ -59,20 +66,20 @@ public type Customer record { # The customer's email address. string? email?; # Unique identifier for the object. - string? id; + string id; # The prefix for the customer used to generate unique invoice numbers. string? invoice_prefix?; - InvoiceSettingCustomerSetting? invoice_settings?; + InvoiceSettingCustomerSetting invoice_settings?; # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. - boolean? livemode; + boolean livemode; # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. record {} metadata?; # The customer's full name or business name. string? name?; # The suffix of the customer's next invoice number, e.g., 0001. - int? next_invoice_sequence?; + int next_invoice_sequence?; # String representing the object's type. Objects of the same type share the same value. - string? 'object; + string 'object; # The customer's phone number. string? phone?; # The customer's preferred locales (languages), ordered by preference. @@ -80,14 +87,14 @@ public type Customer record { # Mailing and shipping address for the customer. Appears on invoices emailed to this customer. Shipping? shipping?; # The customer's payment sources, if any. - ApmsSourcesSourceList? sources?; + ApmsSourcesSourceList sources?; # The customer's current subscriptions, if any. - SubscriptionList? subscriptions?; - CustomerTax? tax?; + SubscriptionList subscriptions?; + CustomerTax tax?; # 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"**. string? tax_exempt?; # The customer's tax IDs. - TaxIDsList? tax_ids?; + TaxIDsList tax_ids?; }; public type IssuingCardholderVerification record { @@ -109,23 +116,23 @@ public type PaymentMethodDetailsMultibanco record { # Related guides: [Set up a subscription](https://stripe.com/docs/billing/subscriptions/set-up-subscription) or accept [one-time payments with Checkout](https://stripe.com/docs/payments/checkout/client#create-products) and more about [Products and Prices](https://stripe.com/docs/billing/prices-guide) public type Product record { # Whether the product is currently available for purchase. - boolean? active; + boolean active; # Time at which the object was created. Measured in seconds since the Unix epoch. - int? created; + int created; # 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. string? description?; # Unique identifier for the object. - string? id; + string id; # A list of up to 8 URLs of images for this product, meant to be displayable to the customer. - string[]? images; + string[] images; # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. - boolean? livemode; + boolean livemode; # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. record {} metadata; # The product's name, meant to be displayable to the customer. Whenever this product is sold via a subscription, name will show up on associated invoice line item descriptions. - string? name; + string name; # String representing the object's type. Objects of the same type share the same value. - string? 'object; + string 'object; # The dimensions of this product for shipping purposes. PackageDimensions? package_dimensions?; # Whether this product is shipped (i.e., physical goods). @@ -137,43 +144,84 @@ public type Product record { # 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. string? unit_label?; # Time at which the object was last updated. Measured in seconds since the Unix epoch. - int? updated; + int updated; # A URL of a publicly-accessible webpage for this product. string? url?; }; public type SubscriptionSchedulesResourceDefaultSettingsAutomaticTax record { # Whether Stripe automatically computes tax on invoices created during this phase. - boolean? enabled; + boolean enabled; +}; + +# A VerificationSession guides you through the process of collecting and verifying the identities +# of your users. It contains details about the type of verification, such as what [verification +# check](/docs/identity/verification-checks) to perform. Only create one VerificationSession for +# each verification in your system. +# +# A VerificationSession transitions through [multiple +# statuses](/docs/identity/how-sessions-work) throughout its lifetime as it progresses through +# the verification flow. The VerificationSession contains the user’s verified data after +# verification checks are complete. +# +# Related guide: [The Verification Sessions API](https://stripe.com/docs/identity/verification-sessions) +public type IdentityVerificationSession record { + # The short-lived client secret used by Stripe.js to [show a verification modal](https://stripe.com/docs/js/identity/modal) inside your app. This client secret expires after 24 hours and can only be used once. Don’t store it, log it, embed it in a URL, or expose it to anyone other than the user. Make sure that you have TLS enabled on any page that includes the client secret. Refer to our docs on [passing the client secret to the frontend](https://stripe.com/docs/identity/verification-sessions#client-secret) to learn more. + string? client_secret?; + # Time at which the object was created. Measured in seconds since the Unix epoch. + int created; + # Unique identifier for the object. + string id; + # If present, this property tells you the last error encountered when processing the verification. + GelatoSessionLastError? last_error?; + # ID of the most recent VerificationReport. [Learn more about accessing detailed verification results.](https://stripe.com/docs/identity/verification-sessions#results) + string|IdentityVerificationReport? last_verification_report?; + # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. + boolean livemode; + # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. + record {} metadata; + # String representing the object's type. Objects of the same type share the same value. + string 'object; + GelatoVerificationSessionOptions options; + # Redaction status of this VerificationSession. If the VerificationSession is not redacted, this field will be null. + VerificationSessionRedaction? redaction?; + # Status of this VerificationSession. [Learn more about the lifecycle of sessions](https://stripe.com/docs/identity/how-sessions-work). + string status; + # The type of [verification check](https://stripe.com/docs/identity/verification-checks) to be performed. + string 'type; + # The short-lived URL that you use to redirect a user to Stripe to submit their identity information. This URL expires after 48 hours and can only be used once. Don’t store it, log it, send it in emails or expose it to anyone other than the user. Refer to our docs on [verifying identity documents](https://stripe.com/docs/identity/verify-identity-documents?platform=web&type=redirect) to learn how to redirect users to Stripe. + string? url?; + # The user’s verified data. + GelatoVerifiedOutputs? verified_outputs?; }; public type SourceTypeKlarna record { - string? background_image_url?; + string background_image_url?; string? client_token?; - string? first_name?; - string? last_name?; - string? locale?; - string? logo_url?; - string? page_title?; - string? pay_later_asset_urls_descriptive?; - string? pay_later_asset_urls_standard?; - string? pay_later_name?; - string? pay_later_redirect_url?; - string? pay_now_asset_urls_descriptive?; - string? pay_now_asset_urls_standard?; - string? pay_now_name?; - string? pay_now_redirect_url?; - string? pay_over_time_asset_urls_descriptive?; - string? pay_over_time_asset_urls_standard?; - string? pay_over_time_name?; - string? pay_over_time_redirect_url?; - string? payment_method_categories?; - string? purchase_country?; - string? purchase_type?; - string? redirect_url?; - int? shipping_delay?; - string? shipping_first_name?; - string? shipping_last_name?; + string first_name?; + string last_name?; + string locale?; + string logo_url?; + string page_title?; + string pay_later_asset_urls_descriptive?; + string pay_later_asset_urls_standard?; + string pay_later_name?; + string pay_later_redirect_url?; + string pay_now_asset_urls_descriptive?; + string pay_now_asset_urls_standard?; + string pay_now_name?; + string pay_now_redirect_url?; + string pay_over_time_asset_urls_descriptive?; + string pay_over_time_asset_urls_standard?; + string pay_over_time_name?; + string pay_over_time_redirect_url?; + string payment_method_categories?; + string purchase_country?; + string purchase_type?; + string redirect_url?; + int shipping_delay?; + string shipping_first_name?; + string shipping_last_name?; }; public type PaymentMethodDetailsIdeal record { @@ -196,76 +244,76 @@ public type SourceReceiverFlow record { # The address of the receiver source. This is the value that should be communicated to the customer to send their funds to. string? address?; # The total amount that was moved to your balance. This is almost always equal to the amount charged. In rare cases when customers deposit excess funds and we are unable to refund those, those funds get moved to your balance and show up in amount_charged as well. The amount charged is expressed in the source's currency. - int? amount_charged; + int amount_charged; # The total amount received by the receiver source. `amount_received = amount_returned + amount_charged` should be true for consumed sources unless customers deposit excess funds. The amount received is expressed in the source's currency. - int? amount_received; + int amount_received; # The total amount that was returned to the customer. The amount returned is expressed in the source's currency. - int? amount_returned; + int amount_returned; # Type of refund attribute method, one of `email`, `manual`, or `none`. - string? refund_attributes_method; + string refund_attributes_method; # Type of refund attribute status, one of `missing`, `requested`, or `available`. - string? refund_attributes_status; + string refund_attributes_status; }; public type V1PricesBody record { # Whether the price can be used for new purchases. Defaults to `true`. - boolean? active?; + boolean active?; # Describes 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. - string? billing_scheme?; + string billing_scheme?; # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). - string? currency; + string currency; # Specifies which fields in the response should be expanded. - string[]? expand?; + string[] expand?; # A lookup key used to retrieve prices dynamically from a static string. - string? lookup_key?; + string lookup_key?; # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. record {} metadata?; # A brief description of the price, hidden from customers. - string? nickname?; + string nickname?; # The ID of the product that this price will belong to. - string? product?; + string product?; # These fields can be used to create a new product that this price will belong to. - InlineProductParams? product_data?; + InlineProductParams product_data?; # The recurring components of a price such as `interval` and `usage_type`. - Recurring1? recurring?; + Recurring1 recurring?; # 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. - string? tax_behavior?; + string tax_behavior?; # Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`. - Tier[]? tiers?; + Tier[] tiers?; # 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 successively change as the quantity grows. - string? tiers_mode?; + string tiers_mode?; # If set to true, will atomically remove the lookup key from the existing price, and assign it to this price. - boolean? transfer_lookup_key?; + boolean transfer_lookup_key?; # Apply a transformation to the reported usage or set quantity before computing the billed price. Cannot be combined with `tiers`. - TransformUsageParam? transform_quantity?; + TransformUsageParam transform_quantity?; # A positive integer in %s (or 0 for a free price) representing how much to charge. - int? unit_amount?; + int unit_amount?; # Same as `unit_amount`, but accepts a decimal value in %s with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set. - string? unit_amount_decimal?; + string unit_amount_decimal?; }; public type PaymentIntentNextActionWechatPayRedirectToAndroidApp record { # app_id is the APP ID registered on WeChat open platform - string? app_id; + string app_id; # nonce_str is a random string - string? nonce_str; + string nonce_str; # package is static value - string? package; + string package; # an unique merchant ID assigned by Wechat Pay - string? partner_id; + string partner_id; # an unique trading ID assigned by Wechat Pay - string? prepay_id; + string prepay_id; # A signature - string? sign; + string sign; # Specifies the current time in epoch format - string? timestamp; + string timestamp; }; # The Pause Collection settings determine how we will pause collection for this subscription and for how long the subscription # should be paused. public type SubscriptionsResourcePauseCollection record { # The payment collection behavior for this subscription while paused. One of `keep_as_draft`, `mark_uncollectible`, or `void`. - string? behavior; + string behavior; # The time after which the subscription will resume collecting payments. int? resumes_at?; }; @@ -296,20 +344,20 @@ public type AccountBusinessProfile record { string? url?; }; -public type TaxRateArray string[]?; +public type TaxRateArray string[]; -public type InvoiceSettingsCustomFields CustomFieldParams[]?; +public type InvoiceSettingsCustomFields CustomFieldParams[]; public type GetInvoicesUpcomingRequestBody record { - ItemBillingThresholdsParam|string? billing_thresholds?; - boolean? clear_usage?; - boolean? deleted?; - string? id?; - record {}|string? metadata?; - string? price?; - RecurringPriceData1? price_data?; - int? quantity?; - string[]|string? tax_rates?; + ItemBillingThresholdsParam|string billing_thresholds?; + boolean clear_usage?; + boolean deleted?; + string id?; + record {}|string metadata?; + string price?; + RecurringPriceData1 price_data?; + int quantity?; + string[]|string tax_rates?; }; public type InvoiceSettingSubscriptionScheduleSetting record { @@ -317,6 +365,11 @@ public type InvoiceSettingSubscriptionScheduleSetting record { int? days_until_due?; }; +public type GelatoVerificationReportOptions record { + GelatoReportDocumentOptions document?; + GelatoReportIdNumberOptions id_number?; +}; + public type ThreeDSecureDetails record { # For authenticated transactions: how the customer was authenticated by # the issuing bank. @@ -330,55 +383,66 @@ public type ThreeDSecureDetails record { string? 'version?; }; +public type ExternalAccount BankAccount|Card; + # These fields can be used to create a new product that this price will belong to. public type InlineProductParams record { # Whether the product is currently available for purchase. Defaults to true. - boolean? active?; + boolean active?; # The ID of the product that this price will belong to. - string? id?; + string id?; # 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata record {} metadata?; # The product’s name, meant to be displayable to the customer. Whenever this product is sold via a subscription, name will show up on associated invoice line item descriptions - string? name; + string name; # An arbitrary string to be displayed on your customer’s credit card or bank statement. While most banks display this information consistently, some may display it incorrectly or not at all - string? statement_descriptor?; + string statement_descriptor?; # A tax code ID - string? tax_code?; + string tax_code?; # 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 - string? unit_label?; + string unit_label?; }; public type AccountSepaDebitPaymentsSettings record { # SEPA creditor identifier that identifies the company making the payment. - string? creditor_id?; + string creditor_id?; }; public type ChargeTransferData record { # The amount transferred to the destination account, if specified. By default, the entire charge amount is transferred to the destination account. int? amount?; # ID of an existing, connected Stripe account to transfer funds to if `transfer_data` was specified in the charge request. - string|Account? destination; + string|Account destination; }; public type PaymentIntentNextActionVerifyWithMicrodeposits record { # The timestamp when the microdeposits are expected to land. - int? arrival_date; + int arrival_date; # The URL for the hosted verification page, which allows customers to verify their bank account. - string? hosted_verification_url; + string hosted_verification_url; +}; + +public type BalanceAmountBySourceType record { + # Amount for bank account. + int bank_account?; + # Amount for card. + int card?; + # Amount for FPX. + int fpx?; }; public type SubscriptionScheduleCurrentPhase record { # The end of this phase of the subscription schedule. - int? end_date; + int end_date; # The start of this phase of the subscription schedule. - int? start_date; + int start_date; }; public type PaymentMethodAttachBody record { # The ID of the customer to which to attach the PaymentMethod. - string? customer; + string customer; # Specifies which fields in the response should be expanded. - string[]? expand?; + string[] expand?; }; public type PaymentMethodDetailsP24 record { @@ -398,14 +462,14 @@ public type AccountTosAcceptance record { # The IP address from which the account representative accepted their service agreement string? ip?; # The user's service agreement type - string? service_agreement?; + string service_agreement?; # The user agent of the browser from which the account representative accepted their service agreement string? user_agent?; }; public type AutomaticTax record { # Whether Stripe automatically computes tax on this invoice. - boolean? enabled; + boolean enabled; # The status of the most recent automated tax calculation for this invoice. string? status?; }; @@ -422,33 +486,33 @@ public type AutomaticTax record { # Related guide: [Creating Separate Charges and Transfers](https://stripe.com/docs/connect/charges-transfers). public type Transfer record { # Amount in %s to be transferred. - int? amount; + int amount; # Amount in %s reversed (can be less than the amount attribute on the transfer if a partial reversal was issued). - int? amount_reversed; + int amount_reversed; # Balance transaction that describes the impact of this transfer on your account balance. string|BalanceTransaction? balance_transaction?; # Time that this record of the transfer was first created. - int? created; + int created; # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). - string? currency; + string currency; # An arbitrary string attached to the object. Often useful for displaying to users. string? description?; # ID of the Stripe account the transfer was sent to. string|Account? destination?; # If the destination is a Stripe account, this will be the ID of the payment that the destination account received for the transfer. - string|Charge? destination_payment?; + string|Charge destination_payment?; # Unique identifier for the object. - string? id; + string id; # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. - boolean? livemode; + boolean livemode; # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. record {} metadata; # String representing the object's type. Objects of the same type share the same value. - string? 'object; + string 'object; # A list of reversals that have been applied to the transfer. - TransferReversalList? reversals; + TransferReversalList reversals; # Whether the transfer has been fully reversed. If the transfer is only partially reversed, this attribute will still be false. - boolean? reversed; + boolean reversed; # ID of the charge or payment that was used to fund the transfer. If null, the transfer was funded from the available balance. string|Charge? source_transaction?; # The source balance this transfer came from. One of `card`, `fpx`, or `bank_account`. @@ -479,31 +543,31 @@ public type SubscriptionSchedule record { # Time at which the subscription schedule was completed. Measured in seconds since the Unix epoch. int? completed_at?; # Time at which the object was created. Measured in seconds since the Unix epoch. - int? created; + int created; # Object representing the start and end dates for the current phase of the subscription schedule, if it is `active`. SubscriptionScheduleCurrentPhase? current_phase?; # ID of the customer who owns the subscription schedule. - string|Customer|DeletedCustomer? customer; + string|Customer|DeletedCustomer customer; # Object representing the subscription schedule’s default settings - SubscriptionSchedulesResourceDefaultSettings? default_settings; + SubscriptionSchedulesResourceDefaultSettings default_settings; # Behavior of the subscription schedule and underlying subscription when it ends. Possible values are `release` and `cancel`. - string? end_behavior; + string end_behavior; # Unique identifier for the object. - string? id; + string id; # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. - boolean? livemode; + boolean livemode; # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. record {} metadata?; # String representing the object's type. Objects of the same type share the same value. - string? 'object; + string 'object; # Configuration for the subscription schedule's phases. - SubscriptionSchedulePhaseConfiguration[]? phases; + SubscriptionSchedulePhaseConfiguration[] phases; # Time at which the subscription schedule was released. Measured in seconds since the Unix epoch. int? released_at?; # ID of the subscription once managed by the subscription schedule (if it is released). string? released_subscription?; # The present status of the subscription schedule. Possible values are `not_started`, `active`, `completed`, `released`, and `canceled`. You can read more about the different states in our [behavior guide](https://stripe.com/docs/billing/subscriptions/subscription-schedules). - string? status; + string status; # ID of the subscription managed by the subscription schedule. string|Subscription? subscription?; }; @@ -523,11 +587,11 @@ public type DeletedBankAccount record { # Three-letter [ISO code for the currency](https://stripe.com/docs/payouts) paid out to the bank account. string? currency?; # Always true for a deleted object - boolean? deleted; + boolean deleted; # Unique identifier for the object. - string? id; + string id; # String representing the object's type. Objects of the same type share the same value. - string? 'object; + string 'object; }; # To share the contents of a `File` object with non-Stripe users, you can @@ -535,21 +599,21 @@ public type DeletedBankAccount record { # retrieve the contents of the file without authentication. public type FileLink record { # Time at which the object was created. Measured in seconds since the Unix epoch. - int? created; + int created; # Whether this link is already expired. - boolean? expired; + boolean expired; # Time at which the link expires. int? expires_at?; # The file object this link points to. - string|File? file; + string|File file; # Unique identifier for the object. - string? id; + string id; # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. - boolean? livemode; + boolean livemode; # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. record {} metadata; # String representing the object's type. Objects of the same type share the same value. - string? 'object; + string 'object; # The publicly accessible URL to download the file. string? url?; }; @@ -567,20 +631,20 @@ public type SourceOrderItem record { # The ID of the associated object for this line item. Expandable if not null (e.g., expandable to a SKU). string? parent?; # The quantity of this order item. When type is `sku`, this is the number of instances of the SKU to be ordered. - int? quantity?; + int quantity?; # The type of this order item. Must be `sku`, `tax`, or `shipping`. string? 'type?; }; public type SubscriptionItemsItemBody record { # Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. When updating, pass an empty string to remove previously-defined thresholds. - BillingThresholds|string? billing_thresholds?; + BillingThresholds|string billing_thresholds?; # Specifies which fields in the response should be expanded. - string[]? expand?; + string[] expand?; # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. - AdditionalProperties|string? metadata?; + AdditionalProperties|string metadata?; # Indicates if a customer is on or off-session while an invoice payment is attempted. - boolean? off_session?; + boolean off_session?; # 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. For example, SCA regulation may require 3DS authentication to complete payment. See the [SCA Migration Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior. # # Use `default_incomplete` to transition the subscription to `status=past_due` when payment is required and await explicit confirmation of the invoice's payment intent. This allows simpler management of scenarios where additional user actions are needed to pay a subscription’s invoice. Such as failed payments, [SCA regulation](https://stripe.com/docs/billing/migration/strong-customer-authentication), or collecting a mandate for a bank debit payment method. @@ -588,23 +652,23 @@ public type SubscriptionItemsItemBody record { # Use `pending_if_incomplete` to update the subscription using [pending updates](https://stripe.com/docs/billing/subscriptions/pending-updates). When you use `pending_if_incomplete` you can only pass the parameters [supported by pending updates](https://stripe.com/docs/billing/pending-updates-reference#supported-attributes). # # Use `error_if_incomplete` if you want Stripe to return an HTTP 402 status code if a subscription's invoice cannot be paid. For example, if a payment method requires 3DS authentication due to SCA regulation and further user action is needed, this parameter does not update the subscription and returns an error instead. This was the default behavior for API versions prior to 2019-03-14. See the [changelog](https://stripe.com/docs/upgrades#2019-03-14) to learn more. - string? payment_behavior?; + string payment_behavior?; # The ID of the price object. When changing a subscription item's price, `quantity` is set to 1 unless a `quantity` parameter is provided. - string? price?; + string price?; # Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. - RecurringPriceData? price_data?; + RecurringPriceData price_data?; # Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#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. Valid values are `create_prorations`, `none`, or `always_invoice`. # # Passing `create_prorations` will cause proration invoice items to be created when applicable. These proration items will only be invoiced immediately under [certain conditions](https://stripe.com/docs/subscriptions/upgrading-downgrading#immediate-payment). In order to always invoice immediately for prorations, pass `always_invoice`. # # Prorations can be disabled by passing `none`. - string? proration_behavior?; + string proration_behavior?; # If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply the same proration that was previewed with the [upcoming invoice](https://stripe.com/docs/api#retrieve_customer_invoice) endpoint. - int? proration_date?; + int proration_date?; # The quantity you'd like to apply to the subscription item you're creating. - int? quantity?; + int quantity?; # A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will override the [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates) on the Subscription. When updating, pass an empty string to remove previously-defined tax rates. - TaxRateArray|string? tax_rates?; + TaxRateArray|string tax_rates?; }; public type LegalEntityPersonVerification record { @@ -614,9 +678,9 @@ public type LegalEntityPersonVerification record { string? details?; # One of `document_address_mismatch`, `document_dob_mismatch`, `document_duplicate_type`, `document_id_number_mismatch`, `document_name_mismatch`, `document_nationality_mismatch`, `failed_keyed_identity`, or `failed_other`. A machine-readable code specifying the verification state for the person. string? details_code?; - LegalEntityPersonVerificationDocument? document?; + LegalEntityPersonVerificationDocument document?; # The state of verification for the person. Possible values are `unverified`, `pending`, or `verified`. - string? status; + string status; }; public type LegalEntityCompanyVerificationDocument record { @@ -632,18 +696,18 @@ public type LegalEntityCompanyVerificationDocument record { public type InvoiceItemThresholdReason record { # The IDs of the line items that triggered the threshold invoice. - string[]? line_item_ids; + string[] line_item_ids; # The quantity threshold boundary that applied to the given line item. - int? usage_gte; + int usage_gte; }; public type InvoiceTaxAmount record { # The amount, in %s, of the tax. - int? amount; + int amount; # Whether this tax amount is inclusive or exclusive. - boolean? inclusive; + boolean inclusive; # The tax rate that was applied to get this tax amount. - string|TaxRate? tax_rate; + string|TaxRate tax_rate; }; public type StatusTransitions record { @@ -659,11 +723,11 @@ public type StatusTransitions record { public type TransferData record { # Amount intended to be collected by this PaymentIntent. A positive integer representing how much to charge in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The minimum amount is $0.50 US or [equivalent in charge currency](https://stripe.com/docs/currencies#minimum-and-maximum-charge-amounts). The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99). - int? amount?; + int amount?; # 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. - string|Account? destination; + string|Account destination; }; public type PaymentMethodCardWalletVisaCheckout record { @@ -677,10 +741,48 @@ public type PaymentMethodCardWalletVisaCheckout record { Address? shipping_address?; }; +# The Billing customer portal is a Stripe-hosted UI for subscription and +# billing management. +# +# A portal configuration describes the functionality and features that you +# want to provide to your customers through the portal. +# +# A portal session describes the instantiation of the customer portal for +# a particular customer. By visiting the session's URL, the customer +# can manage their subscriptions and billing details. For security reasons, +# sessions are short-lived and will expire if the customer does not visit the URL. +# Create sessions on-demand when customers intend to manage their subscriptions +# and billing details. +# +# Learn more in the [product overview](https://stripe.com/docs/billing/subscriptions/customer-portal) +# and [integration guide](https://stripe.com/docs/billing/subscriptions/integrating-customer-portal). +public type BillingPortalSession record { + # The configuration used by this session, describing the features available. + string|BillingPortalConfiguration configuration; + # Time at which the object was created. Measured in seconds since the Unix epoch. + int created; + # The ID of the customer for this session. + string customer; + # Unique identifier for the object. + string id; + # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. + boolean livemode; + # The IETF language tag of the locale Customer Portal is displayed in. If blank or auto, the customer’s `preferred_locales` or browser’s locale is used. + string? locale?; + # String representing the object's type. Objects of the same type share the same value. + string 'object; + # The account for which the session was created on behalf of. When specified, only subscriptions and invoices with this `on_behalf_of` account appear in the portal. For more information, see the [docs](https://stripe.com/docs/connect/charges-transfers#on-behalf-of). Use the [Accounts API](https://stripe.com/docs/api/accounts/object#account_object-settings-branding) to modify the `on_behalf_of` account's branding settings, which the portal displays. + string? on_behalf_of?; + # The URL to redirect customers to when they click on the portal's link to return to your website. + string return_url; + # The short-lived URL of the session that gives customers access to the customer portal. + string url; +}; + public type PaymentFlowsPrivatePaymentMethodsAlipay record { }; -public type SubscriptionCancelAt int|string?; +public type SubscriptionCancelAt int|string; public type PaymentMethodDetailsCardWalletMasterpass record { # Owner's verified billing address. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated. @@ -693,6 +795,13 @@ public type PaymentMethodDetailsCardWalletMasterpass record { Address? shipping_address?; }; +public type PortalSubscriptionCancellationReason record { + # Whether the feature is enabled. + boolean enabled; + # Which cancellation reasons will be given as options to the customer. + string[] options; +}; + public type IssuingDisputeMerchandiseNotAsDescribedEvidence record { # (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute. string|File? additional_documentation?; @@ -710,9 +819,9 @@ public type IssuingDisputeMerchandiseNotAsDescribedEvidence record { public type QuotesResourceFromQuote record { # Whether this quote is a revision of a different quote. - boolean? is_revision; + boolean is_revision; # The quote that was cloned. - string|Quote? quote; + string|Quote quote; }; # These bank accounts are payment methods on `Customer` objects. @@ -736,9 +845,9 @@ public type BankAccount record { # Name of the bank associated with the routing number (e.g., `WELLS FARGO`). string? bank_name?; # Two-letter ISO code representing the country the bank account is located in. - string? country; + string country; # Three-letter [ISO code for the currency](https://stripe.com/docs/payouts) paid out to the bank account. - string? currency; + string currency; # The ID of the customer that the bank account is associated with. string|Customer|DeletedCustomer? customer?; # Whether this bank account is the default external account for its currency. @@ -746,34 +855,34 @@ public type BankAccount record { # Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. string? fingerprint?; # Unique identifier for the object. - string? id; + string id; # The last four digits of the bank account number. - string? last4; + string last4; # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. record {} metadata?; # String representing the object's type. Objects of the same type share the same value. - string? 'object; + string 'object; # The routing transit number for the bank account. string? routing_number?; # For bank accounts, possible values are `new`, `validated`, `verified`, `verification_failed`, or `errored`. A bank account that hasn't had any activity or validation performed is `new`. If Stripe can determine that the bank account exists, its status will be `validated`. Note that there often isn’t enough information to know (e.g., for smaller credit unions), and the validation is not always run. If customer bank account verification has succeeded, the bank account status will be `verified`. If the verification failed for any reason, such as microdeposit failure, the status will be `verification_failed`. If a transfer sent to this bank account fails, we'll set the status to `errored` and will not continue to send transfers until the bank details are updated. # # For external accounts, possible values are `new` and `errored`. Validations aren't run against external accounts because they're only used for payouts. This means the other statuses don't apply. If a transfer fails, the status is set to `errored` and transfers are stopped until account details are updated. - string? status; + string status; }; public type IssuingAuthorizationPendingRequest record { # The additional amount Stripe will hold if the authorization is approved, in the card's [currency](https://stripe.com/docs/api#issuing_authorization_object-pending-request-currency) and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). - int? amount; + int amount; # Detailed breakdown of amount components. These amounts are denominated in `currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). IssuingAuthorizationAmountDetails? amount_details?; # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). - string? currency; + string currency; # If set `true`, you may provide [amount](https://stripe.com/docs/api/issuing/authorizations/approve#approve_issuing_authorization-amount) to control how much to hold for the authorization. - boolean? is_amount_controllable; + boolean is_amount_controllable; # The amount the merchant is requesting to be authorized in the `merchant_currency`. The amount is in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). - int? merchant_amount; + int merchant_amount; # The local currency the merchant is requesting to authorize. - string? merchant_currency; + string merchant_currency; }; public type PaymentMethodCardWalletAmexExpressCheckout record { @@ -788,25 +897,25 @@ public type SourceTypeCard record { string? dynamic_last4?; int? exp_month?; int? exp_year?; - string? fingerprint?; + string fingerprint?; string? funding?; string? last4?; string? name?; - string? three_d_secure?; + string three_d_secure?; string? tokenization_method?; }; public type TaxParam1 record { - string|string? ip_address?; + string|string ip_address?; }; public type MandateAcssDebit record { # Description of the interval. Only required if the 'payment_schedule' parameter is 'interval' or 'combined'. string? interval_description?; # Payment schedule for the mandate. - string? payment_schedule; + string payment_schedule; # Transaction type of the mandate. - string? transaction_type; + string transaction_type; }; public type PaymentIntentPaymentMethodOptionsCard record { @@ -820,18 +929,23 @@ public type PaymentIntentPaymentMethodOptionsCard record { string? request_three_d_secure?; }; -public type InlineResponse2001 Customer|DeletedCustomer?; +public type InlineResponse2001 Customer|DeletedCustomer; + +public type SourceMandateNotificationBacsDebitData record { + # Last 4 digits of the account number associated with the debit. + string last4?; +}; # The customer's current subscriptions, if any. public type SubscriptionList record { # Details about each object. - Subscription[]? data; + Subscription[] data; # True if this list has another page of items after this one that can be fetched. - boolean? has_more; + boolean has_more; # String representing the object's type. Objects of the same type share the same value. Always has the value `list`. - string? 'object; + string 'object; # The URL where this list can be accessed. - string? url; + string url; }; public type PaymentFlowsPrivatePaymentMethodsAlipayDetails record { @@ -842,54 +956,95 @@ public type PaymentFlowsPrivatePaymentMethodsAlipayDetails record { }; public type InlineResponse2003 record { - SubscriptionSchedule[]? data; + SubscriptionSchedule[] data; # True if this list has another page of items after this one that can be fetched. - boolean? has_more; + boolean has_more; # String representing the object's type. Objects of the same type share the same value. Always has the value `list`. - string? 'object; + string 'object; # The URL where this list can be accessed. - string? url; + string url; }; public type InlineResponse2002 record { - Subscription[]? data; + Subscription[] data; + # True if this list has another page of items after this one that can be fetched. + boolean has_more; + # String representing the object's type. Objects of the same type share the same value. Always has the value `list`. + string 'object; + # The URL where this list can be accessed. + string url; +}; + +# List of items contained within this value list. +public type RadarListListItemList record { + # Details about each object. + RadarValueListItem[] data; # True if this list has another page of items after this one that can be fetched. - boolean? has_more; + boolean has_more; # String representing the object's type. Objects of the same type share the same value. Always has the value `list`. - string? 'object; + string 'object; # The URL where this list can be accessed. - string? url; + string url; }; public type DeletedProduct record { # Always true for a deleted object - boolean? deleted; + boolean deleted; + # Unique identifier for the object. + string id; + # String representing the object's type. Objects of the same type share the same value. + string 'object; +}; + +# Value list items allow you to add specific values to a given Radar value list, which can then be used in rules. +# +# Related guide: [Managing List Items](https://stripe.com/docs/radar/lists#managing-list-items). +public type RadarValueListItem record { + # Time at which the object was created. Measured in seconds since the Unix epoch. + int created; + # The name or email address of the user who added this item to the value list. + string created_by; # Unique identifier for the object. - string? id; + string id; + # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. + boolean livemode; # String representing the object's type. Objects of the same type share the same value. - string? 'object; + string 'object; + # The value of the item. + string value; + # The identifier of the value list this item belongs to. + string value_list; }; public type DeletedCustomer record { # Always true for a deleted object - boolean? deleted; + boolean deleted; + # Unique identifier for the object. + string id; + # String representing the object's type. Objects of the same type share the same value. + string 'object; +}; + +public type DeletedInvoiceitem record { + # Always true for a deleted object + boolean deleted; # Unique identifier for the object. - string? id; + string id; # String representing the object's type. Objects of the same type share the same value. - string? 'object; + string 'object; }; public type ShippingMethod record { # A positive integer in the smallest currency unit (that is, 100 cents for $1.00, or 1 for ¥1, Japanese Yen being a zero-decimal currency) representing the total amount for the line item. - int? amount; + int amount; # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). - string? currency; + string currency; # The estimated delivery date for the given shipping method. Can be either a specific date or a range. DeliveryEstimate? delivery_estimate?; # An arbitrary string attached to the object. Often useful for displaying to users. - string? description; + string description; # Unique identifier for the object. - string? id; + string id; }; public type PaymentMethodOptionsIdeal record { @@ -897,9 +1052,9 @@ public type PaymentMethodOptionsIdeal record { public type CustomerTaxLocation record { # The customer's country as identified by Stripe Tax. - string? country; + string country; # The data source used to infer the customer's location. - string? 'source; + string 'source; # The customer's state, county, province, or region as identified by Stripe Tax. string? state?; }; @@ -921,9 +1076,9 @@ public type PaymentMethodDetailsInteracPresent record { # Authorization response cryptogram. string? emv_auth_data?; # Two-digit number representing the card's expiration month. - int? exp_month; + int exp_month; # Four-digit number representing the card's expiration year. - int? exp_year; + int exp_year; # Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number. # # *Starting May 1, 2021, card fingerprint in India for Connect will change to allow two fingerprints for the same card --- one for India and one for the rest of the world.* @@ -944,46 +1099,55 @@ public type PaymentMethodDetailsInteracPresent record { PaymentMethodDetailsInteracPresentReceipt? receipt?; }; +public type DeletedSubscriptionItem record { + # Always true for a deleted object + boolean deleted; + # Unique identifier for the object. + string id; + # String representing the object's type. Objects of the same type share the same value. + string 'object; +}; + public type QuotesResourceTotalDetails record { # This is the sum of all the line item discounts. - int? amount_discount; + int amount_discount; # This is the sum of all the line item shipping amounts. int? amount_shipping?; # This is the sum of all the line item tax amounts. - int? amount_tax; - QuotesResourceTotalDetailsResourceBreakdown? breakdown?; + int amount_tax; + QuotesResourceTotalDetailsResourceBreakdown breakdown?; }; public type CustomFieldParams record { - string? name; - string? value; + string name; + string value; }; # A list of refunds that have been applied to the charge. public type RefundList record { # Details about each object. - Refund[]? data; + Refund[] data; # True if this list has another page of items after this one that can be fetched. - boolean? has_more; + boolean has_more; # String representing the object's type. Objects of the same type share the same value. Always has the value `list`. - string? 'object; + string 'object; # The URL where this list can be accessed. - string? url; + string url; }; public type ApiErrors record { # For card errors, the ID of the failed charge. - string? charge?; + string charge?; # For some errors that could be handled programmatically, a short string indicating the [error code](https://stripe.com/docs/error-codes) reported. - string? code?; + string code?; # For card errors resulting from a card issuer decline, a short string indicating the [card issuer's reason for the decline](https://stripe.com/docs/declines#issuer-declines) if they provide one. - string? decline_code?; + string decline_code?; # A URL to more information about the [error code](https://stripe.com/docs/error-codes) reported. - string? doc_url?; + string doc_url?; # A human-readable message providing more details about the error. For card errors, these messages can be shown to your users. - string? message?; + string message?; # 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. - string? param?; + string param?; # A PaymentIntent guides you through the process of collecting a payment from your customer. # We recommend that you create exactly one PaymentIntent for each order or # customer session in your system. You can reference the PaymentIntent later to @@ -995,15 +1159,15 @@ public type ApiErrors record { # authentication flows and ultimately creates at most one successful charge. # # Related guide: [Payment Intents API](https://stripe.com/docs/payments/payment-intents). - PaymentIntent? payment_intent?; + PaymentIntent payment_intent?; # PaymentMethod objects represent your customer's payment instruments. # They can be used with [PaymentIntents](https://stripe.com/docs/payments/payment-intents) to collect payments or saved to # Customer objects to store instrument details for future payments. # # Related guides: [Payment Methods](https://stripe.com/docs/payments/payment-methods) and [More Payment Scenarios](https://stripe.com/docs/payments/more-payment-scenarios). - PaymentMethod? payment_method?; + PaymentMethod payment_method?; # 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. - string? payment_method_type?; + string payment_method_type?; # A SetupIntent guides you through the process of setting up and saving a customer's payment credentials for future payments. # For example, you could use a SetupIntent to set up and save your customer's card without immediately collecting a payment. # Later, you can use [PaymentIntents](https://stripe.com/docs/api#payment_intents) to drive the payment flow. @@ -1026,11 +1190,11 @@ public type ApiErrors record { # even as regulations change over time. # # Related guide: [Setup Intents API](https://stripe.com/docs/payments/setup-intents). - SetupIntent? setup_intent?; + SetupIntent setup_intent?; # The source object for errors returned on a request involving a source. - BankAccount|Card|Source? 'source?; + BankAccount|Card|Source 'source?; # The type of error returned. One of `api_error`, `card_error`, `idempotency_error`, or `invalid_request_error` - string? 'type; + string 'type; }; public type PaymentMethodAuBecsDebit record { @@ -1062,55 +1226,55 @@ public type PersonRelationship record { # Related guide: [How to create a Cardholder](https://stripe.com/docs/issuing/cards#create-cardholder) public type IssuingCardholder record { # The cardholder’s billing information - IssuingCardholderAddress? billing; + IssuingCardholderAddress billing; # Additional information about a `company` cardholder. IssuingCardholderCompany? company?; # Time at which the object was created. Measured in seconds since the Unix epoch. - int? created; + int created; # The cardholder's email address. string? email?; # Unique identifier for the object. - string? id; + string id; # Additional information about an `individual` cardholder. IssuingCardholderIndividual? individual?; # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. - boolean? livemode; + boolean livemode; # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. record {} metadata; # The cardholder's name. This will be printed on cards issued to them. - string? name; + string name; # String representing the object's type. Objects of the same type share the same value. - string? 'object; + string 'object; # The cardholder's phone number. This is required for all cardholders who will be creating EU cards. See the [3D Secure documentation](https://stripe.com/docs/issuing/3d-secure#when-is-3d-secure-applied) for more details. string? phone_number?; - IssuingCardholderRequirements? requirements; + IssuingCardholderRequirements requirements; # Rules that control spending across this cardholder's cards. Refer to our [documentation](https://stripe.com/docs/issuing/controls/spending-controls) for more details. IssuingCardholderAuthorizationControls? spending_controls?; # Specifies whether to permit authorizations on this cardholder's cards. - string? status; + string status; # One of `individual` or `company`. - string? 'type; + string 'type; }; # If this is an `acss_debit` PaymentMethod, this hash contains details about the ACSS Debit payment method. public type PaymentMethodParam record { # Customer’s bank account number - string? account_number; + string account_number; # Institution number of the customer’s bank - string? institution_number; + string institution_number; # Transit number of the customer’s bank - string? transit_number; + string transit_number; }; public type DeliveryEstimate record { # If `type` is `"exact"`, `date` will be the expected delivery date in the format YYYY-MM-DD. - string? date?; + string date?; # If `type` is `"range"`, `earliest` will be be the earliest delivery date in the format YYYY-MM-DD. - string? earliest?; + string earliest?; # If `type` is `"range"`, `latest` will be the latest delivery date in the format YYYY-MM-DD. - string? latest?; + string latest?; # The type of estimate. Must be either `"range"` or `"exact"`. - string? 'type; + string 'type; }; public type SetupAttemptPaymentMethodDetailsAuBecsDebit record { @@ -1124,98 +1288,115 @@ public type PaymentMethodOptionsAfterpayClearpay record { # The cardholder’s billing information public type IssuingCardholderAddress record { - Address? address; + Address address; }; public type PaymentMethodDetailsCardWalletApplePay record { }; public type SourceTypeWechat record { - string? prepay_id?; + string prepay_id?; string? qr_code_url?; - string? statement_descriptor?; + string statement_descriptor?; }; # A list of [file links](https://stripe.com/docs/api#file_links) that point at this file. public type FileFileLinkList record { # Details about each object. - FileLink[]? data; + FileLink[] data; # True if this list has another page of items after this one that can be fetched. - boolean? has_more; + boolean has_more; # String representing the object's type. Objects of the same type share the same value. Always has the value `list`. - string? 'object; + string 'object; # The URL where this list can be accessed. - string? url; + string url; }; public type ChargeFraudDetails record { # Assessments from Stripe. If set, the value is `fraudulent`. - string? stripe_report?; + string stripe_report?; # Assessments reported by you. If set, possible values of are `safe` and `fraudulent`. - string? user_report?; + string user_report?; +}; + +public type PortalSubscriptionCancel record { + PortalSubscriptionCancellationReason cancellation_reason?; + # Whether the feature is enabled. + boolean enabled; + # Whether to cancel subscriptions immediately or at the end of the billing period. + string mode; + # Whether to create prorations when canceling subscriptions. Possible values are `none` and `create_prorations`. + string proration_behavior; +}; + +public type PaymentPagesCheckoutSessionTotalDetailsResourceBreakdown record { + # The aggregated line item discounts. + LineItemsDiscountAmount[] discounts; + # The aggregated line item tax amounts by rate. + LineItemsTaxAmount[] taxes; }; # Object representing the subscription schedule's default settings. public type DefaultSettingsParams record { # A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the application owner’s Stripe account. The request must be made by a platform account on a connected account in order to set an application fee percentage. - decimal? application_fee_percent?; + decimal application_fee_percent?; # Default settings for automatic tax computation - AutomaticTaxConfig2? automatic_tax?; + AutomaticTaxConfig2 automatic_tax?; # Can be set to phase_start to set the anchor to the start of the phase or automatic to automatically change it if needed. Cannot be set to phase_start if this phase specifies a trial - string? billing_cycle_anchor?; + string billing_cycle_anchor?; # Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds - BillingThresholdParams|string? billing_thresholds?; + BillingThresholdParams|string billing_thresholds?; # Either charge_automatically, or send_invoice. When charging automatically, Stripe will attempt to pay the underlying subscription at the end of each billing cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions. Defaults to charge_automatically on creation - string? collection_method?; + string collection_method?; # ID of the default payment method for the subscription schedule. It must belong to the customer associated with the subscription schedule. If not set, invoices will use the default payment method in the customer’s invoice settings - string? default_payment_method?; + string default_payment_method?; # All invoices will be billed using the specified settings - SubscriptionSchedulesParam? invoice_settings?; + SubscriptionSchedulesParam invoice_settings?; # The data with which to automatically create a Transfer for each of the associated subscription’s invoices - TransferDataSpecs|string? transfer_data?; + TransferDataSpecs|string transfer_data?; }; public type InvoicesInvoiceBody record { # The account tax IDs associated with the invoice. Only editable when the invoice is a draft. - string[]|string? account_tax_ids?; + string[]|string account_tax_ids?; # A fee in %s that will be applied to the invoice and transferred to the application owner's Stripe account. The request must be made with an OAuth key or the Stripe-Account header in order to take an application fee. For more information, see the application fees [documentation](https://stripe.com/docs/billing/invoices/connect#collecting-fees). - int? application_fee_amount?; + int application_fee_amount?; # Controls whether Stripe will perform [automatic collection](https://stripe.com/docs/billing/invoices/workflow/#auto_advance) of the invoice. - boolean? auto_advance?; + boolean auto_advance?; # Settings for automatic tax lookup for this invoice. - AutomaticTaxParam? automatic_tax?; + AutomaticTaxParam automatic_tax?; # Either `charge_automatically` or `send_invoice`. This field can be updated only on `draft` invoices. - string? collection_method?; + string collection_method?; # A list of up to 4 custom fields to be displayed on the invoice. If a value for `custom_fields` is specified, the list specified will replace the existing custom field list on this invoice. Pass an empty string to remove previously-defined fields. - InvoiceSettingsCustomFields|string? custom_fields?; + InvoiceSettingsCustomFields|string custom_fields?; # The number of days from which the invoice is created until it is due. Only valid for invoices where `collection_method=send_invoice`. This field can only be updated on `draft` invoices. - int? days_until_due?; + int days_until_due?; # ID of the default payment method for the invoice. It must belong to the customer associated with the invoice. If not set, defaults to the subscription's default payment method, if any, or to the default payment method in the customer's invoice settings. - string? default_payment_method?; + string default_payment_method?; # ID of the default payment source for the invoice. It must belong to the customer associated with the invoice and be in a chargeable state. If not set, defaults to the subscription's default source, if any, or to the customer's default source. - string? default_source?; + string default_source?; # The tax rates that will apply to any line item that does not have `tax_rates` set. Pass an empty string to remove previously-defined tax rates. - string[]|string? default_tax_rates?; + string[]|string default_tax_rates?; # An arbitrary string attached to the object. Often useful for displaying to users. Referenced as 'memo' in the Dashboard. - string? description?; + string description?; # The discounts that will apply to the invoice. Pass an empty string to remove previously-defined discounts. - DiscountsDataParam|string? discounts?; + DiscountsDataParam|string discounts?; # The date on which payment for this invoice is due. Only valid for invoices where `collection_method=send_invoice`. This field can only be updated on `draft` invoices. - int? due_date?; + int due_date?; # Specifies which fields in the response should be expanded. - string[]? expand?; + string[] expand?; # Footer to be displayed on the invoice. - string? footer?; + string footer?; # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. - record {}|string? metadata?; + record {}|string metadata?; # The account (if any) for which the funds of the invoice payment are intended. If set, the invoice will be presented with the branding and support information of the specified account. See the [Invoices with Connect](https://stripe.com/docs/billing/invoices/connect) documentation for details. - string|string? on_behalf_of?; + string|string on_behalf_of?; # Configuration settings for the PaymentIntent that is generated when the invoice is finalized. - PaymentSettings? payment_settings?; + PaymentSettings payment_settings?; # Extra information about a charge for the customer's credit card statement. It must contain at least one letter. If not specified and this invoice is part of a subscription, the default `statement_descriptor` will be set to the first subscription item's product's `statement_descriptor`. - string? statement_descriptor?; + string statement_descriptor?; # If specified, the funds from the invoice will be transferred to the destination and the ID of the resulting transfer will be found on the invoice's charge. This will be unset if you POST an empty value. - DiscountsDataParam|string? transfer_data?; + DiscountsDataParam|string transfer_data?; }; public type SetupIntentPaymentMethodOptionsMandateOptionsSepaDebit record { @@ -1224,13 +1405,13 @@ public type SetupIntentPaymentMethodOptionsMandateOptionsSepaDebit record { # The individual line items that make up the invoice. `lines` is sorted as follows: invoice items in reverse chronological order, followed by the subscription, if any. public type Invoicelineslist1 record { # Details about each object. - LineItem[]? data; + LineItem[] data; # True if this list has another page of items after this one that can be fetched. - boolean? has_more; + boolean has_more; # String representing the object's type. Objects of the same type share the same value. Always has the value `list`. - string? 'object; + string 'object; # The URL where this list can be accessed. - string? url; + string url; }; public type AdditionalProperties record { @@ -1252,11 +1433,26 @@ public type SetupAttemptPaymentMethodDetailsIdeal record { string? verified_name?; }; +# Account Links are the means by which a Connect platform grants a connected account permission to access +# Stripe-hosted applications, such as Connect Onboarding. +# +# Related guide: [Connect Onboarding](https://stripe.com/docs/connect/connect-onboarding). +public type AccountLink record { + # Time at which the object was created. Measured in seconds since the Unix epoch. + int created; + # The timestamp at which this account link will expire. + int expires_at; + # String representing the object's type. Objects of the same type share the same value. + string 'object; + # The URL for the account link. + string url; +}; + public type DiscountsResourceDiscountAmount record { # The amount, in %s, of the discount. - int? amount; + int amount; # The discount that was applied to get this discount amount. - string|Discount|DeletedDiscount? discount; + string|Discount|DeletedDiscount discount; }; public type PaymentMethodCardWalletMasterpass record { @@ -1279,22 +1475,22 @@ public type PaymentMethodIdeal record { public type QuotesResourceRecurring record { # Total before any discounts or taxes are applied. - int? amount_subtotal; + int amount_subtotal; # Total after discounts and taxes are applied. - int? amount_total; + int amount_total; # The frequency at which a subscription is billed. One of `day`, `week`, `month` or `year`. - string? interval; + string interval; # The number of intervals (specified in the `interval` attribute) between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. - int? interval_count; - QuotesResourceTotalDetails? total_details; + int interval_count; + QuotesResourceTotalDetails total_details; }; public type CustomerDetailsParam record { - CustomerAdresss|string? address?; - CustomerAddressWithName|string? shipping?; - TaxParam1? tax?; - string? tax_exempt?; - DataParams[]? tax_ids?; + CustomerAdresss|string address?; + CustomerAddressWithName|string shipping?; + TaxParam1 tax?; + string tax_exempt?; + DataParams[] tax_ids?; }; public type PaymentMethodDetailsCardChecks record { @@ -1307,12 +1503,17 @@ public type PaymentMethodDetailsCardChecks record { }; public type SubscriptionItemCreateParams record { - ItemBillingThresholdsParam|string? billing_thresholds?; + ItemBillingThresholdsParam|string billing_thresholds?; record {} metadata?; - string? price?; - RecurringPriceData1? price_data?; - int? quantity?; - TaxRateArray|string? tax_rates?; + string price?; + RecurringPriceData1 price_data?; + int quantity?; + TaxRateArray|string tax_rates?; +}; + +public type BalanceDetail record { + # Funds that are available for use. + BalanceAmount[] available; }; public type PaymentMethodP24 record { @@ -1321,34 +1522,47 @@ public type PaymentMethodP24 record { }; public type Period1 record { - int? end; - int? 'start; + int end; + int 'start; }; public type TokenParamas record { - string? token; + string token; +}; + +public type SourceTransactionChfCreditTransferData record { + # Reference associated with the transfer. + string reference?; + # Sender's country address. + string sender_address_country?; + # Sender's line 1 address. + string sender_address_line1?; + # Sender's bank account IBAN. + string sender_iban?; + # Sender's name. + string sender_name?; }; # Object representing the subscription schedule's default settings. public type DefaultSettingsParams1 record { - decimal? application_fee_percent?; - AutomaticTaxConfig3? automatic_tax?; - string? billing_cycle_anchor?; - BillingThresholdParams|string? billing_thresholds?; - string? collection_method?; - string? default_payment_method?; - SubscriptionSchedulesParam1? invoice_settings?; - TransferDataSpecs|string? transfer_data?; + decimal application_fee_percent?; + AutomaticTaxConfig3 automatic_tax?; + string billing_cycle_anchor?; + BillingThresholdParams|string billing_thresholds?; + string collection_method?; + string default_payment_method?; + SubscriptionSchedulesParam1 invoice_settings?; + TransferDataSpecs|string transfer_data?; }; public type CardList record { - Card[]? data; + Card[] data; # True if this list has another page of items after this one that can be fetched. - boolean? has_more; + boolean has_more; # String representing the object's type. Objects of the same type share the same value. Always has the value `list`. - string? 'object; + string 'object; # The URL where this list can be accessed. - string? url; + string url; }; public type IssuingDisputeServiceNotAsDescribedEvidence record { @@ -1376,61 +1590,61 @@ public type SourceTypeThreeDSecure record { string? dynamic_last4?; int? exp_month?; int? exp_year?; - string? fingerprint?; + string fingerprint?; string? funding?; string? last4?; string? name?; - string? three_d_secure?; + string three_d_secure?; string? tokenization_method?; }; public type RecurringPriceData1 record { - string? currency; - string? product; - RecurringAdhoc? recurring; - string? tax_behavior?; - int? unit_amount?; - string? unit_amount_decimal?; + string currency; + string product; + RecurringAdhoc recurring; + string tax_behavior?; + int unit_amount?; + string unit_amount_decimal?; }; public type V1CustomersBody record { # The customer's address. - CustomerAdresss|string? address?; + CustomerAdresss|string address?; # An integer amount in %s that represents the customer's current balance, which affect the customer's future invoices. A negative amount represents a credit that decreases the amount due on an invoice; a positive amount increases the amount due on an invoice. - int? balance?; - string? coupon?; + int balance?; + string coupon?; # An arbitrary string that you can attach to a customer object. It is displayed alongside the customer in the dashboard. - string? description?; + string description?; # Customer's email address. It's displayed alongside the customer in your dashboard and can be useful for searching and tracking. This may be up to *512 characters*. - string? email?; + string email?; # Specifies which fields in the response should be expanded. - string[]? expand?; + string[] expand?; # The prefix for the customer used to generate unique invoice numbers. Must be 3–12 uppercase letters or numbers. - string? invoice_prefix?; + string invoice_prefix?; # Default invoice settings for this customer. - CustomerParam? invoice_settings?; + CustomerParam invoice_settings?; # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. - AdditionalProperties|string? metadata?; + AdditionalProperties|string metadata?; # The customer's full name or business name. - string? name?; + string name?; # The sequence to be used on the customer's next invoice. Defaults to 1. - int? next_invoice_sequence?; - string? payment_method?; + int next_invoice_sequence?; + string payment_method?; # The customer's phone number. - string? phone?; + string phone?; # Customer's preferred languages, ordered by preference. - string[]? preferred_locales?; + string[] preferred_locales?; # The API ID of a promotion code to apply to the customer. The customer will have a discount applied on all recurring payments. Charges you create through the API will not have the discount. - string? promotion_code?; + string promotion_code?; # The customer's shipping information. Appears on invoices emailed to this customer. - CustomerAddressWithName|string? shipping?; - string? 'source?; + CustomerAddressWithName|string shipping?; + string 'source?; # Tax details about the customer. - TaxParam? tax?; + TaxParam tax?; # The customer's tax exemption. One of `none`, `exempt`, or `reverse`. - string? tax_exempt?; + string tax_exempt?; # The customer's tax IDs. - DataParams[]? tax_id_data?; + DataParams[] tax_id_data?; }; public type SourceTypeEps record { @@ -1449,7 +1663,16 @@ public type IssuingDisputeOtherEvidence record { string? product_type?; }; -public type PaymentMethodTypesArray string[]?; +public type PaymentMethodTypesArray string[]; + +public type DeletedRadarValueList record { + # Always true for a deleted object + boolean deleted; + # Unique identifier for the object. + string id; + # String representing the object's type. Objects of the same type share the same value. + string 'object; +}; # A SetupIntent guides you through the process of setting up and saving a customer's payment credentials for future payments. # For example, you could use a SetupIntent to set up and save your customer's card without immediately collecting a payment. @@ -1483,7 +1706,7 @@ public type SetupIntent record { # The client secret can be used to complete payment setup from your frontend. It should not be stored, logged, embedded in URLs, or exposed to anyone other than the customer. Make sure that you have TLS enabled on any page that includes the client secret. string? client_secret?; # Time at which the object was created. Measured in seconds since the Unix epoch. - int? created; + int created; # ID of the Customer this SetupIntent belongs to, if one exists. # # If present, the SetupIntent's payment method will be attached to the Customer on successful setup. Payment methods attached to other Customers cannot be used with this SetupIntent. @@ -1491,13 +1714,13 @@ public type SetupIntent record { # An arbitrary string attached to the object. Often useful for displaying to users. string? description?; # Unique identifier for the object. - string? id; + string id; # The error encountered in the previous SetupIntent confirmation. ApiErrors? last_setup_error?; # The most recent SetupAttempt for this SetupIntent. string|SetupAttempt? latest_attempt?; # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. - boolean? livemode; + boolean livemode; # ID of the multi use Mandate generated by the SetupIntent. string|Mandate? mandate?; # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. @@ -1505,7 +1728,7 @@ public type SetupIntent record { # If present, this property tells you what actions you need to take in order for your customer to continue payment setup. SetupIntentNextAction? next_action?; # String representing the object's type. Objects of the same type share the same value. - string? 'object; + string 'object; # The account (if any) for which the setup is intended. string|Account? on_behalf_of?; # ID of the payment method used with this SetupIntent. @@ -1513,15 +1736,15 @@ public type SetupIntent record { # Payment-method-specific configuration for this SetupIntent. SetupIntentPaymentMethodOptions? payment_method_options?; # The list of payment method types (e.g. card) that this SetupIntent is allowed to set up. - string[]? payment_method_types; + string[] payment_method_types; # ID of the single_use Mandate generated by the SetupIntent. string|Mandate? single_use_mandate?; # [Status](https://stripe.com/docs/payments/intents#intent-statuses) of this SetupIntent, one of `requires_payment_method`, `requires_confirmation`, `requires_action`, `processing`, `canceled`, or `succeeded`. - string? status; + string status; # Indicates how the payment method is intended to be used in the future. # # Use `on_session` if you intend to only reuse the payment method when the customer is in your checkout flow. Use `off_session` if your customer may or may not be in your checkout flow. If not provided, this value defaults to `off_session`. - string? usage; + string usage; }; # As a [card issuer](https://stripe.com/docs/issuing), you can dispute transactions that the cardholder does not recognize, suspects to be fraudulent, or has other issues with. @@ -1529,27 +1752,27 @@ public type SetupIntent record { # Related guide: [Disputing Transactions](https://stripe.com/docs/issuing/purchases/disputes) public type IssuingDispute record { # Disputed amount. Usually the amount of the `transaction`, but can differ (usually because of currency fluctuation). - int? amount; + int amount; # List of balance transactions associated with the dispute. BalanceTransaction[]? balance_transactions?; # Time at which the object was created. Measured in seconds since the Unix epoch. - int? created; + int created; # The currency the `transaction` was made in. - string? currency; + string currency; # Evidence for the dispute. Evidence contains exactly two non-null fields: the reason for the dispute and the associated evidence field for the selected reason - IssuingDisputeEvidence? evidence; + IssuingDisputeEvidence evidence; # Unique identifier for the object. - string? id; + string id; # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. - boolean? livemode; + boolean livemode; # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. record {} metadata; # String representing the object's type. Objects of the same type share the same value. - string? 'object; + string 'object; # Current status of the dispute. - string? status; + string status; # The transaction being disputed. - string|IssuingTransaction? 'transaction; + string|IssuingTransaction 'transaction; }; public type CardIssuingAccountTermsOfService record { @@ -1558,7 +1781,16 @@ public type CardIssuingAccountTermsOfService record { # The IP address from which the account representative accepted the service agreement. string? ip?; # The user agent of the browser from which the account representative accepted the service agreement. - string? user_agent?; + string user_agent?; +}; + +public type DeletedPerson record { + # Always true for a deleted object + boolean deleted; + # Unique identifier for the object. + string id; + # String representing the object's type. Objects of the same type share the same value. + string 'object; }; public type PaymentMethodSepaDebit record { @@ -1602,24 +1834,26 @@ public type SetupAttemptPaymentMethodDetailsBancontact record { string? verified_name?; }; +public type DeletedExternalAccount DeletedBankAccount|DeletedCard; + public type PaymentMethodDetailsStripeAccount record { }; # List of subscription items, each with an attached price. public type SubscriptionItemList record { # Details about each object. - SubscriptionItem[]? data; + SubscriptionItem[] data; # True if this list has another page of items after this one that can be fetched. - boolean? has_more; + boolean has_more; # String representing the object's type. Objects of the same type share the same value. Always has the value `list`. - string? 'object; + string 'object; # The URL where this list can be accessed. - string? url; + string url; }; public type TaxIdVerification record { # Verification status, one of `pending`, `verified`, `unverified`, or `unavailable`. - string? status; + string status; # Verified address. string? verified_address?; # Verified name. @@ -1631,29 +1865,29 @@ public type TaxIdVerification record { # Related guide: [Tax Rates](https://stripe.com/docs/billing/taxes/tax-rates). public type TaxRate record { # Defaults to `true`. When set to `false`, this tax rate cannot be used with new applications or Checkout Sessions, but will still work for subscriptions and invoices that already have it set. - boolean? active; + boolean active; # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). string? country?; # Time at which the object was created. Measured in seconds since the Unix epoch. - int? created; + int created; # An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers. string? description?; # The display name of the tax rates as it will appear to your customer on their receipt email, PDF, and the hosted invoice page. - string? display_name; + string display_name; # Unique identifier for the object. - string? id; + string id; # This specifies if the tax rate is inclusive or exclusive. - boolean? inclusive; + boolean inclusive; # The jurisdiction for the tax rate. You can use this label field for tax reporting purposes. It also appears on your customer’s invoice. string? jurisdiction?; # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. - boolean? livemode; + boolean livemode; # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. record {} metadata?; # String representing the object's type. Objects of the same type share the same value. - string? 'object; + string 'object; # This represents the tax rate percent out of 100. - decimal? percentage; + decimal percentage; # [ISO 3166-2 subdivision code](https://en.wikipedia.org/wiki/ISO_3166-2:US), without country prefix. For example, "NY" for New York, United States. string? state?; # The high-level tax type, such as `vat` or `sales_tax`. @@ -1661,7 +1895,7 @@ public type TaxRate record { }; public type Shipping record { - Address? address?; + Address address?; # The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc. string? carrier?; # Recipient name. @@ -1679,6 +1913,15 @@ public type AccountDashboardSettings record { string? timezone?; }; +public type SourceMandateNotificationSepaDebitData record { + # SEPA creditor ID. + string creditor_identifier?; + # Last 4 digits of the account number associated with the debit. + string last4?; + # Mandate reference associated with the debit. + string mandate_reference?; +}; + # A coupon contains information about a percent-off or amount-off discount you # might want to apply to a customer. Coupons may be applied to [invoices](https://stripe.com/docs/api#invoices) or # [orders](https://stripe.com/docs/api#create_order-coupon). Coupons do not work with conventional one-off [charges](https://stripe.com/docs/api#create_charge). @@ -1686,19 +1929,19 @@ public type Coupon record { # Amount (in the `currency` specified) that will be taken off the subtotal of any invoices for this customer. int? amount_off?; # Contains information about what this coupon applies to - CouponAppliesTo? applies_to?; + CouponAppliesTo applies_to?; # Time at which the object was created. Measured in seconds since the Unix epoch. - int? created; + int created; # If `amount_off` has been set, the three-letter [ISO code for the currency](https://stripe.com/docs/currencies) of the amount to take off. string? currency?; # One of `forever`, `once`, and `repeating`. Describes how long a customer who applies this coupon will get the discount. - string? duration; + string duration; # If `duration` is `repeating`, the number of months the coupon applies. Null if coupon `duration` is `forever` or `once`. int? duration_in_months?; # Unique identifier for the object. - string? id; + string id; # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. - boolean? livemode; + boolean livemode; # Maximum number of times this coupon can be redeemed, in total, across all customers, before it is no longer valid. int? max_redemptions?; # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. @@ -1706,15 +1949,15 @@ public type Coupon record { # Name of the coupon displayed to customers on for instance invoices or receipts. string? name?; # String representing the object's type. Objects of the same type share the same value. - string? 'object; + string 'object; # Percent that will be taken off the subtotal of any invoices for this customer for the duration of the coupon. For example, a coupon with percent_off of 50 will make a %s100 invoice %s50 instead. decimal? percent_off?; # Date after which the coupon can no longer be redeemed. int? redeem_by?; # Number of times this coupon has been applied to a customer. - int? times_redeemed; + int times_redeemed; # Taking account of the above properties, whether this coupon can still be applied to a customer. - boolean? valid; + boolean valid; }; public type PaymentMethodDetailsCardWalletSamsungPay record { @@ -1727,6 +1970,15 @@ public type QuotesResourceSubscriptionData record { int? trial_period_days?; }; +public type DeletedAccount record { + # Always true for a deleted object + boolean deleted; + # Unique identifier for the object. + string id; + # String representing the object's type. Objects of the same type share the same value. + string 'object; +}; + public type PaymentMethodDetailsWechatPay record { # Uniquely identifies this particular WeChat Pay account. You can use this attribute to check whether two WeChat accounts are the same. string? fingerprint?; @@ -1739,53 +1991,53 @@ public type PaymentMethodBancontact record { public type PlatformTaxFee record { # The Connected account that incurred this charge. - string? account; + string account; # Unique identifier for the object. - string? id; + string id; # String representing the object's type. Objects of the same type share the same value. - string? 'object; + string 'object; # The payment object that caused this tax to be inflicted. - string? source_transaction; + string source_transaction; # The type of tax (VAT). - string? 'type; + string 'type; }; public type IssuingAuthorizationVerificationData record { # Whether the cardholder provided an address first line and if it matched the cardholder’s `billing.address.line1`. - string? address_line1_check; + string address_line1_check; # Whether the cardholder provided a postal code and if it matched the cardholder’s `billing.address.postal_code`. - string? address_postal_code_check; + string address_postal_code_check; # Whether the cardholder provided a CVC and if it matched Stripe’s record. - string? cvc_check; + string cvc_check; # Whether the cardholder provided an expiry date and if it matched Stripe’s record. - string? expiry_check; + string expiry_check; }; public type AlipayAccount record { # Time at which the object was created. Measured in seconds since the Unix epoch. - int? created; + int created; # The ID of the customer associated with this Alipay Account. string|Customer|DeletedCustomer? customer?; # Uniquely identifies the account and will be the same across all Alipay account objects that are linked to the same Alipay account. - string? fingerprint; + string fingerprint; # Unique identifier for the object. - string? id; + string id; # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. - boolean? livemode; + boolean livemode; # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. record {} metadata?; # String representing the object's type. Objects of the same type share the same value. - string? 'object; + string 'object; # If the Alipay account object is not reusable, the exact amount that you can create a charge for. int? payment_amount?; # If the Alipay account object is not reusable, the exact currency that you can create a charge for. string? payment_currency?; # True if you can create multiple payments using this account. If the account is reusable, then you can freely choose the amount of each payment. - boolean? reusable; + boolean reusable; # Whether this Alipay account object has ever been used for a payment. - boolean? used; + boolean used; # The username for the Alipay account. - string? username; + string username; }; public type IssuingDisputeFraudulentEvidence record { @@ -1813,16 +2065,16 @@ public type AccountRequirements record { }; public type CreatedFilterOptions record { - int? gt?; - int? gte?; - int? lt?; - int? lte?; + int gt?; + int gte?; + int lt?; + int lte?; }; public type PaymentIntentPaymentMethodOptionsAcssDebit record { - PaymentIntentPaymentMethodOptionsMandateOptionsAcssDebit? mandate_options?; + PaymentIntentPaymentMethodOptionsMandateOptionsAcssDebit mandate_options?; # Bank account verification method. - string? verification_method?; + string verification_method?; }; public type PaymentMethodDetailsCardInstallmentsPlan record { @@ -1832,43 +2084,52 @@ public type PaymentMethodDetailsCardInstallmentsPlan record { # One of `month`. string? interval?; # Type of installment plan, one of `fixed_count`. - string? 'type; + string 'type; }; public type OptionalFieldsAddress record { - string? city?; - string? country?; - string? line1?; - string? line2?; - string? postal_code?; - string? state?; + string city?; + string country?; + string line1?; + string line2?; + string postal_code?; + string state?; +}; + +public type PortalBusinessProfile record { + # The messaging shown to customers in the portal. + string? headline?; + # A link to the business’s publicly available privacy policy. + string privacy_policy_url; + # A link to the business’s publicly available terms of service. + string terms_of_service_url; }; # If this is an `au_becs_debit` PaymentMethod, this hash contains details about the bank account. public type Param record { # The account number for the bank account - string? account_number; + string account_number; # Bank-State-Branch number of the bank account - string? bsb_number; + string bsb_number; }; public type BitcoinReceiver record { # True when this bitcoin receiver has received a non-zero amount of bitcoin. - boolean? active; + boolean active; # The amount of `currency` that you are collecting as payment. - int? amount; + int amount; # The amount of `currency` to which `bitcoin_amount_received` has been converted. - int? amount_received; + int amount_received; # The amount of bitcoin that the customer should send to fill the receiver. The `bitcoin_amount` is denominated in Satoshi: there are 10^8 Satoshi in one bitcoin. - int? bitcoin_amount; + int bitcoin_amount; # The amount of bitcoin that has been sent by the customer to this receiver. - int? bitcoin_amount_received; + int bitcoin_amount_received; # This URI can be displayed to the customer as a clickable link (to activate their bitcoin client) or as a QR code (for mobile wallets). - string? bitcoin_uri; + string bitcoin_uri; # Time at which the object was created. Measured in seconds since the Unix epoch. - int? created; + int created; # Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) to which the bitcoin will be converted. - string? currency; + string currency; # The customer ID of the bitcoin receiver. string? customer?; # An arbitrary string attached to the object. Often useful for displaying to users. @@ -1876,29 +2137,38 @@ public type BitcoinReceiver record { # The customer's email address, set by the API call that creates the receiver. string? email?; # This flag is initially false and updates to true when the customer sends the `bitcoin_amount` to this receiver. - boolean? filled; + boolean filled; # Unique identifier for the object. - string? id; + string id; # A bitcoin address that is specific to this receiver. The customer can send bitcoin to this address to fill the receiver. - string? inbound_address; + string inbound_address; # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. - boolean? livemode; + boolean livemode; # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. record {} metadata?; # String representing the object's type. Objects of the same type share the same value. - string? 'object; + string 'object; # The ID of the payment created from the receiver, if any. Hidden when viewing the receiver with a publishable key. string? payment?; # The refund address of this bitcoin receiver. string? refund_address?; # A list with one entry for each time that the customer sent bitcoin to the receiver. Hidden when viewing the receiver with a publishable key. - BitcoinTransactionList? transactions?; + BitcoinTransactionList transactions?; # This receiver contains uncaptured funds that can be used for a payment or refunded. - boolean? uncaptured_funds; + boolean uncaptured_funds; # Indicate if this source is used for payment. boolean? used_for_payment?; }; +public type PortalFeatures record { + PortalCustomerUpdate customer_update; + PortalInvoiceList invoice_history; + PortalPaymentMethodUpdate payment_method_update; + PortalSubscriptionCancel subscription_cancel; + PortalSubscriptionPause subscription_pause; + PortalSubscriptionUpdate subscription_update; +}; + # Stores representations of [stock keeping units](http://en.wikipedia.org/wiki/Stock_keeping_unit). # SKUs describe specific product variations, taking into account any combination of: attributes, # currency, and cost. For example, a product may be a T-shirt, whereas a specific SKU represents @@ -1909,48 +2179,48 @@ public type BitcoinReceiver record { # Related guide: [Tax, Shipping, and Inventory](https://stripe.com/docs/orders). public type Sku record { # Whether the SKU is available for purchase. - boolean? active; + boolean active; # A dictionary of attributes and values for the attributes defined by the product. If, for example, a product's attributes are `["size", "gender"]`, a valid SKU has the following dictionary of attributes: `{"size": "Medium", "gender": "Unisex"}`. record {} attributes; # Time at which the object was created. Measured in seconds since the Unix epoch. - int? created; + int created; # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). - string? currency; + string currency; # Unique identifier for the object. - string? id; + string id; # The URL of an image for this SKU, meant to be displayable to the customer. string? image?; # Description of the SKU’s inventory - SkuInventory? inventory; + SkuInventory inventory; # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. - boolean? livemode; + boolean livemode; # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. record {} metadata; # String representing the object's type. Objects of the same type share the same value. - string? 'object; + string 'object; # The dimensions of this SKU for shipping purposes. PackageDimensions? package_dimensions?; # The cost of the item as a positive integer in the smallest currency unit (that is, 100 cents to charge $1.00, or 100 to charge ¥100, Japanese Yen being a zero-decimal currency). - int? price; + int price; # The ID of the product this SKU is associated with. The product must be currently active. - string|Product? product; + string|Product product; # Time at which the object was last updated. Measured in seconds since the Unix epoch. - int? updated; + int updated; }; public type DisputeEvidenceDetails record { # Date by which evidence must be submitted in order to successfully challenge dispute. Will be null if the customer's bank or credit card company doesn't allow a response for this particular dispute. int? due_by?; # Whether evidence has been staged for this dispute. - boolean? has_evidence; + boolean has_evidence; # Whether the last evidence submission was submitted past the due date. Defaults to `false` if no evidence submissions have occurred. If `true`, then delivery of the latest evidence is *not* guaranteed. - boolean? past_due; + boolean past_due; # The number of times evidence has been submitted. Typically, you may only submit evidence once. - int? submission_count; + int submission_count; }; public type PaymentIntentPaymentMethodOptionsSepaDebit record { - PaymentIntentPaymentMethodOptionsMandateOptionsSepaDebit? mandate_options?; + PaymentIntentPaymentMethodOptionsMandateOptionsSepaDebit mandate_options?; }; public type PaymentMethodDetailsAfterpayClearpay record { @@ -1958,6 +2228,19 @@ public type PaymentMethodDetailsAfterpayClearpay record { string? reference?; }; +public type SourceMandateNotificationAcssDebitData record { + # The statement descriptor associate with the debit. + string statement_descriptor?; +}; + +public type SigmaScheduledQueryRunError record { + # Information about the run failure. + string message; +}; + +public type GelatoReportIdNumberOptions record { +}; + public type Address record { # City, district, suburb, town, or village. string? city?; @@ -1976,35 +2259,106 @@ public type Address record { # Automatic tax settings for this subscription. public type AutomaticTaxConfig record { # Enabled - boolean? enabled; + boolean enabled; +}; + +public type UsageRecordSummary record { + # Unique identifier for the object. + string id; + # The invoice in which this usage period has been billed for. + string? invoice?; + # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. + boolean livemode; + # String representing the object's type. Objects of the same type share the same value. + string 'object; + Period period; + # The ID of the subscription item this summary is describing. + string subscription_item; + # The total usage within this usage period. + int total_usage; +}; + +public type PaymentSource Account|AlipayAccount|BankAccount|BitcoinReceiver|Card|Source; + +# Tokenization is the process Stripe uses to collect sensitive card or bank +# account details, or personally identifiable information (PII), directly from +# your customers in a secure manner. A token representing this information is +# returned to your server to use. You should use our +# [recommended payments integrations](https://stripe.com/docs/payments) to perform this process +# client-side. This ensures that no sensitive card data touches your server, +# and allows your integration to operate in a PCI-compliant way. +# +# If you cannot use client-side tokenization, you can also create tokens using +# the API with either your publishable or secret API key. Keep in mind that if +# your integration uses this method, you are responsible for any PCI compliance +# that may be required, and you must keep your secret API key safe. Unlike with +# client-side tokenization, your customer's information is not sent directly to +# Stripe, so we cannot determine how it is handled or stored. +# +# Tokens cannot be stored or used more than once. To store card or bank account +# information for later use, you can create [Customer](https://stripe.com/docs/api#customers) +# objects or [Custom accounts](https://stripe.com/docs/api#external_accounts). Note that +# [Radar](https://stripe.com/docs/radar), our integrated solution for automatic fraud protection, +# performs best with integrations that use client-side tokenization. +# +# Related guide: [Accept a payment](https://stripe.com/docs/payments/accept-a-payment-charges#web-create-token) +public type Token record { + # These bank accounts are payment methods on `Customer` objects. + # + # On the other hand [External Accounts](https://stripe.com/docs/api#external_accounts) are transfer + # destinations on `Account` objects for [Custom accounts](https://stripe.com/docs/connect/custom-accounts). + # They can be bank accounts or debit cards as well, and are documented in the links above. + # + # Related guide: [Bank Debits and Transfers](https://stripe.com/docs/payments/bank-debits-transfers). + BankAccount bank_account?; + # You can store multiple cards on a customer in order to charge the customer + # later. You can also store multiple debit cards on a recipient in order to + # transfer to those cards later. + # + # Related guide: [Card Payments with Sources](https://stripe.com/docs/sources/cards). + Card card?; + # IP address of the client that generated the token. + string? client_ip?; + # Time at which the object was created. Measured in seconds since the Unix epoch. + int created; + # Unique identifier for the object. + string id; + # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. + boolean livemode; + # String representing the object's type. Objects of the same type share the same value. + string 'object; + # Type of the token: `account`, `bank_account`, `card`, or `pii`. + string 'type; + # Whether this token has already been used (tokens can be used only once). + boolean used; }; public type CustomerCardDetails record { - string? address_city?; - string? address_country?; - string? address_line1?; - string? address_line2?; - string? address_state?; - string? address_zip?; - string? cvc?; - int? exp_month; - int? exp_year; + string address_city?; + string address_country?; + string address_line1?; + string address_line2?; + string address_state?; + string address_zip?; + string cvc?; + int exp_month; + int exp_year; record {} metadata?; - string? name?; - string? number; - string? 'object?; + string name?; + string number; + string 'object?; }; -public type SubscriptionCancelAt1 int|string?; +public type SubscriptionCancelAt1 int|string; # A phase describes the plans, coupon, and trialing status of a subscription for a predefined time period. public type SubscriptionSchedulePhaseConfiguration record { # A list of prices and quantities that will generate invoice items appended to the first invoice for this phase. - SubscriptionScheduleAddInvoiceItem[]? add_invoice_items; + SubscriptionScheduleAddInvoiceItem[] add_invoice_items; # A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the application owner's Stripe account during this phase of the schedule. decimal? application_fee_percent?; # Automatic tax configuration details - SchedulesPhaseAutomaticTax? automatic_tax?; + SchedulesPhaseAutomaticTax automatic_tax?; # Possible values are `phase_start` or `automatic`. If `phase_start` then billing cycle anchor of the subscription is set to the start of the phase when entering the phase. If `automatic` then the billing cycle anchor is automatically modified as needed when entering the phase. For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle). string? billing_cycle_anchor?; # Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period @@ -2018,21 +2372,29 @@ public type SubscriptionSchedulePhaseConfiguration record { # The default tax rates to apply to the subscription during this phase of the subscription schedule. TaxRate[]? default_tax_rates?; # The end of this phase of the subscription schedule. - int? end_date; + int end_date; # The invoice settings applicable during this phase. InvoiceSettingSubscriptionScheduleSetting? invoice_settings?; # Subscription items to configure the subscription to during this phase of the subscription schedule. - SubscriptionScheduleConfigurationItem[]? items; + SubscriptionScheduleConfigurationItem[] items; # If the subscription schedule will prorate when transitioning to this phase. Possible values are `create_prorations` and `none`. - string? proration_behavior; + string proration_behavior; # The start of this phase of the subscription schedule. - int? start_date; + int start_date; # The account (if any) the associated 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. SubscriptionTransferData? transfer_data?; # When the trial ends within the phase. int? trial_end?; }; +# Shows last VerificationSession error +public type GelatoSessionLastError record { + # A short machine-readable string giving the reason for the verification or user-session failure. + string? code?; + # A message that explains the reason for verification or user-session failure. + string? reason?; +}; + public type SetupAttemptPaymentMethodDetailsSofort record { # Bank code of bank associated with the bank account. string? bank_code?; @@ -2061,53 +2423,53 @@ public type IssuingCardholderIndividual record { # The date of birth of this cardholder. IssuingCardholderIndividualDob? dob?; # The first name of this cardholder. - string? first_name; + string first_name; # The last name of this cardholder. - string? last_name; + string last_name; # Government-issued ID document for this cardholder. IssuingCardholderVerification? verification?; }; public type OneTimePriceData record { - string? currency; - string? product; - string? tax_behavior?; - int? unit_amount?; - string? unit_amount_decimal?; + string currency; + string product; + string tax_behavior?; + int unit_amount?; + string unit_amount_decimal?; }; # Payment settings to pass to invoices created by the subscription. public type PaymentSettings2 record { - PaymentMethodOptions? payment_method_options?; - string[]|string? payment_method_types?; + PaymentMethodOptions payment_method_options?; + string[]|string payment_method_types?; }; # Payment settings to pass to invoices created by the subscription. public type PaymentSettings1 record { - PaymentMethodOptions1? payment_method_options?; - PaymentMethodTypesArray|string? payment_method_types?; + PaymentMethodOptions1 payment_method_options?; + PaymentMethodTypesArray|string payment_method_types?; }; public type BillingDetailsAddress record { - string? city?; - string? country?; - string? line1?; - string? line2?; - string? postal_code?; - string? state?; + string city?; + string country?; + string line1?; + string line2?; + string postal_code?; + string state?; }; # Evidence for the dispute. Evidence contains exactly two non-null fields: the reason for the dispute and the associated evidence field for the selected reason public type IssuingDisputeEvidence record { - IssuingDisputeCanceledEvidence? canceled?; - IssuingDisputeDuplicateEvidence? duplicate?; - IssuingDisputeFraudulentEvidence? fraudulent?; - IssuingDisputeMerchandiseNotAsDescribedEvidence? merchandise_not_as_described?; - IssuingDisputeNotReceivedEvidence? not_received?; - IssuingDisputeOtherEvidence? other?; + IssuingDisputeCanceledEvidence canceled?; + IssuingDisputeDuplicateEvidence duplicate?; + IssuingDisputeFraudulentEvidence fraudulent?; + IssuingDisputeMerchandiseNotAsDescribedEvidence merchandise_not_as_described?; + IssuingDisputeNotReceivedEvidence not_received?; + IssuingDisputeOtherEvidence other?; # The reason for filing the dispute. Its value will match the field containing the evidence. - string? reason; - IssuingDisputeServiceNotAsDescribedEvidence? service_not_as_described?; + string reason; + IssuingDisputeServiceNotAsDescribedEvidence service_not_as_described?; }; public type AccountBrandingSettings record { @@ -2122,61 +2484,90 @@ public type AccountBrandingSettings record { }; public type SetupAttemptPaymentMethodDetails record { - SetupAttemptPaymentMethodDetailsAcssDebit? acss_debit?; - SetupAttemptPaymentMethodDetailsAuBecsDebit? au_becs_debit?; - SetupAttemptPaymentMethodDetailsBacsDebit? bacs_debit?; - SetupAttemptPaymentMethodDetailsBancontact? bancontact?; - SetupAttemptPaymentMethodDetailsCard? card?; - SetupAttemptPaymentMethodDetailsCardPresent? card_present?; - SetupAttemptPaymentMethodDetailsIdeal? ideal?; - SetupAttemptPaymentMethodDetailsSepaDebit? sepa_debit?; - SetupAttemptPaymentMethodDetailsSofort? sofort?; + SetupAttemptPaymentMethodDetailsAcssDebit acss_debit?; + SetupAttemptPaymentMethodDetailsAuBecsDebit au_becs_debit?; + SetupAttemptPaymentMethodDetailsBacsDebit bacs_debit?; + SetupAttemptPaymentMethodDetailsBancontact bancontact?; + SetupAttemptPaymentMethodDetailsCard card?; + SetupAttemptPaymentMethodDetailsCardPresent card_present?; + SetupAttemptPaymentMethodDetailsIdeal ideal?; + SetupAttemptPaymentMethodDetailsSepaDebit sepa_debit?; + SetupAttemptPaymentMethodDetailsSofort sofort?; # The type of the payment method used in the SetupIntent (e.g., `card`). An additional hash is included on `payment_method_details` with a name matching this value. It contains confirmation-specific information for the payment method. - string? 'type; + string 'type; +}; + +# This is an object representing a capability for a Stripe account. +# +# Related guide: [Account capabilities](https://stripe.com/docs/connect/account-capabilities). +public type Capability record { + # The account for which the capability enables functionality. + string|Account account; + # The identifier for the capability. + string id; + # String representing the object's type. Objects of the same type share the same value. + string 'object; + # Whether the capability has been requested. + boolean requested; + # Time at which the capability was requested. Measured in seconds since the Unix epoch. + int? requested_at?; + AccountCapabilityRequirements requirements?; + # The status of the capability. Can be `active`, `inactive`, `pending`, or `unrequested`. + string status; }; public type PaymentMethodOptions record { - record {string? preferred_language?;}|string? bancontact?; - record {string? request_three_d_secure?;}|string? card?; + record {string preferred_language?;}|string bancontact?; + record {string request_three_d_secure?;}|string card?; }; # A list of returns that have taken place for this order. public type OrdersResourceOrderReturnList record { # Details about each object. - OrderReturn[]? data; + OrderReturn[] data; # True if this list has another page of items after this one that can be fetched. - boolean? has_more; + boolean has_more; # String representing the object's type. Objects of the same type share the same value. Always has the value `list`. - string? 'object; + string 'object; # The URL where this list can be accessed. - string? url; + string url; +}; + +# Point in Time +public type GelatoDataDocumentReportExpirationDate record { + # Numerical day between 1 and 31. + int? day?; + # Numerical month between 1 and 12. + int? month?; + # The four-digit year. + int? year?; }; -public type CreatedDetails CreatedFilterOptions|int?; +public type CreatedDetails CreatedFilterOptions|int; public type LineItemsTaxAmount record { # Amount of tax applied for this rate. - int? amount; + int amount; # Tax rates can be applied to [invoices](https://stripe.com/docs/billing/invoices/tax-rates), [subscriptions](https://stripe.com/docs/billing/subscriptions/taxes) and [Checkout Sessions](https://stripe.com/docs/payments/checkout/set-up-a-subscription#tax-rates) to collect tax. # # Related guide: [Tax Rates](https://stripe.com/docs/billing/taxes/tax-rates). - TaxRate? rate; + TaxRate rate; }; public type SetupIntentPaymentMethodOptionsAcssDebit record { # Currency supported by the bank account string? currency?; - SetupIntentPaymentMethodOptionsMandateOptionsAcssDebit? mandate_options?; + SetupIntentPaymentMethodOptionsMandateOptionsAcssDebit mandate_options?; # Bank account verification method. - string? verification_method?; + string verification_method?; }; public type SetupAttemptPaymentMethodDetailsAcssDebit record { }; public type DataParams record { - string? 'type; - string? value; + string 'type; + string value; }; public type IssuingCardholderIdDocument record { @@ -2203,11 +2594,11 @@ public type IssuingDisputeDuplicateEvidence record { public type Application record { # Unique identifier for the object. - string? id; + string id; # The name of the application. string? name?; # String representing the object's type. Objects of the same type share the same value. - string? 'object; + string 'object; }; # This is an object representing a person associated with a Stripe account. @@ -2218,13 +2609,13 @@ public type Application record { # Related guide: [Handling Identity Verification with the API](https://stripe.com/docs/connect/identity-verification-api#person-information). public type Person record { # The account the person is associated with. - string? account; - Address? address?; + string account; + Address address?; LegalEntityJapanAddress? address_kana?; LegalEntityJapanAddress? address_kanji?; # Time at which the object was created. Measured in seconds since the Unix epoch. - int? created; - LegalEntityDob? dob?; + int created; + LegalEntityDob dob?; # The person's email address. string? email?; # The person's first name. @@ -2236,9 +2627,9 @@ public type Person record { # The person's gender (International regulations require either "male" or "female"). string? gender?; # Unique identifier for the object. - string? id; + string id; # Whether the person's `id_number` was provided. - boolean? id_number_provided?; + boolean id_number_provided?; # The person's last name. string? last_name?; # The Kana variation of the person's last name (Japan only). @@ -2252,16 +2643,16 @@ public type Person record { # The country where the person is a national. string? nationality?; # String representing the object's type. Objects of the same type share the same value. - string? 'object; + string 'object; # The person's phone number. string? phone?; # 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. - string? political_exposure?; - PersonRelationship? relationship?; + string political_exposure?; + PersonRelationship relationship?; PersonRequirements? requirements?; # Whether the last four digits of the person's Social Security number have been provided (U.S. only). - boolean? ssn_last_4_provided?; - LegalEntityPersonVerification? verification?; + boolean ssn_last_4_provided?; + LegalEntityPersonVerification verification?; }; public type QuotesResourceStatusTransitions record { @@ -2275,7 +2666,7 @@ public type QuotesResourceStatusTransitions record { public type InvoiceVoidBody record { # Specifies which fields in the response should be expanded. - string[]? expand?; + string[] expand?; }; # A discount represents the actual application of a coupon to a particular @@ -2289,23 +2680,23 @@ public type Discount record { # A coupon contains information about a percent-off or amount-off discount you # might want to apply to a customer. Coupons may be applied to [invoices](https://stripe.com/docs/api#invoices) or # [orders](https://stripe.com/docs/api#create_order-coupon). Coupons do not work with conventional one-off [charges](https://stripe.com/docs/api#create_charge). - Coupon? coupon; + Coupon coupon; # The ID of the customer associated with this discount. string|Customer|DeletedCustomer? customer?; # 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. int? end?; # The ID of the discount object. Discounts cannot be fetched by ID. Use `expand[]=discounts` in API calls to expand discount IDs in an array. - string? id; + string id; # The invoice that the discount's coupon was applied to, if it was applied directly to a particular invoice. string? invoice?; # The invoice item `id` (or invoice line item `id` for invoice line items of type='subscription') that the discount's coupon was applied to, if it was applied directly to a particular invoice item or invoice line item. string? invoice_item?; # String representing the object's type. Objects of the same type share the same value. - string? 'object; + string 'object; # The promotion code applied to create this discount. string|PromotionCode? promotion_code?; # Date that the coupon was applied. - int? 'start; + int 'start; # The subscription that this coupon is applied to, if it is applied to a particular subscription. string? subscription?; }; @@ -2321,32 +2712,60 @@ public type PaymentMethodDetailsBacsDebit record { string? sort_code?; }; -public type CurrentPeriodStart RangeQuerySpecs|int?; +public type CurrentPeriodStart RangeQuerySpecs|int; + +# Result from a document check +public type GelatoDocumentReport record { + # Address as it appears in the document. + Address? address?; + # Date of birth as it appears in the document. + GelatoDataDocumentReportDateOfBirth? dob?; + # Details on the verification error. Present when status is `unverified`. + GelatoDocumentReportError? _error?; + # Expiration date of the document. + GelatoDataDocumentReportExpirationDate? expiration_date?; + # Array of [File](https://stripe.com/docs/api/files) ids containing images for this document. + string[]? files?; + # First name as it appears in the document. + string? first_name?; + # Issued date of the document. + GelatoDataDocumentReportIssuedDate? issued_date?; + # Issuing country of the document. + string? issuing_country?; + # Last name as it appears in the document. + string? last_name?; + # Document ID number. + string? number?; + # Status of this `document` check. + string status; + # Type of the document. + string? 'type?; +}; public type SourceTypeCardPresent record { - string? application_cryptogram?; - string? application_preferred_name?; + string application_cryptogram?; + string application_preferred_name?; string? authorization_code?; - string? authorization_response_code?; + string authorization_response_code?; string? brand?; string? country?; - string? cvm_type?; + string cvm_type?; string? data_type?; - string? dedicated_file_name?; - string? emv_auth_data?; + string dedicated_file_name?; + string emv_auth_data?; string? evidence_customer_signature?; string? evidence_transaction_certificate?; int? exp_month?; int? exp_year?; - string? fingerprint?; + string fingerprint?; string? funding?; string? last4?; string? pos_device_id?; - string? pos_entry_mode?; + string pos_entry_mode?; string? read_method?; string? reader?; - string? terminal_verification_results?; - string? transaction_status_information?; + string terminal_verification_results?; + string transaction_status_information?; }; public type RadarReviewResourceSession record { @@ -2362,31 +2781,42 @@ public type RadarReviewResourceSession record { public type TransferSchedule record { # The number of days charges for the account will be held before being paid out. - int? delay_days; + int delay_days; # How frequently funds will be paid out. One of `manual` (payouts only created via API call), `daily`, `weekly`, or `monthly`. - string? interval; + string interval; # The day of the month funds will be paid out. Only shown if `interval` is monthly. Payouts scheduled between the 29th and 31st of the month are sent on the last day of shorter months. - int? monthly_anchor?; + int monthly_anchor?; # The day of the week funds will be paid out, of the style 'monday', 'tuesday', etc. Only shown if `interval` is weekly. - string? weekly_anchor?; + string weekly_anchor?; }; # If specified, the funds from the invoice will be transferred to the destination and the ID of the resulting transfer will be found on the invoice's charge. public type TransferDataSpecs1 record { - int? amount?; - string? destination; + int amount?; + string destination; }; # If specified, the funds from the subscription's invoices will be transferred to the destination and the ID of the resulting transfers will be found on the resulting charges. public type TransferDataSpecs2 record { - decimal? amount_percent?; - string? destination; + decimal amount_percent?; + string destination; +}; + +public type CheckoutAcssDebitMandateOptions record { + # A URL for custom mandate text + string custom_mandate_url?; + # Description of the interval. Only required if the 'payment_schedule' parameter is 'interval' or 'combined'. + string? interval_description?; + # Payment schedule for the mandate. + string? payment_schedule?; + # Transaction type of the mandate. + string? transaction_type?; }; # An Add Invoice Item describes the prices and quantities that will be added as pending invoice items when entering a phase. public type SubscriptionScheduleAddInvoiceItem record { # ID of the price used to generate the invoice item. - string|Price|DeletedPrice? price; + string|Price|DeletedPrice price; # The quantity of the invoice item. int? quantity?; # The tax rates which apply to the item. When set, the `default_tax_rates` do not apply to this item. @@ -2394,8 +2824,8 @@ public type SubscriptionScheduleAddInvoiceItem record { }; public type TransferDataSpecs3 record { - decimal? amount_percent?; - string? destination; + decimal amount_percent?; + string destination; }; public type SourceTypeSofort record { @@ -2409,43 +2839,67 @@ public type SourceTypeSofort record { }; public type PhaseConfigurationParams1 record { - AddInvoiceItemEntry1[]? add_invoice_items?; - decimal? application_fee_percent?; - AutomaticTaxConfig3? automatic_tax?; - string? billing_cycle_anchor?; - BillingThresholdParams|string? billing_thresholds?; - string? collection_method?; - string? coupon?; - string? default_payment_method?; - string[]|string? default_tax_rates?; - int|string? end_date?; - SubscriptionSchedulesParam1? invoice_settings?; - ConfigurationItemParams[]? items; - int? iterations?; - string? proration_behavior?; - int|string? start_date?; - TransferDataSpecs3? transfer_data?; - boolean? trial?; - int|string? trial_end?; + AddInvoiceItemEntry1[] add_invoice_items?; + decimal application_fee_percent?; + AutomaticTaxConfig3 automatic_tax?; + string billing_cycle_anchor?; + BillingThresholdParams|string billing_thresholds?; + string collection_method?; + string coupon?; + string default_payment_method?; + string[]|string default_tax_rates?; + int|string end_date?; + SubscriptionSchedulesParam1 invoice_settings?; + ConfigurationItemParams[] items; + int iterations?; + string proration_behavior?; + int|string start_date?; + TransferDataSpecs3 transfer_data?; + boolean trial?; + int|string trial_end?; }; public type SourceCodeVerificationFlow record { # The number of attempts remaining to authenticate the source object with a verification code. - int? attempts_remaining; + int attempts_remaining; # The status of the code verification, either `pending` (awaiting verification, `attempts_remaining` should be greater than 0), `succeeded` (successful verification) or `failed` (failed verification, cannot be verified anymore as `attempts_remaining` should be 0). - string? status; + string status; +}; + +# This resource has been renamed to [Early Fraud +# Warning](#early_fraud_warning_object) and will be removed in a future API +# version. +public type IssuerFraudRecord record { + # An IFR is actionable if it has not received a dispute and has not been fully refunded. You may wish to proactively refund a charge that receives an IFR, in order to avoid receiving a dispute later. + boolean actionable; + # ID of the charge this issuer fraud record is for, optionally expanded. + string|Charge charge; + # Time at which the object was created. Measured in seconds since the Unix epoch. + int created; + # The type of fraud labelled by the issuer. One of `card_never_received`, `fraudulent_card_application`, `made_with_counterfeit_card`, `made_with_lost_card`, `made_with_stolen_card`, `misc`, `unauthorized_use_of_card`. + string fraud_type; + # If true, the associated charge is subject to [liability shift](https://stripe.com/docs/payments/3d-secure#disputed-payments). + boolean has_liability_shift; + # Unique identifier for the object. + string id; + # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. + boolean livemode; + # String representing the object's type. Objects of the same type share the same value. + string 'object; + # The timestamp at which the card issuer posted the issuer fraud record. + int post_date; }; public type ThreeDSecureUsage record { # Whether 3D Secure is supported on this card. - boolean? supported; + boolean supported; }; public type RangeQuerySpecs record { - int? gt?; - int? gte?; - int? lt?; - int? lte?; + int gt?; + int gte?; + int lt?; + int lte?; }; public type SepaDebitGeneratedFrom record { @@ -2467,6 +2921,18 @@ public type PaymentIntentNextActionRedirectToUrl record { string? url?; }; +# A Connection Token is used by the Stripe Terminal SDK to connect to a reader. +# +# Related guide: [Fleet Management](https://stripe.com/docs/terminal/creating-locations). +public type TerminalConnectionToken record { + # The id of the location that this connection token is scoped to. Note that location scoping only applies to internet-connected readers. For more details, see [the docs on scoping connection tokens](https://stripe.com/docs/terminal/readers/fleet-management#connection-tokens). + string location?; + # String representing the object's type. Objects of the same type share the same value. + string 'object; + # Your application should pass this token to the Stripe Terminal SDK. + string secret; +}; + public type PaymentMethodDetailsAchDebit record { # Type of entity that holds the account. This can be either `individual` or `company`. string? account_holder_type?; @@ -2482,6 +2948,16 @@ public type PaymentMethodDetailsAchDebit record { string? routing_number?; }; +# Point in Time +public type GelatoDataDocumentReportDateOfBirth record { + # Numerical day between 1 and 31. + int? day?; + # Numerical month between 1 and 12. + int? month?; + # The four-digit year. + int? year?; +}; + public type SetupIntentNextActionRedirectToUrl record { # If the customer does not exit their browser while authenticating, they will be redirected to this specified URL after completion. string? return_url?; @@ -2490,32 +2966,32 @@ public type SetupIntentNextActionRedirectToUrl record { }; public type CustomerDetailsParam1 record { - CustomerAdresss|string? address?; - CustomerAddressWithName|string? shipping?; - TaxParam1? tax?; - string? tax_exempt?; - DataParams[]? tax_ids?; + CustomerAdresss|string address?; + CustomerAddressWithName|string shipping?; + TaxParam1 tax?; + string tax_exempt?; + DataParams[] tax_ids?; }; public type PaymentMethodOptionsCardPresent record { }; -public type CurrentPeriodEnd RangeQuerySpecs|int?; +public type CurrentPeriodEnd RangeQuerySpecs|int; public type PaymentIntentPaymentMethodOptions record { - PaymentIntentPaymentMethodOptionsAcssDebit? acss_debit?; - PaymentMethodOptionsAfterpayClearpay? afterpay_clearpay?; - PaymentMethodOptionsAlipay? alipay?; - PaymentMethodOptionsBancontact? bancontact?; - PaymentMethodOptionsBoleto? boleto?; - PaymentIntentPaymentMethodOptionsCard? card?; - PaymentMethodOptionsCardPresent? card_present?; - PaymentMethodOptionsIdeal? ideal?; - PaymentMethodOptionsOxxo? oxxo?; - PaymentMethodOptionsP24? p24?; - PaymentIntentPaymentMethodOptionsSepaDebit? sepa_debit?; - PaymentMethodOptionsSofort? sofort?; - PaymentMethodOptionsWechatPay? wechat_pay?; + PaymentIntentPaymentMethodOptionsAcssDebit acss_debit?; + PaymentMethodOptionsAfterpayClearpay afterpay_clearpay?; + PaymentMethodOptionsAlipay alipay?; + PaymentMethodOptionsBancontact bancontact?; + PaymentMethodOptionsBoleto boleto?; + PaymentIntentPaymentMethodOptionsCard card?; + PaymentMethodOptionsCardPresent card_present?; + PaymentMethodOptionsIdeal ideal?; + PaymentMethodOptionsOxxo oxxo?; + PaymentMethodOptionsP24 p24?; + PaymentIntentPaymentMethodOptionsSepaDebit sepa_debit?; + PaymentMethodOptionsSofort sofort?; + PaymentMethodOptionsWechatPay wechat_pay?; }; # `Application Fee Refund` objects allow you to refund an application fee that @@ -2525,63 +3001,79 @@ public type PaymentIntentPaymentMethodOptions record { # Related guide: [Refunding Application Fees](https://stripe.com/docs/connect/destination-charges#refunding-app-fee). public type FeeRefund record { # Amount, in %s. - int? amount; + int amount; # Balance transaction that describes the impact on your account balance. string|BalanceTransaction? balance_transaction?; # Time at which the object was created. Measured in seconds since the Unix epoch. - int? created; + int created; # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). - string? currency; + string currency; # ID of the application fee that was refunded. - string|ApplicationFee? fee; + string|ApplicationFee fee; # Unique identifier for the object. - string? id; + string id; # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. record {} metadata?; # String representing the object's type. Objects of the same type share the same value. - string? 'object; + string 'object; }; public type CardInvoicePaymentMethodOptionsParam record { - string? request_three_d_secure?; + string request_three_d_secure?; }; public type CustomerBankAccountDetails record { - string? account_holder_name?; - string? account_holder_type?; - string? account_number; - string? country; - string? currency?; - string? 'object?; - string? routing_number?; + string account_holder_name?; + string account_holder_type?; + string account_number; + string country; + string currency?; + string 'object?; + string routing_number?; }; public type PersonRequirements record { # Fields that need to be collected to keep the person's account enabled. If not collected by the account's `current_deadline`, these fields appear in `past_due` as well, and the account is disabled. - string[]? currently_due; + string[] currently_due; # Fields that are `currently_due` and need to be collected again because validation or verification failed. - AccountRequirementsError[]? errors; + AccountRequirementsError[] errors; # Fields that need to be collected assuming all volume thresholds are reached. As they become required, they appear in `currently_due` as well, and the account's `current_deadline` becomes set. - string[]? eventually_due; + string[] eventually_due; # Fields that weren't collected by the account's `current_deadline`. These fields need to be collected to enable the person's account. - string[]? past_due; + string[] past_due; # Fields that may become required depending on the results of verification or review. Will be an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due`, `currently_due`, or `past_due`. - string[]? pending_verification; + string[] pending_verification; }; public type AccountRequirementsError record { # The code for the type of error. - string? code; + string code; # An informative message that indicates the error type and provides additional details about the error. - string? reason; + string reason; # The specific user onboarding requirement field (in the requirements hash) that needs to be resolved. - string? requirement; + string requirement; }; public type PaymentMethodOxxo record { }; -public type PaymentMethodDetailsAchCreditTransfer record { +public type GelatoDocumentReportError record { + # A short machine-readable string giving the reason for the verification failure. + string? code?; + # A human-readable message giving the reason for the failure. These messages can be shown to your users. + string? reason?; +}; + +public type DeletedApplePayDomain record { + # Always true for a deleted object + boolean deleted; + # Unique identifier for the object. + string id; + # String representing the object's type. Objects of the same type share the same value. + string 'object; +}; + +public type PaymentMethodDetailsAchCreditTransfer record { # Account number to transfer funds to. string? account_number?; # Name of the bank associated with the routing number. @@ -2597,16 +3089,16 @@ public type SubscriptionScheduleConfigurationItem record { # Define thresholds at which an invoice will be sent, and the related subscription advanced to a new billing period SubscriptionItemBillingThresholds? billing_thresholds?; # ID of the price to which the customer should be subscribed. - string|Price|DeletedPrice? price; + string|Price|DeletedPrice price; # Quantity of the plan to which the customer should be subscribed. - int? quantity?; + int quantity?; # The tax rates which apply to this `phase_item`. When set, the `default_tax_rates` on the phase do not apply to this `phase_item`. TaxRate[]? tax_rates?; }; public type PaymentMethodDetailsInteracPresentReceipt record { # The type of account being debited or credited - string? account_type?; + string account_type?; # EMV tag 9F26, cryptogram generated by the integrated circuit chip. string? application_cryptogram?; # Mnenomic of the Application Identifier. @@ -2636,7 +3128,7 @@ public type SourceTypeBancontact record { public type SubscriptionAutomaticTax record { # Whether Stripe automatically computes tax on this subscription. - boolean? enabled; + boolean enabled; }; public type PaymentMethodOptionsWechatPay record { @@ -2647,27 +3139,36 @@ public type PaymentMethodOptionsWechatPay record { }; public type RecurringAdhoc record { - string? interval; - int? interval_count?; + string interval; + int interval_count?; }; public type ScheduleCancelBody record { # Specifies which fields in the response should be expanded. - string[]? expand?; + string[] expand?; # If the subscription schedule is `active`, indicates if a final invoice will be generated that contains any un-invoiced metered usage and new/pending proration invoice items. Defaults to `true`. - boolean? invoice_now?; + boolean invoice_now?; # If the subscription schedule is `active`, indicates if the cancellation should be prorated. Defaults to `true`. - boolean? prorate?; + boolean prorate?; }; public type QuotesResourceUpfront record { # Total before any discounts or taxes are applied. - int? amount_subtotal; + int amount_subtotal; # Total after discounts and taxes are applied. - int? amount_total; + int amount_total; # The line items that will appear on the next invoice after this quote is accepted. This does not include pending invoice items that exist on the customer but may still be included in the next invoice. - Quotesresourcelistlineitems1? line_items?; - QuotesResourceTotalDetails? total_details; + Quotesresourcelistlineitems1 line_items?; + QuotesResourceTotalDetails total_details; +}; + +public type DeletedAlipayAccount record { + # Always true for a deleted object + boolean deleted; + # Unique identifier for the object. + string id; + # String representing the object's type. Objects of the same type share the same value. + string 'object; }; public type PaymentIntentNextActionAlipayHandleRedirect record { @@ -2691,6 +3192,16 @@ public type SourceTypeIdeal record { string? statement_descriptor?; }; +public type CustomerResourceCustomerList record { + Customer[] data; + # True if this list has another page of items after this one that can be fetched. + boolean has_more; + # String representing the object's type. Objects of the same type share the same value. Always has the value `list`. + string 'object; + # The URL where this list can be accessed. + string url; +}; + public type AccountPaymentsSettings record { # The default text that appears on credit card statements when a charge is made. This field prefixes any dynamic `statement_descriptor` specified on the charge. string? statement_descriptor?; @@ -2700,20 +3211,27 @@ public type AccountPaymentsSettings record { string? statement_descriptor_kanji?; }; +public type PortalCustomerUpdate record { + # The types of customer updates that are supported. When empty, customers are not updateable. + string[] allowed_updates; + # Whether the feature is enabled. + boolean enabled; +}; + public type InvoiceTransferData record { # The amount in %s that will be transferred to the destination account when the invoice is paid. By default, the entire amount is transferred to the destination. int? amount?; # The account where funds from the payment will be transferred to upon payment success. - string|Account? destination; + string|Account destination; }; public type MandateBacsDebit record { # The status of the mandate on the Bacs network. Can be one of `pending`, `revoked`, `refused`, or `accepted`. - string? network_status; + string network_status; # The unique reference identifying the mandate on the Bacs network. - string? reference; + string reference; # The URL that will contain the mandate that the customer has signed. - string? url; + string url; }; # With `Recipient` objects, you can transfer money from your Stripe account to a @@ -2731,16 +3249,16 @@ public type Recipient record { BankAccount? active_account?; CardList? cards?; # Time at which the object was created. Measured in seconds since the Unix epoch. - int? created; + int created; # The default card to use for creating transfers to this recipient. string|Card? default_card?; # An arbitrary string attached to the object. Often useful for displaying to users. string? description?; string? email?; # Unique identifier for the object. - string? id; + string id; # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. - boolean? livemode; + boolean livemode; # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. record {} metadata; # The ID of the [Custom account](https://stripe.com/docs/connect/custom-accounts) this recipient was migrated to. If set, the recipient can no longer be updated, nor can transfers be made to it: use the Custom account instead. @@ -2748,10 +3266,10 @@ public type Recipient record { # Full, legal name of the recipient. string? name?; # String representing the object's type. Objects of the same type share the same value. - string? 'object; - string|Account? rolled_back_from?; + string 'object; + string|Account rolled_back_from?; # Type of the recipient, one of `individual` or `corporation`. - string? 'type; + string 'type; }; public type ChargeOutcome record { @@ -2760,49 +3278,49 @@ public type ChargeOutcome record { # An enumerated value providing a more detailed explanation of the outcome's `type`. Charges blocked by Radar's default block rule have the value `highest_risk_level`. Charges placed in review by Radar's default review rule have the value `elevated_risk_level`. Charges authorized, blocked, or placed in review by custom rules have the value `rule`. See [understanding declines](https://stripe.com/docs/declines) for more details. string? reason?; # Stripe Radar's evaluation of the riskiness of the payment. Possible values for evaluated payments are `normal`, `elevated`, `highest`. For non-card payments, and card-based payments predating the public assignment of risk levels, this field will have the value `not_assessed`. In the event of an error in the evaluation, this field will have the value `unknown`. This field is only available with Radar. - string? risk_level?; + string risk_level?; # Stripe Radar's evaluation of the riskiness of the payment. Possible values for evaluated payments are between 0 and 100. For non-card payments, card-based payments predating the public assignment of risk scores, or in the event of an error during evaluation, this field will not be present. This field is only available with Radar for Fraud Teams. - int? risk_score?; + int risk_score?; # The ID of the Radar rule that matched the payment, if applicable. - string|Rule? rule?; + string|Rule rule?; # A human-readable description of the outcome type and reason, designed for you (the recipient of the payment), not your customer. string? seller_message?; # Possible values are `authorized`, `manual_review`, `issuer_declined`, `blocked`, and `invalid`. See [understanding declines](https://stripe.com/docs/declines) and [Radar reviews](https://stripe.com/docs/radar/reviews) for details. - string? 'type; + string 'type; }; # You can [create physical or virtual cards](https://stripe.com/docs/issuing/cards) that are issued to cardholders. public type IssuingCard record { # The brand of the card. - string? brand; + string brand; # The reason why the card was canceled. string? cancellation_reason?; # An Issuing `Cardholder` object represents an individual or business entity who is [issued](https://stripe.com/docs/issuing) cards. # # Related guide: [How to create a Cardholder](https://stripe.com/docs/issuing/cards#create-cardholder) - IssuingCardholder? cardholder; + IssuingCardholder cardholder; # Time at which the object was created. Measured in seconds since the Unix epoch. - int? created; + int created; # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). - string? currency; + string currency; # The card's CVC. For security reasons, this is only available for virtual cards, and will be omitted unless you explicitly request it with [the `expand` parameter](https://stripe.com/docs/api/expanding_objects). Additionally, it's only available via the ["Retrieve a card" endpoint](https://stripe.com/docs/api/issuing/cards/retrieve), not via "List all cards" or any other endpoint. - string? cvc?; + string cvc?; # The expiration month of the card. - int? exp_month; + int exp_month; # The expiration year of the card. - int? exp_year; + int exp_year; # Unique identifier for the object. - string? id; + string id; # The last 4 digits of the card number. - string? last4; + string last4; # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. - boolean? livemode; + boolean livemode; # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. record {} metadata; # The full unredacted card number. For security reasons, this is only available for virtual cards, and will be omitted unless you explicitly request it with [the `expand` parameter](https://stripe.com/docs/api/expanding_objects). Additionally, it's only available via the ["Retrieve a card" endpoint](https://stripe.com/docs/api/issuing/cards/retrieve), not via "List all cards" or any other endpoint. - string? number?; + string number?; # String representing the object's type. Objects of the same type share the same value. - string? 'object; + string 'object; # The latest card that replaces this card, if any. string|IssuingCard? replaced_by?; # The card this card replaces, if any. @@ -2811,47 +3329,75 @@ public type IssuingCard record { string? replacement_reason?; # Where and how the card will be shipped. IssuingCardShipping? shipping?; - IssuingCardAuthorizationControls? spending_controls; + IssuingCardAuthorizationControls spending_controls; # Whether authorizations can be approved on this card. - string? status; + string status; # The type of the card. - string? 'type; + string 'type; }; public type ScheduleReleaseBody record { # Specifies which fields in the response should be expanded. - string[]? expand?; + string[] expand?; # Keep any cancellation on the subscription that the schedule has set - boolean? preserve_cancel_date?; + boolean preserve_cancel_date?; }; public type CustomerAcceptance record { # The time at which the customer accepted the Mandate. int? accepted_at?; - OfflineAcceptance? offline?; - OnlineAcceptance? online?; + OfflineAcceptance offline?; + OnlineAcceptance online?; # The type of customer acceptance information included with the Mandate. One of `online` or `offline`. - string? 'type; + string 'type; }; public type PromotionCodesResourceRestrictions record { # A Boolean indicating if the Promotion Code should only be redeemed for Customers without any successful payments or invoices - boolean? first_time_transaction; + boolean first_time_transaction; # Minimum amount required to redeem this Promotion Code into a Coupon (e.g., a purchase must be $100 or more to work). int? minimum_amount?; # Three-letter [ISO code](https://stripe.com/docs/currencies) for minimum_amount string? minimum_amount_currency?; }; +# If you have [scheduled a Sigma query](https://stripe.com/docs/sigma/scheduled-queries), you'll +# receive a `sigma.scheduled_query_run.created` webhook each time the query +# runs. The webhook contains a `ScheduledQueryRun` object, which you can use to +# retrieve the query results. +public type ScheduledQueryRun record { + # Time at which the object was created. Measured in seconds since the Unix epoch. + int created; + # When the query was run, Sigma contained a snapshot of your Stripe data at this time. + int data_load_time; + SigmaScheduledQueryRunError _error?; + # The file object representing the results of the query. + File? file?; + # Unique identifier for the object. + string id; + # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. + boolean livemode; + # String representing the object's type. Objects of the same type share the same value. + string 'object; + # Time at which the result expires and is no longer available for download. + int result_available_until; + # SQL for the query. + string sql; + # The query's execution status, which will be `completed` for successful runs, and `canceled`, `failed`, or `timed_out` otherwise. + string status; + # Title of the query. + string title; +}; + public type SubscriptionItemUsageRecordsBody record { # Valid values are `increment` (default) or `set`. When using `increment` the specified `quantity` will be added to the usage at the specified timestamp. The `set` action will overwrite the usage quantity at that timestamp. If the subscription has [billing thresholds](https://stripe.com/docs/api/subscriptions/object#subscription_object-billing_thresholds), `increment` is the only allowed value. - string? action?; + string action?; # Specifies which fields in the response should be expanded. - string[]? expand?; + string[] expand?; # The usage quantity for the specified timestamp. - int? quantity; + int quantity; # The timestamp for the usage event. This timestamp must be within the current billing period of the subscription of the provided `subscription_item`. - int? timestamp; + int timestamp; }; # Prices define the unit cost, currency, and (optional) billing cycle for both recurring and one-time purchases of products. @@ -2862,17 +3408,17 @@ public type SubscriptionItemUsageRecordsBody record { # Related guides: [Set up a subscription](https://stripe.com/docs/billing/subscriptions/set-up-subscription), [create an invoice](https://stripe.com/docs/billing/invoices/create), and more about [products and prices](https://stripe.com/docs/billing/prices-guide). public type Price record { # Whether the price can be used for new purchases. - boolean? active; + boolean active; # Describes 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. - string? billing_scheme; + string billing_scheme; # Time at which the object was created. Measured in seconds since the Unix epoch. - int? created; + int created; # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). - string? currency; + string currency; # Unique identifier for the object. - string? id; + string id; # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. - boolean? livemode; + boolean livemode; # A lookup key used to retrieve prices dynamically from a static string. string? lookup_key?; # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. @@ -2880,21 +3426,21 @@ public type Price record { # A brief description of the price, hidden from customers. string? nickname?; # String representing the object's type. Objects of the same type share the same value. - string? 'object; + string 'object; # The ID of the product this price is associated with. - string|Product|DeletedProduct? product; + string|Product|DeletedProduct product; # The recurring components of a price such as `interval` and `usage_type`. Recurring? recurring?; # 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. string? tax_behavior?; # Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`. - PriceTier[]? tiers?; + PriceTier[] tiers?; # 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. string? tiers_mode?; # Apply a transformation to the reported usage or set quantity before computing the amount billed. Cannot be combined with `tiers`. TransformQuantity? transform_quantity?; # One of `one_time` or `recurring` depending on whether the price is for a one-time purchase or a recurring (subscription) purchase. - string? 'type; + string 'type; # The unit amount in %s to be charged, represented as a whole integer if possible. Only set if `billing_scheme=per_unit`. int? unit_amount?; # The unit amount in %s to be charged, represented as a decimal string with at most 12 decimal places. Only set if `billing_scheme=per_unit`. @@ -2904,22 +3450,29 @@ public type Price record { # Automatic tax configuration details public type SchedulesPhaseAutomaticTax record { # Whether Stripe automatically computes tax on invoices created during this phase. - boolean? enabled; + boolean enabled; }; public type SetupIntentPaymentMethodOptions record { - SetupIntentPaymentMethodOptionsAcssDebit? acss_debit?; - SetupIntentPaymentMethodOptionsCard? card?; - SetupIntentPaymentMethodOptionsSepaDebit? sepa_debit?; + SetupIntentPaymentMethodOptionsAcssDebit acss_debit?; + SetupIntentPaymentMethodOptionsCard card?; + SetupIntentPaymentMethodOptionsSepaDebit sepa_debit?; }; public type CustomerAdresss record { - string? city?; - string? country?; - string? line1?; - string? line2?; - string? postal_code?; - string? state?; + string city?; + string country?; + string line1?; + string line2?; + string postal_code?; + string state?; +}; + +public type TransformUsage record { + # Divide usage by this number. + int divide_by; + # After division, either round the result `up` or `down`. + string round; }; public type PaymentMethodDetailsCardWalletVisaCheckout record { @@ -2935,69 +3488,96 @@ public type PaymentMethodDetailsCardWalletVisaCheckout record { public type TaxDeductedAtSource record { # Unique identifier for the object. - string? id; + string id; # String representing the object's type. Objects of the same type share the same value. - string? 'object; + string 'object; # The end of the invoicing period. This TDS applies to Stripe fees collected during this invoicing period. - int? period_end; + int period_end; # The start of the invoicing period. This TDS applies to Stripe fees collected during this invoicing period. - int? period_start; + int period_start; # The TAN that was supplied to Stripe when TDS was assessed - string? tax_deduction_account_number; + string tax_deduction_account_number; }; # Tax details about the customer. public type TaxParam record { - string|string? ip_address?; + string|string ip_address?; }; public type V1ProductsBody record { # Whether the product is currently available for purchase. Defaults to `true`. - boolean? active?; + boolean active?; # 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. - string? description?; + string description?; # Specifies which fields in the response should be expanded. - string[]? expand?; + string[] expand?; # An identifier will be randomly generated by Stripe. You can optionally override this ID, but the ID must be unique across all products in your Stripe account. - string? id?; + string id?; # A list of up to 8 URLs of images for this product, meant to be displayable to the customer. - string[]? images?; + string[] images?; # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. record {} metadata?; # The product's name, meant to be displayable to the customer. Whenever this product is sold via a subscription, name will show up on associated invoice line item descriptions. - string? name; + string name; # The dimensions of this product for shipping purposes. - PackageDimensionsSpecs? package_dimensions?; + PackageDimensionsSpecs package_dimensions?; # Whether this product is shipped (i.e., physical goods). - boolean? shippable?; + boolean shippable?; # An arbitrary string to be displayed on your customer's credit card or bank statement. While most banks display this information consistently, some may display it incorrectly or not at all. # # This may be up to 22 characters. The statement description may not include `<`, `>`, `\`, `"`, `'` characters, and will appear on your customer's statement in capital letters. Non-ASCII characters are automatically stripped. # It must contain at least one letter. - string? statement_descriptor?; + string statement_descriptor?; # A [tax code](https://stripe.com/docs/tax/tax-codes) ID. - string? tax_code?; + string tax_code?; # 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. - string? unit_label?; + string unit_label?; # A URL of a publicly-accessible webpage for this product. - string? url?; + string url?; }; public type InvoiceItemPreviewParams record { - int? amount?; - string? currency?; - string? description?; - boolean? discountable?; - DiscountsDataParam|string? discounts?; - string? invoiceitem?; - record {}|string? metadata?; - Period1? period?; - string? price?; - OneTimePriceData? price_data?; - int? quantity?; - string[]|string? tax_rates?; - int? unit_amount?; - string? unit_amount_decimal?; + int amount?; + string currency?; + string description?; + boolean discountable?; + DiscountsDataParam|string discounts?; + string invoiceitem?; + record {}|string metadata?; + Period1 period?; + string price?; + OneTimePriceData price_data?; + int quantity?; + string[]|string tax_rates?; + int unit_amount?; + string unit_amount_decimal?; +}; + +# This is an object representing your Stripe balance. You can retrieve it to see +# the balance currently on your Stripe account. +# +# You can also retrieve the balance history, which contains a list of +# [transactions](https://stripe.com/docs/reporting/balance-transaction-types) that contributed to the balance +# (charges, payouts, and so forth). +# +# The available and pending amounts for each currency are broken down further by +# payment source types. +# +# Related guide: [Understanding Connect Account Balances](https://stripe.com/docs/connect/account-balances). +public type Balance record { + # Funds that are available to be transferred or paid out, whether automatically by Stripe or explicitly via the [Transfers API](https://stripe.com/docs/api#transfers) or [Payouts API](https://stripe.com/docs/api#payouts). The available balance for each currency and payment type can be found in the `source_types` property. + BalanceAmount[] available; + # Funds held due to negative balances on connected Custom accounts. The connect reserve balance for each currency and payment type can be found in the `source_types` property. + BalanceAmount[] connect_reserved?; + # Funds that can be paid out using Instant Payouts. + BalanceAmount[] instant_available?; + BalanceDetail issuing?; + # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. + boolean livemode; + # String representing the object's type. Objects of the same type share the same value. + string 'object; + # Funds that are not yet available in the balance, due to the 7-day rolling pay cycle. The pending balance for each currency, and for each payment type, can be found in the `source_types` property. + BalanceAmount[] pending; }; # This is an object representing a file hosted on Stripe's servers. The @@ -3009,21 +3589,21 @@ public type InvoiceItemPreviewParams record { # Related guide: [File Upload Guide](https://stripe.com/docs/file-upload). public type File record { # Time at which the object was created. Measured in seconds since the Unix epoch. - int? created; + int created; # The time at which the file expires and is no longer available in epoch seconds. int? expires_at?; # A filename for the file, suitable for saving to a filesystem. string? filename?; # Unique identifier for the object. - string? id; + string id; # A list of [file links](https://stripe.com/docs/api#file_links) that point at this file. FileFileLinkList? links?; # String representing the object's type. Objects of the same type share the same value. - string? 'object; + string 'object; # The [purpose](https://stripe.com/docs/file-upload#uploading-a-file) of the uploaded file. - string? purpose; + string purpose; # The size in bytes of the file object. - int? size; + int size; # A user friendly title for the document. string? title?; # The type of the file returned (e.g., `csv`, `pdf`, `jpg`, or `png`). @@ -3032,6 +3612,50 @@ public type File record { string? url?; }; +# Point in Time +public type GelatoDataDocumentReportIssuedDate record { + # Numerical day between 1 and 31. + int? day?; + # Numerical month between 1 and 12. + int? month?; + # The four-digit year. + int? year?; +}; + +public type AccountCapabilityRequirements record { + # Date by which the fields in `currently_due` must be collected to keep the capability enabled for the account. These fields may disable the capability sooner if the next threshold is reached before they are collected. + int? current_deadline?; + # Fields that need to be collected to keep the capability enabled. If not collected by `current_deadline`, these fields appear in `past_due` as well, and the capability is disabled. + string[] currently_due; + # If the capability is disabled, this string describes why. Can be `requirements.past_due`, `requirements.pending_verification`, `listed`, `platform_paused`, `rejected.fraud`, `rejected.listed`, `rejected.terms_of_service`, `rejected.other`, `under_review`, or `other`. + # + # `rejected.unsupported_business` means that the account's business is not supported by the capability. For example, payment methods may restrict the businesses they support in their terms of service: + # + # - [Afterpay Clearpay's terms of service](/afterpay-clearpay/legal#restricted-businesses) + # + # If you believe that the rejection is in error, please contact support@stripe.com for assistance. + string? disabled_reason?; + # Fields that are `currently_due` and need to be collected again because validation or verification failed. + AccountRequirementsError[] errors; + # Fields that need to be collected assuming all volume thresholds are reached. As they become required, they appear in `currently_due` as well, and `current_deadline` becomes set. + string[] eventually_due; + # Fields that weren't collected by `current_deadline`. These fields need to be collected to enable the capability on the account. + string[] past_due; + # Fields that may become required depending on the results of verification or review. Will be an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due`, `currently_due`, or `past_due`. + string[] pending_verification; +}; + +public type SourceTransactionAchCreditTransferData record { + # Customer data associated with the transfer. + string customer_data?; + # Bank account fingerprint associated with the transfer. + string fingerprint?; + # Last 4 digits of the account number associated with the transfer. + string last4?; + # Routing number associated with the transfer. + string routing_number?; +}; + public type SetupAttemptPaymentMethodDetailsCard record { # Populated if this authorization used 3D Secure authentication. ThreeDSecureDetails? three_d_secure?; @@ -3039,34 +3663,34 @@ public type SetupAttemptPaymentMethodDetailsCard record { # The recurring components of a price such as `interval` and `usage_type`. public type Recurring1 record { - string? aggregate_usage?; - string? interval; - int? interval_count?; - string? usage_type?; + string aggregate_usage?; + string interval; + int interval_count?; + string usage_type?; }; public type InlineResponse200 record { - Coupon[]? data; + Coupon[] data; # True if this list has another page of items after this one that can be fetched. - boolean? has_more; + boolean has_more; # String representing the object's type. Objects of the same type share the same value. Always has the value `list`. - string? 'object; + string 'object; # The URL where this list can be accessed. - string? url; + string url; }; public type PaymentMethodDetachBody record { # Specifies which fields in the response should be expanded. - string[]? expand?; + string[] expand?; }; public type IssuingCardholderSpendingLimit record { # Maximum amount allowed to spend per interval. - int? amount; + int amount; # Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) this limit applies to. Omitting this field will apply the limit to all categories. string[]? categories?; # Interval (or event) to which the amount applies. - string? interval; + string interval; }; public type InvoicesPaymentMethodOptions record { @@ -3076,148 +3700,185 @@ public type InvoicesPaymentMethodOptions record { InvoicePaymentMethodOptionsCard? card?; }; +# The Report Type resource corresponds to a particular type of report, such as +# the "Activity summary" or "Itemized payouts" reports. These objects are +# identified by an ID belonging to a set of enumerated values. See +# [API Access to Reports documentation](https://stripe.com/docs/reporting/statements/api) +# for those Report Type IDs, along with required and optional parameters. +# +# Note that certain report types can only be run based on your live-mode data (not test-mode +# data), and will error when queried without a [live-mode API key](https://stripe.com/docs/keys#test-live-modes). +public type ReportingReportType record { + # Most recent time for which this Report Type is available. Measured in seconds since the Unix epoch. + int data_available_end; + # Earliest time for which this Report Type is available. Measured in seconds since the Unix epoch. + int data_available_start; + # 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.) + string[]? default_columns?; + # The [ID of the Report Type](https://stripe.com/docs/reporting/statements/api#available-report-types), such as `balance.summary.1`. + string id; + # Human-readable name of the Report Type + string name; + # String representing the object's type. Objects of the same type share the same value. + string 'object; + # When this Report Type was latest updated. Measured in seconds since the Unix epoch. + int updated; + # 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. + int 'version; +}; + # Default invoice settings for this customer. public type CustomerParam record { - record {string? name; string? value;}[]|string? custom_fields?; - string? default_payment_method?; - string? footer?; + record {string name; string value;}[]|string custom_fields?; + string default_payment_method?; + string footer?; }; public type PaymentMethodCardWallet record { - PaymentMethodCardWalletAmexExpressCheckout? amex_express_checkout?; - PaymentMethodCardWalletApplePay? apple_pay?; + PaymentMethodCardWalletAmexExpressCheckout amex_express_checkout?; + PaymentMethodCardWalletApplePay apple_pay?; # (For tokenized numbers only.) The last four digits of the device account number. string? dynamic_last4?; - PaymentMethodCardWalletGooglePay? google_pay?; - PaymentMethodCardWalletMasterpass? masterpass?; - PaymentMethodCardWalletSamsungPay? samsung_pay?; + PaymentMethodCardWalletGooglePay google_pay?; + PaymentMethodCardWalletMasterpass masterpass?; + PaymentMethodCardWalletSamsungPay samsung_pay?; # The type of the card wallet, one of `amex_express_checkout`, `apple_pay`, `google_pay`, `masterpass`, `samsung_pay`, or `visa_checkout`. 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. - string? 'type; - PaymentMethodCardWalletVisaCheckout? visa_checkout?; + string 'type; + PaymentMethodCardWalletVisaCheckout visa_checkout?; }; public type AccountCapabilities record { # The status of the ACSS Direct Debits payments capability of the account, or whether the account can directly process ACSS Direct Debits charges. - string? acss_debit_payments?; + string acss_debit_payments?; # The status of the Afterpay Clearpay capability of the account, or whether the account can directly process Afterpay Clearpay charges. - string? afterpay_clearpay_payments?; + string afterpay_clearpay_payments?; # The status of the BECS Direct Debit (AU) payments capability of the account, or whether the account can directly process BECS Direct Debit (AU) charges. - string? au_becs_debit_payments?; + string au_becs_debit_payments?; # The status of the Bacs Direct Debits payments capability of the account, or whether the account can directly process Bacs Direct Debits charges. - string? bacs_debit_payments?; + string bacs_debit_payments?; # The status of the Bancontact payments capability of the account, or whether the account can directly process Bancontact charges. - string? bancontact_payments?; + string bancontact_payments?; # The status of the boleto payments capability of the account, or whether the account can directly process boleto charges. - string? boleto_payments?; + string boleto_payments?; # The status of the card issuing capability of the account, or whether you can use Issuing to distribute funds on cards - string? card_issuing?; + string card_issuing?; # The status of the card payments capability of the account, or whether the account can directly process credit and debit card charges. - string? card_payments?; + string card_payments?; # The status of the Cartes Bancaires payments capability of the account, or whether the account can directly process Cartes Bancaires card charges in EUR currency. - string? cartes_bancaires_payments?; + string cartes_bancaires_payments?; # The status of the EPS payments capability of the account, or whether the account can directly process EPS charges. - string? eps_payments?; + string eps_payments?; # The status of the FPX payments capability of the account, or whether the account can directly process FPX charges. - string? fpx_payments?; + string fpx_payments?; # The status of the giropay payments capability of the account, or whether the account can directly process giropay charges. - string? giropay_payments?; + string giropay_payments?; # The status of the GrabPay payments capability of the account, or whether the account can directly process GrabPay charges. - string? grabpay_payments?; + string grabpay_payments?; # The status of the iDEAL payments capability of the account, or whether the account can directly process iDEAL charges. - string? ideal_payments?; + string ideal_payments?; # The status of the JCB payments capability of the account, or whether the account (Japan only) can directly process JCB credit card charges in JPY currency. - string? jcb_payments?; + string jcb_payments?; # The status of the legacy payments capability of the account. - string? legacy_payments?; + string legacy_payments?; # The status of the OXXO payments capability of the account, or whether the account can directly process OXXO charges. - string? oxxo_payments?; + string oxxo_payments?; # The status of the P24 payments capability of the account, or whether the account can directly process P24 charges. - string? p24_payments?; + string p24_payments?; # The status of the SEPA Direct Debits payments capability of the account, or whether the account can directly process SEPA Direct Debits charges. - string? sepa_debit_payments?; + string sepa_debit_payments?; # The status of the Sofort payments capability of the account, or whether the account can directly process Sofort charges. - string? sofort_payments?; + string sofort_payments?; # The status of the tax reporting 1099-K (US) capability of the account. - string? tax_reporting_us_1099_k?; + string tax_reporting_us_1099_k?; # The status of the tax reporting 1099-MISC (US) capability of the account. - string? tax_reporting_us_1099_misc?; + string tax_reporting_us_1099_misc?; # The status of the transfers capability of the account, or whether your platform can transfer funds to the account. - string? transfers?; + string transfers?; }; public type SetupIntentNextActionVerifyWithMicrodeposits record { # The timestamp when the microdeposits are expected to land. - int? arrival_date; + int arrival_date; # The URL for the hosted verification page, which allows customers to verify their bank account. - string? hosted_verification_url; + string hosted_verification_url; }; # Line items that make up the credit note public type CreditNoteLinesList record { # Details about each object. - CreditNoteLineItem[]? data; + CreditNoteLineItem[] data; # True if this list has another page of items after this one that can be fetched. - boolean? has_more; + boolean has_more; # String representing the object's type. Objects of the same type share the same value. Always has the value `list`. - string? 'object; + string 'object; # The URL where this list can be accessed. - string? url; + string url; }; public type V1InvoicesBody record { # The account tax IDs associated with the invoice. Only editable when the invoice is a draft. - string[]|string? account_tax_ids?; + string[]|string account_tax_ids?; # A fee in %s that will be applied to the invoice and transferred to the application owner's Stripe account. The request must be made with an OAuth key or the Stripe-Account header in order to take an application fee. For more information, see the application fees [documentation](https://stripe.com/docs/billing/invoices/connect#collecting-fees). - int? application_fee_amount?; + int application_fee_amount?; # Controls whether Stripe will perform [automatic collection](https://stripe.com/docs/billing/invoices/workflow/#auto_advance) of the invoice. When `false`, the invoice's state will not automatically advance without an explicit action. - boolean? auto_advance?; + boolean auto_advance?; # Settings for automatic tax lookup for this invoice. - AutomaticTaxParam? automatic_tax?; + AutomaticTaxParam automatic_tax?; # 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. Defaults to `charge_automatically`. - string? collection_method?; + string collection_method?; # A list of up to 4 custom fields to be displayed on the invoice. - InvoiceSettingsCustomFields|string? custom_fields?; + InvoiceSettingsCustomFields|string custom_fields?; # The ID of the customer who will be billed. - string? customer; + string customer; # The number of days from when the invoice is created until it is due. Valid only for invoices where `collection_method=send_invoice`. - int? days_until_due?; + int days_until_due?; # ID of the default payment method for the invoice. It must belong to the customer associated with the invoice. If not set, defaults to the subscription's default payment method, if any, or to the default payment method in the customer's invoice settings. - string? default_payment_method?; + string default_payment_method?; # ID of the default payment source for the invoice. It must belong to the customer associated with the invoice and be in a chargeable state. If not set, defaults to the subscription's default source, if any, or to the customer's default source. - string? default_source?; + string default_source?; # The tax rates that will apply to any line item that does not have `tax_rates` set. - string[]? default_tax_rates?; + string[] default_tax_rates?; # An arbitrary string attached to the object. Often useful for displaying to users. Referenced as 'memo' in the Dashboard. - string? description?; + string description?; # The coupons to redeem into discounts for the invoice. If not specified, inherits the discount from the invoice's customer. Pass an empty string to avoid inheriting any discounts. - DiscountsDataParam|string? discounts?; + DiscountsDataParam|string discounts?; # The date on which payment for this invoice is due. Valid only for invoices where `collection_method=send_invoice`. - int? due_date?; + int due_date?; # Specifies which fields in the response should be expanded. - string[]? expand?; + string[] expand?; # Footer to be displayed on the invoice. - string? footer?; + string footer?; # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. - record {}|string? metadata?; + record {}|string metadata?; # The account (if any) for which the funds of the invoice payment are intended. If set, the invoice will be presented with the branding and support information of the specified account. See the [Invoices with Connect](https://stripe.com/docs/billing/invoices/connect) documentation for details. - string? on_behalf_of?; + string on_behalf_of?; # Configuration settings for the PaymentIntent that is generated when the invoice is finalized. - PaymentSettings? payment_settings?; + PaymentSettings payment_settings?; # Extra information about a charge for the customer's credit card statement. It must contain at least one letter. If not specified and this invoice is part of a subscription, the default `statement_descriptor` will be set to the first subscription item's product's `statement_descriptor`. - string? statement_descriptor?; + string statement_descriptor?; # The ID of the subscription to invoice, if any. If not set, the created invoice will include all pending invoice items for the customer. If set, the created invoice will only include pending invoice items for that subscription and pending invoice items not associated with any subscription. The subscription's billing cycle and regular subscription events won't be affected. - string? subscription?; + string subscription?; # If specified, the funds from the invoice will be transferred to the destination and the ID of the resulting transfer will be found on the invoice's charge. - TransferDataSpecs1? transfer_data?; + TransferDataSpecs1 transfer_data?; }; -public type SubscriptionDefaultTaxRates string[]|string?; +public type SubscriptionDefaultTaxRates string[]|string; -public type DueDate RangeQuerySpecs|int?; +public type DueDate RangeQuerySpecs|int; + +# Point in Time +public type GelatoDataVerifiedOutputsDate record { + # Numerical day between 1 and 31. + int? day?; + # Numerical month between 1 and 12. + int? month?; + # The four-digit year. + int? year?; +}; public type InvoiceSendBody record { # Specifies which fields in the response should be expanded. - string[]? expand?; + string[] expand?; }; # Pending Updates store the changes pending from a previous update that will be applied @@ -3226,7 +3887,7 @@ public type SubscriptionsResourcePendingUpdate record { # If the update is applied, determines the date of the first full invoice, and, for plans with `month` or `year` intervals, the day of the month for subsequent invoices. int? billing_cycle_anchor?; # The point after which the changes reflected by this update will be discarded and no longer applied. - int? expires_at; + int expires_at; # List of subscription items, each with an attached plan, that will be set if the update is applied. SubscriptionItem[]? subscription_items?; # Unix timestamp representing the end of the trial period the customer will get before being charged for the first time, if the update is applied. @@ -3243,13 +3904,13 @@ public type SetupAttemptPaymentMethodDetailsCardPresent record { # A list of reversals that have been applied to the transfer. public type TransferReversalList record { # Details about each object. - TransferReversal[]? data; + TransferReversal[] data; # True if this list has another page of items after this one that can be fetched. - boolean? has_more; + boolean has_more; # String representing the object's type. Objects of the same type share the same value. Always has the value `list`. - string? 'object; + string 'object; # The URL where this list can be accessed. - string? url; + string url; }; public type IssuingCardholderAuthorizationControls record { @@ -3263,6 +3924,55 @@ public type IssuingCardholderAuthorizationControls record { string? spending_limits_currency?; }; +public type CountrySpecVerificationFieldDetails record { + # Additional fields which are only required for some users. + string[] additional; + # Fields which every account must eventually provide. + string[] minimum; +}; + +# A Reader represents a physical device for accepting payment details. +# +# Related guide: [Connecting to a Reader](https://stripe.com/docs/terminal/readers/connecting). +public type TerminalReader record { + # The current software version of the reader. + string? device_sw_version?; + # Type of reader, one of `bbpos_chipper2x` or `verifone_P400`. + string device_type; + # Unique identifier for the object. + string id; + # The local IP address of the reader. + string? ip_address?; + # Custom label given to the reader for easier identification. + string label; + # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. + boolean livemode; + # The location identifier of the reader. + string|TerminalLocation? location?; + # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. + record {} metadata; + # String representing the object's type. Objects of the same type share the same value. + string 'object; + # Serial number of the reader. + string serial_number; + # The networking status of the reader. + string? status?; +}; + +# An error response from the Stripe API +public type Error record { + ApiErrors _error; +}; + +public type DeletedWebhookEndpoint record { + # Always true for a deleted object + boolean deleted; + # Unique identifier for the object. + string id; + # String representing the object's type. Objects of the same type share the same value. + string 'object; +}; + public type IssuingTransactionPurchaseDetails record { # Information about the flight that was purchased with this transaction. IssuingTransactionFlightData? flight?; @@ -3285,17 +3995,17 @@ public type PaymentMethodBacsDebit record { string? sort_code?; }; -public type Discounts1 DiscountsDataParam|string?; +public type Discounts1 DiscountsDataParam|string; public type AccountSettings record { - AccountBacsDebitPaymentsSettings? bacs_debit_payments?; - AccountBrandingSettings? branding; - AccountCardIssuingSettings? card_issuing?; - AccountCardPaymentsSettings? card_payments; - AccountDashboardSettings? dashboard; - AccountPaymentsSettings? payments; - AccountPayoutSettings? payouts?; - AccountSepaDebitPaymentsSettings? sepa_debit_payments?; + AccountBacsDebitPaymentsSettings bacs_debit_payments?; + AccountBrandingSettings branding; + AccountCardIssuingSettings card_issuing?; + AccountCardPaymentsSettings card_payments; + AccountDashboardSettings dashboard; + AccountPaymentsSettings payments; + AccountPayoutSettings payouts?; + AccountSepaDebitPaymentsSettings sepa_debit_payments?; }; public type OfflineAcceptance record { @@ -3320,24 +4030,24 @@ public type SourceTypeSepaDebit record { # The dimensions of this product for shipping purposes. public type PackageDimensionsSpecs record { - decimal? height; - decimal? length; - decimal? weight; - decimal? width; + decimal height; + decimal length; + decimal weight; + decimal width; }; public type TransformQuantity record { # Divide usage by this number. - int? divide_by; + int divide_by; # After division, either round the result `up` or `down`. - string? round; + string round; }; public type InvoiceSettingCustomField record { # The name of the custom field. - string? name; + string name; # The value of the custom field. - string? value; + string value; }; public type IssuingTransactionFlightData record { @@ -3353,9 +4063,18 @@ public type IssuingTransactionFlightData record { string? travel_agency?; }; +public type DeletedPlan record { + # Always true for a deleted object + boolean deleted; + # Unique identifier for the object. + string id; + # String representing the object's type. Objects of the same type share the same value. + string 'object; +}; + public type Networks record { # All available networks for the card. - string[]? available; + string[] available; # The preferred network for the card. string? preferred?; }; @@ -3374,8 +4093,8 @@ public type PaymentMethodCardChecks record { public type AccountPayoutSettings record { # A Boolean indicating if Stripe should try to reclaim negative balances from an attached bank account. See our [Understanding Connect Account Balances](https://stripe.com/docs/connect/account-balances) documentation for details. Default value is `true` for Express accounts and `false` for Custom accounts. - boolean? debit_negative_balances; - TransferSchedule? schedule; + boolean debit_negative_balances; + TransferSchedule schedule; # The text that appears on the bank account statement for payouts. If not set, this defaults to the platform's bank descriptor as set in the Dashboard. string? statement_descriptor?; }; @@ -3384,7 +4103,7 @@ public type InvoiceThresholdReason record { # The total invoice amount threshold boundary if it triggered the threshold invoice. int? amount_gte?; # Indicates which line items triggered a threshold invoice. - InvoiceItemThresholdReason[]? item_reasons; + InvoiceItemThresholdReason[] item_reasons; }; public type LegalEntityPersonVerificationDocument record { @@ -3407,26 +4126,35 @@ public type PaymentMethodSofort record { }; public type ConfigurationItemParams record { - ItemBillingThresholdsParam|string? billing_thresholds?; - string? price?; - RecurringPriceData1? price_data?; - int? quantity?; - string[]|string? tax_rates?; + ItemBillingThresholdsParam|string billing_thresholds?; + string price?; + RecurringPriceData1 price_data?; + int quantity?; + string[]|string tax_rates?; +}; + +public type DeletedTerminalLocation record { + # Always true for a deleted object + boolean deleted; + # Unique identifier for the object. + string id; + # String representing the object's type. Objects of the same type share the same value. + string 'object; }; public type SubscriptionSchedulesScheduleBody record { # Object representing the subscription schedule's default settings. - DefaultSettingsParams1? default_settings?; + DefaultSettingsParams1 default_settings?; # Configures how the subscription schedule behaves when it ends. Possible values are `release` or `cancel` with the default being `release`. `release` will end the subscription schedule and keep the underlying subscription running.`cancel` will end the subscription schedule and cancel the underlying subscription. - string? end_behavior?; + string end_behavior?; # Specifies which fields in the response should be expanded. - string[]? expand?; + string[] expand?; # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. - record {}|string? metadata?; + record {}|string metadata?; # List representing phases of the subscription schedule. Each phase can be customized to have different durations, plans, and coupons. If there are multiple phases, the `end_date` of one phase will always equal the `start_date` of the next phase. Note that past phases can be omitted. - PhaseConfigurationParams1[]? phases?; + PhaseConfigurationParams1[] phases?; # If the update changes the current phase, indicates if the changes should be prorated. Possible values are `create_prorations` or `none`, and the default value is `create_prorations`. - string? proration_behavior?; + string proration_behavior?; }; public type QuotesResourceTransferData record { @@ -3435,7 +4163,7 @@ public type QuotesResourceTransferData record { # 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 destination account. By default, the entire amount will be transferred to the destination. decimal? amount_percent?; # The account where funds from the payment will be transferred to upon payment success. - string|Account? destination; + string|Account destination; }; public type SubscriptionBillingThresholds record { @@ -3449,11 +4177,11 @@ public type DeletedCard record { # Three-letter [ISO code for the currency](https://stripe.com/docs/payouts) paid out to the bank account. string? currency?; # Always true for a deleted object - boolean? deleted; + boolean deleted; # Unique identifier for the object. - string? id; + string id; # String representing the object's type. Objects of the same type share the same value. - string? 'object; + string 'object; }; public type PriceTier record { @@ -3469,13 +4197,22 @@ public type PriceTier record { int? up_to?; }; +public type LoginLink record { + # Time at which the object was created. Measured in seconds since the Unix epoch. + int created; + # String representing the object's type. Objects of the same type share the same value. + string 'object; + # The URL for the login link. + string url; +}; + public type DeletedTaxId record { # Always true for a deleted object - boolean? deleted; + boolean deleted; # Unique identifier for the object. - string? id; + string id; # String representing the object's type. Objects of the same type share the same value. - string? 'object; + string 'object; }; public type IssuingDisputeNotReceivedEvidence record { @@ -3496,41 +4233,46 @@ public type SkuInventory record { # The count of inventory available. Will be present if and only if `type` is `finite`. int? quantity?; # Inventory type. Possible values are `finite`, `bucket` (not quantified), and `infinite`. - string? 'type; + string 'type; # An indicator of the inventory available. Possible values are `in_stock`, `limited`, and `out_of_stock`. Will be present if and only if `type` is `bucket`. string? value?; }; +public type CountrySpecVerificationFields record { + CountrySpecVerificationFieldDetails company; + CountrySpecVerificationFieldDetails individual; +}; + public type PaymentMethodDetailsCardWallet record { - PaymentMethodDetailsCardWalletAmexExpressCheckout? amex_express_checkout?; - PaymentMethodDetailsCardWalletApplePay? apple_pay?; + PaymentMethodDetailsCardWalletAmexExpressCheckout amex_express_checkout?; + PaymentMethodDetailsCardWalletApplePay apple_pay?; # (For tokenized numbers only.) The last four digits of the device account number. string? dynamic_last4?; - PaymentMethodDetailsCardWalletGooglePay? google_pay?; - PaymentMethodDetailsCardWalletMasterpass? masterpass?; - PaymentMethodDetailsCardWalletSamsungPay? samsung_pay?; + PaymentMethodDetailsCardWalletGooglePay google_pay?; + PaymentMethodDetailsCardWalletMasterpass masterpass?; + PaymentMethodDetailsCardWalletSamsungPay samsung_pay?; # The type of the card wallet, one of `amex_express_checkout`, `apple_pay`, `google_pay`, `masterpass`, `samsung_pay`, or `visa_checkout`. 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. - string? 'type; - PaymentMethodDetailsCardWalletVisaCheckout? visa_checkout?; + string 'type; + PaymentMethodDetailsCardWalletVisaCheckout visa_checkout?; }; public type Tier record { - int? flat_amount?; - string? flat_amount_decimal?; - int? unit_amount?; - string? unit_amount_decimal?; - string|int? up_to; + int flat_amount?; + string flat_amount_decimal?; + int unit_amount?; + string unit_amount_decimal?; + string|int up_to; }; # Default invoice settings for this customer. public type CustomerParam1 record { - InvoiceSettingsCustomFields|string? custom_fields?; - string? default_payment_method?; - string? footer?; + InvoiceSettingsCustomFields|string custom_fields?; + string default_payment_method?; + string footer?; }; public type BillingThresholds record { - int? usage_gte; + int usage_gte; }; # [Stripe Connect](https://stripe.com/docs/connect) platforms can reverse transfers made to a @@ -3548,25 +4290,25 @@ public type BillingThresholds record { # Related guide: [Reversing Transfers](https://stripe.com/docs/connect/charges-transfers#reversing-transfers). public type TransferReversal record { # Amount, in %s. - int? amount; + int amount; # Balance transaction that describes the impact on your account balance. string|BalanceTransaction? balance_transaction?; # Time at which the object was created. Measured in seconds since the Unix epoch. - int? created; + int created; # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). - string? currency; + string currency; # Linked payment refund for the transfer reversal. string|Refund? destination_payment_refund?; # Unique identifier for the object. - string? id; + string id; # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. record {} metadata?; # String representing the object's type. Objects of the same type share the same value. - string? 'object; + string 'object; # ID of the refund responsible for the transfer reversal. string|Refund? source_refund?; # ID of the transfer that was reversed. - string|Transfer? transfer; + string|Transfer transfer; }; public type PaymentIntentNextActionBoleto record { @@ -3580,19 +4322,36 @@ public type PaymentIntentNextActionBoleto record { string? pdf?; }; +public type EphemeralKey record { + # Time at which the object was created. Measured in seconds since the Unix epoch. + int created; + # Time at which the key will expire. Measured in seconds since the Unix epoch. + int expires; + # Unique identifier for the object. + string id; + # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. + boolean livemode; + # String representing the object's type. Objects of the same type share the same value. + string 'object; + # The key's secret. You can use this value to make authorized requests to the Stripe API. + string secret?; +}; + +public type Created2 RangeQuerySpecs|int; + +public type Created1 RangeQuerySpecs|int; + public type PaymentMethodsPaymentMethodBody record { # Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods. - BillingDetailsInnerParams? billing_details?; + BillingDetailsInnerParams billing_details?; # If this is a `card` PaymentMethod, this hash contains the user's card details. - UpdateApiParam? card?; + UpdateApiParam card?; # Specifies which fields in the response should be expanded. - string[]? expand?; + string[] expand?; # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. - record {}|string? metadata?; + record {}|string metadata?; }; -public type Created1 RangeQuerySpecs|int?; - # `Refund` objects allow you to refund a charge that has previously been created # but not yet refunded. Funds will be refunded to the credit or debit card that # was originally charged. @@ -3600,27 +4359,27 @@ public type Created1 RangeQuerySpecs|int?; # Related guide: [Refunds](https://stripe.com/docs/refunds). public type Refund record { # Amount, in %s. - int? amount; + int amount; # Balance transaction that describes the impact on your account balance. string|BalanceTransaction? balance_transaction?; # ID of the charge that was refunded. string|Charge? charge?; # Time at which the object was created. Measured in seconds since the Unix epoch. - int? created; + int created; # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). - string? currency; + string currency; # An arbitrary string attached to the object. Often useful for displaying to users. (Available on non-card refunds only) - string? description?; + string description?; # If the refund failed, this balance transaction describes the adjustment made on your account balance that reverses the initial balance transaction. - string|BalanceTransaction? failure_balance_transaction?; + string|BalanceTransaction failure_balance_transaction?; # If the refund failed, the reason for refund failure if known. Possible values are `lost_or_stolen_card`, `expired_or_canceled_card`, or `unknown`. - string? failure_reason?; + string failure_reason?; # Unique identifier for the object. - string? id; + string id; # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. record {} metadata?; # String representing the object's type. Objects of the same type share the same value. - string? 'object; + string 'object; # ID of the PaymentIntent that was refunded. string|PaymentIntent? payment_intent?; # Reason for the refund, either user-provided (`duplicate`, `fraudulent`, or `requested_by_customer`) or generated by Stripe internally (`expired_uncaptured_charge`). @@ -3642,61 +4401,81 @@ public type SourceTypeP24 record { # The customer's tax IDs. public type TaxIDsList record { # Details about each object. - TaxId[]? data; + TaxId[] data; # True if this list has another page of items after this one that can be fetched. - boolean? has_more; + boolean has_more; # String representing the object's type. Objects of the same type share the same value. Always has the value `list`. - string? 'object; + string 'object; # The URL where this list can be accessed. - string? url; + string url; }; public type SourceRedirectFlow record { # The failure reason for the redirect, either `user_abort` (the customer aborted or dropped out of the redirect flow), `declined` (the authentication failed or the transaction was declined), or `processing_error` (the redirect failed due to a technical error). Present only if the redirect status is `failed`. string? failure_reason?; # The URL you provide to redirect the customer to after they authenticated their payment. - string? return_url; + string return_url; # The status of the redirect, either `pending` (ready to be used by your customer to authenticate the transaction), `succeeded` (succesful authentication, cannot be reused) or `not_required` (redirect should not be used) or `failed` (failed authentication, cannot be reused). - string? status; + string status; # The URL provided to you to redirect a customer to as part of a `redirect` authentication flow. - string? url; + string url; }; public type SubscriptionItemUpdateParams record { - record {int? usage_gte;}|string? billing_thresholds?; - boolean? clear_usage?; - boolean? deleted?; - string? id?; - record {}|string? metadata?; - string? price?; - RecurringPriceData1? price_data?; - int? quantity?; - string[]|string? tax_rates?; + record {int usage_gte;}|string billing_thresholds?; + boolean clear_usage?; + boolean deleted?; + string id?; + record {}|string metadata?; + string price?; + RecurringPriceData1 price_data?; + int quantity?; + string[]|string tax_rates?; +}; + +public type PortalSubscriptionPause record { + # Whether the feature is enabled. + boolean enabled; }; public type SetupIntentNextAction record { - SetupIntentNextActionRedirectToUrl? redirect_to_url?; + SetupIntentNextActionRedirectToUrl redirect_to_url?; # Type of the next action to perform, one of `redirect_to_url`, `use_stripe_sdk`, `alipay_handle_redirect`, or `oxxo_display_details`. - string? 'type; + string 'type; # When confirming a SetupIntent with Stripe.js, Stripe.js depends on the contents of this dictionary to invoke authentication flows. The shape of the contents is subject to change and is only intended to be used by Stripe.js. record {} use_stripe_sdk?; - SetupIntentNextActionVerifyWithMicrodeposits? verify_with_microdeposits?; + SetupIntentNextActionVerifyWithMicrodeposits verify_with_microdeposits?; }; public type PaymentMethodOptionsCardInstallments record { # Installment plans that may be selected for this PaymentIntent. PaymentMethodDetailsCardInstallmentsPlan[]? available_plans?; # Whether Installments are enabled for this PaymentIntent. - boolean? enabled; + boolean enabled; # Installment plan selected for this PaymentIntent. PaymentMethodDetailsCardInstallmentsPlan? plan?; }; public type AddInvoiceItemEntry record { - string? price?; - OneTimePriceData? price_data?; - int? quantity?; - TaxRateArray|string? tax_rates?; + string price?; + OneTimePriceData price_data?; + int quantity?; + TaxRateArray|string tax_rates?; +}; + +public type PaymentPagesPaymentPageResourcesShippingAddressCollection record { + # An array of two-letter ISO country codes representing which countries Checkout should provide as options for + # shipping locations. Unsupported country codes: `AS, CX, CC, CU, HM, IR, KP, MH, FM, NF, MP, PW, SD, SY, UM, VI`. + string[] allowed_countries; +}; + +public type SourceTransactionSepaCreditTransferData record { + # Reference associated with the transfer. + string reference?; + # Sender's bank account IBAN. + string sender_iban?; + # Sender's name. + string sender_name?; }; # To top up your Stripe balance, you create a top-up object. You can retrieve @@ -3706,13 +4485,13 @@ public type AddInvoiceItemEntry record { # Related guide: [Topping Up your Platform Account](https://stripe.com/docs/connect/top-ups). public type Topup record { # Amount transferred. - int? amount; + int amount; # ID of the balance transaction that describes the impact of this top-up on your account balance. May not be specified depending on status of top-up. string|BalanceTransaction? balance_transaction?; # Time at which the object was created. Measured in seconds since the Unix epoch. - int? created; + int created; # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). - string? currency; + string currency; # An arbitrary string attached to the object. Often useful for displaying to users. string? description?; # Date the funds are expected to arrive in your Stripe account for payouts. This factors in delays like weekends or bank holidays. May not be specified depending on status of top-up. @@ -3722,32 +4501,32 @@ public type Topup record { # Message to user further explaining reason for top-up failure if available. string? failure_message?; # Unique identifier for the object. - string? id; + string id; # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. - boolean? livemode; + boolean livemode; # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. record {} metadata; # String representing the object's type. Objects of the same type share the same value. - string? 'object; + string 'object; # `Source` objects allow you to accept a variety of payment methods. They # represent a customer's payment instrument, and can be used with the Stripe API # just like a `Card` object: once chargeable, they can be charged, or can be # attached to customers. # # Related guides: [Sources API](https://stripe.com/docs/sources) and [Sources & Customers](https://stripe.com/docs/sources/customers). - Source? 'source; + Source 'source; # Extra information about a top-up. This will appear on your source's bank statement. It must contain at least one letter. string? statement_descriptor?; # The status of the top-up is either `canceled`, `failed`, `pending`, `reversed`, or `succeeded`. - string? status; + string status; # A string that identifies this top-up as part of a group. string? transfer_group?; }; public type CustomerShippingAddress record { - OptionalFieldsAddress? address; - string? name; - string? phone?; + OptionalFieldsAddress address; + string name; + string phone?; }; public type SourceOwner record { @@ -3771,50 +4550,62 @@ public type SourceOwner record { public type PaymentMethodDetailsBoleto record { # Uniquely identifies this customer tax_id (CNPJ or CPF) - string? tax_id; + string tax_id; }; -public type DiscountsDataParam DiscountsDataParam1[]?; +public type DiscountsDataParam DiscountsDataParam1[]; # Contains information about what this coupon applies to public type CouponAppliesTo record { # A list of product IDs this coupon applies to - string[]? products; + string[] products; +}; + +# The line items purchased by the customer. +public type PaymentPagesCheckoutSessionListLineItems record { + # Details about each object. + Item[] data; + # True if this list has another page of items after this one that can be fetched. + boolean has_more; + # String representing the object's type. Objects of the same type share the same value. Always has the value `list`. + string 'object; + # The URL where this list can be accessed. + string url; }; public type V1PaymentMethodsBody record { # If this is an `acss_debit` PaymentMethod, this hash contains details about the ACSS Debit payment method. - PaymentMethodParam? acss_debit?; + PaymentMethodParam acss_debit?; # If this is an `AfterpayClearpay` PaymentMethod, this hash contains details about the AfterpayClearpay payment method. record {} afterpay_clearpay?; # If this is an `Alipay` PaymentMethod, this hash contains details about the Alipay payment method. record {} alipay?; # If this is an `au_becs_debit` PaymentMethod, this hash contains details about the bank account. - Param? au_becs_debit?; + Param au_becs_debit?; # If this is a `bacs_debit` PaymentMethod, this hash contains details about the Bacs Direct Debit bank account. - Param1? bacs_debit?; + Param1 bacs_debit?; # If this is a `bancontact` PaymentMethod, this hash contains details about the Bancontact payment method. record {} bancontact?; # Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods. - BillingDetailsInnerParams? billing_details?; + BillingDetailsInnerParams billing_details?; # If this is a `boleto` PaymentMethod, this hash contains details about the Boleto payment method. - Param2? boleto?; + Param2 boleto?; # If this is a `card` PaymentMethod, this hash contains the user's card details. For backwards compatibility, you can alternatively provide a Stripe token (e.g., for Apple Pay, Amex Express Checkout, or legacy Checkout) into the card hash with format `card: {token: "tok_visa"}`. When providing a card number, you must meet the requirements for [PCI compliance](https://stripe.com/docs/security#validating-pci-compliance). We strongly recommend using Stripe.js instead of interacting with this API directly. - CardDetailsParams|TokenParamas? card?; + CardDetailsParams|TokenParamas card?; # The `Customer` to whom the original PaymentMethod is attached. - string? customer?; + string customer?; # If this is an `eps` PaymentMethod, this hash contains details about the EPS payment method. - Param3? eps?; + Param3 eps?; # Specifies which fields in the response should be expanded. - string[]? expand?; + string[] expand?; # If this is an `fpx` PaymentMethod, this hash contains details about the FPX payment method. - Param4? fpx?; + Param4 fpx?; # If this is a `giropay` PaymentMethod, this hash contains details about the Giropay payment method. record {} giropay?; # If this is a `grabpay` PaymentMethod, this hash contains details about the GrabPay payment method. record {} grabpay?; # If this is an `ideal` PaymentMethod, this hash contains details about the iDEAL payment method. - Param5? ideal?; + Param5 ideal?; # If this is an `interac_present` PaymentMethod, this hash contains details about the Interac Present payment method. record {} interac_present?; # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. @@ -3822,41 +4613,86 @@ public type V1PaymentMethodsBody record { # If this is an `oxxo` PaymentMethod, this hash contains details about the OXXO payment method. record {} oxxo?; # If this is a `p24` PaymentMethod, this hash contains details about the P24 payment method. - Param6? p24?; + Param6 p24?; # The PaymentMethod to share. - string? payment_method?; + string payment_method?; # If this is a `sepa_debit` PaymentMethod, this hash contains details about the SEPA debit bank account. - Param7? sepa_debit?; + Param7 sepa_debit?; # If this is a `sofort` PaymentMethod, this hash contains details about the SOFORT payment method. - Param8? sofort?; + Param8 sofort?; # The type of the PaymentMethod. An additional hash is included on the PaymentMethod with a name matching this value. It contains additional information specific to the PaymentMethod type. - string? 'type?; + string 'type?; # If this is an `wechat_pay` PaymentMethod, this hash contains details about the wechat_pay payment method. record {} wechat_pay?; }; -public type Created RangeQuerySpecs|int?; +public type PaymentPagesCheckoutSessionTotalDetails record { + # This is the sum of all the line item discounts. + int amount_discount; + # This is the sum of all the line item shipping amounts. + int? amount_shipping?; + # This is the sum of all the line item tax amounts. + int amount_tax; + PaymentPagesCheckoutSessionTotalDetailsResourceBreakdown breakdown?; +}; + +public type Created record { + # Minimum value to filter by (exclusive) + int gt?; + # Minimum value to filter by (inclusive) + int gte?; + # Maximum value to filter by (exclusive) + int lt?; + # Maximum value to filter by (inclusive) + int lte?; +}|int; + +# Value lists allow you to group values together which can then be referenced in rules. +# +# Related guide: [Default Stripe Lists](https://stripe.com/docs/radar/lists#managing-list-items). +public type RadarValueList record { + # The name of the value list for use in rules. + string alias; + # Time at which the object was created. Measured in seconds since the Unix epoch. + int created; + # The name or email address of the user who created this value list. + string created_by; + # Unique identifier for the object. + string id; + # The type of items in the value list. One of `card_fingerprint`, `card_bin`, `email`, `ip_address`, `country`, `string`, or `case_sensitive_string`. + string item_type; + # List of items contained within this value list. + RadarListListItemList list_items; + # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. + boolean livemode; + # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. + record {} metadata; + # The name of the value list. + string name; + # String representing the object's type. Objects of the same type share the same value. + string 'object; +}; public type Recurring record { # Specifies a usage aggregation strategy for prices of `usage_type=metered`. Allowed values are `sum` for summing up all usage during a period, `last_during_period` for using the last usage record reported within a period, `last_ever` for using the last usage record ever (across period bounds) or `max` which uses the usage record with the maximum reported usage during a period. Defaults to `sum`. string? aggregate_usage?; # The frequency at which a subscription is billed. One of `day`, `week`, `month` or `year`. - string? interval; + string interval; # The number of intervals (specified in the `interval` attribute) between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. - int? interval_count; + int interval_count; # Configures how the quantity per period should be determined. Can be either `metered` or `licensed`. `licensed` automatically bills the `quantity` set when adding it to a subscription. `metered` aggregates the total usage based on usage records. Defaults to `licensed`. - string? usage_type; + string usage_type; }; public type PackageDimensions record { # Height, in inches. - decimal? height; + decimal height; # Length, in inches. - decimal? length; + decimal length; # Weight, in ounces. - decimal? weight; + decimal weight; # Width, in inches. - decimal? width; + decimal width; }; public type SetupAttemptPaymentMethodDetailsBacsDebit record { @@ -3868,13 +4704,23 @@ public type PaymentMethodDetailsWechat record { # The customer's payment sources, if any. public type ApmsSourcesSourceList record { # Details about each object. - (AlipayAccount|BankAccount|BitcoinReceiver|Card|Source?)[]? data; + (AlipayAccount|BankAccount|BitcoinReceiver|Card|Source)[] data; # True if this list has another page of items after this one that can be fetched. - boolean? has_more; + boolean has_more; # String representing the object's type. Objects of the same type share the same value. Always has the value `list`. - string? 'object; + string 'object; # The URL where this list can be accessed. - string? url; + string url; +}; + +# Point in Time +public type GelatoDataIdNumberReportDate record { + # Numerical day between 1 and 31. + int? day?; + # Numerical month between 1 and 12. + int? month?; + # The four-digit year. + int? year?; }; public type PaymentMethodOptionsSofort record { @@ -3882,52 +4728,154 @@ public type PaymentMethodOptionsSofort record { string? preferred_language?; }; +# A Checkout Session represents your customer's session as they pay for +# one-time purchases or subscriptions through [Checkout](https://stripe.com/docs/payments/checkout). +# We recommend creating a new Session each time your customer attempts to pay. +# +# Once payment is successful, the Checkout Session will contain a reference +# to the [Customer](https://stripe.com/docs/api/customers), and either the successful +# [PaymentIntent](https://stripe.com/docs/api/payment_intents) or an active +# [Subscription](https://stripe.com/docs/api/subscriptions). +# +# You can create a Checkout Session on your server and pass its ID to the +# client to begin Checkout. +# +# Related guide: [Checkout Server Quickstart](https://stripe.com/docs/payments/checkout/api). +public type CheckoutSession record { + # Enables user redeemable promotion codes. + boolean? allow_promotion_codes?; + # Total of all items before discounts or taxes are applied. + int? amount_subtotal?; + # Total of all items after discounts and taxes are applied. + int? amount_total?; + PaymentPagesCheckoutSessionAutomaticTax automatic_tax; + # Describes whether Checkout should collect the customer's billing address. + string? billing_address_collection?; + # The URL the customer will be directed to if they decide to cancel payment and return to your website. + string cancel_url; + # A unique string to reference the Checkout Session. This can be a + # customer ID, a cart ID, or similar, and can be used to reconcile the + # Session with your internal systems. + string? client_reference_id?; + # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + string? currency?; + # The ID of the customer for this Session. + # For Checkout Sessions in `payment` or `subscription` mode, Checkout + # will create a new customer object based on information provided + # during the payment flow unless an existing customer was provided when + # the Session was created. + string|Customer|DeletedCustomer? customer?; + # The customer details including the customer's tax exempt status and the customer's tax IDs. Only present on Sessions in `payment` or `subscription` mode. + PaymentPagesCheckoutSessionCustomerDetails? customer_details?; + # If provided, this value will be used when the Customer object is created. + # If not provided, customers will be asked to enter their email address. + # Use this parameter to prefill customer data if you already have an email + # on file. To access information about the customer once the payment flow is + # complete, use the `customer` attribute. + string? customer_email?; + # Unique identifier for the object. Used to pass to `redirectToCheckout` + # in Stripe.js. + string id; + # The line items purchased by the customer. + PaymentPagesCheckoutSessionListLineItems line_items?; + # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. + boolean livemode; + # The IETF language tag of the locale Checkout is displayed in. If blank or `auto`, the browser's locale is used. + string? locale?; + # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. + record {} metadata?; + # The mode of the Checkout Session. + string mode; + # String representing the object's type. Objects of the same type share the same value. + string 'object; + # The ID of the PaymentIntent for Checkout Sessions in `payment` mode. + string|PaymentIntent? payment_intent?; + # Payment-method-specific configuration for the PaymentIntent or SetupIntent of this CheckoutSession. + CheckoutSessionPaymentMethodOptions? payment_method_options?; + # A list of the types of payment methods (e.g. card) this Checkout + # Session is allowed to accept. + string[] payment_method_types; + # The payment status of the Checkout Session, one of `paid`, `unpaid`, or `no_payment_required`. + # You can use this value to decide when to fulfill your customer's order. + string payment_status; + # The ID of the SetupIntent for Checkout Sessions in `setup` mode. + string|SetupIntent? setup_intent?; + # Shipping information for this Checkout Session. + Shipping? shipping?; + # When set, provides configuration for Checkout to collect a shipping address from a customer. + PaymentPagesPaymentPageResourcesShippingAddressCollection? shipping_address_collection?; + # 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. + string? submit_type?; + # The ID of the subscription for Checkout Sessions in `subscription` mode. + string|Subscription? subscription?; + # The URL the customer will be directed to after the payment or + # subscription creation is successful. + string success_url; + PaymentPagesCheckoutSessionTaxIdCollection tax_id_collection?; + # Tax and discount details for the computed total amount. + PaymentPagesCheckoutSessionTotalDetails? total_details?; + # The URL to the Checkout Session. + string? url?; +}; + +public type DeletedSku record { + # Always true for a deleted object + boolean deleted; + # Unique identifier for the object. + string id; + # String representing the object's type. Objects of the same type share the same value. + string 'object; +}; + public type PhaseConfigurationParams record { - AddInvoiceItemEntry1[]? add_invoice_items?; - decimal? application_fee_percent?; - AutomaticTaxConfig3? automatic_tax?; - string? billing_cycle_anchor?; - record {int? amount_gte?; boolean? reset_billing_cycle_anchor?;}|string? billing_thresholds?; - string? collection_method?; - string? coupon?; - string? default_payment_method?; - string[]|string? default_tax_rates?; - int? end_date?; - SubscriptionSchedulesParam1? invoice_settings?; - ConfigurationItemParams[]? items; - int? iterations?; - string? proration_behavior?; - TransferDataSpecs3? transfer_data?; - boolean? trial?; - int? trial_end?; + AddInvoiceItemEntry1[] add_invoice_items?; + decimal application_fee_percent?; + AutomaticTaxConfig3 automatic_tax?; + string billing_cycle_anchor?; + record {int amount_gte?; boolean reset_billing_cycle_anchor?;}|string billing_thresholds?; + string collection_method?; + string coupon?; + string default_payment_method?; + string[]|string default_tax_rates?; + int end_date?; + SubscriptionSchedulesParam1 invoice_settings?; + ConfigurationItemParams[] items; + int iterations?; + string proration_behavior?; + TransferDataSpecs3 transfer_data?; + boolean trial?; + int trial_end?; }; public type InvoicesList record { - Invoice[]? data; + Invoice[] data; # True if this list has another page of items after this one that can be fetched. - boolean? has_more; + boolean has_more; # String representing the object's type. Objects of the same type share the same value. Always has the value `list`. - string? 'object; + string 'object; # The URL where this list can be accessed. - string? url; + string url; }; # If this is a `card` PaymentMethod, this hash contains the user's card details. public type UpdateApiParam record { - int? exp_month?; - int? exp_year?; + int exp_month?; + int exp_year?; }; public type LegalEntityCompany record { - Address? address?; + Address address?; # The Kana variation of the company's primary address (Japan only). LegalEntityJapanAddress? address_kana?; # The Kanji variation of the company's primary address (Japan only). LegalEntityJapanAddress? address_kanji?; # Whether the company's directors have been provided. This Boolean will be `true` if you've manually indicated that all directors are provided via [the `directors_provided` parameter](https://stripe.com/docs/api/accounts/update#update_account-company-directors_provided). - boolean? directors_provided?; + boolean directors_provided?; # Whether the company's executives have been provided. This Boolean will be `true` if you've manually indicated that all executives are provided via [the `executives_provided` parameter](https://stripe.com/docs/api/accounts/update#update_account-company-executives_provided), or if Stripe determined that sufficient executives were provided. - boolean? executives_provided?; + boolean executives_provided?; # The company's legal name. string? name?; # The Kana variation of the company's legal name (Japan only). @@ -3935,17 +4883,17 @@ public type LegalEntityCompany record { # The Kanji variation of the company's legal name (Japan only). string? name_kanji?; # Whether the company's owners have been provided. This Boolean will be `true` if you've manually indicated that all owners are provided via [the `owners_provided` parameter](https://stripe.com/docs/api/accounts/update#update_account-company-owners_provided), or if Stripe determined that sufficient owners were provided. Stripe determines ownership requirements using both the number of owners provided and their total percent ownership (calculated by adding the `percent_ownership` of each owner together). - boolean? owners_provided?; + boolean owners_provided?; # The company's phone number (used for verification). string? phone?; # The category identifying the legal structure of the company or legal entity. See [Business structure](https://stripe.com/docs/connect/identity-verification#business-structure) for more details. - string? structure?; + string structure?; # Whether the company's business ID number was provided. - boolean? tax_id_provided?; + boolean tax_id_provided?; # The jurisdiction in which the `tax_id` is registered (Germany-based companies only). - string? tax_id_registrar?; + string tax_id_registrar?; # Whether the company's business VAT number was provided. - boolean? vat_id_provided?; + boolean vat_id_provided?; # Information on the verification state of the company. LegalEntityCompanyVerification? verification?; }; @@ -3955,21 +4903,21 @@ public type SetupIntentPaymentMethodOptionsCard record { string? request_three_d_secure?; }; -public type SubscriptionBillingCycleAnchor string|int?; +public type SubscriptionBillingCycleAnchor string|int; public type AutomaticTaxParam2 record { - boolean? enabled; + boolean enabled; }; public type SubscriptionPendingInvoiceItemInterval record { # Specifies invoicing frequency. Either `day`, `week`, `month` or `year`. - string? interval; + string interval; # The number of intervals between invoices. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks). - int? interval_count; + int interval_count; }; public type AutomaticTaxParam1 record { - boolean? enabled; + boolean enabled; }; # A dispute occurs when a customer questions your charge with their card issuer. @@ -3981,33 +4929,84 @@ public type AutomaticTaxParam1 record { # Related guide: [Disputes and Fraud](https://stripe.com/docs/disputes). public type Dispute record { # Disputed amount. Usually the amount of the charge, but can differ (usually because of currency fluctuation or because only part of the order is disputed). - int? amount; + int amount; # List of zero, one, or two balance transactions that show funds withdrawn and reinstated to your Stripe account as a result of this dispute. - BalanceTransaction[]? balance_transactions; + BalanceTransaction[] balance_transactions; # ID of the charge that was disputed. - string|Charge? charge; + string|Charge charge; # Time at which the object was created. Measured in seconds since the Unix epoch. - int? created; + int created; # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). - string? currency; - DisputeEvidence? evidence; - DisputeEvidenceDetails? evidence_details; + string currency; + DisputeEvidence evidence; + DisputeEvidenceDetails evidence_details; # Unique identifier for the object. - string? id; + string id; # If true, it is still possible to refund the disputed payment. Once the payment has been fully refunded, no further funds will be withdrawn from your Stripe account as a result of this dispute. - boolean? is_charge_refundable; + boolean is_charge_refundable; # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. - boolean? livemode; + boolean livemode; # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. record {} metadata; # String representing the object's type. Objects of the same type share the same value. - string? 'object; + string 'object; # ID of the PaymentIntent that was disputed. string|PaymentIntent? payment_intent?; # Reason given by cardholder for dispute. Possible values are `bank_cannot_process`, `check_returned`, `credit_not_processed`, `customer_initiated`, `debit_not_authorized`, `duplicate`, `fraudulent`, `general`, `incorrect_account_details`, `insufficient_funds`, `product_not_received`, `product_unacceptable`, `subscription_canceled`, or `unrecognized`. Read more about [dispute reasons](https://stripe.com/docs/disputes/categories). - string? reason; + string reason; # Current status of dispute. Possible values are `warning_needs_response`, `warning_under_review`, `warning_closed`, `needs_response`, `under_review`, `charge_refunded`, `won`, or `lost`. - string? status; + string status; +}; + +# Events are our way of letting you know when something interesting happens in +# your account. When an interesting event occurs, we create a new `Event` +# object. For example, when a charge succeeds, we create a `charge.succeeded` +# event; and when an invoice payment attempt fails, we create an +# `invoice.payment_failed` event. Note that many API requests may cause multiple +# events to be created. For example, if you create a new subscription for a +# customer, you will receive both a `customer.subscription.created` event and a +# `charge.succeeded` event. +# +# Events occur when the state of another API resource changes. The state of that +# resource at the time of the change is embedded in the event's data field. For +# example, a `charge.succeeded` event will contain a charge, and an +# `invoice.payment_failed` event will contain an invoice. +# +# As with other API resources, you can use endpoints to retrieve an +# [individual event](https://stripe.com/docs/api#retrieve_event) or a [list of events](https://stripe.com/docs/api#list_events) +# from the API. We also have a separate +# [webhooks](http://en.wikipedia.org/wiki/Webhook) system for sending the +# `Event` objects directly to an endpoint on your server. Webhooks are managed +# in your +# [account settings](https://dashboard.stripe.com/account/webhooks), +# and our [Using Webhooks](https://stripe.com/docs/webhooks) guide will help you get set up. +# +# When using [Connect](https://stripe.com/docs/connect), you can also receive notifications of +# events that occur in connected accounts. For these events, there will be an +# additional `account` attribute in the received `Event` object. +# +# **NOTE:** Right now, access to events through the [Retrieve Event API](https://stripe.com/docs/api#retrieve_event) is +# guaranteed only for 30 days. +public type Event record { + # The connected account that originated the event. + string account?; + # The Stripe API version used to render `data`. *Note: This property is populated only for events on or after October 31, 2014*. + string? api_version?; + # Time at which the object was created. Measured in seconds since the Unix epoch. + int created; + NotificationEventData data; + # Unique identifier for the object. + string id; + # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. + boolean livemode; + # String representing the object's type. Objects of the same type share the same value. + string 'object; + # Number of webhooks that have yet to be successfully delivered (i.e., to return a 20x response) to the URLs you've specified. + int pending_webhooks; + # Information on the API request that instigated the event. + NotificationEventRequest? request?; + # Description of the event (e.g., `invoice.created` or `charge.refunded`). + string 'type; }; public type PaymentMethodDetailsOxxo record { @@ -4020,37 +5019,44 @@ public type PaymentMethodOptionsP24 record { # Configuration settings for the PaymentIntent that is generated when the invoice is finalized. public type PaymentSettings record { - PaymentMethodOptions? payment_method_options?; - string[]|string? payment_method_types?; + PaymentMethodOptions payment_method_options?; + string[]|string payment_method_types?; }; # The line items that will appear on the next invoice after this quote is accepted. This does not include pending invoice items that exist on the customer but may still be included in the next invoice. public type Quotesresourcelistlineitems1 record { # Details about each object. - Item[]? data; + Item[] data; # True if this list has another page of items after this one that can be fetched. - boolean? has_more; + boolean has_more; # String representing the object's type. Objects of the same type share the same value. Always has the value `list`. - string? 'object; + string 'object; # The URL where this list can be accessed. - string? url; + string url; }; public type BitcoinTransaction record { # The amount of `currency` that the transaction was converted to in real-time. - int? amount; + int amount; # The amount of bitcoin contained in the transaction. - int? bitcoin_amount; + int bitcoin_amount; # Time at which the object was created. Measured in seconds since the Unix epoch. - int? created; + int created; # Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) to which this transaction was converted. - string? currency; + string currency; # Unique identifier for the object. - string? id; + string id; # String representing the object's type. Objects of the same type share the same value. - string? 'object; + string 'object; # The receiver to which this transaction was sent. - string? receiver; + string receiver; +}; + +public type PaymentPagesCheckoutSessionTaxId record { + # The type of the tax ID, one of `eu_vat`, `br_cnpj`, `br_cpf`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `li_uid`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, or `unknown` + string 'type; + # The value of the tax ID. + string? value?; }; public type IssuingDisputeCanceledEvidence record { @@ -4079,9 +5085,40 @@ public type IssuingDisputeCanceledEvidence record { public type PaymentMethodCardWalletApplePay record { }; +public type GelatoSessionIdNumberOptions record { +}; + +public type CheckoutAcssDebitPaymentMethodOptions record { + # Currency supported by the bank account. Returned when the Session is in `setup` mode. + string currency?; + CheckoutAcssDebitMandateOptions mandate_options?; + # Bank account verification method. + string verification_method?; +}; + +public type PortalPaymentMethodUpdate record { + # Whether the feature is enabled. + boolean enabled; +}; + public type PaymentMethodInteracPresent record { }; +public type GelatoVerifiedOutputs record { + # The user's verified address. + Address? address?; + # The user’s verified date of birth. + GelatoDataVerifiedOutputsDate? dob?; + # The user's verified first name. + string? first_name?; + # The user's verified id number. + string? id_number?; + # The user's verified id number type. + string? id_number_type?; + # The user's verified last name. + string? last_name?; +}; + public type PaymentMethodGiropay record { }; @@ -4110,7 +5147,7 @@ public type PaymentMethodDetailsSofort record { public type InvoiceMarkUncollectibleBody record { # Specifies which fields in the response should be expanded. - string[]? expand?; + string[] expand?; }; public type IssuingTransactionAmountDetails record { @@ -4118,33 +5155,38 @@ public type IssuingTransactionAmountDetails record { int? atm_fee?; }; +public type PaymentPagesCheckoutSessionTaxIdCollection record { + # Indicates whether tax ID collection is enabled for the session + boolean enabled; +}; + public type LineItemsDiscountAmount record { # The amount discounted. - int? amount; + int amount; # A discount represents the actual application of a coupon to a particular # customer. It contains information about when the discount began and when it # will end. # # Related guide: [Applying Discounts to Subscriptions](https://stripe.com/docs/billing/subscriptions/discounts). - Discount? discount; + Discount discount; }; -public type SubscriptionTrialEnd1 string|int?; +public type SubscriptionTrialEnd1 string|int; public type InvoicesResourceInvoiceTaxId record { # The type of the tax ID, one of `eu_vat`, `br_cnpj`, `br_cpf`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `li_uid`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, or `unknown` - string? 'type; + string 'type; # The value of the tax ID. string? value?; }; public type IssuingCardSpendingLimit record { # Maximum amount allowed to spend per interval. - int? amount; + int amount; # Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) this limit applies to. Omitting this field will apply the limit to all categories. string[]? categories?; # Interval (or event) to which the amount applies. - string? interval; + string interval; }; public type PaymentMethodDetailsAcssDebit record { @@ -4157,28 +5199,28 @@ public type PaymentMethodDetailsAcssDebit record { # Last four digits of the bank account number. string? last4?; # ID of the mandate used to make this payment. - string? mandate?; + string mandate?; # Transit number of the bank account. string? transit_number?; }; public type SourceOrder record { # A positive integer in the smallest currency unit (that is, 100 cents for $1.00, or 1 for ¥1, Japanese Yen being a zero-decimal currency) representing the total amount for the order. - int? amount; + int amount; # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). - string? currency; + string currency; # The email address of the customer placing the order. - string? email?; + string email?; # List of items constituting the order. SourceOrderItem[]? items?; - Shipping? shipping?; + Shipping shipping?; }; public type QuotesResourceTotalDetailsResourceBreakdown record { # The aggregated line item discounts. - LineItemsDiscountAmount[]? discounts; + LineItemsDiscountAmount[] discounts; # The aggregated line item tax amounts by rate. - LineItemsTaxAmount[]? taxes; + LineItemsTaxAmount[] taxes; }; public type PaymentMethodDetailsGiropay record { @@ -4195,7 +5237,7 @@ public type PaymentMethodDetailsGiropay record { }; public type SetupIntentPaymentMethodOptionsSepaDebit record { - SetupIntentPaymentMethodOptionsMandateOptionsSepaDebit? mandate_options?; + SetupIntentPaymentMethodOptionsMandateOptionsSepaDebit mandate_options?; }; public type SourceTypeMultibanco record { @@ -4211,36 +5253,70 @@ public type SourceTypeMultibanco record { string? refund_iban?; }; -public type SubscriptionDefaultTaxRates1 string[]|string?; +# You can configure [webhook endpoints](https://stripe.com/docs/webhooks/) via the API to be +# notified about events that happen in your Stripe account or connected +# accounts. +# +# Most users configure webhooks from [the dashboard](https://dashboard.stripe.com/webhooks), which provides a user interface for registering and testing your webhook endpoints. +# +# Related guide: [Setting up Webhooks](https://stripe.com/docs/webhooks/configure). +public type WebhookEndpoint record { + # The API version events are rendered as for this webhook endpoint. + string? api_version?; + # The ID of the associated Connect application. + string? application?; + # Time at which the object was created. Measured in seconds since the Unix epoch. + int created; + # An optional description of what the webhook is used for. + string? description?; + # The list of events to enable for this endpoint. `['*']` indicates that all events are enabled, except those that require explicit selection. + string[] enabled_events; + # Unique identifier for the object. + string id; + # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. + boolean livemode; + # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. + record {} metadata; + # String representing the object's type. Objects of the same type share the same value. + string 'object; + # The endpoint's secret, used to generate [webhook signatures](https://stripe.com/docs/webhooks/signatures). Only returned at creation. + string secret?; + # The status of the webhook. It can be `enabled` or `disabled`. + string status; + # The URL of the webhook endpoint. + string url; +}; + +public type SubscriptionDefaultTaxRates1 string[]|string; public type ProductsIdBody record { # Whether the product is available for purchase. - boolean? active?; + boolean active?; # 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. - string? description?; + string description?; # Specifies which fields in the response should be expanded. - string[]? expand?; + string[] expand?; # A list of up to 8 URLs of images for this product, meant to be displayable to the customer. - string[]|string? images?; + string[]|string images?; # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. - AdditionalProperties|string? metadata?; + AdditionalProperties|string metadata?; # The product's name, meant to be displayable to the customer. Whenever this product is sold via a subscription, name will show up on associated invoice line item descriptions. - string? name?; + string name?; # The dimensions of this product for shipping purposes. - PackageDimentionsSpecs|string? package_dimensions?; + PackageDimentionsSpecs|string package_dimensions?; # Whether this product is shipped (i.e., physical goods). - boolean? shippable?; + boolean shippable?; # An arbitrary string to be displayed on your customer's credit card or bank statement. While most banks display this information consistently, some may display it incorrectly or not at all. # # This may be up to 22 characters. The statement description may not include `<`, `>`, `\`, `"`, `'` characters, and will appear on your customer's statement in capital letters. Non-ASCII characters are automatically stripped. # It must contain at least one letter. May only be set if `type=service`. - string? statement_descriptor?; + string statement_descriptor?; # A [tax code](https://stripe.com/docs/tax/tax-codes) ID. - string|string? tax_code?; + string|string tax_code?; # 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. May only be set if `type=service`. - string? unit_label?; + string unit_label?; # A URL of a publicly-accessible webpage for this product. - string? url?; + string url?; }; # Any use of an [issued card](https://stripe.com/docs/issuing) that results in funds entering or leaving @@ -4250,7 +5326,7 @@ public type ProductsIdBody record { # Related guide: [Issued Card Transactions](https://stripe.com/docs/issuing/purchases/transactions). public type IssuingTransaction record { # The transaction amount, which will be reflected in your balance. This amount is in your currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). - int? amount; + int amount; # Detailed breakdown of amount components. These amounts are denominated in `currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). IssuingTransactionAmountDetails? amount_details?; # The `Authorization` object that led to this transaction. @@ -4258,41 +5334,60 @@ public type IssuingTransaction record { # ID of the [balance transaction](https://stripe.com/docs/api/balance_transactions) associated with this transaction. string|BalanceTransaction? balance_transaction?; # The card used to make this transaction. - string|IssuingCard? card; + string|IssuingCard card; # The cardholder to whom this transaction belongs. string|IssuingCardholder? cardholder?; # Time at which the object was created. Measured in seconds since the Unix epoch. - int? created; + int created; # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). - string? currency; + string currency; # If you've disputed the transaction, the ID of the dispute. string|IssuingDispute? dispute?; # Unique identifier for the object. - string? id; + string id; # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. - boolean? livemode; + boolean livemode; # The amount that the merchant will receive, denominated in `merchant_currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). It will be different from `amount` if the merchant is taking payment in a different currency. - int? merchant_amount; + int merchant_amount; # The currency with which the merchant is taking payment. - string? merchant_currency; - IssuingAuthorizationMerchantData? merchant_data; + string merchant_currency; + IssuingAuthorizationMerchantData merchant_data; # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. record {} metadata; # String representing the object's type. Objects of the same type share the same value. - string? 'object; + string 'object; # Additional purchase information that is optionally provided by the merchant. IssuingTransactionPurchaseDetails? purchase_details?; # The nature of the transaction. - string? 'type; + string 'type; # The digital wallet used for this transaction. One of `apple_pay`, `google_pay`, or `samsung_pay`. string? wallet?; }; +public type FinancialReportingFinanceReportRunRunParameters record { + # The set of output columns requested for inclusion in the report run. + string[] columns?; + # Connected account ID by which to filter the report run. + string connected_account?; + # Currency of objects to be included in the report run. + string currency?; + # Ending timestamp of data to be included in the report run (exclusive). + int interval_end?; + # Starting timestamp of data to be included in the report run. + int interval_start?; + # Payout ID by which to filter the report run. + string payout?; + # Category of balance transactions to be included in the report run. + string reporting_category?; + # Defaults to `Etc/UTC`. The output timezone for all timestamps in the report. A list of possible time zone values is maintained at the [IANA Time Zone Database](http://www.iana.org/time-zones). Has no effect on `interval_start` or `interval_end`. + string timezone?; +}; + public type IssuingAuthorizationMerchantData record { # A categorization of the seller's type of business. See our [merchant categories guide](https://stripe.com/docs/issuing/merchant-categories) for a list of possible values. - string? category; + string category; # The merchant category code for the seller’s business - string? category_code; + string category_code; # City where the seller is located string? city?; # Country where the seller is located @@ -4300,7 +5395,7 @@ public type IssuingAuthorizationMerchantData record { # Name of the seller string? name?; # Identifier assigned to the seller by the card brand - string? network_id; + string network_id; # Postal code where the seller is located string? postal_code?; # State where the seller is located @@ -4324,16 +5419,47 @@ public type PaymentMethodDetailsSepaDebit record { # All invoices will be billed using the specified settings public type SubscriptionSchedulesParam record { - int? days_until_due?; + int days_until_due?; +}; + +public type GelatoSessionDocumentOptions record { + # Array of strings of allowed identity document types. If the provided identity document isn’t one of the allowed types, the verification check will fail with a document_type_not_allowed error code. + string[] allowed_types?; + # Collect an ID number and perform an [ID number check](https://stripe.com/docs/identity/verification-checks?type=id-number) with the document’s extracted name and date of birth. + boolean require_id_number?; + # Disable image uploads, identity document images have to be captured using the device’s camera. + boolean require_live_capture?; + # Capture a face image and perform a [selfie check](https://stripe.com/docs/identity/verification-checks?type=selfie) comparing a photo ID and a picture of your user’s face. [Learn more](https://stripe.com/docs/identity/selfie). + boolean require_matching_selfie?; +}; + +# `Exchange Rate` objects allow you to determine the rates that Stripe is +# currently using to convert from one currency to another. Since this number is +# variable throughout the day, there are various reasons why you might want to +# know the current rate (for example, to dynamically price an item for a user +# with a default payment in a foreign currency). +# +# If you want a guarantee that the charge is made with a certain exchange rate +# you expect is current, you can pass in `exchange_rate` to charges endpoints. +# If the value is no longer up to date, the charge won't go through. Please +# refer to our [Exchange Rates API](https://stripe.com/docs/exchange-rates) guide for more +# details. +public type ExchangeRate record { + # Unique identifier for the object. Represented as the three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) in lowercase. + string id; + # String representing the object's type. Objects of the same type share the same value. + string 'object; + # Hash where the keys are supported currencies and the values are the exchange rate at which the base id currency converts to the key currency. + record {} rates; }; public type IssuingTransactionFuelData record { # The type of fuel that was purchased. One of `diesel`, `unleaded_plus`, `unleaded_regular`, `unleaded_super`, or `other`. - string? 'type; + string 'type; # The units for `volume_decimal`. One of `us_gallon` or `liter`. - string? unit; + string unit; # The cost in cents per each unit of fuel, represented as a decimal string with at most 12 decimal places. - string? unit_cost_decimal; + string unit_cost_decimal; # The volume of the fuel that was pumped, represented as a decimal string with at most 12 decimal places. string? volume_decimal?; }; @@ -4344,23 +5470,23 @@ public type DeletedDiscount record { # A coupon contains information about a percent-off or amount-off discount you # might want to apply to a customer. Coupons may be applied to [invoices](https://stripe.com/docs/api#invoices) or # [orders](https://stripe.com/docs/api#create_order-coupon). Coupons do not work with conventional one-off [charges](https://stripe.com/docs/api#create_charge). - Coupon? coupon; + Coupon coupon; # The ID of the customer associated with this discount. string|Customer|DeletedCustomer? customer?; # Always true for a deleted object - boolean? deleted; + boolean deleted; # The ID of the discount object. Discounts cannot be fetched by ID. Use `expand[]=discounts` in API calls to expand discount IDs in an array. - string? id; + string id; # The invoice that the discount's coupon was applied to, if it was applied directly to a particular invoice. string? invoice?; # The invoice item `id` (or invoice line item `id` for invoice line items of type='subscription') that the discount's coupon was applied to, if it was applied directly to a particular invoice item or invoice line item. string? invoice_item?; # String representing the object's type. Objects of the same type share the same value. - string? 'object; + string 'object; # The promotion code applied to create this discount. string|PromotionCode? promotion_code?; # Date that the coupon was applied. - int? 'start; + int 'start; # The subscription that this coupon is applied to, if it is applied to a particular subscription. string? subscription?; }; @@ -4381,43 +5507,43 @@ public type PaymentMethodAfterpayClearpay record { public type V1SubscriptionsBody record { # A list of prices and quantities that will generate invoice items appended to the first invoice for this subscription. You may pass up to 20 items. - AddInvoiceItemEntry[]? add_invoice_items?; + AddInvoiceItemEntry[] add_invoice_items?; # A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the application owner's Stripe account. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions). - decimal? application_fee_percent?; + decimal application_fee_percent?; # Automatic tax settings for this subscription. - AutomaticTaxConfig? automatic_tax?; + AutomaticTaxConfig automatic_tax?; # For new subscriptions, a past timestamp to backdate the subscription's start date to. If set, the first invoice will contain a proration for the timespan between the start date and the current time. Can be combined with trials and the billing cycle anchor. - int? backdate_start_date?; + int backdate_start_date?; # A future timestamp to anchor the subscription's [billing cycle](https://stripe.com/docs/subscriptions/billing-cycle). This is used to determine the date of the first full invoice, and, for plans with `month` or `year` intervals, the day of the month for subsequent invoices. - int? billing_cycle_anchor?; + int billing_cycle_anchor?; # Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds. - BillingThresholdParams|string? billing_thresholds?; + BillingThresholdParams|string billing_thresholds?; # A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using `proration_behavior`. If set during a future period, this will always cause a proration for that period. - int? cancel_at?; + int cancel_at?; # Boolean indicating whether this subscription should cancel at the end of the current period. - boolean? cancel_at_period_end?; + boolean cancel_at_period_end?; # 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. When sending an invoice, Stripe will email your customer an invoice with payment instructions. Defaults to `charge_automatically`. - string? collection_method?; + string collection_method?; # The ID of the coupon to apply to this subscription. A coupon applied to a subscription will only affect invoices created for that particular subscription. - string? coupon?; + string coupon?; # The identifier of the customer to subscribe. - string? customer; + string customer; # Number of days a customer has to pay invoices generated by this subscription. Valid only for subscriptions where `collection_method` is set to `send_invoice`. - int? days_until_due?; + int days_until_due?; # ID of the default payment method for the subscription. It must belong to the customer associated with the subscription. This takes precedence over `default_source`. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://stripe.com/docs/api/customers/object#customer_object-default_source). - string? default_payment_method?; + string default_payment_method?; # ID of the default payment source for the subscription. It must belong to the customer associated with the subscription and be in a chargeable state. If `default_payment_method` is also set, `default_payment_method` will take precedence. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://stripe.com/docs/api/customers/object#customer_object-default_source). - string? default_source?; + string default_source?; # 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. - TaxRateArray|string? default_tax_rates?; + TaxRateArray|string default_tax_rates?; # Specifies which fields in the response should be expanded. - string[]? expand?; + string[] expand?; # A list of up to 20 subscription items, each with an attached price. - SubscriptionItemCreateParams[]? items?; + SubscriptionItemCreateParams[] items?; # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. - AdditionalProperties|string? metadata?; + AdditionalProperties|string metadata?; # Indicates if a customer is on or off-session while an invoice payment is attempted. - boolean? off_session?; + boolean off_session?; # Use `allow_incomplete` to create subscriptions with `status=incomplete` if the first invoice cannot be paid. Creating subscriptions with this status allows you to manage scenarios where additional user actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the [SCA Migration Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior. # # Use `default_incomplete` to create Subscriptions with `status=incomplete` when the first invoice requires payment, otherwise start as active. Subscriptions transition to `status=active` when successfully confirming the payment intent on the first invoice. This allows simpler management of scenarios where additional user actions are needed to pay a subscription’s invoice. Such as failed payments, [SCA regulation](https://stripe.com/docs/billing/migration/strong-customer-authentication), or collecting a mandate for a bank debit payment method. If the payment intent is not confirmed within 23 hours subscriptions transition to `status=incomplete_expired`, which is a terminal state. @@ -4425,30 +5551,30 @@ public type V1SubscriptionsBody record { # Use `error_if_incomplete` if you want Stripe to return an HTTP 402 status code if a subscription's first invoice cannot be paid. For example, if a payment method requires 3DS authentication due to SCA regulation and further user action is needed, this parameter does not create a subscription and returns an error instead. This was the default behavior for API versions prior to 2019-03-14. See the [changelog](https://stripe.com/docs/upgrades#2019-03-14) to learn more. # # `pending_if_incomplete` is only used with updates and cannot be passed when creating a subscription. - string? payment_behavior?; + string payment_behavior?; # Payment settings to pass to invoices created by the subscription. - PaymentSettings1? payment_settings?; + PaymentSettings1 payment_settings?; # Specifies an interval for how often to bill for any pending invoice items. It is analogous to calling [Create an invoice](https://stripe.com/docs/api#create_invoice) for the given subscription at the specified interval. - PendingInvoiceItemIntervalParams|string? pending_invoice_item_interval?; + PendingInvoiceItemIntervalParams|string pending_invoice_item_interval?; # The API ID of a promotion code to apply to this subscription. A promotion code applied to a subscription will only affect invoices created for that particular subscription. - string? promotion_code?; + string promotion_code?; # Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#prorations) resulting from the `billing_cycle_anchor`. Valid values are `create_prorations` or `none`. # # Passing `create_prorations` will cause proration invoice items to be created when applicable. Prorations can be disabled by passing `none`. If no value is passed, the default is `create_prorations`. - string? proration_behavior?; + string proration_behavior?; # If specified, the funds from the subscription's invoices will be transferred to the destination and the ID of the resulting transfers will be found on the resulting charges. - TransferDataSpecs2? transfer_data?; + TransferDataSpecs2 transfer_data?; # Unix timestamp representing the end of the trial period the customer will get before being charged for the first time. This will always overwrite any trials that might apply via a subscribed plan. If set, trial_end will override the default trial period of the plan the customer is being subscribed to. The special value `now` can be provided to end the customer's trial immediately. Can be at most two years from `billing_cycle_anchor`. - string|int? trial_end?; + string|int trial_end?; # Indicates if a plan's `trial_period_days` should be applied to the subscription. Setting `trial_end` per subscription is preferred, and this defaults to `false`. Setting this flag to `true` together with `trial_end` is not allowed. - boolean? trial_from_plan?; + boolean trial_from_plan?; # Integer representing the number of trial period days before the customer is charged for the first time. This will always overwrite any trials that might apply via a subscribed plan. - int? trial_period_days?; + int trial_period_days?; }; public type PaymentIntentPaymentMethodOptionsMandateOptionsAcssDebit record { # A URL for custom mandate text - string? custom_mandate_url?; + string custom_mandate_url?; # Description of the interval. Only required if the 'payment_schedule' parameter is 'interval' or 'combined'. string? interval_description?; # Payment schedule for the mandate. @@ -4469,25 +5595,25 @@ public type Review record { # The reason the review was closed, or null if it has not yet been closed. One of `approved`, `refunded`, `refunded_as_fraud`, `disputed`, or `redacted`. string? closed_reason?; # Time at which the object was created. Measured in seconds since the Unix epoch. - int? created; + int created; # Unique identifier for the object. - string? id; + string id; # The IP address where the payment originated. string? ip_address?; # Information related to the location of the payment. Note that this information is an approximation and attempts to locate the nearest population center - it should not be used to determine a specific address. RadarReviewResourceLocation? ip_address_location?; # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. - boolean? livemode; + boolean livemode; # String representing the object's type. Objects of the same type share the same value. - string? 'object; + string 'object; # If `true`, the review needs action. - boolean? open; + boolean open; # The reason the review was opened. One of `rule` or `manual`. - string? opened_reason; + string opened_reason; # The PaymentIntent ID associated with this review, if one exists. - string|PaymentIntent? payment_intent?; + string|PaymentIntent payment_intent?; # The reason the review is currently open or closed. One of `rule`, `manual`, `approved`, `refunded`, `refunded_as_fraud`, `disputed`, or `redacted`. - string? reason; + string reason; # Information related to the browsing session of the user who initiated the payment. RadarReviewResourceSession? session?; }; @@ -4500,47 +5626,83 @@ public type TaxId record { # Two-letter ISO code representing the country of the tax ID. string? country?; # Time at which the object was created. Measured in seconds since the Unix epoch. - int? created; + int created; # ID of the customer. string|Customer? customer?; # Unique identifier for the object. - string? id; + string id; # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. - boolean? livemode; + boolean livemode; # String representing the object's type. Objects of the same type share the same value. - string? 'object; + string 'object; # Type of the tax ID, one of `ae_trn`, `au_abn`, `au_arn`, `br_cnpj`, `br_cpf`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_vat`, `cl_tin`, `es_cif`, `eu_vat`, `gb_vat`, `hk_br`, `id_npwp`, `il_vat`, `in_gst`, `jp_cn`, `jp_rn`, `kr_brn`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `no_vat`, `nz_gst`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `th_vat`, `tw_vat`, `us_ein`, or `za_vat`. Note that some legacy tax IDs have type `unknown` - string? 'type; + string 'type; # Value of the tax ID. - string? value; + string value; # Tax ID verification information. TaxIdVerification? verification?; }; +# When a non-stripe BIN is used, any use of an [issued card](https://stripe.com/docs/issuing) must be settled directly with the card network. The net amount owed is represented by an Issuing `Settlement` object. +public type IssuingSettlement record { + # The Bank Identification Number reflecting this settlement record. + string bin; + # The date that the transactions are cleared and posted to user's accounts. + int clearing_date; + # Time at which the object was created. Measured in seconds since the Unix epoch. + int created; + # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + string currency; + # Unique identifier for the object. + string id; + # The total interchange received as reimbursement for the transactions. + int interchange_fees; + # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. + boolean livemode; + # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. + record {} metadata; + # The total net amount required to settle with the network. + int net_total; + # The card network for this settlement report. One of ["visa"] + string network; + # The total amount of fees owed to the network. + int network_fees; + # The Settlement Identification Number assigned by the network. + string network_settlement_identifier; + # String representing the object's type. Objects of the same type share the same value. + string 'object; + # One of `international` or `uk_national_net`. + string settlement_service; + # The total number of transactions reflected in this settlement. + int transaction_count; + # The total transaction amount reflected in this settlement. + int transaction_volume; +}; + public type PaymentMethodCardWalletGooglePay record { }; public type PaymentMethodCard record { # Card brand. Can be `amex`, `diners`, `discover`, `jcb`, `mastercard`, `unionpay`, `visa`, or `unknown`. - string? brand; + string brand; # Checks on Card address and CVC if provided. PaymentMethodCardChecks? checks?; # Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected. string? country?; # Two-digit number representing the card's expiration month. - int? exp_month; + int exp_month; # Four-digit number representing the card's expiration year. - int? exp_year; + int exp_year; # Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number. # # *Starting May 1, 2021, card fingerprint in India for Connect will change to allow two fingerprints for the same card --- one for India and one for the rest of the world.* string? fingerprint?; # Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`. - string? funding; + string funding; # Details of the original PaymentMethod that created this object. PaymentMethodCardGeneratedCard? generated_from?; # The last four digits of the card. - string? last4; + string last4; # Contains information about card networks that can be used to process the payment. Networks? networks?; # Contains details on how this Card maybe be used for 3D Secure authentication. @@ -4555,13 +5717,36 @@ public type PaymentMethodDetailsCardInstallments record { }; public type PaymentFlowsPaymentMethodList record { - PaymentMethod[]? data; + PaymentMethod[] data; # True if this list has another page of items after this one that can be fetched. - boolean? has_more; + boolean has_more; # String representing the object's type. Objects of the same type share the same value. Always has the value `list`. - string? 'object; + string 'object; # The URL where this list can be accessed. - string? url; + string url; +}; + +# An early fraud warning indicates that the card issuer has notified us that a +# charge may be fraudulent. +# +# Related guide: [Early Fraud Warnings](https://stripe.com/docs/disputes/measuring#early-fraud-warnings). +public type RadarEarlyFraudWarning record { + # An EFW is actionable if it has not received a dispute and has not been fully refunded. You may wish to proactively refund a charge that receives an EFW, in order to avoid receiving a dispute later. + boolean actionable; + # ID of the charge this early fraud warning is for, optionally expanded. + string|Charge charge; + # Time at which the object was created. Measured in seconds since the Unix epoch. + int created; + # The type of fraud labelled by the issuer. One of `card_never_received`, `fraudulent_card_application`, `made_with_counterfeit_card`, `made_with_lost_card`, `made_with_stolen_card`, `misc`, `unauthorized_use_of_card`. + string fraud_type; + # Unique identifier for the object. + string id; + # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. + boolean livemode; + # String representing the object's type. Objects of the same type share the same value. + string 'object; + # ID of the Payment Intent this early fraud warning is for, optionally expanded. + string|PaymentIntent payment_intent?; }; # When an [issued card](https://stripe.com/docs/issuing) is used to make a purchase, an Issuing `Authorization` @@ -4571,70 +5756,106 @@ public type PaymentFlowsPaymentMethodList record { # Related guide: [Issued Card Authorizations](https://stripe.com/docs/issuing/purchases/authorizations). public type IssuingAuthorization record { # The total amount that was authorized or rejected. This amount is in the card's currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). - int? amount; + int amount; # Detailed breakdown of amount components. These amounts are denominated in `currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). IssuingAuthorizationAmountDetails? amount_details?; # Whether the authorization has been approved. - boolean? approved; + boolean approved; # How the card details were provided. - string? authorization_method; + string authorization_method; # List of balance transactions associated with this authorization. - BalanceTransaction[]? balance_transactions; + BalanceTransaction[] balance_transactions; # You can [create physical or virtual cards](https://stripe.com/docs/issuing/cards) that are issued to cardholders. - IssuingCard? card; + IssuingCard card; # The cardholder to whom this authorization belongs. string|IssuingCardholder? cardholder?; # Time at which the object was created. Measured in seconds since the Unix epoch. - int? created; + int created; # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). - string? currency; + string currency; # Unique identifier for the object. - string? id; + string id; # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. - boolean? livemode; + boolean livemode; # The total amount that was authorized or rejected. This amount is in the `merchant_currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). - int? merchant_amount; + int merchant_amount; # The currency that was presented to the cardholder for the authorization. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). - string? merchant_currency; - IssuingAuthorizationMerchantData? merchant_data; + string merchant_currency; + IssuingAuthorizationMerchantData merchant_data; # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. record {} metadata; # String representing the object's type. Objects of the same type share the same value. - string? 'object; + string 'object; # The pending authorization request. This field will only be non-null during an `issuing_authorization.request` webhook. IssuingAuthorizationPendingRequest? pending_request?; # History of every time `pending_request` was approved/denied, either by you directly or by Stripe (e.g. based on your `spending_controls`). If the merchant changes the authorization by performing an [incremental authorization](https://stripe.com/docs/issuing/purchases/authorizations), you can look at this field to see the previous requests for the authorization. - IssuingAuthorizationRequest[]? request_history; + IssuingAuthorizationRequest[] request_history; # The current status of the authorization in its lifecycle. - string? status; + string status; # List of [transactions](https://stripe.com/docs/api/issuing/transactions) associated with this authorization. - IssuingTransaction[]? transactions; - IssuingAuthorizationVerificationData? verification_data; + IssuingTransaction[] transactions; + IssuingAuthorizationVerificationData verification_data; # The digital wallet used for this authorization. One of `apple_pay`, `google_pay`, or `samsung_pay`. string? wallet?; }; +# Cardholder authentication via 3D Secure is initiated by creating a `3D Secure` +# object. Once the object has been created, you can use it to authenticate the +# cardholder and create a charge. +public type ThreeDSecure record { + # Amount of the charge that you will create when authentication completes. + int amount; + # True if the cardholder went through the authentication flow and their bank indicated that authentication succeeded. + boolean authenticated; + # You can store multiple cards on a customer in order to charge the customer + # later. You can also store multiple debit cards on a recipient in order to + # transfer to those cards later. + # + # Related guide: [Card Payments with Sources](https://stripe.com/docs/sources/cards). + Card card; + # Time at which the object was created. Measured in seconds since the Unix epoch. + int created; + # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + string currency; + # Unique identifier for the object. + string id; + # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. + boolean livemode; + # String representing the object's type. Objects of the same type share the same value. + string 'object; + # If present, this is the URL that you should send the cardholder to for authentication. If you are going to use Stripe.js to display the authentication page in an iframe, you should use the value "_callback". + string? redirect_url?; + # Possible values are `redirect_pending`, `succeeded`, or `failed`. When the cardholder can be authenticated, the object starts with status `redirect_pending`. When liability will be shifted to the cardholder's bank (either because the cardholder was successfully authenticated, or because the bank has not implemented 3D Secure, the object wlil be in status `succeeded`. `failed` indicates that authentication was attempted unsuccessfully. + string status; +}; + public type InvoicePayBody record { # Specifies which fields in the response should be expanded. - string[]? expand?; + string[] expand?; # In cases where the source used to pay the invoice has insufficient funds, passing `forgive=true` controls whether a charge should be attempted for the full amount available on the source, up to the amount to fully pay the invoice. This effectively forgives the difference between the amount available on the source and the amount due. # # Passing `forgive=false` will fail the charge if the source hasn't been pre-funded with the right amount. An example for this case is with ACH Credit Transfers and wires: if the amount wired is less than the amount due by a small amount, you might want to forgive the difference. Defaults to `false`. - boolean? forgive?; + boolean forgive?; # Indicates if a customer is on or off-session while an invoice payment is attempted. Defaults to `true` (off-session). - boolean? off_session?; + boolean off_session?; # Boolean representing whether an invoice is paid outside of Stripe. This will result in no charge being made. Defaults to `false`. - boolean? paid_out_of_band?; + boolean paid_out_of_band?; # A PaymentMethod to be charged. The PaymentMethod must be the ID of a PaymentMethod belonging to the customer associated with the invoice being paid. - string? payment_method?; + string payment_method?; # 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. - string? 'source?; + string 'source?; }; public type CustomerAddressWithName record { - OptionalFieldsAddress? address; - string? name; - string? phone?; + OptionalFieldsAddress address; + string name; + string phone?; +}; + +public type CheckoutSessionPaymentMethodOptions record { + CheckoutAcssDebitPaymentMethodOptions acss_debit?; + PaymentMethodOptionsBoleto boleto?; + PaymentMethodOptionsOxxo oxxo?; }; public type PaymentMethodOptionsAlipay record { @@ -4642,15 +5863,15 @@ public type PaymentMethodOptionsAlipay record { # Settings for automatic tax lookup for this invoice. public type AutomaticTaxParam record { - boolean? enabled; + boolean enabled; }; public type SubscriptionSchedulesParam1 record { - int? days_until_due?; + int days_until_due?; }; public type ItemBillingThresholdsParam record { - int? usage_gte; + int usage_gte; }; public type PaymentMethodDetailsKlarna record { @@ -4658,11 +5879,11 @@ public type PaymentMethodDetailsKlarna record { public type DeletedInvoice record { # Always true for a deleted object - boolean? deleted; + boolean deleted; # Unique identifier for the object. - string? id; + string id; # String representing the object's type. Objects of the same type share the same value. - string? 'object; + string 'object; }; public type InvoiceSettingQuoteSetting record { @@ -4672,7 +5893,7 @@ public type InvoiceSettingQuoteSetting record { public type PaymentMethodOptionsBancontact record { # Preferred language of the Bancontact authorization page that the customer is redirected to. - string? preferred_language; + string preferred_language; }; # To charge a credit or a debit card, you create a `Charge` object. You can @@ -4682,11 +5903,11 @@ public type PaymentMethodOptionsBancontact record { # Related guide: [Accept a payment with the Charges API](https://stripe.com/docs/payments/accept-a-payment-charges). public type Charge record { # Amount intended to be collected by this payment. A positive integer representing how much to charge in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The minimum amount is $0.50 US or [equivalent in charge currency](https://stripe.com/docs/currencies#minimum-and-maximum-charge-amounts). The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99). - int? amount; + int amount; # Amount in %s captured (can be less than the amount attribute on the charge if a partial capture was made). - int? amount_captured; + int amount_captured; # Amount in %s refunded (can be less than the amount attribute on the charge if a partial refund was issued). - int? amount_refunded; + int amount_refunded; # ID of the Connect application that created the charge. string|Application? application?; # The application fee (if any) for the charge. [See the Connect documentation](https://stripe.com/docs/connect/direct-charges#collecting-fees) for details. @@ -4695,21 +5916,21 @@ public type Charge record { int? application_fee_amount?; # ID of the balance transaction that describes the impact of this charge on your account balance (not including refunds or disputes). string|BalanceTransaction? balance_transaction?; - BillingDetails? billing_details; + BillingDetails billing_details; # 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. string? calculated_statement_descriptor?; # If the charge was created without capturing, this Boolean represents whether it is still uncaptured or has since been captured. - boolean? captured; + boolean captured; # Time at which the object was created. Measured in seconds since the Unix epoch. - int? created; + int created; # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). - string? currency; + string currency; # ID of the customer this charge is for if one exists. string|Customer|DeletedCustomer? customer?; # An arbitrary string attached to the object. Often useful for displaying to users. string? description?; # Whether the charge has been disputed. - boolean? disputed; + boolean disputed; # Error code explaining reason for charge failure if available (see [the errors section](https://stripe.com/docs/api#errors) for a list of codes). string? failure_code?; # Message to user further explaining reason for charge failure if available. @@ -4717,15 +5938,15 @@ public type Charge record { # Information on fraud assessments for the charge. ChargeFraudDetails? fraud_details?; # Unique identifier for the object. - string? id; + string id; # ID of the invoice this charge is for if one exists. string|Invoice? invoice?; # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. - boolean? livemode; + boolean livemode; # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. record {} metadata; # String representing the object's type. Objects of the same type share the same value. - string? 'object; + string 'object; # The account (if any) the charge was made on behalf of without triggering an automatic transfer. See the [Connect documentation](https://stripe.com/docs/connect/charges-transfers) for details. string|Account? on_behalf_of?; # ID of the order this charge is for if one exists. @@ -4733,7 +5954,7 @@ public type Charge record { # Details about whether the payment was accepted, and why. See [understanding declines](https://stripe.com/docs/declines) for details. ChargeOutcome? outcome?; # `true` if the charge succeeded, or was successfully authorized for later capture. - boolean? paid; + boolean paid; # ID of the PaymentIntent associated with this charge, if one exists. string|PaymentIntent? payment_intent?; # ID of the payment method used in this charge. @@ -4747,9 +5968,9 @@ public type Charge record { # 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 will be stylized as an Invoice receipt. string? receipt_url?; # Whether the charge has been fully refunded. If the charge is only partially refunded, this attribute will still be false. - boolean? refunded; + boolean refunded; # A list of refunds that have been applied to the charge. - RefundList? refunds; + RefundList refunds; # ID of the review associated with this charge if one exists. string|Review? review?; # Shipping information for the charge. @@ -4761,9 +5982,9 @@ public type Charge record { # Provides information about the charge that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters for the concatenated descriptor. string? statement_descriptor_suffix?; # The status of the payment is either `succeeded`, `pending`, or `failed`. - string? status; + string status; # ID of the transfer to the `destination` account (only applicable if the charge was created using the `destination` parameter). - string|Transfer? transfer?; + string|Transfer transfer?; # An optional dictionary including the account to automatically transfer to as part of a destination charge. [See the Connect documentation](https://stripe.com/docs/connect/destination-charges) for details. ChargeTransferData? transfer_data?; # A string that identifies this transaction as part of a group. See the [Connect documentation](https://stripe.com/docs/connect/charges-transfers#transfer-options) for details. @@ -4772,22 +5993,22 @@ public type Charge record { # A Mandate is a record of the permission a customer has given you to debit their payment method. public type Mandate record { - CustomerAcceptance? customer_acceptance; + CustomerAcceptance customer_acceptance; # Unique identifier for the object. - string? id; + string id; # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. - boolean? livemode; - MandateMultiUse? multi_use?; + boolean livemode; + MandateMultiUse multi_use?; # String representing the object's type. Objects of the same type share the same value. - string? 'object; + string 'object; # ID of the payment method associated with this mandate. - string|PaymentMethod? payment_method; - MandatePaymentMethodDetails? payment_method_details; - MandateSingleUse? single_use?; + string|PaymentMethod payment_method; + MandatePaymentMethodDetails payment_method_details; + MandateSingleUse single_use?; # The status of the mandate, which indicates whether it can be used to initiate a payment. - string? status; + string status; # The type of the mandate. - string? 'type; + string 'type; }; public type PaymentMethodDetailsCard record { @@ -4798,9 +6019,9 @@ public type PaymentMethodDetailsCard record { # Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected. string? country?; # Two-digit number representing the card's expiration month. - int? exp_month; + int exp_month; # Four-digit number representing the card's expiration year. - int? exp_year; + int exp_year; # Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number. # # *Starting May 1, 2021, card fingerprint in India for Connect will change to allow two fingerprints for the same card --- one for India and one for the rest of the world.* @@ -4846,31 +6067,31 @@ public type MandateMultiUse record { # Once accepted, it will automatically create an invoice, subscription or subscription schedule. public type Quote record { # Total before any discounts or taxes are applied. - int? amount_subtotal; + int amount_subtotal; # Total after discounts and taxes are applied. - int? amount_total; + int amount_total; # The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. Only applicable if there are no line items with recurring prices on the quote. int? application_fee_amount?; # A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the application owner's Stripe account. Only applicable if there are line items with recurring prices on the quote. decimal? application_fee_percent?; - QuotesResourceAutomaticTax? automatic_tax; + QuotesResourceAutomaticTax automatic_tax; # Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay invoices at the end of the subscription cycle or on finalization using the default payment method attached to the subscription or customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions. Defaults to `charge_automatically`. - string? collection_method; - QuotesResourceComputed? computed; + string collection_method; + QuotesResourceComputed computed; # Time at which the object was created. Measured in seconds since the Unix epoch. - int? created; + int created; # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). string? currency?; # The customer which this quote belongs to. A customer is required before finalizing the quote. Once specified, it cannot be changed. string|Customer|DeletedCustomer? customer?; # The tax rates applied to this quote. - (string|TaxRate?)[]? default_tax_rates?; + (string|TaxRate)[] default_tax_rates?; # A description that will be displayed on the quote PDF. string? description?; # The discounts applied to this quote. - (string|Discount?)[]? discounts; + (string|Discount)[] discounts; # The date on which the quote will be canceled if in `open` or `draft` status. Measured in seconds since the Unix epoch. - int? expires_at; + int expires_at; # A footer that will be displayed on the quote PDF. string? footer?; # Details of the quote that was cloned. See the [cloning documentation](https://stripe.com/docs/quotes/clone) for more details. @@ -4878,32 +6099,32 @@ public type Quote record { # A header that will be displayed on the quote PDF. string? header?; # Unique identifier for the object. - string? id; + string id; # The invoice that was created from this quote. string|Invoice|DeletedInvoice? invoice?; # All invoices will be billed using the specified settings. InvoiceSettingQuoteSetting? invoice_settings?; # A list of items the customer is being quoted for. - QuotesResourceListLineItems? line_items?; + QuotesResourceListLineItems line_items?; # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. - boolean? livemode; + boolean livemode; # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. record {} metadata; # A unique number that identifies this particular quote. This number is assigned once the quote is [finalized](https://stripe.com/docs/quotes/overview#finalize). string? number?; # String representing the object's type. Objects of the same type share the same value. - string? 'object; + string 'object; # The account on behalf of which to charge. See the [Connect documentation](https://support.stripe.com/questions/sending-invoices-on-behalf-of-connected-accounts) for details. string|Account? on_behalf_of?; # The status of the quote. - string? status; - QuotesResourceStatusTransitions? status_transitions; + string status; + QuotesResourceStatusTransitions status_transitions; # The subscription that was created or updated from this quote. string|Subscription? subscription?; - QuotesResourceSubscriptionData? subscription_data; + QuotesResourceSubscriptionData subscription_data; # The subscription schedule that was created or updated from this quote. string|SubscriptionSchedule? subscription_schedule?; - QuotesResourceTotalDetails? total_details; + QuotesResourceTotalDetails total_details; # The account (if any) the payments will be attributed to for tax reporting, and where funds from each payment will be transferred to for each of the invoices. QuotesResourceTransferData? transfer_data?; }; @@ -4914,28 +6135,30 @@ public type SubscriptionItem record { # Define thresholds at which an invoice will be sent, and the related subscription advanced to a new billing period SubscriptionItemBillingThresholds? billing_thresholds?; # Time at which the object was created. Measured in seconds since the Unix epoch. - int? created; + int created; # Unique identifier for the object. - string? id; + string id; # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. record {} metadata; # String representing the object's type. Objects of the same type share the same value. - string? 'object; + string 'object; # Prices define the unit cost, currency, and (optional) billing cycle for both recurring and one-time purchases of products. # [Products](https://stripe.com/docs/api#products) help you track inventory or provisioning, and prices help you track payment terms. Different physical goods or levels of service should be represented by products, and pricing options should be represented by prices. This approach lets you change prices without having to change your provisioning scheme. # # For example, you might have a single "gold" product that has prices for $10/month, $100/year, and €9 once. # # Related guides: [Set up a subscription](https://stripe.com/docs/billing/subscriptions/set-up-subscription), [create an invoice](https://stripe.com/docs/billing/invoices/create), and more about [products and prices](https://stripe.com/docs/billing/prices-guide). - Price? price; + Price price; # The [quantity](https://stripe.com/docs/subscriptions/quantities) of the plan to which the customer should be subscribed. - int? quantity?; + int quantity?; # The `subscription` this `subscription_item` belongs to. - string? subscription; + string subscription; # 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`. TaxRate[]? tax_rates?; }; +public type DeletedPaymentSource DeletedAlipayAccount|DeletedBankAccount|DeletedBitcoinReceiver|DeletedCard; + public type SourceTypeAuBecsDebit record { string? bsb_number?; string? fingerprint?; @@ -4945,13 +6168,13 @@ public type SourceTypeAuBecsDebit record { # External accounts (bank accounts and debit cards) currently attached to this account public type ExternalAccountList record { # The list contains all external accounts that have been attached to the Stripe account. These may be bank accounts or cards. - (BankAccount|Card?)[]? data; + (BankAccount|Card)[] data; # True if this list has another page of items after this one that can be fetched. - boolean? has_more; + boolean has_more; # String representing the object's type. Objects of the same type share the same value. Always has the value `list`. - string? 'object; + string 'object; # The URL where this list can be accessed. - string? url; + string url; }; public type OnlineAcceptance record { @@ -4967,11 +6190,29 @@ public type SubscriptionItemBillingThresholds record { }; public type AccountCardPaymentsSettings record { - AccountDeclineChargeOn? decline_on?; + AccountDeclineChargeOn decline_on?; # The default text that appears on credit card statements when a charge is made. This field prefixes any dynamic `statement_descriptor` specified on the charge. `statement_descriptor_prefix` is useful for maximizing descriptor space for the dynamic portion. string? statement_descriptor_prefix?; }; +public type SourceTransactionPaperCheckData record { + # Time at which the deposited funds will be available for use. Measured in seconds since the Unix epoch. + string available_at?; + # Comma-separated list of invoice IDs associated with the paper check. + string invoices?; +}; + +public type GelatoReportDocumentOptions record { + # Array of strings of allowed identity document types. If the provided identity document isn’t one of the allowed types, the verification check will fail with a document_type_not_allowed error code. + string[] allowed_types?; + # Collect an ID number and perform an [ID number check](https://stripe.com/docs/identity/verification-checks?type=id-number) with the document’s extracted name and date of birth. + boolean require_id_number?; + # Disable image uploads, identity document images have to be captured using the device’s camera. + boolean require_live_capture?; + # Capture a face image and perform a [selfie check](https://stripe.com/docs/identity/verification-checks?type=selfie) comparing a photo ID and a picture of your user’s face. [Learn more](https://stripe.com/docs/identity/selfie). + boolean require_matching_selfie?; +}; + # This is an object representing a Stripe account. You can retrieve it to see # properties on the account like its current e-mail address or if the account is # enabled yet to make live charges. @@ -4983,44 +6224,44 @@ public type Account record { AccountBusinessProfile? business_profile?; # The business type. string? business_type?; - AccountCapabilities? capabilities?; + AccountCapabilities capabilities?; # Whether the account can create live charges. - boolean? charges_enabled?; - LegalEntityCompany? company?; - AccountController? controller?; + boolean charges_enabled?; + LegalEntityCompany company?; + AccountController controller?; # The account's country. - string? country?; + string country?; # Time at which the object was created. Measured in seconds since the Unix epoch. - int? created?; + int created?; # Three-letter ISO currency code representing the default currency for the account. This must be a currency that [Stripe supports in the account's country](https://stripe.com/docs/payouts). - string? default_currency?; + string default_currency?; # Whether account details have been submitted. Standard accounts cannot receive payouts before this is true. - boolean? details_submitted?; + boolean details_submitted?; # An email address associated with the account. You can treat this as metadata: it is not used for authentication or messaging account holders. string? email?; # External accounts (bank accounts and debit cards) currently attached to this account - ExternalAccountList? external_accounts?; + ExternalAccountList external_accounts?; # Unique identifier for the object. - string? id; + string id; # This is an object representing a person associated with a Stripe account. # # A platform cannot access a Standard or Express account's persons after the account starts onboarding, such as after generating an account link for the account. # See the [Standard onboarding](https://stripe.com/docs/connect/standard-accounts) or [Express onboarding documentation](https://stripe.com/docs/connect/express-accounts) for information about platform pre-filling and account onboarding steps. # # Related guide: [Handling Identity Verification with the API](https://stripe.com/docs/connect/identity-verification-api#person-information). - Person? individual?; + Person individual?; # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. record {} metadata?; # String representing the object's type. Objects of the same type share the same value. - string? 'object; + string 'object; # Whether Stripe can send payouts to this account. - boolean? payouts_enabled?; - AccountRequirements? requirements?; + boolean payouts_enabled?; + AccountRequirements requirements?; # Options for customizing how the account functions within Stripe. AccountSettings? settings?; - AccountTosAcceptance? tos_acceptance?; + AccountTosAcceptance tos_acceptance?; # The Stripe account type. Can be `standard`, `express`, or `custom`. - string? 'type?; + string 'type?; }; # Invoices are statements of amounts owed by a customer, and are either @@ -5061,32 +6302,32 @@ public type Invoice record { # The public name of the business associated with this invoice, most often the business creating the invoice. string? account_name?; # The account tax IDs associated with the invoice. Only editable when the invoice is a draft. - (string|TaxId|DeletedTaxId?)[]? account_tax_ids?; + (string|TaxId|DeletedTaxId)[]? account_tax_ids?; # Final amount due at this time for this invoice. If the invoice's total is smaller than the minimum charge amount, for example, or if there is account credit that can be applied to the invoice, the `amount_due` may be 0. If there is a positive `starting_balance` for the invoice (the customer owes money), the `amount_due` will also take that into account. The charge that gets generated for the invoice will be for the amount specified in `amount_due`. - int? amount_due; + int amount_due; # The amount, in %s, that was paid. - int? amount_paid; + int amount_paid; # The amount remaining, in %s, that is due. - int? amount_remaining; + int amount_remaining; # The fee in %s that will be applied to the invoice and transferred to the application owner's Stripe account when the invoice is paid. int? application_fee_amount?; # Number of payment attempts made for this invoice, from the perspective of the payment retry schedule. Any payment attempt counts as the first attempt, and subsequently only automatic retries increment the attempt count. In other words, manual payment attempts after the first attempt do not affect the retry schedule. - int? attempt_count; + int attempt_count; # Whether an attempt has been made to pay the invoice. An invoice is not attempted until 1 hour after the `invoice.created` webhook, for example, so you might not want to display that invoice as unpaid to your users. - boolean? attempted; + boolean attempted; # Controls whether Stripe will perform [automatic collection](https://stripe.com/docs/billing/invoices/workflow/#auto_advance) of the invoice. When `false`, the invoice's state will not automatically advance without an explicit action. - boolean? auto_advance?; - AutomaticTax? automatic_tax; + boolean auto_advance?; + AutomaticTax automatic_tax; # Indicates the reason why the invoice was created. `subscription_cycle` indicates an invoice created by a subscription advancing into a new period. `subscription_create` indicates an invoice created due to creating a subscription. `subscription_update` indicates an invoice created due to updating a subscription. `subscription` is set for all old invoices to indicate either a change to a subscription or a period advancement. `manual` is set for all invoices unrelated to a subscription (for example: created via the invoice editor). The `upcoming` value is reserved for simulated invoices per the upcoming invoice endpoint. `subscription_threshold` indicates an invoice created due to a billing threshold being reached. string? billing_reason?; # ID of the latest charge generated for this invoice, if any. string|Charge? charge?; # 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. - string? collection_method; + string collection_method; # Time at which the object was created. Measured in seconds since the Unix epoch. - int? created; + int created; # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). - string? currency; + string currency; # Custom fields displayed on the invoice. InvoiceSettingCustomField[]? custom_fields?; # The ID of the customer who will be billed. @@ -5110,13 +6351,13 @@ public type Invoice record { # ID of the default payment source for the invoice. It must belong to the customer associated with the invoice and be in a chargeable state. If not set, defaults to the subscription's default source, if any, or to the customer's default source. string|AlipayAccount|BankAccount|BitcoinReceiver|Card|Source? default_source?; # The tax rates applied to this invoice, if any. - TaxRate[]? default_tax_rates; + TaxRate[] default_tax_rates; # An arbitrary string attached to the object. Often useful for displaying to users. Referenced as 'memo' in the Dashboard. string? description?; # Describes the current discount applied to this invoice, if there is one. Not populated if there are multiple discounts. Discount? discount?; # The discounts applied to the invoice. Line item discounts are applied before invoice discounts. Use `expand[]=discounts` to expand each discount. - (string|Discount|DeletedDiscount?)[]? discounts?; + (string|Discount|DeletedDiscount)[]? discounts?; # The date on which payment for this invoice is due. This value will be `null` for invoices where `collection_method=charge_automatically`. int? due_date?; # Ending customer balance after the invoice is finalized. Invoices are finalized approximately an hour after successful webhook delivery or when payment collection is attempted for the invoice. If the invoice has not been finalized yet, this will be null. @@ -5126,15 +6367,15 @@ public type Invoice record { # The URL for the hosted invoice page, which allows customers to view and pay an invoice. If the invoice has not been finalized yet, this will be null. string? hosted_invoice_url?; # Unique identifier for the object. - string? id?; + string id?; # The link to download the PDF for the invoice. If the invoice has not been finalized yet, this will be null. string? invoice_pdf?; # The error encountered during the previous attempt to finalize the invoice. This field is cleared when the invoice is successfully finalized. ApiErrors? last_finalization_error?; # The individual line items that make up the invoice. `lines` is sorted as follows: invoice items in reverse chronological order, followed by the subscription, if any. - Invoicelineslist1? lines; + Invoicelineslist1 lines; # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. - boolean? livemode; + boolean livemode; # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. record {} metadata?; # The time at which payment will next be attempted. This value will be `null` for invoices where `collection_method=send_invoice`. @@ -5142,48 +6383,48 @@ public type Invoice record { # A unique, identifying string that appears on emails sent to the customer for this invoice. This starts with the customer's unique invoice_prefix if it is specified. string? number?; # String representing the object's type. Objects of the same type share the same value. - string? 'object; + string 'object; # The account (if any) for which the funds of the invoice payment are intended. If set, the invoice will be presented with the branding and support information of the specified account. See the [Invoices with Connect](https://stripe.com/docs/billing/invoices/connect) documentation for details. string|Account? on_behalf_of?; # 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. - boolean? paid; + boolean paid; # The PaymentIntent associated with this invoice. The PaymentIntent is generated when the invoice is finalized, and can then be used to pay the invoice. Note that voiding an invoice will cancel the PaymentIntent. string|PaymentIntent? payment_intent?; - InvoicesPaymentSettings? payment_settings; + InvoicesPaymentSettings payment_settings; # End of the usage period during which invoice items were added to this invoice. - int? period_end; + int period_end; # Start of the usage period during which invoice items were added to this invoice. - int? period_start; + int period_start; # Total amount of all post-payment credit notes issued for this invoice. - int? post_payment_credit_notes_amount; + int post_payment_credit_notes_amount; # Total amount of all pre-payment credit notes issued for this invoice. - int? pre_payment_credit_notes_amount; + int pre_payment_credit_notes_amount; # The quote this invoice was generated from. string|Quote? quote?; # This is the transaction number that appears on email receipts sent for this invoice. string? receipt_number?; # Starting customer balance before the invoice is finalized. If the invoice has not been finalized yet, this will be the current customer balance. - int? starting_balance; + int starting_balance; # Extra information about an invoice for the customer's credit card statement. string? statement_descriptor?; # The status of the invoice, one of `draft`, `open`, `paid`, `uncollectible`, or `void`. [Learn more](https://stripe.com/docs/billing/invoices/workflow#workflow-overview) string? status?; - InvoicesStatusTransitions? status_transitions; + InvoicesStatusTransitions status_transitions; # The subscription that this invoice was prepared for, if any. string|Subscription? subscription?; # Only set for upcoming invoices that preview prorations. The time used to calculate prorations. - int? subscription_proration_date?; + int subscription_proration_date?; # Total of all subscriptions, invoice items, and prorations on the invoice before any invoice level discount or tax is applied. Item discounts are already incorporated - int? subtotal; + int subtotal; # The amount of tax on this invoice. This is the sum of all the tax amounts on this invoice. int? tax?; - InvoiceThresholdReason? threshold_reason?; + InvoiceThresholdReason threshold_reason?; # Total after discounts and taxes. - int? total; + int total; # The aggregate amounts calculated per discount across all line items. DiscountsResourceDiscountAmount[]? total_discount_amounts?; # The aggregate amounts calculated per tax rate for all line items. - InvoiceTaxAmount[]? total_tax_amounts; + InvoiceTaxAmount[] total_tax_amounts; # The account (if any) the payment will be attributed to for tax reporting, and where funds from the payment will be transferred to for the invoice. InvoiceTransferData? transfer_data?; # Invoices are automatically paid or sent 1 hour after webhooks are delivered, or until all webhook delivery attempts have [been exhausted](https://stripe.com/docs/billing/webhooks#understand). This field tracks the time when webhooks for this invoice were successfully delivered. If the invoice had no webhooks to deliver, this will be set while the invoice is being created. @@ -5192,26 +6433,35 @@ public type Invoice record { public type CustomerTax record { # Surfaces if automatic tax computation is possible given the current customer location information. - string? automatic_tax; + string automatic_tax; # A recent IP address of the customer used for tax reporting and tax location inference. string? ip_address?; # The customer's location as identified by Stripe Tax. CustomerTaxLocation? location?; }; +public type DeletedTerminalReader record { + # Always true for a deleted object + boolean deleted; + # Unique identifier for the object. + string id; + # String representing the object's type. Objects of the same type share the same value. + string 'object; +}; + public type ConnectCollectionTransfer record { # Amount transferred, in %s. - int? amount; + int amount; # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). - string? currency; + string currency; # ID of the account that funds are being collected for. - string|Account? destination; + string|Account destination; # Unique identifier for the object. - string? id; + string id; # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. - boolean? livemode; + boolean livemode; # String representing the object's type. Objects of the same type share the same value. - string? 'object; + string 'object; }; public type PaymentMethodDetailsAuBecsDebit record { @@ -5222,10 +6472,10 @@ public type PaymentMethodDetailsAuBecsDebit record { # Last four digits of the bank account number. string? last4?; # ID of the mandate used to make this payment. - string? mandate?; + string mandate?; }; -public type Discounts DiscountsDataParam|string?; +public type Discounts DiscountsDataParam|string; public type SourceTypeAcssDebit record { string? bank_address_city?; @@ -5240,67 +6490,79 @@ public type SourceTypeAcssDebit record { string? routing_number?; }; +public type PaymentPagesCheckoutSessionAutomaticTax record { + # Indicates whether automatic tax is enabled for the session + boolean enabled; + # The status of the most recent automated tax calculation for this session. + string? status?; +}; + public type TransferDataSpecs record { - decimal? amount_percent?; - string? destination; + decimal amount_percent?; + string destination; }; # A line item. public type Item record { # Total before any discounts or taxes are applied. - int? amount_subtotal; + int amount_subtotal; # Total after discounts and taxes. - int? amount_total; + int amount_total; # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). - string? currency; + string currency; # An arbitrary string attached to the object. Often useful for displaying to users. Defaults to product name. - string? description; + string description; # The discounts applied to the line item. - LineItemsDiscountAmount[]? discounts?; + LineItemsDiscountAmount[] discounts?; # Unique identifier for the object. - string? id; + string id; # String representing the object's type. Objects of the same type share the same value. - string? 'object; + string 'object; # The price used to generate the line item. Price? price?; # The quantity of products being purchased. int? quantity?; # The taxes applied to the line item. - LineItemsTaxAmount[]? taxes?; + LineItemsTaxAmount[] taxes?; }; public type CreditNoteTaxAmount record { # The amount, in %s, of the tax. - int? amount; + int amount; # Whether this tax amount is inclusive or exclusive. - boolean? inclusive; + boolean inclusive; # The tax rate that was applied to get this tax amount. - string|TaxRate? tax_rate; + string|TaxRate tax_rate; }; public type CardGeneratedFromPaymentMethodDetails record { - PaymentMethodDetailsCardPresent? card_present?; + PaymentMethodDetailsCardPresent card_present?; # The type of payment method transaction-specific details from the transaction that generated this `card` payment method. Always `card_present`. - string? 'type; + string 'type; }; public type V1SubscriptionSchedulesBody record { # The identifier of the customer to create the subscription schedule for. - string? customer?; + string customer?; # Object representing the subscription schedule's default settings. - DefaultSettingsParams? default_settings?; + DefaultSettingsParams default_settings?; # Configures how the subscription schedule behaves when it ends. Possible values are `release` or `cancel` with the default being `release`. `release` will end the subscription schedule and keep the underlying subscription running.`cancel` will end the subscription schedule and cancel the underlying subscription. - string? end_behavior?; + string end_behavior?; # Specifies which fields in the response should be expanded. - string[]? expand?; + string[] expand?; # Migrate an existing subscription to be managed by a subscription schedule. If this parameter is set, a subscription schedule will be created using the subscription's item(s), set to auto-renew using the subscription's interval. When using this parameter, other parameters (such as phase values) cannot be set. To create a subscription schedule with other modifications, we recommend making two separate API calls. - string? from_subscription?; + string from_subscription?; # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. - record {}|string? metadata?; + record {}|string metadata?; # List representing phases of the subscription schedule. Each phase can be customized to have different durations, plans, and coupons. If there are multiple phases, the `end_date` of one phase will always equal the `start_date` of the next phase. - PhaseConfigurationParams[]? phases?; + PhaseConfigurationParams[] phases?; # When the subscription schedule starts. We recommend using `now` so that it starts the subscription immediately. You can also use a Unix timestamp to backdate the subscription so that it starts on a past date, or set a future date for the subscription to start on. - int|string? start_date?; + int|string start_date?; +}; + +public type PortalInvoiceList record { + # Whether the feature is enabled. + boolean enabled; }; # Subscriptions allow you to charge a customer on a recurring basis. @@ -5309,27 +6571,27 @@ public type V1SubscriptionSchedulesBody record { public type Subscription record { # A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the application owner's Stripe account. decimal? application_fee_percent?; - SubscriptionAutomaticTax? automatic_tax; + SubscriptionAutomaticTax automatic_tax; # Determines the date of the first full invoice, and, for plans with `month` or `year` intervals, the day of the month for subsequent invoices. - int? billing_cycle_anchor; + int billing_cycle_anchor; # Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period SubscriptionBillingThresholds? billing_thresholds?; # A date in the future at which the subscription will automatically get canceled int? cancel_at?; # 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. - boolean? cancel_at_period_end; + boolean cancel_at_period_end; # If the subscription has been canceled, the date of that cancellation. If the subscription was canceled with `cancel_at_period_end`, `canceled_at` will reflect the time of the most recent update request, not the end of the subscription period when the subscription is automatically moved to a canceled state. int? canceled_at?; # 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. When sending an invoice, Stripe will email your customer an invoice with payment instructions. - string? collection_method; + string collection_method; # Time at which the object was created. Measured in seconds since the Unix epoch. - int? created; + int created; # End of the current period that the subscription has been invoiced for. At the end of this period, a new invoice will be created. - int? current_period_end; + int current_period_end; # Start of the current period that the subscription has been invoiced for. - int? current_period_start; + int current_period_start; # ID of the customer who owns the subscription. - string|Customer|DeletedCustomer? customer; + string|Customer|DeletedCustomer customer; # Number of days a customer has to pay invoices generated by this subscription. This value will be `null` for subscriptions where `collection_method=charge_automatically`. int? days_until_due?; # ID of the default payment method for the subscription. It must belong to the customer associated with the subscription. This takes precedence over `default_source`. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://stripe.com/docs/api/customers/object#customer_object-default_source). @@ -5343,19 +6605,19 @@ public type Subscription record { # If the subscription has ended, the date the subscription ended. int? ended_at?; # Unique identifier for the object. - string? id; + string id; # List of subscription items, each with an attached price. - SubscriptionItemList? items; + SubscriptionItemList items; # The most recent invoice this subscription has generated. string|Invoice? latest_invoice?; # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. - boolean? livemode; + boolean livemode; # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. record {} metadata; # Specifies the approximate timestamp on which any pending invoice items will be billed according to the schedule provided at `pending_invoice_item_interval`. int? next_pending_invoice_item_invoice?; # String representing the object's type. Objects of the same type share the same value. - string? 'object; + string 'object; # If specified, payment collection for this subscription will be paused. SubscriptionsResourcePauseCollection? pause_collection?; # Payment settings passed on to invoices created by the subscription. @@ -5369,7 +6631,7 @@ public type Subscription record { # The schedule attached to the subscription string|SubscriptionSchedule? schedule?; # Date when the subscription was first created. The date might differ from the `created` date due to backdating. - int? start_date; + int start_date; # Possible values are `incomplete`, `incomplete_expired`, `trialing`, `active`, `past_due`, `canceled`, or `unpaid`. # # For `collection_method=charge_automatically` a subscription moves into `incomplete` if the initial payment attempt fails. A subscription in this state can only have metadata and default_source updated. Once the first invoice is paid, the subscription moves into an `active` state. If the first invoice is not paid within 23 hours, the subscription transitions to `incomplete_expired`. This is a terminal state, the open invoice will be voided and no further invoices will be generated. @@ -5379,7 +6641,7 @@ public type Subscription record { # If subscription `collection_method=charge_automatically` it becomes `past_due` when payment to renew it fails and `canceled` or `unpaid` (depending on your subscriptions settings) when Stripe has exhausted all payment retry attempts. # # If subscription `collection_method=send_invoice` it becomes `past_due` when its invoice is not paid by the due date, and `canceled` or `unpaid` if it is still not paid by an additional deadline after that. Note that when a subscription has a status of `unpaid`, no subsequent invoices will be attempted (invoices will be created, but then immediately automatically closed). After receiving updated payment information from a customer, you may choose to reopen and pay their closed invoices. - string? status; + string status; # 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. SubscriptionTransferData? transfer_data?; # If the subscription has a trial, the end of that trial. @@ -5395,42 +6657,42 @@ public type PaymentMethodCardPresent record { # create multiple codes for a single coupon. public type PromotionCode record { # Whether the promotion code is currently active. A promotion code is only active if the coupon is also valid. - boolean? active; + boolean active; # The customer-facing code. Regardless of case, this code must be unique across all active promotion codes for each customer. - string? code; + string code; # A coupon contains information about a percent-off or amount-off discount you # might want to apply to a customer. Coupons may be applied to [invoices](https://stripe.com/docs/api#invoices) or # [orders](https://stripe.com/docs/api#create_order-coupon). Coupons do not work with conventional one-off [charges](https://stripe.com/docs/api#create_charge). - Coupon? coupon; + Coupon coupon; # Time at which the object was created. Measured in seconds since the Unix epoch. - int? created; + int created; # The customer that this promotion code can be used by. string|Customer|DeletedCustomer? customer?; # Date at which the promotion code can no longer be redeemed. int? expires_at?; # Unique identifier for the object. - string? id; + string id; # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. - boolean? livemode; + boolean livemode; # Maximum number of times this promotion code can be redeemed. int? max_redemptions?; # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. record {} metadata?; # String representing the object's type. Objects of the same type share the same value. - string? 'object; - PromotionCodesResourceRestrictions? restrictions; + string 'object; + PromotionCodesResourceRestrictions restrictions; # Number of times this promotion code has been used. - int? times_redeemed; + int times_redeemed; }; public type AccountBacsDebitPaymentsSettings record { # The Bacs Direct Debit Display Name for this account. For payments made with Bacs Direct Debit, this will appear on the mandate, and as the statement descriptor. - string? display_name?; + string display_name?; }; public type IssuingCardholderCompany record { # Whether the company's business ID number was provided. - boolean? tax_id_provided; + boolean tax_id_provided; }; public type SetupAttemptPaymentMethodDetailsSepaDebit record { @@ -5440,18 +6702,18 @@ public type SubscriptionTransferData record { # 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 destination account. By default, the entire amount is transferred to the destination. decimal? amount_percent?; # The account where funds from the payment will be transferred to upon payment success. - string|Account? destination; + string|Account destination; }; public type InvoiceLinesList record { # Details about each object. - LineItem[]? data; + LineItem[] data; # True if this list has another page of items after this one that can be fetched. - boolean? has_more; + boolean has_more; # String representing the object's type. Objects of the same type share the same value. Always has the value `list`. - string? 'object; + string 'object; # The URL where this list can be accessed. - string? url; + string url; }; # You can store multiple cards on a customer in order to charge the customer @@ -5481,7 +6743,7 @@ public type Card record { # A set of available payout methods for this card. Only values from this set should be passed as the `method` when creating a payout. string[]? available_payout_methods?; # Card brand. Can be `American Express`, `Diners Club`, `Discover`, `JCB`, `MasterCard`, `UnionPay`, `Visa`, or `Unknown`. - string? brand; + string brand; # Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected. string? country?; # Three-letter [ISO code for currency](https://stripe.com/docs/payouts). Only applicable on accounts (not customers or recipients). The card can be used as a transfer destination for funds in this currency. @@ -5495,25 +6757,25 @@ public type Card record { # (For tokenized numbers only.) The last four digits of the device account number. string? dynamic_last4?; # Two-digit number representing the card's expiration month. - int? exp_month; + int exp_month; # Four-digit number representing the card's expiration year. - int? exp_year; + int exp_year; # Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number. # # *Starting May 1, 2021, card fingerprint in India for Connect will change to allow two fingerprints for the same card --- one for India and one for the rest of the world.* string? fingerprint?; # Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`. - string? funding; + string funding; # Unique identifier for the object. - string? id; + string id; # The last four digits of the card. - string? last4; + string last4; # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. record {} metadata?; # Cardholder name. string? name?; # String representing the object's type. Objects of the same type share the same value. - string? 'object; + string 'object; # The recipient that this card belongs to. This attribute will not be in the card object if the card belongs to a customer or account instead. string|Recipient? recipient?; # If the card number is tokenized, this is the method that was used. Can be `android_pay` (includes Google Pay), `apple_pay`, `masterpass`, `visa_checkout`, or null. @@ -5523,7 +6785,31 @@ public type Card record { public type QuotesResourceComputed record { # The definitive totals and line items the customer will be charged on a recurring basis. Takes into account the line items with recurring prices and discounts with `duration=forever` coupons only. Defaults to `null` if no inputted line items with recurring prices. QuotesResourceRecurring? recurring?; - QuotesResourceUpfront? upfront; + QuotesResourceUpfront upfront; +}; + +# Stripe needs to collect certain pieces of information about each account +# created. These requirements can differ depending on the account's country. The +# Country Specs API makes these rules available to your integration. +# +# You can also view the information from this API call as [an online +# guide](/docs/connect/required-verification-information). +public type CountrySpec record { + # The default currency for this country. This applies to both payment methods and bank accounts. + string default_currency; + # Unique identifier for the object. Represented as the ISO country code for this country. + string id; + # String representing the object's type. Objects of the same type share the same value. + string 'object; + # Currencies that can be accepted in the specific country (for transfers). + record {} supported_bank_account_currencies; + # Currencies that can be accepted in the specified country (for payments). + string[] supported_payment_currencies; + # Payment methods available in the specified country. You may need to enable some payment methods (e.g., [ACH](https://stripe.com/docs/ach)) on your account before they appear in this list. The `stripe` payment method refers to [charging through your platform](https://stripe.com/docs/connect/destination-charges). + string[] supported_payment_methods; + # Countries that can accept transfers from the specified country. + string[] supported_transfer_countries; + CountrySpecVerificationFields verification_fields; }; public type PaymentMethodEps record { @@ -5533,11 +6819,11 @@ public type PaymentMethodEps record { public type Rule record { # The action taken on the payment. - string? action; + string action; # Unique identifier for the object. - string? id; + string id; # The predicate to evaluate the payment against. - string? predicate; + string predicate; }; # Balance transactions represent funds moving through your Stripe account. @@ -5546,48 +6832,66 @@ public type Rule record { # Related guide: [Balance Transaction Types](https://stripe.com/docs/reports/balance-transaction-types). public type BalanceTransaction record { # Gross amount of the transaction, in %s. - int? amount; + int amount; # The date the transaction's net funds will become available in the Stripe balance. - int? available_on; + int available_on; # Time at which the object was created. Measured in seconds since the Unix epoch. - int? created; + int created; # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). - string? currency; + string currency; # An arbitrary string attached to the object. Often useful for displaying to users. string? description?; # The exchange rate used, if applicable, for this transaction. Specifically, if money was converted from currency A to currency B, then the `amount` in currency A, times `exchange_rate`, would be the `amount` in currency B. For example, suppose you charged a customer 10.00 EUR. Then the PaymentIntent's `amount` would be `1000` and `currency` would be `eur`. Suppose this was converted into 12.34 USD in your Stripe account. Then the BalanceTransaction's `amount` would be `1234`, `currency` would be `usd`, and `exchange_rate` would be `1.234`. decimal? exchange_rate?; # Fees (in %s) paid for this transaction. - int? fee; + int fee; # Detailed breakdown of fees (in %s) paid for this transaction. - Fee[]? fee_details; + Fee[] fee_details; # Unique identifier for the object. - string? id; + string id; # Net amount of the transaction, in %s. - int? net; + int net; # String representing the object's type. Objects of the same type share the same value. - string? 'object; + string 'object; # [Learn more](https://stripe.com/docs/reports/reporting-categories) about how reporting categories can help you understand balance transactions from an accounting perspective. - string? reporting_category; + string reporting_category; # The Stripe object to which this transaction is related. string|ApplicationFee|Charge|ConnectCollectionTransfer|Dispute|FeeRefund|IssuingAuthorization|IssuingDispute|IssuingTransaction|Payout|PlatformTaxFee|Refund|ReserveTransaction|TaxDeductedAtSource|Topup|Transfer|TransferReversal? 'source?; # If the transaction's net funds are available in the Stripe balance yet. Either `available` or `pending`. - string? status; + string status; # Transaction type: `adjustment`, `advance`, `advance_funding`, `anticipation_repayment`, `application_fee`, `application_fee_refund`, `charge`, `connect_collection_transfer`, `contribution`, `issuing_authorization_hold`, `issuing_authorization_release`, `issuing_dispute`, `issuing_transaction`, `payment`, `payment_failure_refund`, `payment_refund`, `payout`, `payout_cancel`, `payout_failure`, `refund`, `refund_failure`, `reserve_transaction`, `reserved_funds`, `stripe_fee`, `stripe_fx_fee`, `tax_fee`, `topup`, `topup_reversal`, `transfer`, `transfer_cancel`, `transfer_failure`, or `transfer_refund`. [Learn more](https://stripe.com/docs/reports/balance-transaction-types) about balance transaction types and what they represent. If you are looking to classify transactions for accounting purposes, you might want to consider `reporting_category` instead. - string? 'type; + string 'type; +}; + +# Result from an id_number check +public type GelatoIdNumberReport record { + # Date of birth. + GelatoDataIdNumberReportDate? dob?; + # Details on the verification error. Present when status is `unverified`. + GelatoIdNumberReportError? _error?; + # First name. + string? first_name?; + # ID number. + string? id_number?; + # Type of ID number. + string? id_number_type?; + # Last name. + string? last_name?; + # Status of this `id_number` check. + string status; }; public type AccountCardIssuingSettings record { - CardIssuingAccountTermsOfService? tos_acceptance?; + CardIssuingAccountTermsOfService tos_acceptance?; }; # Object representing the subscription schedule’s default settings public type SubscriptionSchedulesResourceDefaultSettings record { # A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the application owner's Stripe account during this phase of the schedule. decimal? application_fee_percent?; - SubscriptionSchedulesResourceDefaultSettingsAutomaticTax? automatic_tax?; + SubscriptionSchedulesResourceDefaultSettingsAutomaticTax automatic_tax?; # Possible values are `phase_start` or `automatic`. If `phase_start` then billing cycle anchor of the subscription is set to the start of the phase when entering the phase. If `automatic` then the billing cycle anchor is automatically modified as needed when entering the phase. For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle). - string? billing_cycle_anchor; + string billing_cycle_anchor; # Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period SubscriptionBillingThresholds? billing_thresholds?; # Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay the underlying subscription at the end of each billing cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions. @@ -5600,6 +6904,11 @@ public type SubscriptionSchedulesResourceDefaultSettings record { SubscriptionTransferData? transfer_data?; }; +public type GelatoVerificationSessionOptions record { + GelatoSessionDocumentOptions document?; + GelatoSessionIdNumberOptions id_number?; +}; + public type PaymentMethodCardGeneratedCard record { # The charge that created this object. string? charge?; @@ -5620,14 +6929,25 @@ public type SourceTypeAchCreditTransfer record { string? swift_code?; }; +public type PortalSubscriptionUpdate record { + # The types of subscription updates that are supported for items listed in the `products` attribute. When empty, subscriptions are not updateable. + string[] default_allowed_updates; + # Whether the feature is enabled. + boolean enabled; + # The list of products that support subscription updates. + PortalSubscriptionUpdateProduct[]? products?; + # Determines how to handle prorations resulting from subscription updates. Valid values are `none`, `create_prorations`, and `always_invoice`. + string proration_behavior; +}; + public type PaymentMethodOptionsOxxo record { # The number of calendar days before an OXXO invoice expires. For example, if you create an OXXO invoice on Monday and you set expires_after_days to 2, the OXXO invoice will expire on Wednesday at 23:59 America/Mexico_City time. - int? expires_after_days; + int expires_after_days; }; public type PendingInvoiceItemIntervalParams record { - string? interval; - int? interval_count?; + string interval; + int interval_count?; }; public type LegalEntityDob record { @@ -5640,13 +6960,13 @@ public type LegalEntityDob record { }; public type BillingThresholdParams record { - int? amount_gte?; - boolean? reset_billing_cycle_anchor?; + int amount_gte?; + boolean reset_billing_cycle_anchor?; }; public type SetupIntentPaymentMethodOptionsMandateOptionsAcssDebit record { # A URL for custom mandate text - string? custom_mandate_url?; + string custom_mandate_url?; # Description of the interval. Only required if the 'payment_schedule' parameter is 'interval' or 'combined'. string? interval_description?; # Payment schedule for the mandate. @@ -5657,11 +6977,11 @@ public type SetupIntentPaymentMethodOptionsMandateOptionsAcssDebit record { public type DeletedPrice record { # Always true for a deleted object - boolean? deleted; + boolean deleted; # Unique identifier for the object. - string? id; + string id; # String representing the object's type. Objects of the same type share the same value. - string? 'object; + string 'object; }; public type DisputeEvidence record { @@ -5750,29 +7070,29 @@ public type PaymentMethodDetailsBancontact record { public type CreditNoteLineItem record { # The integer amount in %s representing the gross amount being credited for this line item, excluding (exclusive) tax and discounts. - int? amount; + int amount; # Description of the item being credited. string? description?; # The integer amount in %s representing the discount being credited for this line item. - int? discount_amount; + int discount_amount; # The amount of discount calculated per discount for this line item - DiscountsResourceDiscountAmount[]? discount_amounts; + DiscountsResourceDiscountAmount[] discount_amounts; # Unique identifier for the object. - string? id; + string id; # ID of the invoice line item being credited - string? invoice_line_item?; + string invoice_line_item?; # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. - boolean? livemode; + boolean livemode; # String representing the object's type. Objects of the same type share the same value. - string? 'object; + string 'object; # The number of units of product being credited. int? quantity?; # The amount of tax calculated per tax rate for this line item - CreditNoteTaxAmount[]? tax_amounts; + CreditNoteTaxAmount[] tax_amounts; # The tax rates which apply to the line item. - TaxRate[]? tax_rates; + TaxRate[] tax_rates; # 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. - string? 'type; + string 'type; # The cost of each unit of product being credited. int? unit_amount?; # Same as `unit_amount`, but contains a decimal value with at most 12 decimal places. @@ -5794,74 +7114,125 @@ public type IssuingCardholderIndividualDob record { # A list with one entry for each time that the customer sent bitcoin to the receiver. Hidden when viewing the receiver with a publishable key. public type BitcoinTransactionList record { # Details about each object. - BitcoinTransaction[]? data; + BitcoinTransaction[] data; # True if this list has another page of items after this one that can be fetched. - boolean? has_more; + boolean has_more; # String representing the object's type. Objects of the same type share the same value. Always has the value `list`. - string? 'object; + string 'object; # The URL where this list can be accessed. - string? url; + string url; }; # If this is a `sofort` PaymentMethod, this hash contains details about the SOFORT payment method. public type Param8 record { - string? country; + string country; }; # If this is a `sepa_debit` PaymentMethod, this hash contains details about the SEPA debit bank account. public type Param7 record { - string? iban; + string iban; }; # If this is a `p24` PaymentMethod, this hash contains details about the P24 payment method. public type Param6 record { - string? bank?; + string bank?; }; public type Fee record { # Amount of the fee, in cents. - int? amount; + int amount; # ID of the Connect application that earned the fee. string? application?; # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). - string? currency; + string currency; # An arbitrary string attached to the object. Often useful for displaying to users. string? description?; # Type of the fee, one of: `application_fee`, `stripe_fee` or `tax`. - string? 'type; + string 'type; }; # If this is an `ideal` PaymentMethod, this hash contains details about the iDEAL payment method. public type Param5 record { - string? bank?; + string bank?; }; # If this is an `fpx` PaymentMethod, this hash contains details about the FPX payment method. public type Param4 record { - string? bank; + string bank; }; # If this is an `eps` PaymentMethod, this hash contains details about the EPS payment method. public type Param3 record { - string? bank?; + string bank?; }; # If this is a `boleto` PaymentMethod, this hash contains details about the Boleto payment method. public type Param2 record { - string? tax_id; + string tax_id; }; # If this is a `bacs_debit` PaymentMethod, this hash contains details about the Bacs Direct Debit bank account. public type Param1 record { - string? account_number?; - string? sort_code?; + string account_number?; + string sort_code?; }; public type PackageDimentionsSpecs record { - decimal? height; - decimal? length; - decimal? weight; - decimal? width; + decimal height; + decimal length; + decimal weight; + decimal width; +}; + +# You can now model subscriptions more flexibly using the [Prices API](https://stripe.com/docs/api#prices). It replaces the Plans API and is backwards compatible to simplify your migration. +# +# Plans define the base price, currency, and billing cycle for recurring purchases of products. +# [Products](https://stripe.com/docs/api#products) help you track inventory or provisioning, and plans help you track pricing. Different physical goods or levels of service should be represented by products, and pricing options should be represented by plans. This approach lets you change prices without having to change your provisioning scheme. +# +# For example, you might have a single "gold" product that has plans for $10/month, $100/year, €9/month, and €90/year. +# +# Related guides: [Set up a subscription](https://stripe.com/docs/billing/subscriptions/set-up-subscription) and more about [products and prices](https://stripe.com/docs/billing/prices-guide). +public type Plan record { + # Whether the plan can be used for new purchases. + boolean active; + # Specifies a usage aggregation strategy for plans of `usage_type=metered`. Allowed values are `sum` for summing up all usage during a period, `last_during_period` for using the last usage record reported within a period, `last_ever` for using the last usage record ever (across period bounds) or `max` which uses the usage record with the maximum reported usage during a period. Defaults to `sum`. + string? aggregate_usage?; + # The unit amount in %s to be charged, represented as a whole integer if possible. Only set if `billing_scheme=per_unit`. + int? amount?; + # The unit amount in %s to be charged, represented as a decimal string with at most 12 decimal places. Only set if `billing_scheme=per_unit`. + string? amount_decimal?; + # Describes how to compute the price per period. Either `per_unit` or `tiered`. `per_unit` indicates that the fixed amount (specified in `amount`) will be charged per unit in `quantity` (for plans with `usage_type=licensed`), or per unit of total usage (for plans 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. + string billing_scheme; + # Time at which the object was created. Measured in seconds since the Unix epoch. + int created; + # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + string currency; + # Unique identifier for the object. + string id; + # The frequency at which a subscription is billed. One of `day`, `week`, `month` or `year`. + string interval; + # The number of intervals (specified in the `interval` attribute) between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. + int interval_count; + # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. + boolean livemode; + # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. + record {} metadata?; + # A brief description of the plan, hidden from customers. + string? nickname?; + # String representing the object's type. Objects of the same type share the same value. + string 'object; + # The product whose pricing this plan determines. + string|Product|DeletedProduct? product?; + # Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`. + PlanTier[] tiers?; + # 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. + string? tiers_mode?; + # Apply a transformation to the reported usage or set quantity before computing the amount billed. Cannot be combined with `tiers`. + TransformUsage? transform_usage?; + # Default number of trial days when subscribing a customer to this plan using [`trial_from_plan=true`](https://stripe.com/docs/api#create_subscription-trial_from_plan). + int? trial_period_days?; + # Configures how the quantity per period should be determined. Can be either `metered` or `licensed`. `licensed` automatically bills the `quantity` set when adding it to a subscription. `metered` aggregates the total usage based on usage records. Defaults to `licensed`. + string usage_type; }; # A SetupAttempt describes one attempted confirmation of a SetupIntent, @@ -5872,28 +7243,61 @@ public type SetupAttempt record { # The value of [application](https://stripe.com/docs/api/setup_intents/object#setup_intent_object-application) on the SetupIntent at the time of this confirmation. string|Application? application?; # Time at which the object was created. Measured in seconds since the Unix epoch. - int? created; + int created; # The value of [customer](https://stripe.com/docs/api/setup_intents/object#setup_intent_object-customer) on the SetupIntent at the time of this confirmation. string|Customer|DeletedCustomer? customer?; # Unique identifier for the object. - string? id; + string id; # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. - boolean? livemode; + boolean livemode; # String representing the object's type. Objects of the same type share the same value. - string? 'object; + string 'object; # The value of [on_behalf_of](https://stripe.com/docs/api/setup_intents/object#setup_intent_object-on_behalf_of) on the SetupIntent at the time of this confirmation. string|Account? on_behalf_of?; # ID of the payment method used with this SetupAttempt. - string|PaymentMethod? payment_method; - SetupAttemptPaymentMethodDetails? payment_method_details; + string|PaymentMethod payment_method; + SetupAttemptPaymentMethodDetails payment_method_details; # The error encountered during this attempt to confirm the SetupIntent, if any. ApiErrors? setup_error?; # ID of the SetupIntent that this attempt belongs to. - string|SetupIntent? setup_intent; + string|SetupIntent setup_intent; # Status of this SetupAttempt, one of `requires_confirmation`, `requires_action`, `processing`, `succeeded`, `failed`, or `abandoned`. - string? status; + string status; # The value of [usage](https://stripe.com/docs/api/setup_intents/object#setup_intent_object-usage) on the SetupIntent at the time of this confirmation, one of `off_session` or `on_session`. - string? usage; + string usage; +}; + +# A portal configuration describes the functionality and behavior of a portal session. +public type BillingPortalConfiguration record { + # Whether the configuration is active and can be used to create portal sessions. + boolean active; + # ID of the Connect Application that created the configuration. + string? application?; + PortalBusinessProfile business_profile; + # Time at which the object was created. Measured in seconds since the Unix epoch. + int created; + # The default URL to redirect customers to when they click on the portal's link to return to your website. This can be [overriden](https://stripe.com/docs/api/customer_portal/sessions/create#create_portal_session-return_url) when creating the session. + string? default_return_url?; + PortalFeatures features; + # Unique identifier for the object. + string id; + # Whether the configuration is the default. If `true`, this configuration can be managed in the Dashboard and portal sessions will use this configuration unless it is overriden when creating the session. + boolean is_default; + # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. + boolean livemode; + # String representing the object's type. Objects of the same type share the same value. + string 'object; + # Time at which the object was last updated. Measured in seconds since the Unix epoch. + int updated; +}; + +public type DeletedRecipient record { + # Always true for a deleted object + boolean deleted; + # Unique identifier for the object. + string id; + # String representing the object's type. Objects of the same type share the same value. + string 'object; }; public type InvoicesStatusTransitions record { @@ -5909,64 +7313,71 @@ public type InvoicesStatusTransitions record { public type CustomersCustomerBody record { # The customer's address. - CustomerAdresss|string? address?; + CustomerAdresss|string address?; # An integer amount in %s that represents the customer's current balance, which affect the customer's future invoices. A negative amount represents a credit that decreases the amount due on an invoice; a positive amount increases the amount due on an invoice. - int? balance?; + int balance?; # Either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/js), or a dictionary containing a user's bank account details. - CustomerBankAccountDetails|string? bank_account?; + CustomerBankAccountDetails|string bank_account?; # A token, like the ones returned by [Stripe.js](https://stripe.com/docs/js). - CustomerCardDetails|string? card?; - string? coupon?; + CustomerCardDetails|string card?; + string coupon?; # ID of Alipay account to make the customer's new default for invoice payments. - string? default_alipay_account?; + string default_alipay_account?; # ID of bank account to make the customer's new default for invoice payments. - string? default_bank_account?; + string default_bank_account?; # ID of card to make the customer's new default for invoice payments. - string? default_card?; + string default_card?; # If you are using payment methods created via the PaymentMethods API, see the [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/update#update_customer-invoice_settings-default_payment_method) parameter. # # Provide the ID of a payment source already attached to this customer to make it this customer's default payment source. # # If you want to add a new payment source and make it the default, see the [source](https://stripe.com/docs/api/customers/update#update_customer-source) property. - string? default_source?; + string default_source?; # An arbitrary string that you can attach to a customer object. It is displayed alongside the customer in the dashboard. - string? description?; + string description?; # Customer's email address. It's displayed alongside the customer in your dashboard and can be useful for searching and tracking. This may be up to *512 characters*. - string? email?; + string email?; # Specifies which fields in the response should be expanded. - string[]? expand?; + string[] expand?; # The prefix for the customer used to generate unique invoice numbers. Must be 3–12 uppercase letters or numbers. - string? invoice_prefix?; + string invoice_prefix?; # Default invoice settings for this customer. - CustomerParam1? invoice_settings?; + CustomerParam1 invoice_settings?; # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. - record {}|string? metadata?; + record {}|string metadata?; # The customer's full name or business name. - string? name?; + string name?; # The sequence to be used on the customer's next invoice. Defaults to 1. - int? next_invoice_sequence?; + int next_invoice_sequence?; # The customer's phone number. - string? phone?; + string phone?; # Customer's preferred languages, ordered by preference. - string[]? preferred_locales?; + string[] preferred_locales?; # The API ID of a promotion code to apply to the customer. The customer will have a discount applied on all recurring payments. Charges you create through the API will not have the discount. - string? promotion_code?; + string promotion_code?; # The customer's shipping information. Appears on invoices emailed to this customer. - CustomerShippingAddress|string? shipping?; - string? 'source?; + CustomerShippingAddress|string shipping?; + string 'source?; # Tax details about the customer. - TaxParam? tax?; + TaxParam tax?; # The customer's tax exemption. One of `none`, `exempt`, or `reverse`. - string? tax_exempt?; + string tax_exempt?; # Unix timestamp representing the end of the trial period the customer will get before being charged for the first time. This will always overwrite any trials that might apply via a subscribed plan. If set, trial_end will override the default trial period of the plan the customer is being subscribed to. The special value `now` can be provided to end the customer's trial immediately. Can be at most two years from `billing_cycle_anchor`. - string|int? trial_end?; + string|int trial_end?; +}; + +public type PortalSubscriptionUpdateProduct record { + # The list of price IDs which, when subscribed to, a subscription can be updated. + string[] prices; + # The product ID. + string product; }; public type AccountDeclineChargeOn record { # Whether Stripe automatically declines charges with an incorrect ZIP or postal code. This setting only applies when a ZIP or postal code is provided and they fail bank verification. - boolean? avs_failure; + boolean avs_failure; # Whether Stripe automatically declines charges with an incorrect CVC. This setting only applies when a CVC is provided and it fails bank verification. - boolean? cvc_failure; + boolean cvc_failure; }; # A representation of the constituent items of any given order. Can be used to @@ -5975,55 +7386,87 @@ public type AccountDeclineChargeOn record { # Related guide: [Orders](https://stripe.com/docs/orders/guide). public type OrderItem record { # A positive integer in the smallest currency unit (that is, 100 cents for $1.00, or 1 for ¥1, Japanese Yen being a zero-decimal currency) representing the total amount for the line item. - int? amount; + int amount; # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). - string? currency; + string currency; # Description of the line item, meant to be displayable to the user (e.g., `"Express shipping"`). - string? description; + string description; # String representing the object's type. Objects of the same type share the same value. - string? 'object; + string 'object; # The ID of the associated object for this line item. Expandable if not null (e.g., expandable to a SKU). string|Sku? parent?; # A positive integer representing the number of instances of `parent` that are included in this order item. Applicable/present only if `type` is `sku`. int? quantity?; # The type of line item. One of `sku`, `tax`, `shipping`, or `discount`. - string? 'type; + string 'type; }; public type LegalEntityCompanyVerification record { - LegalEntityCompanyVerificationDocument? document; + LegalEntityCompanyVerificationDocument document; }; # Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods. public type BillingDetailsInnerParams record { - BillingDetailsAddress|string? address?; - string? email?; - string? name?; - string? phone?; + BillingDetailsAddress|string address?; + string email?; + string name?; + string phone?; }; public type MandateSepaDebit record { # The unique reference of the mandate. - string? reference; + string reference; # The URL of the mandate. This URL generally contains sensitive information about the customer and should be shared with them exclusively. - string? url; + string url; }; public type PaymentMethodFpx record { # The customer's bank, if provided. Can be one of `affin_bank`, `alliance_bank`, `ambank`, `bank_islam`, `bank_muamalat`, `bank_rakyat`, `bsn`, `cimb`, `hong_leong_bank`, `hsbc`, `kfh`, `maybank2u`, `ocbc`, `public_bank`, `rhb`, `standard_chartered`, `uob`, `deutsche_bank`, `maybank2e`, or `pb_enterprise`. - string? bank; + string bank; +}; + +# Source mandate notifications should be created when a notification related to +# a source mandate must be sent to the payer. They will trigger a webhook or +# deliver an email to the customer. +public type SourceMandateNotification record { + SourceMandateNotificationAcssDebitData acss_debit?; + # A positive integer in the smallest currency unit (that is, 100 cents for $1.00, or 1 for ¥1, Japanese Yen being a zero-decimal currency) representing the amount associated with the mandate notification. The amount is expressed in the currency of the underlying source. Required if the notification type is `debit_initiated`. + int? amount?; + SourceMandateNotificationBacsDebitData bacs_debit?; + # Time at which the object was created. Measured in seconds since the Unix epoch. + int created; + # Unique identifier for the object. + string id; + # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. + boolean livemode; + # String representing the object's type. Objects of the same type share the same value. + string 'object; + # The reason of the mandate notification. Valid reasons are `mandate_confirmed` or `debit_initiated`. + string reason; + SourceMandateNotificationSepaDebitData sepa_debit?; + # `Source` objects allow you to accept a variety of payment methods. They + # represent a customer's payment instrument, and can be used with the Stripe API + # just like a `Card` object: once chargeable, they can be charged, or can be + # attached to customers. + # + # Related guides: [Sources API](https://stripe.com/docs/sources) and [Sources & Customers](https://stripe.com/docs/sources/customers). + Source 'source; + # The status of the mandate notification. Valid statuses are `pending` or `submitted`. + string status; + # The type of source this mandate notification is attached to. Should be the source type identifier code for the payment method, such as `three_d_secure`. + string 'type; }; public type ReserveTransaction record { - int? amount; + int amount; # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). - string? currency; + string currency; # An arbitrary string attached to the object. Often useful for displaying to users. string? description?; # Unique identifier for the object. - string? id; + string id; # String representing the object's type. Objects of the same type share the same value. - string? 'object; + string 'object; }; # Issue a credit note to adjust an invoice's amount after the invoice is finalized. @@ -6031,57 +7474,104 @@ public type ReserveTransaction record { # Related guide: [Credit Notes](https://stripe.com/docs/billing/invoices/credit-notes). public type CreditNote record { # The integer amount in %s representing the total amount of the credit note, including tax. - int? amount; + int amount; # Time at which the object was created. Measured in seconds since the Unix epoch. - int? created; + int created; # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). - string? currency; + string currency; # ID of the customer. - string|Customer|DeletedCustomer? customer; + string|Customer|DeletedCustomer customer; # Customer balance transaction related to this credit note. string|CustomerBalanceTransaction? customer_balance_transaction?; # The integer amount in %s representing the total amount of discount that was credited. - int? discount_amount; + int discount_amount; # The aggregate amounts calculated per discount for all line items. - DiscountsResourceDiscountAmount[]? discount_amounts; + DiscountsResourceDiscountAmount[] discount_amounts; # Unique identifier for the object. - string? id; + string id; # ID of the invoice. - string|Invoice? invoice; + string|Invoice invoice; # Line items that make up the credit note - CreditNoteLinesList? lines; + CreditNoteLinesList lines; # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. - boolean? livemode; + boolean livemode; # Customer-facing text that appears on the credit note PDF. string? memo?; # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. record {} metadata?; # A unique number that identifies this particular credit note and appears on the PDF of the credit note and its associated invoice. - string? number; + string number; # String representing the object's type. Objects of the same type share the same value. - string? 'object; + string 'object; # Amount that was credited outside of Stripe. int? out_of_band_amount?; # The link to download the PDF of the credit note. - string? pdf; + string pdf; # Reason for issuing this credit note, one of `duplicate`, `fraudulent`, `order_change`, or `product_unsatisfactory` string? reason?; # Refund related to this credit note. string|Refund? refund?; # Status of this credit note, one of `issued` or `void`. Learn more about [voiding credit notes](https://stripe.com/docs/billing/invoices/credit-notes#voiding). - string? status; + string status; # The integer amount in %s representing the amount of the credit note, excluding tax and invoice level discounts. - int? subtotal; + int subtotal; # The aggregate amounts calculated per tax rate for all line items. - CreditNoteTaxAmount[]? tax_amounts; + CreditNoteTaxAmount[] tax_amounts; # The integer amount in %s representing the total amount of the credit note, including tax and all discount. - int? total; + int total; # Type of this credit note, one of `pre_payment` or `post_payment`. A `pre_payment` credit note means it was issued when the invoice was open. A `post_payment` credit note means it was issued when the invoice was paid. - string? 'type; + string 'type; # The time that the credit note was voided. int? voided_at?; }; +# A Location represents a grouping of readers. +# +# Related guide: [Fleet Management](https://stripe.com/docs/terminal/creating-locations). +public type TerminalLocation record { + Address address; + # The display name of the location. + string display_name; + # Unique identifier for the object. + string id; + # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. + boolean livemode; + # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. + record {} metadata; + # String representing the object's type. Objects of the same type share the same value. + string 'object; +}; + +# Some payment methods have no required amount that a customer must send. +# Customers can be instructed to send any amount, and it can be made up of +# multiple transactions. As such, sources can have multiple associated +# transactions. +public type SourceTransaction record { + SourceTransactionAchCreditTransferData ach_credit_transfer?; + # A positive integer in the smallest currency unit (that is, 100 cents for $1.00, or 1 for ¥1, Japanese Yen being a zero-decimal currency) representing the amount your customer has pushed to the receiver. + int amount; + SourceTransactionChfCreditTransferData chf_credit_transfer?; + # Time at which the object was created. Measured in seconds since the Unix epoch. + int created; + # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + string currency; + SourceTransactionGbpCreditTransferData gbp_credit_transfer?; + # Unique identifier for the object. + string id; + # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. + boolean livemode; + # String representing the object's type. Objects of the same type share the same value. + string 'object; + SourceTransactionPaperCheckData paper_check?; + SourceTransactionSepaCreditTransferData sepa_credit_transfer?; + # The ID of the source this transaction is attached to. + string 'source; + # The status of the transaction, one of `succeeded`, `pending`, or `failed`. + string status; + # The type of source this transaction is attached to. + string 'type; +}; + public type PaymentMethodWechatPay record { }; @@ -6096,7 +7586,7 @@ public type PaymentIntentNextActionDisplayOxxoDetails record { public type PaymentMethodDetailsCardPresentReceipt record { # The type of account being debited or credited - string? account_type?; + string account_type?; # EMV tag 9F26, cryptogram generated by the integrated circuit chip. string? application_cryptogram?; # Mnenomic of the Application Identifier. @@ -6115,6 +7605,15 @@ public type PaymentMethodDetailsCardPresentReceipt record { string? transaction_status_information?; }; +public type DeletedBitcoinReceiver record { + # Always true for a deleted object + boolean deleted; + # Unique identifier for the object. + string id; + # String representing the object's type. Objects of the same type share the same value. + string 'object; +}; + # Order objects are created to handle end customers' purchases of previously # defined [products](https://stripe.com/docs/api#products). You can create, retrieve, and pay individual orders, as well # as list all orders. Orders are identified by a unique, random ID. @@ -6122,7 +7621,7 @@ public type PaymentMethodDetailsCardPresentReceipt record { # Related guide: [Tax, Shipping, and Inventory](https://stripe.com/docs/orders). public type Order record { # A positive integer in the smallest currency unit (that is, 100 cents for $1.00, or 1 for ¥1, Japanese Yen being a zero-decimal currency) representing the total amount for the order. - int? amount; + int amount; # The total amount that was returned to the customer. int? amount_returned?; # ID of the Connect Application that created the order. @@ -6132,25 +7631,25 @@ public type Order record { # The ID of the payment used to pay for the order. Present if the order status is `paid`, `fulfilled`, or `refunded`. string|Charge? charge?; # Time at which the object was created. Measured in seconds since the Unix epoch. - int? created; + int created; # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). - string? currency; + string currency; # The customer used for the order. string|Customer|DeletedCustomer? customer?; # The email address of the customer placing the order. string? email?; # External coupon code to load for this order. - string? external_coupon_code?; + string external_coupon_code?; # Unique identifier for the object. - string? id; + string id; # List of items constituting the order. An order can have up to 25 items. - OrderItem[]? items; + OrderItem[] items; # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. - boolean? livemode; + boolean livemode; # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. record {} metadata?; # String representing the object's type. Objects of the same type share the same value. - string? 'object; + string 'object; # A list of returns that have taken place for this order. OrdersResourceOrderReturnList? 'returns?; # The shipping method that is currently selected for this order, if any. If present, it is equal to one of the `id`s of shipping methods in the `shipping_methods` array. At order creation time, if there are multiple shipping methods, Stripe will automatically selected the first method. @@ -6160,39 +7659,39 @@ public type Order record { # A list of supported shipping methods for this order. The desired shipping method can be specified either by updating the order, or when paying it. ShippingMethod[]? shipping_methods?; # Current order status. One of `created`, `paid`, `canceled`, `fulfilled`, or `returned`. More details in the [Orders Guide](https://stripe.com/docs/orders/guide#understanding-order-statuses). - string? status; + string status; # The timestamps at which the order status was updated. StatusTransitions? status_transitions?; # Time at which the object was last updated. Measured in seconds since the Unix epoch. int? updated?; # The user's order ID if it is different from the Stripe order ID. - string? upstream_id?; + string upstream_id?; }; public type BancontactInvoicePaymentMethodOptionsParam record { - string? preferred_language?; + string preferred_language?; }; # A list of items the customer is being quoted for. public type QuotesResourceListLineItems record { # Details about each object. - Item[]? data; + Item[] data; # True if this list has another page of items after this one that can be fetched. - boolean? has_more; + boolean has_more; # String representing the object's type. Objects of the same type share the same value. Always has the value `list`. - string? 'object; + string 'object; # The URL where this list can be accessed. - string? url; + string url; }; # Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. public type RecurringPriceData record { - string? currency; - string? product; - RecurringAdhoc? recurring; - string? tax_behavior?; - int? unit_amount?; - string? unit_amount_decimal?; + string currency; + string product; + RecurringAdhoc recurring; + string tax_behavior?; + int unit_amount?; + string unit_amount_decimal?; }; public type PaymentMethodDetailsCardPresent record { @@ -6205,9 +7704,9 @@ public type PaymentMethodDetailsCardPresent record { # Authorization response cryptogram. string? emv_auth_data?; # Two-digit number representing the card's expiration month. - int? exp_month; + int exp_month; # Four-digit number representing the card's expiration year. - int? exp_year; + int exp_year; # Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number. # # *Starting May 1, 2021, card fingerprint in India for Connect will change to allow two fingerprints for the same card --- one for India and one for the rest of the world.* @@ -6228,7 +7727,14 @@ public type PaymentMethodDetailsCardPresent record { # Automatic tax settings for this subscription. public type AutomaticTaxConfig1 record { - boolean? enabled; + boolean enabled; +}; + +public type Period record { + # The end date of this usage period. All usage up to and including this point in time is included. + int? end?; + # The start date of this usage period. All usage after this point in time is included. + int? 'start?; }; # A PaymentIntent guides you through the process of collecting a payment from your customer. @@ -6244,11 +7750,11 @@ public type AutomaticTaxConfig1 record { # Related guide: [Payment Intents API](https://stripe.com/docs/payments/payment-intents). public type PaymentIntent record { # Amount intended to be collected by this PaymentIntent. A positive integer representing how much to charge in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The minimum amount is $0.50 US or [equivalent in charge currency](https://stripe.com/docs/currencies#minimum-and-maximum-charge-amounts). The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99). - int? amount; + int amount; # Amount that can be captured from this PaymentIntent. - int? amount_capturable?; + int amount_capturable?; # Amount that was collected by this PaymentIntent. - int? amount_received?; + int amount_received?; # ID of the Connect application that created the PaymentIntent. string|Application? application?; # The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. The amount of the application fee collected will be capped at the total payment amount. For more information, see the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts). @@ -6258,20 +7764,20 @@ public type PaymentIntent record { # 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`). string? cancellation_reason?; # Controls when the funds will be captured from the customer's account. - string? capture_method; + string capture_method; # Charges that were created by this PaymentIntent, if any. - PaymentFlowsPaymentIntentResourceChargeList? charges?; + PaymentFlowsPaymentIntentResourceChargeList charges?; # The client secret of this PaymentIntent. Used for client-side retrieval using a publishable key. # # The client secret can be used to complete a payment from your frontend. It should not be stored, logged, embedded in URLs, or exposed to anyone other than the customer. Make sure that you have TLS enabled on any page that includes the client secret. # # Refer to our docs to [accept a payment](https://stripe.com/docs/payments/accept-a-payment?integration=elements) and learn about how `client_secret` should be handled. string? client_secret?; - string? confirmation_method; + string confirmation_method; # Time at which the object was created. Measured in seconds since the Unix epoch. - int? created; + int created; # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). - string? currency; + string currency; # ID of the Customer this PaymentIntent belongs to, if one exists. # # Payment methods attached to other Customers cannot be used with this PaymentIntent. @@ -6281,19 +7787,19 @@ public type PaymentIntent record { # An arbitrary string attached to the object. Often useful for displaying to users. string? description?; # Unique identifier for the object. - string? id; + string id; # ID of the invoice that created this PaymentIntent, if it exists. string|Invoice? invoice?; # The payment error encountered in the previous PaymentIntent confirmation. It will be cleared if the PaymentIntent is later updated for any reason. ApiErrors? last_payment_error?; # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. - boolean? livemode; + boolean livemode; # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. For more information, see the [documentation](https://stripe.com/docs/payments/payment-intents/creating-payment-intents#storing-information-in-metadata). record {} metadata?; # 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. PaymentIntentNextAction? next_action?; # String representing the object's type. Objects of the same type share the same value. - string? 'object; + string 'object; # The account (if any) for which the funds of the PaymentIntent are intended. See the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts) for details. string|Account? on_behalf_of?; # ID of the payment method used in this PaymentIntent. @@ -6301,7 +7807,7 @@ public type PaymentIntent record { # Payment-method-specific configuration for this PaymentIntent. PaymentIntentPaymentMethodOptions? payment_method_options?; # The list of payment method types (e.g. card) that this PaymentIntent is allowed to use. - string[]? payment_method_types; + string[] payment_method_types; # Email address that the receipt for the resulting payment will be sent to. If `receipt_email` is specified for a payment in live mode, a receipt will be sent regardless of your [email settings](https://dashboard.stripe.com/account/emails). string? receipt_email?; # ID of the review associated with this PaymentIntent, if any. @@ -6319,21 +7825,54 @@ public type PaymentIntent record { # Provides information about a card payment that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters for the concatenated descriptor. string? statement_descriptor_suffix?; # 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](https://stripe.com/docs/payments/intents#intent-statuses). - string? status; + string status; # The data with which to automatically create a Transfer when the payment is finalized. See the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts) for details. TransferData? transfer_data?; # A string that identifies the resulting payment as part of a group. See the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts) for details. string? transfer_group?; }; +# A VerificationReport is the result of an attempt to collect and verify data from a user. +# The collection of verification checks performed is determined from the `type` and `options` +# parameters used. You can find the result of each verification check performed in the +# appropriate sub-resource: `document`, `id_number`, `selfie`. +# +# Each VerificationReport contains a copy of any data collected by the user as well as +# reference IDs which can be used to access collected images through the [FileUpload](https://stripe.com/docs/api/files) +# API. To configure and create VerificationReports, use the +# [VerificationSession](https://stripe.com/docs/api/identity/verification_sessions) API. +# +# Related guides: [Accessing verification results](https://stripe.com/docs/identity/verification-sessions#results). +public type IdentityVerificationReport record { + # Time at which the object was created. Measured in seconds since the Unix epoch. + int created; + # Result from a document check + GelatoDocumentReport document?; + # Unique identifier for the object. + string id; + # Result from an id_number check + GelatoIdNumberReport id_number?; + # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. + boolean livemode; + # String representing the object's type. Objects of the same type share the same value. + string 'object; + GelatoVerificationReportOptions options; + # Result from a selfie check + GelatoSelfieReport selfie?; + # Type of report. + string 'type; + # ID of the VerificationSession that created this report. + string? verification_session?; +}; + public type MandateAuBecsDebit record { # The URL of the mandate. This URL generally contains sensitive information about the customer and should be shared with them exclusively. - string? url; + string url; }; public type PaymentMethodBoleto record { # Uniquely identifies the customer tax id (CNPJ or CPF) - string? tax_id; + string tax_id; }; public type PaymentMethodDetailsEps record { @@ -6345,9 +7884,95 @@ public type PaymentMethodDetailsEps record { string? verified_name?; }; +# The Report Run object represents an instance of a report type generated with +# specific run parameters. Once the object is created, Stripe begins processing the report. +# When the report has finished running, it will give you a reference to a file +# where you can retrieve your results. For an overview, see +# [API Access to Reports](https://stripe.com/docs/reporting/statements/api). +# +# Note that certain report types can only be run based on your live-mode data (not test-mode +# data), and will error when queried without a [live-mode API key](https://stripe.com/docs/keys#test-live-modes). +public type ReportingReportRun record { + # Time at which the object was created. Measured in seconds since the Unix epoch. + int created; + # If something should go wrong during the run, a message about the failure (populated when + # `status=failed`). + string? _error?; + # Unique identifier for the object. + string id; + # `true` if the report is run on live mode data and `false` if it is run on test mode data. + boolean livemode; + # String representing the object's type. Objects of the same type share the same value. + string 'object; + FinancialReportingFinanceReportRunRunParameters parameters; + # The ID of the [report type](https://stripe.com/docs/reports/report-types) to run, such as `"balance.summary.1"`. + string report_type; + # The file object representing the result of the report run (populated when + # `status=succeeded`). + File? result?; + # 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. + string status; + # Timestamp at which this run successfully finished (populated when + # `status=succeeded`). Measured in seconds since the Unix epoch. + int? succeeded_at?; +}; + +# Sometimes you want to add a charge or credit to a customer, but actually +# charge or credit the customer's card only at the end of a regular billing +# cycle. This is useful for combining several charges (to minimize +# per-transaction fees), or for having Stripe tabulate your usage-based billing +# totals. +# +# Related guide: [Subscription Invoices](https://stripe.com/docs/billing/invoices/subscription#adding-upcoming-invoice-items). +public type Invoiceitem record { + # Amount (in the `currency` specified) of the invoice item. This should always be equal to `unit_amount * quantity`. + int amount; + # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + string currency; + # The ID of the customer who will be billed when this invoice item is billed. + string|Customer|DeletedCustomer customer; + # Time at which the object was created. Measured in seconds since the Unix epoch. + int date; + # An arbitrary string attached to the object. Often useful for displaying to users. + string? description?; + # If true, discounts will apply to this invoice item. Always false for prorations. + boolean discountable; + # The discounts which apply to the invoice item. Item discounts are applied before invoice discounts. Use `expand[]=discounts` to expand each discount. + (string|Discount)[]? discounts?; + # Unique identifier for the object. + string id; + # The ID of the invoice this invoice item belongs to. + string|Invoice? invoice?; + # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. + boolean livemode; + # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. + record {} metadata?; + # String representing the object's type. Objects of the same type share the same value. + string 'object; + InvoiceLineItemPeriod period; + # The price of the invoice item. + Price? price?; + # Whether the invoice item was created automatically as a proration adjustment when the customer switched plans. + boolean proration; + # Quantity of units for the invoice item. If the invoice item is a proration, the quantity of the subscription that the proration was computed for. + int quantity; + # The subscription that this invoice item has been created for, if any. + string|Subscription? subscription?; + # The subscription item that this invoice item has been created for, if any. + string subscription_item?; + # 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. + TaxRate[]? tax_rates?; + # Unit amount (in the `currency` specified) of the invoice item. + int? unit_amount?; + # Same as `unit_amount`, but contains a decimal value with at most 12 decimal places. + string? unit_amount_decimal?; +}; + public type PaymentMethodOptions1 record { - BancontactInvoicePaymentMethodOptionsParam|string? bancontact?; - CardInvoicePaymentMethodOptionsParam|string? card?; + BancontactInvoicePaymentMethodOptionsParam|string bancontact?; + CardInvoicePaymentMethodOptionsParam|string card?; }; # Each customer has a [`balance`](https://stripe.com/docs/api/customers/object#customer_object-balance) value, @@ -6358,88 +7983,88 @@ public type PaymentMethodOptions1 record { # Related guide: [Customer Balance](https://stripe.com/docs/billing/customer/balance) to learn more. public type CustomerBalanceTransaction record { # The amount of the transaction. A negative value is a credit for the customer's balance, and a positive value is a debit to the customer's `balance`. - int? amount; + int amount; # Time at which the object was created. Measured in seconds since the Unix epoch. - int? created; + int created; # The ID of the credit note (if any) related to the transaction. string|CreditNote? credit_note?; # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). - string? currency; + string currency; # The ID of the customer the transaction belongs to. - string|Customer? customer; + string|Customer customer; # An arbitrary string attached to the object. Often useful for displaying to users. string? description?; # The customer's `balance` after the transaction was applied. A negative value decreases the amount due on the customer's next invoice. A positive value increases the amount due on the customer's next invoice. - int? ending_balance; + int ending_balance; # Unique identifier for the object. - string? id; + string id; # The ID of the invoice (if any) related to the transaction. string|Invoice? invoice?; # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. - boolean? livemode; + boolean livemode; # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. record {} metadata?; # String representing the object's type. Objects of the same type share the same value. - string? 'object; + string 'object; # Transaction type: `adjustment`, `applied_to_invoice`, `credit_note`, `initial`, `invoice_too_large`, `invoice_too_small`, `unspent_receiver_credit`, or `unapplied_from_invoice`. See the [Customer Balance page](https://stripe.com/docs/billing/customer/balance#types) to learn more about transaction types. - string? 'type; + string 'type; }; public type AutomaticTaxConfig3 record { - boolean? enabled; + boolean enabled; }; public type DeletedCoupon record { # Always true for a deleted object - boolean? deleted; + boolean deleted; # Unique identifier for the object. - string? id; + string id; # String representing the object's type. Objects of the same type share the same value. - string? 'object; + string 'object; }; # Default settings for automatic tax computation public type AutomaticTaxConfig2 record { # Enabled automatic tax calculation which will automatically compute tax rates on all invoices generated by the subscription - boolean? enabled; + boolean enabled; }; public type ApplicationFee record { # ID of the Stripe account this fee was taken from. - string|Account? account; + string|Account account; # Amount earned, in %s. - int? amount; + int amount; # Amount in %s refunded (can be less than the amount attribute on the fee if a partial refund was issued) - int? amount_refunded; + int amount_refunded; # ID of the Connect application that earned the fee. - string|Application? application; + string|Application application; # Balance transaction that describes the impact of this collected application fee on your account balance (not including refunds). string|BalanceTransaction? balance_transaction?; # ID of the charge that the application fee was taken from. - string|Charge? charge; + string|Charge charge; # Time at which the object was created. Measured in seconds since the Unix epoch. - int? created; + int created; # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). - string? currency; + string currency; # Unique identifier for the object. - string? id; + string id; # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. - boolean? livemode; + boolean livemode; # String representing the object's type. Objects of the same type share the same value. - string? 'object; + string 'object; # ID of the corresponding charge on the platform account, if this fee was the result of a charge using the `destination` parameter. string|Charge? originating_transaction?; # Whether the fee has been fully refunded. If the fee is only partially refunded, this attribute will still be false. - boolean? refunded; + boolean refunded; # A list of refunds that have been applied to the fee. - FeeRefundList? refunds; + FeeRefundList refunds; }; public type PaymentIntentNextActionWechatPayDisplayQrCode record { # The data being used to generate QR code - string? data; + string data; # The base64 image data for a pre-generated QR code - string? image_data_url; + string image_data_url; }; # PaymentMethod objects represent your customer's payment instruments. @@ -6448,41 +8073,41 @@ public type PaymentIntentNextActionWechatPayDisplayQrCode record { # # Related guides: [Payment Methods](https://stripe.com/docs/payments/payment-methods) and [More Payment Scenarios](https://stripe.com/docs/payments/more-payment-scenarios). public type PaymentMethod record { - PaymentMethodAcssDebit? acss_debit?; - PaymentMethodAfterpayClearpay? afterpay_clearpay?; - PaymentFlowsPrivatePaymentMethodsAlipay? alipay?; - PaymentMethodAuBecsDebit? au_becs_debit?; - PaymentMethodBacsDebit? bacs_debit?; - PaymentMethodBancontact? bancontact?; - BillingDetails? billing_details; - PaymentMethodBoleto? boleto?; - PaymentMethodCard? card?; - PaymentMethodCardPresent? card_present?; + PaymentMethodAcssDebit acss_debit?; + PaymentMethodAfterpayClearpay afterpay_clearpay?; + PaymentFlowsPrivatePaymentMethodsAlipay alipay?; + PaymentMethodAuBecsDebit au_becs_debit?; + PaymentMethodBacsDebit bacs_debit?; + PaymentMethodBancontact bancontact?; + BillingDetails billing_details; + PaymentMethodBoleto boleto?; + PaymentMethodCard card?; + PaymentMethodCardPresent card_present?; # Time at which the object was created. Measured in seconds since the Unix epoch. - int? created; + int created; # The ID of the Customer to which this PaymentMethod is saved. This will not be set when the PaymentMethod has not been saved to a Customer. string|Customer? customer?; - PaymentMethodEps? eps?; - PaymentMethodFpx? fpx?; - PaymentMethodGiropay? giropay?; - PaymentMethodGrabpay? grabpay?; + PaymentMethodEps eps?; + PaymentMethodFpx fpx?; + PaymentMethodGiropay giropay?; + PaymentMethodGrabpay grabpay?; # Unique identifier for the object. - string? id; - PaymentMethodIdeal? ideal?; - PaymentMethodInteracPresent? interac_present?; + string id; + PaymentMethodIdeal ideal?; + PaymentMethodInteracPresent interac_present?; # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. - boolean? livemode; + boolean livemode; # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. record {} metadata?; # String representing the object's type. Objects of the same type share the same value. - string? 'object; - PaymentMethodOxxo? oxxo?; - PaymentMethodP24? p24?; - PaymentMethodSepaDebit? sepa_debit?; - PaymentMethodSofort? sofort?; + string 'object; + PaymentMethodOxxo oxxo?; + PaymentMethodP24 p24?; + PaymentMethodSepaDebit sepa_debit?; + PaymentMethodSofort sofort?; # The type of the PaymentMethod. An additional hash is included on the PaymentMethod with a name matching this value. It contains additional information specific to the PaymentMethod type. - string? 'type; - PaymentMethodWechatPay? wechat_pay?; + string 'type; + PaymentMethodWechatPay wechat_pay?; }; public type LegalEntityJapanAddress record { @@ -6504,41 +8129,41 @@ public type LegalEntityJapanAddress record { public type SubscriptionsSubscriptionExposedIdBody record { # A list of prices and quantities that will generate invoice items appended to the first invoice for this subscription. You may pass up to 20 items. - AddInvoiceItemEntry1[]? add_invoice_items?; + AddInvoiceItemEntry1[] add_invoice_items?; # A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the application owner's Stripe account. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions). - decimal? application_fee_percent?; + decimal application_fee_percent?; # Automatic tax settings for this subscription. - AutomaticTaxConfig1? automatic_tax?; + AutomaticTaxConfig1 automatic_tax?; # Either `now` or `unchanged`. Setting the value to `now` resets the subscription's billing cycle anchor to the current time. For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle). - string? billing_cycle_anchor?; + string billing_cycle_anchor?; # Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds. - record {int? amount_gte?; boolean? reset_billing_cycle_anchor?;}|string? billing_thresholds?; + record {int amount_gte?; boolean reset_billing_cycle_anchor?;}|string billing_thresholds?; # A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using `proration_behavior`. If set during a future period, this will always cause a proration for that period. - int|string? cancel_at?; + int|string cancel_at?; # Boolean indicating whether this subscription should cancel at the end of the current period. - boolean? cancel_at_period_end?; + boolean cancel_at_period_end?; # 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. When sending an invoice, Stripe will email your customer an invoice with payment instructions. Defaults to `charge_automatically`. - string? collection_method?; + string collection_method?; # The ID of the coupon to apply to this subscription. A coupon applied to a subscription will only affect invoices created for that particular subscription. - string? coupon?; + string coupon?; # Number of days a customer has to pay invoices generated by this subscription. Valid only for subscriptions where `collection_method` is set to `send_invoice`. - int? days_until_due?; + int days_until_due?; # ID of the default payment method for the subscription. It must belong to the customer associated with the subscription. This takes precedence over `default_source`. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://stripe.com/docs/api/customers/object#customer_object-default_source). - string? default_payment_method?; + string default_payment_method?; # ID of the default payment source for the subscription. It must belong to the customer associated with the subscription and be in a chargeable state. If `default_payment_method` is also set, `default_payment_method` will take precedence. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://stripe.com/docs/api/customers/object#customer_object-default_source). - string? default_source?; + string default_source?; # 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. Pass an empty string to remove previously-defined tax rates. - string[]|string? default_tax_rates?; + string[]|string default_tax_rates?; # Specifies which fields in the response should be expanded. - string[]? expand?; + string[] expand?; # A list of up to 20 subscription items, each with an attached price. - SubscriptionItemUpdateParams[]? items?; + SubscriptionItemUpdateParams[] items?; # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. - record {}|string? metadata?; + record {}|string metadata?; # Indicates if a customer is on or off-session while an invoice payment is attempted. - boolean? off_session?; + boolean off_session?; # If specified, payment collection for this subscription will be paused. - record {string? behavior; int? resumes_at?;}|string? pause_collection?; + record {string behavior; int resumes_at?;}|string pause_collection?; # 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. For example, SCA regulation may require 3DS authentication to complete payment. See the [SCA Migration Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior. # # Use `default_incomplete` to transition the subscription to `status=past_due` when payment is required and await explicit confirmation of the invoice's payment intent. This allows simpler management of scenarios where additional user actions are needed to pay a subscription’s invoice. Such as failed payments, [SCA regulation](https://stripe.com/docs/billing/migration/strong-customer-authentication), or collecting a mandate for a bank debit payment method. @@ -6546,27 +8171,27 @@ public type SubscriptionsSubscriptionExposedIdBody record { # Use `pending_if_incomplete` to update the subscription using [pending updates](https://stripe.com/docs/billing/subscriptions/pending-updates). When you use `pending_if_incomplete` you can only pass the parameters [supported by pending updates](https://stripe.com/docs/billing/pending-updates-reference#supported-attributes). # # Use `error_if_incomplete` if you want Stripe to return an HTTP 402 status code if a subscription's invoice cannot be paid. For example, if a payment method requires 3DS authentication due to SCA regulation and further user action is needed, this parameter does not update the subscription and returns an error instead. This was the default behavior for API versions prior to 2019-03-14. See the [changelog](https://stripe.com/docs/upgrades#2019-03-14) to learn more. - string? payment_behavior?; + string payment_behavior?; # Payment settings to pass to invoices created by the subscription. - PaymentSettings2? payment_settings?; + PaymentSettings2 payment_settings?; # Specifies an interval for how often to bill for any pending invoice items. It is analogous to calling [Create an invoice](https://stripe.com/docs/api#create_invoice) for the given subscription at the specified interval. - record {string? interval; int? interval_count?;}|string? pending_invoice_item_interval?; + record {string interval; int interval_count?;}|string pending_invoice_item_interval?; # The promotion code to apply to this subscription. A promotion code applied to a subscription will only affect invoices created for that particular subscription. - string? promotion_code?; + string promotion_code?; # Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#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. Valid values are `create_prorations`, `none`, or `always_invoice`. # # Passing `create_prorations` will cause proration invoice items to be created when applicable. These proration items will only be invoiced immediately under [certain conditions](https://stripe.com/docs/subscriptions/upgrading-downgrading#immediate-payment). In order to always invoice immediately for prorations, pass `always_invoice`. # # Prorations can be disabled by passing `none`. - string? proration_behavior?; + string proration_behavior?; # If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply exactly the same proration that was previewed with [upcoming invoice](https://stripe.com/docs/api#retrieve_customer_invoice) endpoint. 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. - int? proration_date?; + int proration_date?; # If specified, the funds from the subscription's invoices will be transferred to the destination and the ID of the resulting transfers will be found on the resulting charges. This will be unset if you POST an empty value. - record {decimal? amount_percent?; string? destination;}|string? transfer_data?; + record {decimal amount_percent?; string destination;}|string transfer_data?; # Unix timestamp representing the end of the trial period the customer will get before being charged for the first time. This will always overwrite any trials that might apply via a subscribed plan. If set, trial_end will override the default trial period of the plan the customer is being subscribed to. The special value `now` can be provided to end the customer's trial immediately. Can be at most two years from `billing_cycle_anchor`. - string|int? trial_end?; + string|int trial_end?; # Indicates if a plan's `trial_period_days` should be applied to the subscription. Setting `trial_end` per subscription is preferred, and this defaults to `false`. Setting this flag to `true` together with `trial_end` is not allowed. - boolean? trial_from_plan?; + boolean trial_from_plan?; }; public type RadarReviewResourceLocation record { @@ -6583,48 +8208,55 @@ public type RadarReviewResourceLocation record { }; public type PaymentMethodDetails record { - PaymentMethodDetailsAchCreditTransfer? ach_credit_transfer?; - PaymentMethodDetailsAchDebit? ach_debit?; - PaymentMethodDetailsAcssDebit? acss_debit?; - PaymentMethodDetailsAfterpayClearpay? afterpay_clearpay?; - PaymentFlowsPrivatePaymentMethodsAlipayDetails? alipay?; - PaymentMethodDetailsAuBecsDebit? au_becs_debit?; - PaymentMethodDetailsBacsDebit? bacs_debit?; - PaymentMethodDetailsBancontact? bancontact?; - PaymentMethodDetailsBoleto? boleto?; - PaymentMethodDetailsCard? card?; - PaymentMethodDetailsCardPresent? card_present?; - PaymentMethodDetailsEps? eps?; - PaymentMethodDetailsFpx? fpx?; - PaymentMethodDetailsGiropay? giropay?; - PaymentMethodDetailsGrabpay? grabpay?; - PaymentMethodDetailsIdeal? ideal?; - PaymentMethodDetailsInteracPresent? interac_present?; - PaymentMethodDetailsKlarna? klarna?; - PaymentMethodDetailsMultibanco? multibanco?; - PaymentMethodDetailsOxxo? oxxo?; - PaymentMethodDetailsP24? p24?; - PaymentMethodDetailsSepaDebit? sepa_debit?; - PaymentMethodDetailsSofort? sofort?; - PaymentMethodDetailsStripeAccount? stripe_account?; + PaymentMethodDetailsAchCreditTransfer ach_credit_transfer?; + PaymentMethodDetailsAchDebit ach_debit?; + PaymentMethodDetailsAcssDebit acss_debit?; + PaymentMethodDetailsAfterpayClearpay afterpay_clearpay?; + PaymentFlowsPrivatePaymentMethodsAlipayDetails alipay?; + PaymentMethodDetailsAuBecsDebit au_becs_debit?; + PaymentMethodDetailsBacsDebit bacs_debit?; + PaymentMethodDetailsBancontact bancontact?; + PaymentMethodDetailsBoleto boleto?; + PaymentMethodDetailsCard card?; + PaymentMethodDetailsCardPresent card_present?; + PaymentMethodDetailsEps eps?; + PaymentMethodDetailsFpx fpx?; + PaymentMethodDetailsGiropay giropay?; + PaymentMethodDetailsGrabpay grabpay?; + PaymentMethodDetailsIdeal ideal?; + PaymentMethodDetailsInteracPresent interac_present?; + PaymentMethodDetailsKlarna klarna?; + PaymentMethodDetailsMultibanco multibanco?; + PaymentMethodDetailsOxxo oxxo?; + PaymentMethodDetailsP24 p24?; + PaymentMethodDetailsSepaDebit sepa_debit?; + PaymentMethodDetailsSofort sofort?; + PaymentMethodDetailsStripeAccount stripe_account?; # The type of transaction-specific details of the payment method used in the payment, one of `ach_credit_transfer`, `ach_debit`, `acss_debit`, `alipay`, `au_becs_debit`, `bancontact`, `card`, `card_present`, `eps`, `giropay`, `ideal`, `klarna`, `multibanco`, `p24`, `sepa_debit`, `sofort`, `stripe_account`, or `wechat`. # An additional hash is included on `payment_method_details` with a name matching this value. # It contains information specific to the payment method. - string? 'type; - PaymentMethodDetailsWechat? wechat?; - PaymentMethodDetailsWechatPay? wechat_pay?; + string 'type; + PaymentMethodDetailsWechat wechat?; + PaymentMethodDetailsWechatPay wechat_pay?; }; public type AccountController record { # `true` if the Connect application retrieving the resource controls the account and can therefore exercise [platform controls](https://stripe.com/docs/connect/platform-controls-for-standard-accounts). Otherwise, this field is null. - boolean? is_controller?; + boolean is_controller?; # The controller type. Can be `application`, if a Connect application controls the account, or `account`, if the account controls itself. - string? 'type?; + string 'type?; +}; + +public type GelatoIdNumberReportError record { + # A short machine-readable string giving the reason for the verification failure. + string? code?; + # A human-readable message giving the reason for the failure. These messages can be shown to your users. + string? reason?; }; public type QuotesResourceAutomaticTax record { # Automatically calculate taxes - boolean? enabled; + boolean enabled; # The status of the most recent automated tax calculation for this quote. string? status?; }; @@ -6635,34 +8267,43 @@ public type QuotesResourceAutomaticTax record { # Related guide: [Metered Billing](https://stripe.com/docs/billing/subscriptions/metered-billing). public type UsageRecord record { # Unique identifier for the object. - string? id; + string id; # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. - boolean? livemode; + boolean livemode; # String representing the object's type. Objects of the same type share the same value. - string? 'object; + string 'object; # The usage quantity for the specified date. - int? quantity; + int quantity; # The ID of the subscription item this usage record contains data for. - string? subscription_item; + string subscription_item; # The timestamp when this usage occurred. - int? timestamp; + int timestamp; }; # A list of refunds that have been applied to the fee. public type FeeRefundList record { # Details about each object. - FeeRefund[]? data; + FeeRefund[] data; # True if this list has another page of items after this one that can be fetched. - boolean? has_more; + boolean has_more; # String representing the object's type. Objects of the same type share the same value. Always has the value `list`. - string? 'object; + string 'object; # The URL where this list can be accessed. - string? url; + string url; }; public type InvoicePaymentMethodOptionsBancontact record { # Preferred language of the Bancontact authorization page that the customer is redirected to. - string? preferred_language; + string preferred_language; +}; + +public type PaymentPagesCheckoutSessionCustomerDetails record { + # The customer’s email at time of checkout. + string? email?; + # The customer’s tax exempt status at time of checkout. + string? tax_exempt?; + # The customer’s tax IDs at time of checkout. + PaymentPagesCheckoutSessionTaxId[]? tax_ids?; }; # `Source` objects allow you to accept a variety of payment methods. They @@ -6672,58 +8313,58 @@ public type InvoicePaymentMethodOptionsBancontact record { # # Related guides: [Sources API](https://stripe.com/docs/sources) and [Sources & Customers](https://stripe.com/docs/sources/customers). public type Source record { - SourceTypeAchCreditTransfer? ach_credit_transfer?; - SourceTypeAchDebit? ach_debit?; - SourceTypeAcssDebit? acss_debit?; - SourceTypeAlipay? alipay?; + SourceTypeAchCreditTransfer ach_credit_transfer?; + SourceTypeAchDebit ach_debit?; + SourceTypeAcssDebit acss_debit?; + SourceTypeAlipay alipay?; # A positive integer in the smallest currency unit (that is, 100 cents for $1.00, or 1 for ¥1, Japanese Yen being a zero-decimal currency) representing the total amount associated with the source. This is the amount for which the source will be chargeable once ready. Required for `single_use` sources. int? amount?; - SourceTypeAuBecsDebit? au_becs_debit?; - SourceTypeBancontact? bancontact?; - SourceTypeCard? card?; - SourceTypeCardPresent? card_present?; + SourceTypeAuBecsDebit au_becs_debit?; + SourceTypeBancontact bancontact?; + SourceTypeCard card?; + SourceTypeCardPresent card_present?; # The client secret of the source. Used for client-side retrieval using a publishable key. - string? client_secret; - SourceCodeVerificationFlow? code_verification?; + string client_secret; + SourceCodeVerificationFlow code_verification?; # Time at which the object was created. Measured in seconds since the Unix epoch. - int? created; + int created; # Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) associated with the source. This is the currency for which the source will be chargeable once ready. Required for `single_use` sources. string? currency?; # The ID of the customer to which this source is attached. This will not be present when the source has not been attached to a customer. - string? customer?; - SourceTypeEps? eps?; + string customer?; + SourceTypeEps eps?; # The authentication `flow` of the source. `flow` is one of `redirect`, `receiver`, `code_verification`, `none`. - string? flow; - SourceTypeGiropay? giropay?; + string flow; + SourceTypeGiropay giropay?; # Unique identifier for the object. - string? id; - SourceTypeIdeal? ideal?; - SourceTypeKlarna? klarna?; + string id; + SourceTypeIdeal ideal?; + SourceTypeKlarna klarna?; # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. - boolean? livemode; + boolean livemode; # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. record {} metadata?; - SourceTypeMultibanco? multibanco?; + SourceTypeMultibanco multibanco?; # String representing the object's type. Objects of the same type share the same value. - string? 'object; + string 'object; # Information about the owner of the payment instrument that may be used or required by particular source types. SourceOwner? owner?; - SourceTypeP24? p24?; - SourceReceiverFlow? receiver?; - SourceRedirectFlow? redirect?; - SourceTypeSepaDebit? sepa_debit?; - SourceTypeSofort? sofort?; - SourceOrder? source_order?; + SourceTypeP24 p24?; + SourceReceiverFlow receiver?; + SourceRedirectFlow redirect?; + SourceTypeSepaDebit sepa_debit?; + SourceTypeSofort sofort?; + SourceOrder source_order?; # Extra information about a source. This will appear on your customer's statement every time you charge the source. string? statement_descriptor?; # The status of the source, one of `canceled`, `chargeable`, `consumed`, `failed`, or `pending`. Only `chargeable` sources can be used to create a charge. - string? status; - SourceTypeThreeDSecure? three_d_secure?; + string status; + SourceTypeThreeDSecure three_d_secure?; # The `type` of the source. The `type` is a payment method, one of `ach_credit_transfer`, `ach_debit`, `alipay`, `bancontact`, `card`, `card_present`, `eps`, `giropay`, `ideal`, `multibanco`, `klarna`, `p24`, `sepa_debit`, `sofort`, `three_d_secure`, or `wechat`. An additional hash is included on the source with a name matching this value. It contains additional information specific to the [payment method](https://stripe.com/docs/sources) used. - string? 'type; + string 'type; # Either `reusable` or `single_use`. Whether this source should be reusable or not. Some source types may or may not be reusable by construction, while others may leave the option at creation. If an incompatible value is passed, an error will be returned. string? usage?; - SourceTypeWechat? wechat?; + SourceTypeWechat wechat?; }; public type SubscriptionsResourcePaymentMethodOptions record { @@ -6743,32 +8384,32 @@ public type InvoiceSettingCustomerSetting record { }; public type PaymentIntentNextAction record { - PaymentIntentNextActionAlipayHandleRedirect? alipay_handle_redirect?; - PaymentIntentNextActionBoleto? boleto_display_details?; - PaymentIntentNextActionDisplayOxxoDetails? oxxo_display_details?; - PaymentIntentNextActionRedirectToUrl? redirect_to_url?; + PaymentIntentNextActionAlipayHandleRedirect alipay_handle_redirect?; + PaymentIntentNextActionBoleto boleto_display_details?; + PaymentIntentNextActionDisplayOxxoDetails oxxo_display_details?; + PaymentIntentNextActionRedirectToUrl redirect_to_url?; # Type of the next action to perform, one of `redirect_to_url`, `use_stripe_sdk`, `alipay_handle_redirect`, or `oxxo_display_details`. - string? 'type; + string 'type; # When confirming a PaymentIntent with Stripe.js, Stripe.js depends on the contents of this dictionary to invoke authentication flows. The shape of the contents is subject to change and is only intended to be used by Stripe.js. record {} use_stripe_sdk?; - PaymentIntentNextActionVerifyWithMicrodeposits? verify_with_microdeposits?; - PaymentIntentNextActionWechatPayDisplayQrCode? wechat_pay_display_qr_code?; - PaymentIntentNextActionWechatPayRedirectToAndroidApp? wechat_pay_redirect_to_android_app?; - PaymentIntentNextActionWechatPayRedirectToIosApp? wechat_pay_redirect_to_ios_app?; + PaymentIntentNextActionVerifyWithMicrodeposits verify_with_microdeposits?; + PaymentIntentNextActionWechatPayDisplayQrCode wechat_pay_display_qr_code?; + PaymentIntentNextActionWechatPayRedirectToAndroidApp wechat_pay_redirect_to_android_app?; + PaymentIntentNextActionWechatPayRedirectToIosApp wechat_pay_redirect_to_ios_app?; }; -public type SubscriptionTrialEnd string|int?; +public type SubscriptionTrialEnd string|int; public type MandateSingleUse record { # On a single use mandate, the amount of the payment. - int? amount; + int amount; # On a single use mandate, the currency of the payment. - string? currency; + string currency; }; public type PaymentIntentNextActionWechatPayRedirectToIosApp record { # An universal link that redirect to Wechat Pay APP - string? native_url; + string native_url; }; public type SourceTypeAchDebit record { @@ -6780,18 +8421,18 @@ public type SourceTypeAchDebit record { string? 'type?; }; -public type SubscriptionBillingCycleAnchor1 string|int?; +public type SubscriptionBillingCycleAnchor1 string|int; # [Tax codes](https://stripe.com/docs/tax/tax-codes) classify goods and services for tax purposes. public type TaxCode record { # A detailed description of which types of products the tax code represents. - string? description; + string description; # Unique identifier for the object. - string? id; + string id; # A short name for the tax code. - string? name; + string name; # String representing the object's type. Objects of the same type share the same value. - string? 'object; + string 'object; }; # A `Payout` object is created when you receive funds from Stripe, or when you @@ -6804,17 +8445,17 @@ public type TaxCode record { # Related guide: [Receiving Payouts](https://stripe.com/docs/payouts). public type Payout record { # Amount (in %s) to be transferred to your bank account or debit card. - int? amount; + int amount; # Date the payout is expected to arrive in the bank. This factors in delays like weekends or bank holidays. - int? arrival_date; + int arrival_date; # Returns `true` if the payout was created by an [automated payout schedule](https://stripe.com/docs/payouts#payout-schedule), and `false` if it was [requested manually](https://stripe.com/docs/payouts#manual-payouts). - boolean? automatic; + boolean automatic; # ID of the balance transaction that describes the impact of this payout on your account balance. string|BalanceTransaction? balance_transaction?; # Time at which the object was created. Measured in seconds since the Unix epoch. - int? created; + int created; # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). - string? currency; + string currency; # An arbitrary string attached to the object. Often useful for displaying to users. string? description?; # ID of the bank account or card the payout was sent to. @@ -6826,114 +8467,182 @@ public type Payout record { # Message to user further explaining reason for payout failure if available. string? failure_message?; # Unique identifier for the object. - string? id; + string id; # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. - boolean? livemode; + boolean livemode; # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. record {} metadata?; # The method used to send this payout, which can be `standard` or `instant`. `instant` is only supported for payouts to debit cards. (See [Instant payouts for marketplaces](https://stripe.com/blog/instant-payouts-for-marketplaces) for more information.) - string? method; + string method; # String representing the object's type. Objects of the same type share the same value. - string? 'object; + string 'object; # If the payout reverses another, this is the ID of the original payout. string|Payout? original_payout?; # If the payout was reversed, this is the ID of the payout that reverses this payout. string|Payout? reversed_by?; # The source balance this payout came from. One of `card`, `fpx`, or `bank_account`. - string? source_type; + string source_type; # Extra information about a payout to be displayed on the user's bank statement. string? statement_descriptor?; # Current status of the payout: `paid`, `pending`, `in_transit`, `canceled` or `failed`. A payout is `pending` until it is submitted to the bank, when it becomes `in_transit`. The status then changes to `paid` if the transaction goes through, or to `failed` or `canceled` (within 5 business days). Some failed payouts may initially show as `paid` but then change to `failed`. - string? status; + string status; # Can be `bank_account` or `card`. - string? 'type; + string 'type; }; public type IssuingAuthorizationRequest record { # The `pending_request.amount` at the time of the request, presented in your card's currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). Stripe held this amount from your account to fund the authorization if the request was approved. - int? amount; + int amount; # Detailed breakdown of amount components. These amounts are denominated in `currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). IssuingAuthorizationAmountDetails? amount_details?; # Whether this request was approved. - boolean? approved; + boolean approved; # Time at which the object was created. Measured in seconds since the Unix epoch. - int? created; + int created; # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). - string? currency; + string currency; # The `pending_request.merchant_amount` at the time of the request, presented in the `merchant_currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). - int? merchant_amount; + int merchant_amount; # The currency that was collected by the merchant and presented to the cardholder for the authorization. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). - string? merchant_currency; + string merchant_currency; # The reason for the approval or decline. - string? reason; + string reason; +}; + +public type SourceTransactionGbpCreditTransferData record { + # Bank account fingerprint associated with the Stripe owned bank account receiving the transfer. + string fingerprint?; + # The credit transfer rails the sender used to push this transfer. The possible rails are: Faster Payments, BACS, CHAPS, and wire transfers. Currently only Faster Payments is supported. + string funding_method?; + # Last 4 digits of sender account number associated with the transfer. + string last4?; + # Sender entered arbitrary information about the transfer. + string reference?; + # Sender account number associated with the transfer. + string sender_account_number?; + # Sender name associated with the transfer. + string sender_name?; + # Sender sort code associated with the transfer. + string sender_sort_code?; +}; + +public type ApplePayDomain record { + # Time at which the object was created. Measured in seconds since the Unix epoch. + int created; + string domain_name; + # Unique identifier for the object. + string id; + # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. + boolean livemode; + # String representing the object's type. Objects of the same type share the same value. + string 'object; +}; + +public type VerificationSessionRedaction record { + # Indicates whether this object and its related objects have been redacted or not. + string status; }; public type CardDetailsParams record { - string? cvc?; - int? exp_month; - int? exp_year; - string? number; + string cvc?; + int exp_month; + int exp_year; + string number; +}; + +public type GelatoSelfieReportError record { + # A short machine-readable string giving the reason for the verification failure. + string? code?; + # A human-readable message giving the reason for the failure. These messages can be shown to your users. + string? reason?; }; # Charges that were created by this PaymentIntent, if any. public type PaymentFlowsPaymentIntentResourceChargeList record { # This list only contains the latest charge, even if there were previously multiple unsuccessful charges. To view all previous charges for a PaymentIntent, you can filter the charges list using the `payment_intent` [parameter](https://stripe.com/docs/api/charges/list#list_charges-payment_intent). - Charge[]? data; + Charge[] data; # True if this list has another page of items after this one that can be fetched. - boolean? has_more; + boolean has_more; # String representing the object's type. Objects of the same type share the same value. Always has the value `list`. - string? 'object; + string 'object; # The URL where this list can be accessed. - string? url; + string url; +}; + +# Result from a selfie check +public type GelatoSelfieReport record { + # ID of the [File](https://stripe.com/docs/api/files) holding the image of the identity document used in this check. + string? document?; + # Details on the verification error. Present when status is `unverified`. + GelatoSelfieReportError? _error?; + # ID of the [File](https://stripe.com/docs/api/files) holding the image of the selfie used in this check. + string? selfie?; + # Status of this `selfie` check. + string status; +}; + +public type BalanceAmount record { + # Balance amount. + int amount; + # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + string currency; + BalanceAmountBySourceType source_types?; }; public type InvoiceLineItemPeriod record { # End of the line item's billing period - int? end; + int end; # Start of the line item's billing period - int? 'start; + int 'start; }; public type LineItem record { # The amount, in %s. - int? amount; + int amount; # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). - string? currency; + string currency; # An arbitrary string attached to the object. Often useful for displaying to users. string? description?; # The amount of discount calculated per discount for this line item. DiscountsResourceDiscountAmount[]? discount_amounts?; # If true, discounts will apply to this line item. Always false for prorations. - boolean? discountable; + boolean discountable; # The discounts applied to the invoice line item. Line item discounts are applied before invoice discounts. Use `expand[]=discounts` to expand each discount. - (string|Discount?)[]? discounts?; + (string|Discount)[]? discounts?; # Unique identifier for the object. - string? id; + string id; # The ID of the [invoice item](https://stripe.com/docs/api/invoiceitems) associated with this line item if any. - string? invoice_item?; + string invoice_item?; # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. - boolean? livemode; + boolean livemode; # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Note that for line items with `type=subscription` this will reflect the metadata of the subscription that caused the line item to be created. record {} metadata; # String representing the object's type. Objects of the same type share the same value. - string? 'object; - InvoiceLineItemPeriod? period; + string 'object; + InvoiceLineItemPeriod period; # The price of the line item. Price? price?; # Whether this is a proration. - boolean? proration; + boolean proration; # The quantity of the subscription, if the line item is a subscription or a proration. int? quantity?; # The subscription that the invoice item pertains to, if any. string? subscription?; # The subscription item that generated this invoice item. Left empty if the line item is not an explicit result of a subscription. - string? subscription_item?; + string subscription_item?; # The amount of tax calculated per tax rate for this line item - InvoiceTaxAmount[]? tax_amounts?; + InvoiceTaxAmount[] tax_amounts?; # The tax rates which apply to the line item. - TaxRate[]? tax_rates?; + TaxRate[] tax_rates?; # A string identifying the type of the source of this line item, either an `invoiceitem` or a `subscription`. - string? 'type; + string 'type; +}; + +public type NotificationEventData record { + # Object containing the API resource relevant to the event. For example, an `invoice.created` event will have a full [invoice object](https://stripe.com/docs/api#invoice_object) as the value of the object key. + record {} 'object; + # Object containing the names of the attributes that have changed, and their previous values (sent along only with *.updated events). + record {} previous_attributes?; }; # A return represents the full or partial return of a number of [order items](https://stripe.com/docs/api#order_items). @@ -6942,35 +8651,44 @@ public type LineItem record { # Related guide: [Handling Returns](https://stripe.com/docs/orders/guide#handling-returns). public type OrderReturn record { # A positive integer in the smallest currency unit (that is, 100 cents for $1.00, or 1 for ¥1, Japanese Yen being a zero-decimal currency) representing the total amount for the returned line item. - int? amount; + int amount; # Time at which the object was created. Measured in seconds since the Unix epoch. - int? created; + int created; # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). - string? currency; + string currency; # Unique identifier for the object. - string? id; + string id; # The items included in this order return. - OrderItem[]? items; + OrderItem[] items; # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. - boolean? livemode; + boolean livemode; # String representing the object's type. Objects of the same type share the same value. - string? 'object; + string 'object; # The order that this return includes items from. string|Order? 'order?; # The ID of the refund issued for this return. string|Refund? refund?; }; +public type DeletedRadarValueListItem record { + # Always true for a deleted object + boolean deleted; + # Unique identifier for the object. + string id; + # String representing the object's type. Objects of the same type share the same value. + string 'object; +}; + public type IssuingCardShipping record { - Address? address; + Address address; # The delivery company that shipped a card. string? carrier?; # A unix timestamp representing a best estimate of when the card will be delivered. int? eta?; # Recipient name. - string? name; + string name; # Shipment service, such as `standard` or `express`. - string? 'service; + string 'service; # The delivery status of the card. string? status?; # A tracking number for a card shipment. @@ -6978,38 +8696,51 @@ public type IssuingCardShipping record { # A link to the shipping carrier's site where you can view detailed information about a card shipment. string? tracking_url?; # Packaging options. - string? 'type; + string 'type; }; public type PaymentMethodDetailsFpx record { # The customer's bank. Can be one of `affin_bank`, `alliance_bank`, `ambank`, `bank_islam`, `bank_muamalat`, `bank_rakyat`, `bsn`, `cimb`, `hong_leong_bank`, `hsbc`, `kfh`, `maybank2u`, `ocbc`, `public_bank`, `rhb`, `standard_chartered`, `uob`, `deutsche_bank`, `maybank2e`, or `pb_enterprise`. - string? bank; + string bank; # Unique transaction id generated by FPX for every request from the merchant string? transaction_id?; }; +public type PlanTier record { + # Price for the entire tier. + int? flat_amount?; + # Same as `flat_amount`, but contains a decimal value with at most 12 decimal places. + string? flat_amount_decimal?; + # Per unit price for units relevant to the tier. + int? unit_amount?; + # Same as `unit_amount`, but contains a decimal value with at most 12 decimal places. + string? unit_amount_decimal?; + # Up to and including to this quantity will be contained in the tier. + int? up_to?; +}; + public type PricesPriceBody record { # Whether the price can be used for new purchases. Defaults to `true`. - boolean? active?; + boolean active?; # Specifies which fields in the response should be expanded. - string[]? expand?; + string[] expand?; # A lookup key used to retrieve prices dynamically from a static string. - string? lookup_key?; + string lookup_key?; # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. - AdditionalProperties|string? metadata?; + AdditionalProperties|string metadata?; # A brief description of the price, hidden from customers. - string? nickname?; + string nickname?; # 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. - string? tax_behavior?; + string tax_behavior?; # If set to true, will atomically remove the lookup key from the existing price, and assign it to this price. - boolean? transfer_lookup_key?; + boolean transfer_lookup_key?; }; public type AddInvoiceItemEntry1 record { - string? price?; - OneTimePriceData? price_data?; - int? quantity?; - string[]|string? tax_rates?; + string price?; + OneTimePriceData price_data?; + int quantity?; + string[]|string tax_rates?; }; public type IssuingAuthorizationAmountDetails record { @@ -7018,23 +8749,23 @@ public type IssuingAuthorizationAmountDetails record { }; public type MandatePaymentMethodDetails record { - MandateAcssDebit? acss_debit?; - MandateAuBecsDebit? au_becs_debit?; - MandateBacsDebit? bacs_debit?; - CardMandatePaymentMethodDetails? card?; - MandateSepaDebit? sepa_debit?; + MandateAcssDebit acss_debit?; + MandateAuBecsDebit au_becs_debit?; + MandateBacsDebit bacs_debit?; + CardMandatePaymentMethodDetails card?; + MandateSepaDebit sepa_debit?; # The type of the payment method associated with this mandate. An additional hash is included on `payment_method_details` with a name matching this value. It contains mandate information specific to the payment method. - string? 'type; + string 'type; }; public type PaymentMethodOptionsBoleto record { # The number of calendar days before a Boleto voucher expires. For example, if you create a Boleto voucher on Monday and you set expires_after_days to 2, the Boleto voucher will expire on Wednesday at 23:59 America/Sao_Paulo time. - int? expires_after_days; + int expires_after_days; }; public type DiscountsDataParam1 record { - string? coupon?; - string? discount?; + string coupon?; + string discount?; }; public type SourceTypeGiropay record { @@ -7046,6 +8777,6 @@ public type SourceTypeGiropay record { # Apply a transformation to the reported usage or set quantity before computing the billed price. Cannot be combined with `tiers`. public type TransformUsageParam record { - int? divide_by; - string? round; + int divide_by; + string round; }; From 550e0d618f2d8ce3226d6ae359c41b37c1cf5582 Mon Sep 17 00:00:00 2001 From: ayeshLK Date: Fri, 17 Nov 2023 15:14:13 +0530 Subject: [PATCH 3/6] Generate the client with nullable flag --- openapi/stripe/client.bal | 16 - openapi/stripe/types.bal | 4338 ++++++++++++++++++------------------- openapi/stripe/utils.bal | 16 - 3 files changed, 2161 insertions(+), 2209 deletions(-) diff --git a/openapi/stripe/client.bal b/openapi/stripe/client.bal index 58ae87360..3b0fa5aaf 100644 --- a/openapi/stripe/client.bal +++ b/openapi/stripe/client.bal @@ -1,19 +1,3 @@ -// Copyright (c) 2021 WSO2 Inc. (http://www.wso2.org) All Rights Reserved. -// -// WSO2 Inc. licenses this file to you under the Apache License, -// Version 2.0 (the "License"); you may not use this file except -// in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, -// software distributed under the License is distributed on an -// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -// KIND, either express or implied. See the License for the -// specific language governing permissions and limitations -// under the License. - import ballerina/http; # Provides a set of configurations for controlling the behaviours when communicating with a remote HTTP endpoint. diff --git a/openapi/stripe/types.bal b/openapi/stripe/types.bal index c5e5d754d..6bf768aea 100644 --- a/openapi/stripe/types.bal +++ b/openapi/stripe/types.bal @@ -1,19 +1,3 @@ -// Copyright (c) 2021 WSO2 Inc. (http://www.wso2.org) All Rights Reserved. -// -// WSO2 Inc. licenses this file to you under the Apache License, -// Version 2.0 (the "License"); you may not use this file except -// in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, -// software distributed under the License is distributed on an -// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -// KIND, either express or implied. See the License for the -// specific language governing permissions and limitations -// under the License. - public type NotificationEventRequest record { # ID of the API request that caused the event. If null, the event was automatic (e.g., Stripe's automatic subscription handling). Request logs are available in the [dashboard](https://dashboard.stripe.com/logs), but currently not in the API. string? id?; @@ -46,9 +30,9 @@ public type Customer record { # The customer's address. Address? address?; # Current balance, if any, being stored on the customer. If negative, the customer has credit to apply to their next invoice. If positive, the customer has an amount owed that will be added to their next invoice. The balance does not refer to any unpaid invoices; it solely takes into account amounts that have yet to be successfully applied to any invoice. This balance is only taken into account as invoices are finalized. - int balance?; + int? balance?; # Time at which the object was created. Measured in seconds since the Unix epoch. - int created; + int? created; # Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) the customer can be charged in for recurring billing purposes. string? currency?; # ID of the default payment source for the customer. @@ -66,20 +50,20 @@ public type Customer record { # The customer's email address. string? email?; # Unique identifier for the object. - string id; + string? id; # The prefix for the customer used to generate unique invoice numbers. string? invoice_prefix?; - InvoiceSettingCustomerSetting invoice_settings?; + InvoiceSettingCustomerSetting? invoice_settings?; # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. - boolean livemode; + boolean? livemode; # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. record {} metadata?; # The customer's full name or business name. string? name?; # The suffix of the customer's next invoice number, e.g., 0001. - int next_invoice_sequence?; + int? next_invoice_sequence?; # String representing the object's type. Objects of the same type share the same value. - string 'object; + string? 'object; # The customer's phone number. string? phone?; # The customer's preferred locales (languages), ordered by preference. @@ -87,14 +71,14 @@ public type Customer record { # Mailing and shipping address for the customer. Appears on invoices emailed to this customer. Shipping? shipping?; # The customer's payment sources, if any. - ApmsSourcesSourceList sources?; + ApmsSourcesSourceList? sources?; # The customer's current subscriptions, if any. - SubscriptionList subscriptions?; - CustomerTax tax?; + SubscriptionList? subscriptions?; + CustomerTax? tax?; # 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"**. string? tax_exempt?; # The customer's tax IDs. - TaxIDsList tax_ids?; + TaxIDsList? tax_ids?; }; public type IssuingCardholderVerification record { @@ -116,23 +100,23 @@ public type PaymentMethodDetailsMultibanco record { # Related guides: [Set up a subscription](https://stripe.com/docs/billing/subscriptions/set-up-subscription) or accept [one-time payments with Checkout](https://stripe.com/docs/payments/checkout/client#create-products) and more about [Products and Prices](https://stripe.com/docs/billing/prices-guide) public type Product record { # Whether the product is currently available for purchase. - boolean active; + boolean? active; # Time at which the object was created. Measured in seconds since the Unix epoch. - int created; + int? created; # 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. string? description?; # Unique identifier for the object. - string id; + string? id; # A list of up to 8 URLs of images for this product, meant to be displayable to the customer. - string[] images; + string[]? images; # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. - boolean livemode; + boolean? livemode; # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. record {} metadata; # The product's name, meant to be displayable to the customer. Whenever this product is sold via a subscription, name will show up on associated invoice line item descriptions. - string name; + string? name; # String representing the object's type. Objects of the same type share the same value. - string 'object; + string? 'object; # The dimensions of this product for shipping purposes. PackageDimensions? package_dimensions?; # Whether this product is shipped (i.e., physical goods). @@ -144,14 +128,14 @@ public type Product record { # 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. string? unit_label?; # Time at which the object was last updated. Measured in seconds since the Unix epoch. - int updated; + int? updated; # A URL of a publicly-accessible webpage for this product. string? url?; }; public type SubscriptionSchedulesResourceDefaultSettingsAutomaticTax record { # Whether Stripe automatically computes tax on invoices created during this phase. - boolean enabled; + boolean? enabled; }; # A VerificationSession guides you through the process of collecting and verifying the identities @@ -169,26 +153,26 @@ public type IdentityVerificationSession record { # The short-lived client secret used by Stripe.js to [show a verification modal](https://stripe.com/docs/js/identity/modal) inside your app. This client secret expires after 24 hours and can only be used once. Don’t store it, log it, embed it in a URL, or expose it to anyone other than the user. Make sure that you have TLS enabled on any page that includes the client secret. Refer to our docs on [passing the client secret to the frontend](https://stripe.com/docs/identity/verification-sessions#client-secret) to learn more. string? client_secret?; # Time at which the object was created. Measured in seconds since the Unix epoch. - int created; + int? created; # Unique identifier for the object. - string id; + string? id; # If present, this property tells you the last error encountered when processing the verification. GelatoSessionLastError? last_error?; # ID of the most recent VerificationReport. [Learn more about accessing detailed verification results.](https://stripe.com/docs/identity/verification-sessions#results) string|IdentityVerificationReport? last_verification_report?; # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. - boolean livemode; + boolean? livemode; # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. record {} metadata; # String representing the object's type. Objects of the same type share the same value. - string 'object; - GelatoVerificationSessionOptions options; + string? 'object; + GelatoVerificationSessionOptions? options; # Redaction status of this VerificationSession. If the VerificationSession is not redacted, this field will be null. VerificationSessionRedaction? redaction?; # Status of this VerificationSession. [Learn more about the lifecycle of sessions](https://stripe.com/docs/identity/how-sessions-work). - string status; + string? status; # The type of [verification check](https://stripe.com/docs/identity/verification-checks) to be performed. - string 'type; + string? 'type; # The short-lived URL that you use to redirect a user to Stripe to submit their identity information. This URL expires after 48 hours and can only be used once. Don’t store it, log it, send it in emails or expose it to anyone other than the user. Refer to our docs on [verifying identity documents](https://stripe.com/docs/identity/verify-identity-documents?platform=web&type=redirect) to learn how to redirect users to Stripe. string? url?; # The user’s verified data. @@ -196,32 +180,32 @@ public type IdentityVerificationSession record { }; public type SourceTypeKlarna record { - string background_image_url?; + string? background_image_url?; string? client_token?; - string first_name?; - string last_name?; - string locale?; - string logo_url?; - string page_title?; - string pay_later_asset_urls_descriptive?; - string pay_later_asset_urls_standard?; - string pay_later_name?; - string pay_later_redirect_url?; - string pay_now_asset_urls_descriptive?; - string pay_now_asset_urls_standard?; - string pay_now_name?; - string pay_now_redirect_url?; - string pay_over_time_asset_urls_descriptive?; - string pay_over_time_asset_urls_standard?; - string pay_over_time_name?; - string pay_over_time_redirect_url?; - string payment_method_categories?; - string purchase_country?; - string purchase_type?; - string redirect_url?; - int shipping_delay?; - string shipping_first_name?; - string shipping_last_name?; + string? first_name?; + string? last_name?; + string? locale?; + string? logo_url?; + string? page_title?; + string? pay_later_asset_urls_descriptive?; + string? pay_later_asset_urls_standard?; + string? pay_later_name?; + string? pay_later_redirect_url?; + string? pay_now_asset_urls_descriptive?; + string? pay_now_asset_urls_standard?; + string? pay_now_name?; + string? pay_now_redirect_url?; + string? pay_over_time_asset_urls_descriptive?; + string? pay_over_time_asset_urls_standard?; + string? pay_over_time_name?; + string? pay_over_time_redirect_url?; + string? payment_method_categories?; + string? purchase_country?; + string? purchase_type?; + string? redirect_url?; + int? shipping_delay?; + string? shipping_first_name?; + string? shipping_last_name?; }; public type PaymentMethodDetailsIdeal record { @@ -244,76 +228,76 @@ public type SourceReceiverFlow record { # The address of the receiver source. This is the value that should be communicated to the customer to send their funds to. string? address?; # The total amount that was moved to your balance. This is almost always equal to the amount charged. In rare cases when customers deposit excess funds and we are unable to refund those, those funds get moved to your balance and show up in amount_charged as well. The amount charged is expressed in the source's currency. - int amount_charged; + int? amount_charged; # The total amount received by the receiver source. `amount_received = amount_returned + amount_charged` should be true for consumed sources unless customers deposit excess funds. The amount received is expressed in the source's currency. - int amount_received; + int? amount_received; # The total amount that was returned to the customer. The amount returned is expressed in the source's currency. - int amount_returned; + int? amount_returned; # Type of refund attribute method, one of `email`, `manual`, or `none`. - string refund_attributes_method; + string? refund_attributes_method; # Type of refund attribute status, one of `missing`, `requested`, or `available`. - string refund_attributes_status; + string? refund_attributes_status; }; public type V1PricesBody record { # Whether the price can be used for new purchases. Defaults to `true`. - boolean active?; + boolean? active?; # Describes 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. - string billing_scheme?; + string? billing_scheme?; # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). - string currency; + string? currency; # Specifies which fields in the response should be expanded. - string[] expand?; + string[]? expand?; # A lookup key used to retrieve prices dynamically from a static string. - string lookup_key?; + string? lookup_key?; # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. record {} metadata?; # A brief description of the price, hidden from customers. - string nickname?; + string? nickname?; # The ID of the product that this price will belong to. - string product?; + string? product?; # These fields can be used to create a new product that this price will belong to. - InlineProductParams product_data?; + InlineProductParams? product_data?; # The recurring components of a price such as `interval` and `usage_type`. - Recurring1 recurring?; + Recurring1? recurring?; # 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. - string tax_behavior?; + string? tax_behavior?; # Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`. - Tier[] tiers?; + Tier[]? tiers?; # 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 successively change as the quantity grows. - string tiers_mode?; + string? tiers_mode?; # If set to true, will atomically remove the lookup key from the existing price, and assign it to this price. - boolean transfer_lookup_key?; + boolean? transfer_lookup_key?; # Apply a transformation to the reported usage or set quantity before computing the billed price. Cannot be combined with `tiers`. - TransformUsageParam transform_quantity?; + TransformUsageParam? transform_quantity?; # A positive integer in %s (or 0 for a free price) representing how much to charge. - int unit_amount?; + int? unit_amount?; # Same as `unit_amount`, but accepts a decimal value in %s with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set. - string unit_amount_decimal?; + string? unit_amount_decimal?; }; public type PaymentIntentNextActionWechatPayRedirectToAndroidApp record { # app_id is the APP ID registered on WeChat open platform - string app_id; + string? app_id; # nonce_str is a random string - string nonce_str; + string? nonce_str; # package is static value - string package; + string? package; # an unique merchant ID assigned by Wechat Pay - string partner_id; + string? partner_id; # an unique trading ID assigned by Wechat Pay - string prepay_id; + string? prepay_id; # A signature - string sign; + string? sign; # Specifies the current time in epoch format - string timestamp; + string? timestamp; }; # The Pause Collection settings determine how we will pause collection for this subscription and for how long the subscription # should be paused. public type SubscriptionsResourcePauseCollection record { # The payment collection behavior for this subscription while paused. One of `keep_as_draft`, `mark_uncollectible`, or `void`. - string behavior; + string? behavior; # The time after which the subscription will resume collecting payments. int? resumes_at?; }; @@ -344,20 +328,20 @@ public type AccountBusinessProfile record { string? url?; }; -public type TaxRateArray string[]; +public type TaxRateArray string[]?; -public type InvoiceSettingsCustomFields CustomFieldParams[]; +public type InvoiceSettingsCustomFields CustomFieldParams[]?; public type GetInvoicesUpcomingRequestBody record { - ItemBillingThresholdsParam|string billing_thresholds?; - boolean clear_usage?; - boolean deleted?; - string id?; - record {}|string metadata?; - string price?; - RecurringPriceData1 price_data?; - int quantity?; - string[]|string tax_rates?; + ItemBillingThresholdsParam|string? billing_thresholds?; + boolean? clear_usage?; + boolean? deleted?; + string? id?; + record {}|string? metadata?; + string? price?; + RecurringPriceData1? price_data?; + int? quantity?; + string[]|string? tax_rates?; }; public type InvoiceSettingSubscriptionScheduleSetting record { @@ -366,8 +350,8 @@ public type InvoiceSettingSubscriptionScheduleSetting record { }; public type GelatoVerificationReportOptions record { - GelatoReportDocumentOptions document?; - GelatoReportIdNumberOptions id_number?; + GelatoReportDocumentOptions? document?; + GelatoReportIdNumberOptions? id_number?; }; public type ThreeDSecureDetails record { @@ -383,66 +367,66 @@ public type ThreeDSecureDetails record { string? 'version?; }; -public type ExternalAccount BankAccount|Card; +public type ExternalAccount BankAccount|Card?; # These fields can be used to create a new product that this price will belong to. public type InlineProductParams record { # Whether the product is currently available for purchase. Defaults to true. - boolean active?; + boolean? active?; # The ID of the product that this price will belong to. - string id?; + string? id?; # 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata record {} metadata?; # The product’s name, meant to be displayable to the customer. Whenever this product is sold via a subscription, name will show up on associated invoice line item descriptions - string name; + string? name; # An arbitrary string to be displayed on your customer’s credit card or bank statement. While most banks display this information consistently, some may display it incorrectly or not at all - string statement_descriptor?; + string? statement_descriptor?; # A tax code ID - string tax_code?; + string? tax_code?; # 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 - string unit_label?; + string? unit_label?; }; public type AccountSepaDebitPaymentsSettings record { # SEPA creditor identifier that identifies the company making the payment. - string creditor_id?; + string? creditor_id?; }; public type ChargeTransferData record { # The amount transferred to the destination account, if specified. By default, the entire charge amount is transferred to the destination account. int? amount?; # ID of an existing, connected Stripe account to transfer funds to if `transfer_data` was specified in the charge request. - string|Account destination; + string|Account? destination; }; public type PaymentIntentNextActionVerifyWithMicrodeposits record { # The timestamp when the microdeposits are expected to land. - int arrival_date; + int? arrival_date; # The URL for the hosted verification page, which allows customers to verify their bank account. - string hosted_verification_url; + string? hosted_verification_url; }; public type BalanceAmountBySourceType record { # Amount for bank account. - int bank_account?; + int? bank_account?; # Amount for card. - int card?; + int? card?; # Amount for FPX. - int fpx?; + int? fpx?; }; public type SubscriptionScheduleCurrentPhase record { # The end of this phase of the subscription schedule. - int end_date; + int? end_date; # The start of this phase of the subscription schedule. - int start_date; + int? start_date; }; public type PaymentMethodAttachBody record { # The ID of the customer to which to attach the PaymentMethod. - string customer; + string? customer; # Specifies which fields in the response should be expanded. - string[] expand?; + string[]? expand?; }; public type PaymentMethodDetailsP24 record { @@ -462,14 +446,14 @@ public type AccountTosAcceptance record { # The IP address from which the account representative accepted their service agreement string? ip?; # The user's service agreement type - string service_agreement?; + string? service_agreement?; # The user agent of the browser from which the account representative accepted their service agreement string? user_agent?; }; public type AutomaticTax record { # Whether Stripe automatically computes tax on this invoice. - boolean enabled; + boolean? enabled; # The status of the most recent automated tax calculation for this invoice. string? status?; }; @@ -486,33 +470,33 @@ public type AutomaticTax record { # Related guide: [Creating Separate Charges and Transfers](https://stripe.com/docs/connect/charges-transfers). public type Transfer record { # Amount in %s to be transferred. - int amount; + int? amount; # Amount in %s reversed (can be less than the amount attribute on the transfer if a partial reversal was issued). - int amount_reversed; + int? amount_reversed; # Balance transaction that describes the impact of this transfer on your account balance. string|BalanceTransaction? balance_transaction?; # Time that this record of the transfer was first created. - int created; + int? created; # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). - string currency; + string? currency; # An arbitrary string attached to the object. Often useful for displaying to users. string? description?; # ID of the Stripe account the transfer was sent to. string|Account? destination?; # If the destination is a Stripe account, this will be the ID of the payment that the destination account received for the transfer. - string|Charge destination_payment?; + string|Charge? destination_payment?; # Unique identifier for the object. - string id; + string? id; # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. - boolean livemode; + boolean? livemode; # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. record {} metadata; # String representing the object's type. Objects of the same type share the same value. - string 'object; + string? 'object; # A list of reversals that have been applied to the transfer. - TransferReversalList reversals; + TransferReversalList? reversals; # Whether the transfer has been fully reversed. If the transfer is only partially reversed, this attribute will still be false. - boolean reversed; + boolean? reversed; # ID of the charge or payment that was used to fund the transfer. If null, the transfer was funded from the available balance. string|Charge? source_transaction?; # The source balance this transfer came from. One of `card`, `fpx`, or `bank_account`. @@ -543,31 +527,31 @@ public type SubscriptionSchedule record { # Time at which the subscription schedule was completed. Measured in seconds since the Unix epoch. int? completed_at?; # Time at which the object was created. Measured in seconds since the Unix epoch. - int created; + int? created; # Object representing the start and end dates for the current phase of the subscription schedule, if it is `active`. SubscriptionScheduleCurrentPhase? current_phase?; # ID of the customer who owns the subscription schedule. - string|Customer|DeletedCustomer customer; + string|Customer|DeletedCustomer? customer; # Object representing the subscription schedule’s default settings - SubscriptionSchedulesResourceDefaultSettings default_settings; + SubscriptionSchedulesResourceDefaultSettings? default_settings; # Behavior of the subscription schedule and underlying subscription when it ends. Possible values are `release` and `cancel`. - string end_behavior; + string? end_behavior; # Unique identifier for the object. - string id; + string? id; # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. - boolean livemode; + boolean? livemode; # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. record {} metadata?; # String representing the object's type. Objects of the same type share the same value. - string 'object; + string? 'object; # Configuration for the subscription schedule's phases. - SubscriptionSchedulePhaseConfiguration[] phases; + SubscriptionSchedulePhaseConfiguration[]? phases; # Time at which the subscription schedule was released. Measured in seconds since the Unix epoch. int? released_at?; # ID of the subscription once managed by the subscription schedule (if it is released). string? released_subscription?; # The present status of the subscription schedule. Possible values are `not_started`, `active`, `completed`, `released`, and `canceled`. You can read more about the different states in our [behavior guide](https://stripe.com/docs/billing/subscriptions/subscription-schedules). - string status; + string? status; # ID of the subscription managed by the subscription schedule. string|Subscription? subscription?; }; @@ -587,11 +571,11 @@ public type DeletedBankAccount record { # Three-letter [ISO code for the currency](https://stripe.com/docs/payouts) paid out to the bank account. string? currency?; # Always true for a deleted object - boolean deleted; + boolean? deleted; # Unique identifier for the object. - string id; + string? id; # String representing the object's type. Objects of the same type share the same value. - string 'object; + string? 'object; }; # To share the contents of a `File` object with non-Stripe users, you can @@ -599,21 +583,21 @@ public type DeletedBankAccount record { # retrieve the contents of the file without authentication. public type FileLink record { # Time at which the object was created. Measured in seconds since the Unix epoch. - int created; + int? created; # Whether this link is already expired. - boolean expired; + boolean? expired; # Time at which the link expires. int? expires_at?; # The file object this link points to. - string|File file; + string|File? file; # Unique identifier for the object. - string id; + string? id; # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. - boolean livemode; + boolean? livemode; # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. record {} metadata; # String representing the object's type. Objects of the same type share the same value. - string 'object; + string? 'object; # The publicly accessible URL to download the file. string? url?; }; @@ -631,20 +615,20 @@ public type SourceOrderItem record { # The ID of the associated object for this line item. Expandable if not null (e.g., expandable to a SKU). string? parent?; # The quantity of this order item. When type is `sku`, this is the number of instances of the SKU to be ordered. - int quantity?; + int? quantity?; # The type of this order item. Must be `sku`, `tax`, or `shipping`. string? 'type?; }; public type SubscriptionItemsItemBody record { # Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. When updating, pass an empty string to remove previously-defined thresholds. - BillingThresholds|string billing_thresholds?; + BillingThresholds|string? billing_thresholds?; # Specifies which fields in the response should be expanded. - string[] expand?; + string[]? expand?; # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. - AdditionalProperties|string metadata?; + AdditionalProperties|string? metadata?; # Indicates if a customer is on or off-session while an invoice payment is attempted. - boolean off_session?; + boolean? off_session?; # 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. For example, SCA regulation may require 3DS authentication to complete payment. See the [SCA Migration Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior. # # Use `default_incomplete` to transition the subscription to `status=past_due` when payment is required and await explicit confirmation of the invoice's payment intent. This allows simpler management of scenarios where additional user actions are needed to pay a subscription’s invoice. Such as failed payments, [SCA regulation](https://stripe.com/docs/billing/migration/strong-customer-authentication), or collecting a mandate for a bank debit payment method. @@ -652,23 +636,23 @@ public type SubscriptionItemsItemBody record { # Use `pending_if_incomplete` to update the subscription using [pending updates](https://stripe.com/docs/billing/subscriptions/pending-updates). When you use `pending_if_incomplete` you can only pass the parameters [supported by pending updates](https://stripe.com/docs/billing/pending-updates-reference#supported-attributes). # # Use `error_if_incomplete` if you want Stripe to return an HTTP 402 status code if a subscription's invoice cannot be paid. For example, if a payment method requires 3DS authentication due to SCA regulation and further user action is needed, this parameter does not update the subscription and returns an error instead. This was the default behavior for API versions prior to 2019-03-14. See the [changelog](https://stripe.com/docs/upgrades#2019-03-14) to learn more. - string payment_behavior?; + string? payment_behavior?; # The ID of the price object. When changing a subscription item's price, `quantity` is set to 1 unless a `quantity` parameter is provided. - string price?; + string? price?; # Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. - RecurringPriceData price_data?; + RecurringPriceData? price_data?; # Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#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. Valid values are `create_prorations`, `none`, or `always_invoice`. # # Passing `create_prorations` will cause proration invoice items to be created when applicable. These proration items will only be invoiced immediately under [certain conditions](https://stripe.com/docs/subscriptions/upgrading-downgrading#immediate-payment). In order to always invoice immediately for prorations, pass `always_invoice`. # # Prorations can be disabled by passing `none`. - string proration_behavior?; + string? proration_behavior?; # If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply the same proration that was previewed with the [upcoming invoice](https://stripe.com/docs/api#retrieve_customer_invoice) endpoint. - int proration_date?; + int? proration_date?; # The quantity you'd like to apply to the subscription item you're creating. - int quantity?; + int? quantity?; # A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will override the [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates) on the Subscription. When updating, pass an empty string to remove previously-defined tax rates. - TaxRateArray|string tax_rates?; + TaxRateArray|string? tax_rates?; }; public type LegalEntityPersonVerification record { @@ -678,9 +662,9 @@ public type LegalEntityPersonVerification record { string? details?; # One of `document_address_mismatch`, `document_dob_mismatch`, `document_duplicate_type`, `document_id_number_mismatch`, `document_name_mismatch`, `document_nationality_mismatch`, `failed_keyed_identity`, or `failed_other`. A machine-readable code specifying the verification state for the person. string? details_code?; - LegalEntityPersonVerificationDocument document?; + LegalEntityPersonVerificationDocument? document?; # The state of verification for the person. Possible values are `unverified`, `pending`, or `verified`. - string status; + string? status; }; public type LegalEntityCompanyVerificationDocument record { @@ -696,18 +680,18 @@ public type LegalEntityCompanyVerificationDocument record { public type InvoiceItemThresholdReason record { # The IDs of the line items that triggered the threshold invoice. - string[] line_item_ids; + string[]? line_item_ids; # The quantity threshold boundary that applied to the given line item. - int usage_gte; + int? usage_gte; }; public type InvoiceTaxAmount record { # The amount, in %s, of the tax. - int amount; + int? amount; # Whether this tax amount is inclusive or exclusive. - boolean inclusive; + boolean? inclusive; # The tax rate that was applied to get this tax amount. - string|TaxRate tax_rate; + string|TaxRate? tax_rate; }; public type StatusTransitions record { @@ -723,11 +707,11 @@ public type StatusTransitions record { public type TransferData record { # Amount intended to be collected by this PaymentIntent. A positive integer representing how much to charge in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The minimum amount is $0.50 US or [equivalent in charge currency](https://stripe.com/docs/currencies#minimum-and-maximum-charge-amounts). The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99). - int amount?; + int? amount?; # 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. - string|Account destination; + string|Account? destination; }; public type PaymentMethodCardWalletVisaCheckout record { @@ -758,31 +742,31 @@ public type PaymentMethodCardWalletVisaCheckout record { # and [integration guide](https://stripe.com/docs/billing/subscriptions/integrating-customer-portal). public type BillingPortalSession record { # The configuration used by this session, describing the features available. - string|BillingPortalConfiguration configuration; + string|BillingPortalConfiguration? configuration; # Time at which the object was created. Measured in seconds since the Unix epoch. - int created; + int? created; # The ID of the customer for this session. - string customer; + string? customer; # Unique identifier for the object. - string id; + string? id; # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. - boolean livemode; + boolean? livemode; # The IETF language tag of the locale Customer Portal is displayed in. If blank or auto, the customer’s `preferred_locales` or browser’s locale is used. string? locale?; # String representing the object's type. Objects of the same type share the same value. - string 'object; + string? 'object; # The account for which the session was created on behalf of. When specified, only subscriptions and invoices with this `on_behalf_of` account appear in the portal. For more information, see the [docs](https://stripe.com/docs/connect/charges-transfers#on-behalf-of). Use the [Accounts API](https://stripe.com/docs/api/accounts/object#account_object-settings-branding) to modify the `on_behalf_of` account's branding settings, which the portal displays. string? on_behalf_of?; # The URL to redirect customers to when they click on the portal's link to return to your website. - string return_url; + string? return_url; # The short-lived URL of the session that gives customers access to the customer portal. - string url; + string? url; }; public type PaymentFlowsPrivatePaymentMethodsAlipay record { }; -public type SubscriptionCancelAt int|string; +public type SubscriptionCancelAt int|string?; public type PaymentMethodDetailsCardWalletMasterpass record { # Owner's verified billing address. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated. @@ -797,9 +781,9 @@ public type PaymentMethodDetailsCardWalletMasterpass record { public type PortalSubscriptionCancellationReason record { # Whether the feature is enabled. - boolean enabled; + boolean? enabled; # Which cancellation reasons will be given as options to the customer. - string[] options; + string[]? options; }; public type IssuingDisputeMerchandiseNotAsDescribedEvidence record { @@ -819,9 +803,9 @@ public type IssuingDisputeMerchandiseNotAsDescribedEvidence record { public type QuotesResourceFromQuote record { # Whether this quote is a revision of a different quote. - boolean is_revision; + boolean? is_revision; # The quote that was cloned. - string|Quote quote; + string|Quote? quote; }; # These bank accounts are payment methods on `Customer` objects. @@ -845,9 +829,9 @@ public type BankAccount record { # Name of the bank associated with the routing number (e.g., `WELLS FARGO`). string? bank_name?; # Two-letter ISO code representing the country the bank account is located in. - string country; + string? country; # Three-letter [ISO code for the currency](https://stripe.com/docs/payouts) paid out to the bank account. - string currency; + string? currency; # The ID of the customer that the bank account is associated with. string|Customer|DeletedCustomer? customer?; # Whether this bank account is the default external account for its currency. @@ -855,34 +839,34 @@ public type BankAccount record { # Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. string? fingerprint?; # Unique identifier for the object. - string id; + string? id; # The last four digits of the bank account number. - string last4; + string? last4; # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. record {} metadata?; # String representing the object's type. Objects of the same type share the same value. - string 'object; + string? 'object; # The routing transit number for the bank account. string? routing_number?; # For bank accounts, possible values are `new`, `validated`, `verified`, `verification_failed`, or `errored`. A bank account that hasn't had any activity or validation performed is `new`. If Stripe can determine that the bank account exists, its status will be `validated`. Note that there often isn’t enough information to know (e.g., for smaller credit unions), and the validation is not always run. If customer bank account verification has succeeded, the bank account status will be `verified`. If the verification failed for any reason, such as microdeposit failure, the status will be `verification_failed`. If a transfer sent to this bank account fails, we'll set the status to `errored` and will not continue to send transfers until the bank details are updated. # # For external accounts, possible values are `new` and `errored`. Validations aren't run against external accounts because they're only used for payouts. This means the other statuses don't apply. If a transfer fails, the status is set to `errored` and transfers are stopped until account details are updated. - string status; + string? status; }; public type IssuingAuthorizationPendingRequest record { # The additional amount Stripe will hold if the authorization is approved, in the card's [currency](https://stripe.com/docs/api#issuing_authorization_object-pending-request-currency) and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). - int amount; + int? amount; # Detailed breakdown of amount components. These amounts are denominated in `currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). IssuingAuthorizationAmountDetails? amount_details?; # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). - string currency; + string? currency; # If set `true`, you may provide [amount](https://stripe.com/docs/api/issuing/authorizations/approve#approve_issuing_authorization-amount) to control how much to hold for the authorization. - boolean is_amount_controllable; + boolean? is_amount_controllable; # The amount the merchant is requesting to be authorized in the `merchant_currency`. The amount is in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). - int merchant_amount; + int? merchant_amount; # The local currency the merchant is requesting to authorize. - string merchant_currency; + string? merchant_currency; }; public type PaymentMethodCardWalletAmexExpressCheckout record { @@ -897,25 +881,25 @@ public type SourceTypeCard record { string? dynamic_last4?; int? exp_month?; int? exp_year?; - string fingerprint?; + string? fingerprint?; string? funding?; string? last4?; string? name?; - string three_d_secure?; + string? three_d_secure?; string? tokenization_method?; }; public type TaxParam1 record { - string|string ip_address?; + string|string? ip_address?; }; public type MandateAcssDebit record { # Description of the interval. Only required if the 'payment_schedule' parameter is 'interval' or 'combined'. string? interval_description?; # Payment schedule for the mandate. - string payment_schedule; + string? payment_schedule; # Transaction type of the mandate. - string transaction_type; + string? transaction_type; }; public type PaymentIntentPaymentMethodOptionsCard record { @@ -929,23 +913,23 @@ public type PaymentIntentPaymentMethodOptionsCard record { string? request_three_d_secure?; }; -public type InlineResponse2001 Customer|DeletedCustomer; +public type InlineResponse2001 Customer|DeletedCustomer?; public type SourceMandateNotificationBacsDebitData record { # Last 4 digits of the account number associated with the debit. - string last4?; + string? last4?; }; # The customer's current subscriptions, if any. public type SubscriptionList record { # Details about each object. - Subscription[] data; + Subscription[]? data; # True if this list has another page of items after this one that can be fetched. - boolean has_more; + boolean? has_more; # String representing the object's type. Objects of the same type share the same value. Always has the value `list`. - string 'object; + string? 'object; # The URL where this list can be accessed. - string url; + string? url; }; public type PaymentFlowsPrivatePaymentMethodsAlipayDetails record { @@ -956,44 +940,44 @@ public type PaymentFlowsPrivatePaymentMethodsAlipayDetails record { }; public type InlineResponse2003 record { - SubscriptionSchedule[] data; + SubscriptionSchedule[]? data; # True if this list has another page of items after this one that can be fetched. - boolean has_more; + boolean? has_more; # String representing the object's type. Objects of the same type share the same value. Always has the value `list`. - string 'object; + string? 'object; # The URL where this list can be accessed. - string url; + string? url; }; public type InlineResponse2002 record { - Subscription[] data; + Subscription[]? data; # True if this list has another page of items after this one that can be fetched. - boolean has_more; + boolean? has_more; # String representing the object's type. Objects of the same type share the same value. Always has the value `list`. - string 'object; + string? 'object; # The URL where this list can be accessed. - string url; + string? url; }; # List of items contained within this value list. public type RadarListListItemList record { # Details about each object. - RadarValueListItem[] data; + RadarValueListItem[]? data; # True if this list has another page of items after this one that can be fetched. - boolean has_more; + boolean? has_more; # String representing the object's type. Objects of the same type share the same value. Always has the value `list`. - string 'object; + string? 'object; # The URL where this list can be accessed. - string url; + string? url; }; public type DeletedProduct record { # Always true for a deleted object - boolean deleted; + boolean? deleted; # Unique identifier for the object. - string id; + string? id; # String representing the object's type. Objects of the same type share the same value. - string 'object; + string? 'object; }; # Value list items allow you to add specific values to a given Radar value list, which can then be used in rules. @@ -1001,50 +985,50 @@ public type DeletedProduct record { # Related guide: [Managing List Items](https://stripe.com/docs/radar/lists#managing-list-items). public type RadarValueListItem record { # Time at which the object was created. Measured in seconds since the Unix epoch. - int created; + int? created; # The name or email address of the user who added this item to the value list. - string created_by; + string? created_by; # Unique identifier for the object. - string id; + string? id; # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. - boolean livemode; + boolean? livemode; # String representing the object's type. Objects of the same type share the same value. - string 'object; + string? 'object; # The value of the item. - string value; + string? value; # The identifier of the value list this item belongs to. - string value_list; + string? value_list; }; public type DeletedCustomer record { # Always true for a deleted object - boolean deleted; + boolean? deleted; # Unique identifier for the object. - string id; + string? id; # String representing the object's type. Objects of the same type share the same value. - string 'object; + string? 'object; }; public type DeletedInvoiceitem record { # Always true for a deleted object - boolean deleted; + boolean? deleted; # Unique identifier for the object. - string id; + string? id; # String representing the object's type. Objects of the same type share the same value. - string 'object; + string? 'object; }; public type ShippingMethod record { # A positive integer in the smallest currency unit (that is, 100 cents for $1.00, or 1 for ¥1, Japanese Yen being a zero-decimal currency) representing the total amount for the line item. - int amount; + int? amount; # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). - string currency; + string? currency; # The estimated delivery date for the given shipping method. Can be either a specific date or a range. DeliveryEstimate? delivery_estimate?; # An arbitrary string attached to the object. Often useful for displaying to users. - string description; + string? description; # Unique identifier for the object. - string id; + string? id; }; public type PaymentMethodOptionsIdeal record { @@ -1052,9 +1036,9 @@ public type PaymentMethodOptionsIdeal record { public type CustomerTaxLocation record { # The customer's country as identified by Stripe Tax. - string country; + string? country; # The data source used to infer the customer's location. - string 'source; + string? 'source; # The customer's state, county, province, or region as identified by Stripe Tax. string? state?; }; @@ -1076,9 +1060,9 @@ public type PaymentMethodDetailsInteracPresent record { # Authorization response cryptogram. string? emv_auth_data?; # Two-digit number representing the card's expiration month. - int exp_month; + int? exp_month; # Four-digit number representing the card's expiration year. - int exp_year; + int? exp_year; # Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number. # # *Starting May 1, 2021, card fingerprint in India for Connect will change to allow two fingerprints for the same card --- one for India and one for the rest of the world.* @@ -1101,53 +1085,53 @@ public type PaymentMethodDetailsInteracPresent record { public type DeletedSubscriptionItem record { # Always true for a deleted object - boolean deleted; + boolean? deleted; # Unique identifier for the object. - string id; + string? id; # String representing the object's type. Objects of the same type share the same value. - string 'object; + string? 'object; }; public type QuotesResourceTotalDetails record { # This is the sum of all the line item discounts. - int amount_discount; + int? amount_discount; # This is the sum of all the line item shipping amounts. int? amount_shipping?; # This is the sum of all the line item tax amounts. - int amount_tax; - QuotesResourceTotalDetailsResourceBreakdown breakdown?; + int? amount_tax; + QuotesResourceTotalDetailsResourceBreakdown? breakdown?; }; public type CustomFieldParams record { - string name; - string value; + string? name; + string? value; }; # A list of refunds that have been applied to the charge. public type RefundList record { # Details about each object. - Refund[] data; + Refund[]? data; # True if this list has another page of items after this one that can be fetched. - boolean has_more; + boolean? has_more; # String representing the object's type. Objects of the same type share the same value. Always has the value `list`. - string 'object; + string? 'object; # The URL where this list can be accessed. - string url; + string? url; }; public type ApiErrors record { # For card errors, the ID of the failed charge. - string charge?; + string? charge?; # For some errors that could be handled programmatically, a short string indicating the [error code](https://stripe.com/docs/error-codes) reported. - string code?; + string? code?; # For card errors resulting from a card issuer decline, a short string indicating the [card issuer's reason for the decline](https://stripe.com/docs/declines#issuer-declines) if they provide one. - string decline_code?; + string? decline_code?; # A URL to more information about the [error code](https://stripe.com/docs/error-codes) reported. - string doc_url?; + string? doc_url?; # A human-readable message providing more details about the error. For card errors, these messages can be shown to your users. - string message?; + string? message?; # 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. - string param?; + string? param?; # A PaymentIntent guides you through the process of collecting a payment from your customer. # We recommend that you create exactly one PaymentIntent for each order or # customer session in your system. You can reference the PaymentIntent later to @@ -1159,15 +1143,15 @@ public type ApiErrors record { # authentication flows and ultimately creates at most one successful charge. # # Related guide: [Payment Intents API](https://stripe.com/docs/payments/payment-intents). - PaymentIntent payment_intent?; + PaymentIntent? payment_intent?; # PaymentMethod objects represent your customer's payment instruments. # They can be used with [PaymentIntents](https://stripe.com/docs/payments/payment-intents) to collect payments or saved to # Customer objects to store instrument details for future payments. # # Related guides: [Payment Methods](https://stripe.com/docs/payments/payment-methods) and [More Payment Scenarios](https://stripe.com/docs/payments/more-payment-scenarios). - PaymentMethod payment_method?; + PaymentMethod? payment_method?; # 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. - string payment_method_type?; + string? payment_method_type?; # A SetupIntent guides you through the process of setting up and saving a customer's payment credentials for future payments. # For example, you could use a SetupIntent to set up and save your customer's card without immediately collecting a payment. # Later, you can use [PaymentIntents](https://stripe.com/docs/api#payment_intents) to drive the payment flow. @@ -1190,11 +1174,11 @@ public type ApiErrors record { # even as regulations change over time. # # Related guide: [Setup Intents API](https://stripe.com/docs/payments/setup-intents). - SetupIntent setup_intent?; + SetupIntent? setup_intent?; # The source object for errors returned on a request involving a source. - BankAccount|Card|Source 'source?; + BankAccount|Card|Source? 'source?; # The type of error returned. One of `api_error`, `card_error`, `idempotency_error`, or `invalid_request_error` - string 'type; + string? 'type; }; public type PaymentMethodAuBecsDebit record { @@ -1226,55 +1210,55 @@ public type PersonRelationship record { # Related guide: [How to create a Cardholder](https://stripe.com/docs/issuing/cards#create-cardholder) public type IssuingCardholder record { # The cardholder’s billing information - IssuingCardholderAddress billing; + IssuingCardholderAddress? billing; # Additional information about a `company` cardholder. IssuingCardholderCompany? company?; # Time at which the object was created. Measured in seconds since the Unix epoch. - int created; + int? created; # The cardholder's email address. string? email?; # Unique identifier for the object. - string id; + string? id; # Additional information about an `individual` cardholder. IssuingCardholderIndividual? individual?; # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. - boolean livemode; + boolean? livemode; # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. record {} metadata; # The cardholder's name. This will be printed on cards issued to them. - string name; + string? name; # String representing the object's type. Objects of the same type share the same value. - string 'object; + string? 'object; # The cardholder's phone number. This is required for all cardholders who will be creating EU cards. See the [3D Secure documentation](https://stripe.com/docs/issuing/3d-secure#when-is-3d-secure-applied) for more details. string? phone_number?; - IssuingCardholderRequirements requirements; + IssuingCardholderRequirements? requirements; # Rules that control spending across this cardholder's cards. Refer to our [documentation](https://stripe.com/docs/issuing/controls/spending-controls) for more details. IssuingCardholderAuthorizationControls? spending_controls?; # Specifies whether to permit authorizations on this cardholder's cards. - string status; + string? status; # One of `individual` or `company`. - string 'type; + string? 'type; }; # If this is an `acss_debit` PaymentMethod, this hash contains details about the ACSS Debit payment method. public type PaymentMethodParam record { # Customer’s bank account number - string account_number; + string? account_number; # Institution number of the customer’s bank - string institution_number; + string? institution_number; # Transit number of the customer’s bank - string transit_number; + string? transit_number; }; public type DeliveryEstimate record { # If `type` is `"exact"`, `date` will be the expected delivery date in the format YYYY-MM-DD. - string date?; + string? date?; # If `type` is `"range"`, `earliest` will be be the earliest delivery date in the format YYYY-MM-DD. - string earliest?; + string? earliest?; # If `type` is `"range"`, `latest` will be the latest delivery date in the format YYYY-MM-DD. - string latest?; + string? latest?; # The type of estimate. Must be either `"range"` or `"exact"`. - string 'type; + string? 'type; }; public type SetupAttemptPaymentMethodDetailsAuBecsDebit record { @@ -1288,115 +1272,115 @@ public type PaymentMethodOptionsAfterpayClearpay record { # The cardholder’s billing information public type IssuingCardholderAddress record { - Address address; + Address? address; }; public type PaymentMethodDetailsCardWalletApplePay record { }; public type SourceTypeWechat record { - string prepay_id?; + string? prepay_id?; string? qr_code_url?; - string statement_descriptor?; + string? statement_descriptor?; }; # A list of [file links](https://stripe.com/docs/api#file_links) that point at this file. public type FileFileLinkList record { # Details about each object. - FileLink[] data; + FileLink[]? data; # True if this list has another page of items after this one that can be fetched. - boolean has_more; + boolean? has_more; # String representing the object's type. Objects of the same type share the same value. Always has the value `list`. - string 'object; + string? 'object; # The URL where this list can be accessed. - string url; + string? url; }; public type ChargeFraudDetails record { # Assessments from Stripe. If set, the value is `fraudulent`. - string stripe_report?; + string? stripe_report?; # Assessments reported by you. If set, possible values of are `safe` and `fraudulent`. - string user_report?; + string? user_report?; }; public type PortalSubscriptionCancel record { - PortalSubscriptionCancellationReason cancellation_reason?; + PortalSubscriptionCancellationReason? cancellation_reason?; # Whether the feature is enabled. - boolean enabled; + boolean? enabled; # Whether to cancel subscriptions immediately or at the end of the billing period. - string mode; + string? mode; # Whether to create prorations when canceling subscriptions. Possible values are `none` and `create_prorations`. - string proration_behavior; + string? proration_behavior; }; public type PaymentPagesCheckoutSessionTotalDetailsResourceBreakdown record { # The aggregated line item discounts. - LineItemsDiscountAmount[] discounts; + LineItemsDiscountAmount[]? discounts; # The aggregated line item tax amounts by rate. - LineItemsTaxAmount[] taxes; + LineItemsTaxAmount[]? taxes; }; # Object representing the subscription schedule's default settings. public type DefaultSettingsParams record { # A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the application owner’s Stripe account. The request must be made by a platform account on a connected account in order to set an application fee percentage. - decimal application_fee_percent?; + decimal? application_fee_percent?; # Default settings for automatic tax computation - AutomaticTaxConfig2 automatic_tax?; + AutomaticTaxConfig2? automatic_tax?; # Can be set to phase_start to set the anchor to the start of the phase or automatic to automatically change it if needed. Cannot be set to phase_start if this phase specifies a trial - string billing_cycle_anchor?; + string? billing_cycle_anchor?; # Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds - BillingThresholdParams|string billing_thresholds?; + BillingThresholdParams|string? billing_thresholds?; # Either charge_automatically, or send_invoice. When charging automatically, Stripe will attempt to pay the underlying subscription at the end of each billing cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions. Defaults to charge_automatically on creation - string collection_method?; + string? collection_method?; # ID of the default payment method for the subscription schedule. It must belong to the customer associated with the subscription schedule. If not set, invoices will use the default payment method in the customer’s invoice settings - string default_payment_method?; + string? default_payment_method?; # All invoices will be billed using the specified settings - SubscriptionSchedulesParam invoice_settings?; + SubscriptionSchedulesParam? invoice_settings?; # The data with which to automatically create a Transfer for each of the associated subscription’s invoices - TransferDataSpecs|string transfer_data?; + TransferDataSpecs|string? transfer_data?; }; public type InvoicesInvoiceBody record { # The account tax IDs associated with the invoice. Only editable when the invoice is a draft. - string[]|string account_tax_ids?; + string[]|string? account_tax_ids?; # A fee in %s that will be applied to the invoice and transferred to the application owner's Stripe account. The request must be made with an OAuth key or the Stripe-Account header in order to take an application fee. For more information, see the application fees [documentation](https://stripe.com/docs/billing/invoices/connect#collecting-fees). - int application_fee_amount?; + int? application_fee_amount?; # Controls whether Stripe will perform [automatic collection](https://stripe.com/docs/billing/invoices/workflow/#auto_advance) of the invoice. - boolean auto_advance?; + boolean? auto_advance?; # Settings for automatic tax lookup for this invoice. - AutomaticTaxParam automatic_tax?; + AutomaticTaxParam? automatic_tax?; # Either `charge_automatically` or `send_invoice`. This field can be updated only on `draft` invoices. - string collection_method?; + string? collection_method?; # A list of up to 4 custom fields to be displayed on the invoice. If a value for `custom_fields` is specified, the list specified will replace the existing custom field list on this invoice. Pass an empty string to remove previously-defined fields. - InvoiceSettingsCustomFields|string custom_fields?; + InvoiceSettingsCustomFields|string? custom_fields?; # The number of days from which the invoice is created until it is due. Only valid for invoices where `collection_method=send_invoice`. This field can only be updated on `draft` invoices. - int days_until_due?; + int? days_until_due?; # ID of the default payment method for the invoice. It must belong to the customer associated with the invoice. If not set, defaults to the subscription's default payment method, if any, or to the default payment method in the customer's invoice settings. - string default_payment_method?; + string? default_payment_method?; # ID of the default payment source for the invoice. It must belong to the customer associated with the invoice and be in a chargeable state. If not set, defaults to the subscription's default source, if any, or to the customer's default source. - string default_source?; + string? default_source?; # The tax rates that will apply to any line item that does not have `tax_rates` set. Pass an empty string to remove previously-defined tax rates. - string[]|string default_tax_rates?; + string[]|string? default_tax_rates?; # An arbitrary string attached to the object. Often useful for displaying to users. Referenced as 'memo' in the Dashboard. - string description?; + string? description?; # The discounts that will apply to the invoice. Pass an empty string to remove previously-defined discounts. - DiscountsDataParam|string discounts?; + DiscountsDataParam|string? discounts?; # The date on which payment for this invoice is due. Only valid for invoices where `collection_method=send_invoice`. This field can only be updated on `draft` invoices. - int due_date?; + int? due_date?; # Specifies which fields in the response should be expanded. - string[] expand?; + string[]? expand?; # Footer to be displayed on the invoice. - string footer?; + string? footer?; # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. - record {}|string metadata?; + record {}|string? metadata?; # The account (if any) for which the funds of the invoice payment are intended. If set, the invoice will be presented with the branding and support information of the specified account. See the [Invoices with Connect](https://stripe.com/docs/billing/invoices/connect) documentation for details. - string|string on_behalf_of?; + string|string? on_behalf_of?; # Configuration settings for the PaymentIntent that is generated when the invoice is finalized. - PaymentSettings payment_settings?; + PaymentSettings? payment_settings?; # Extra information about a charge for the customer's credit card statement. It must contain at least one letter. If not specified and this invoice is part of a subscription, the default `statement_descriptor` will be set to the first subscription item's product's `statement_descriptor`. - string statement_descriptor?; + string? statement_descriptor?; # If specified, the funds from the invoice will be transferred to the destination and the ID of the resulting transfer will be found on the invoice's charge. This will be unset if you POST an empty value. - DiscountsDataParam|string transfer_data?; + DiscountsDataParam|string? transfer_data?; }; public type SetupIntentPaymentMethodOptionsMandateOptionsSepaDebit record { @@ -1405,13 +1389,13 @@ public type SetupIntentPaymentMethodOptionsMandateOptionsSepaDebit record { # The individual line items that make up the invoice. `lines` is sorted as follows: invoice items in reverse chronological order, followed by the subscription, if any. public type Invoicelineslist1 record { # Details about each object. - LineItem[] data; + LineItem[]? data; # True if this list has another page of items after this one that can be fetched. - boolean has_more; + boolean? has_more; # String representing the object's type. Objects of the same type share the same value. Always has the value `list`. - string 'object; + string? 'object; # The URL where this list can be accessed. - string url; + string? url; }; public type AdditionalProperties record { @@ -1439,20 +1423,20 @@ public type SetupAttemptPaymentMethodDetailsIdeal record { # Related guide: [Connect Onboarding](https://stripe.com/docs/connect/connect-onboarding). public type AccountLink record { # Time at which the object was created. Measured in seconds since the Unix epoch. - int created; + int? created; # The timestamp at which this account link will expire. - int expires_at; + int? expires_at; # String representing the object's type. Objects of the same type share the same value. - string 'object; + string? 'object; # The URL for the account link. - string url; + string? url; }; public type DiscountsResourceDiscountAmount record { # The amount, in %s, of the discount. - int amount; + int? amount; # The discount that was applied to get this discount amount. - string|Discount|DeletedDiscount discount; + string|Discount|DeletedDiscount? discount; }; public type PaymentMethodCardWalletMasterpass record { @@ -1475,22 +1459,22 @@ public type PaymentMethodIdeal record { public type QuotesResourceRecurring record { # Total before any discounts or taxes are applied. - int amount_subtotal; + int? amount_subtotal; # Total after discounts and taxes are applied. - int amount_total; + int? amount_total; # The frequency at which a subscription is billed. One of `day`, `week`, `month` or `year`. - string interval; + string? interval; # The number of intervals (specified in the `interval` attribute) between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. - int interval_count; - QuotesResourceTotalDetails total_details; + int? interval_count; + QuotesResourceTotalDetails? total_details; }; public type CustomerDetailsParam record { - CustomerAdresss|string address?; - CustomerAddressWithName|string shipping?; - TaxParam1 tax?; - string tax_exempt?; - DataParams[] tax_ids?; + CustomerAdresss|string? address?; + CustomerAddressWithName|string? shipping?; + TaxParam1? tax?; + string? tax_exempt?; + DataParams[]? tax_ids?; }; public type PaymentMethodDetailsCardChecks record { @@ -1503,17 +1487,17 @@ public type PaymentMethodDetailsCardChecks record { }; public type SubscriptionItemCreateParams record { - ItemBillingThresholdsParam|string billing_thresholds?; + ItemBillingThresholdsParam|string? billing_thresholds?; record {} metadata?; - string price?; - RecurringPriceData1 price_data?; - int quantity?; - TaxRateArray|string tax_rates?; + string? price?; + RecurringPriceData1? price_data?; + int? quantity?; + TaxRateArray|string? tax_rates?; }; public type BalanceDetail record { # Funds that are available for use. - BalanceAmount[] available; + BalanceAmount[]? available; }; public type PaymentMethodP24 record { @@ -1522,47 +1506,47 @@ public type PaymentMethodP24 record { }; public type Period1 record { - int end; - int 'start; + int? end; + int? 'start; }; public type TokenParamas record { - string token; + string? token; }; public type SourceTransactionChfCreditTransferData record { # Reference associated with the transfer. - string reference?; + string? reference?; # Sender's country address. - string sender_address_country?; + string? sender_address_country?; # Sender's line 1 address. - string sender_address_line1?; + string? sender_address_line1?; # Sender's bank account IBAN. - string sender_iban?; + string? sender_iban?; # Sender's name. - string sender_name?; + string? sender_name?; }; # Object representing the subscription schedule's default settings. public type DefaultSettingsParams1 record { - decimal application_fee_percent?; - AutomaticTaxConfig3 automatic_tax?; - string billing_cycle_anchor?; - BillingThresholdParams|string billing_thresholds?; - string collection_method?; - string default_payment_method?; - SubscriptionSchedulesParam1 invoice_settings?; - TransferDataSpecs|string transfer_data?; + decimal? application_fee_percent?; + AutomaticTaxConfig3? automatic_tax?; + string? billing_cycle_anchor?; + BillingThresholdParams|string? billing_thresholds?; + string? collection_method?; + string? default_payment_method?; + SubscriptionSchedulesParam1? invoice_settings?; + TransferDataSpecs|string? transfer_data?; }; public type CardList record { - Card[] data; + Card[]? data; # True if this list has another page of items after this one that can be fetched. - boolean has_more; + boolean? has_more; # String representing the object's type. Objects of the same type share the same value. Always has the value `list`. - string 'object; + string? 'object; # The URL where this list can be accessed. - string url; + string? url; }; public type IssuingDisputeServiceNotAsDescribedEvidence record { @@ -1590,61 +1574,61 @@ public type SourceTypeThreeDSecure record { string? dynamic_last4?; int? exp_month?; int? exp_year?; - string fingerprint?; + string? fingerprint?; string? funding?; string? last4?; string? name?; - string three_d_secure?; + string? three_d_secure?; string? tokenization_method?; }; public type RecurringPriceData1 record { - string currency; - string product; - RecurringAdhoc recurring; - string tax_behavior?; - int unit_amount?; - string unit_amount_decimal?; + string? currency; + string? product; + RecurringAdhoc? recurring; + string? tax_behavior?; + int? unit_amount?; + string? unit_amount_decimal?; }; public type V1CustomersBody record { # The customer's address. - CustomerAdresss|string address?; + CustomerAdresss|string? address?; # An integer amount in %s that represents the customer's current balance, which affect the customer's future invoices. A negative amount represents a credit that decreases the amount due on an invoice; a positive amount increases the amount due on an invoice. - int balance?; - string coupon?; + int? balance?; + string? coupon?; # An arbitrary string that you can attach to a customer object. It is displayed alongside the customer in the dashboard. - string description?; + string? description?; # Customer's email address. It's displayed alongside the customer in your dashboard and can be useful for searching and tracking. This may be up to *512 characters*. - string email?; + string? email?; # Specifies which fields in the response should be expanded. - string[] expand?; + string[]? expand?; # The prefix for the customer used to generate unique invoice numbers. Must be 3–12 uppercase letters or numbers. - string invoice_prefix?; + string? invoice_prefix?; # Default invoice settings for this customer. - CustomerParam invoice_settings?; + CustomerParam? invoice_settings?; # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. - AdditionalProperties|string metadata?; + AdditionalProperties|string? metadata?; # The customer's full name or business name. - string name?; + string? name?; # The sequence to be used on the customer's next invoice. Defaults to 1. - int next_invoice_sequence?; - string payment_method?; + int? next_invoice_sequence?; + string? payment_method?; # The customer's phone number. - string phone?; + string? phone?; # Customer's preferred languages, ordered by preference. - string[] preferred_locales?; + string[]? preferred_locales?; # The API ID of a promotion code to apply to the customer. The customer will have a discount applied on all recurring payments. Charges you create through the API will not have the discount. - string promotion_code?; + string? promotion_code?; # The customer's shipping information. Appears on invoices emailed to this customer. - CustomerAddressWithName|string shipping?; - string 'source?; + CustomerAddressWithName|string? shipping?; + string? 'source?; # Tax details about the customer. - TaxParam tax?; + TaxParam? tax?; # The customer's tax exemption. One of `none`, `exempt`, or `reverse`. - string tax_exempt?; + string? tax_exempt?; # The customer's tax IDs. - DataParams[] tax_id_data?; + DataParams[]? tax_id_data?; }; public type SourceTypeEps record { @@ -1663,15 +1647,15 @@ public type IssuingDisputeOtherEvidence record { string? product_type?; }; -public type PaymentMethodTypesArray string[]; +public type PaymentMethodTypesArray string[]?; public type DeletedRadarValueList record { # Always true for a deleted object - boolean deleted; + boolean? deleted; # Unique identifier for the object. - string id; + string? id; # String representing the object's type. Objects of the same type share the same value. - string 'object; + string? 'object; }; # A SetupIntent guides you through the process of setting up and saving a customer's payment credentials for future payments. @@ -1706,7 +1690,7 @@ public type SetupIntent record { # The client secret can be used to complete payment setup from your frontend. It should not be stored, logged, embedded in URLs, or exposed to anyone other than the customer. Make sure that you have TLS enabled on any page that includes the client secret. string? client_secret?; # Time at which the object was created. Measured in seconds since the Unix epoch. - int created; + int? created; # ID of the Customer this SetupIntent belongs to, if one exists. # # If present, the SetupIntent's payment method will be attached to the Customer on successful setup. Payment methods attached to other Customers cannot be used with this SetupIntent. @@ -1714,13 +1698,13 @@ public type SetupIntent record { # An arbitrary string attached to the object. Often useful for displaying to users. string? description?; # Unique identifier for the object. - string id; + string? id; # The error encountered in the previous SetupIntent confirmation. ApiErrors? last_setup_error?; # The most recent SetupAttempt for this SetupIntent. string|SetupAttempt? latest_attempt?; # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. - boolean livemode; + boolean? livemode; # ID of the multi use Mandate generated by the SetupIntent. string|Mandate? mandate?; # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. @@ -1728,7 +1712,7 @@ public type SetupIntent record { # If present, this property tells you what actions you need to take in order for your customer to continue payment setup. SetupIntentNextAction? next_action?; # String representing the object's type. Objects of the same type share the same value. - string 'object; + string? 'object; # The account (if any) for which the setup is intended. string|Account? on_behalf_of?; # ID of the payment method used with this SetupIntent. @@ -1736,15 +1720,15 @@ public type SetupIntent record { # Payment-method-specific configuration for this SetupIntent. SetupIntentPaymentMethodOptions? payment_method_options?; # The list of payment method types (e.g. card) that this SetupIntent is allowed to set up. - string[] payment_method_types; + string[]? payment_method_types; # ID of the single_use Mandate generated by the SetupIntent. string|Mandate? single_use_mandate?; # [Status](https://stripe.com/docs/payments/intents#intent-statuses) of this SetupIntent, one of `requires_payment_method`, `requires_confirmation`, `requires_action`, `processing`, `canceled`, or `succeeded`. - string status; + string? status; # Indicates how the payment method is intended to be used in the future. # # Use `on_session` if you intend to only reuse the payment method when the customer is in your checkout flow. Use `off_session` if your customer may or may not be in your checkout flow. If not provided, this value defaults to `off_session`. - string usage; + string? usage; }; # As a [card issuer](https://stripe.com/docs/issuing), you can dispute transactions that the cardholder does not recognize, suspects to be fraudulent, or has other issues with. @@ -1752,27 +1736,27 @@ public type SetupIntent record { # Related guide: [Disputing Transactions](https://stripe.com/docs/issuing/purchases/disputes) public type IssuingDispute record { # Disputed amount. Usually the amount of the `transaction`, but can differ (usually because of currency fluctuation). - int amount; + int? amount; # List of balance transactions associated with the dispute. BalanceTransaction[]? balance_transactions?; # Time at which the object was created. Measured in seconds since the Unix epoch. - int created; + int? created; # The currency the `transaction` was made in. - string currency; + string? currency; # Evidence for the dispute. Evidence contains exactly two non-null fields: the reason for the dispute and the associated evidence field for the selected reason - IssuingDisputeEvidence evidence; + IssuingDisputeEvidence? evidence; # Unique identifier for the object. - string id; + string? id; # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. - boolean livemode; + boolean? livemode; # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. record {} metadata; # String representing the object's type. Objects of the same type share the same value. - string 'object; + string? 'object; # Current status of the dispute. - string status; + string? status; # The transaction being disputed. - string|IssuingTransaction 'transaction; + string|IssuingTransaction? 'transaction; }; public type CardIssuingAccountTermsOfService record { @@ -1781,16 +1765,16 @@ public type CardIssuingAccountTermsOfService record { # The IP address from which the account representative accepted the service agreement. string? ip?; # The user agent of the browser from which the account representative accepted the service agreement. - string user_agent?; + string? user_agent?; }; public type DeletedPerson record { # Always true for a deleted object - boolean deleted; + boolean? deleted; # Unique identifier for the object. - string id; + string? id; # String representing the object's type. Objects of the same type share the same value. - string 'object; + string? 'object; }; public type PaymentMethodSepaDebit record { @@ -1834,7 +1818,7 @@ public type SetupAttemptPaymentMethodDetailsBancontact record { string? verified_name?; }; -public type DeletedExternalAccount DeletedBankAccount|DeletedCard; +public type DeletedExternalAccount DeletedBankAccount|DeletedCard?; public type PaymentMethodDetailsStripeAccount record { }; @@ -1842,18 +1826,18 @@ public type PaymentMethodDetailsStripeAccount record { # List of subscription items, each with an attached price. public type SubscriptionItemList record { # Details about each object. - SubscriptionItem[] data; + SubscriptionItem[]? data; # True if this list has another page of items after this one that can be fetched. - boolean has_more; + boolean? has_more; # String representing the object's type. Objects of the same type share the same value. Always has the value `list`. - string 'object; + string? 'object; # The URL where this list can be accessed. - string url; + string? url; }; public type TaxIdVerification record { # Verification status, one of `pending`, `verified`, `unverified`, or `unavailable`. - string status; + string? status; # Verified address. string? verified_address?; # Verified name. @@ -1865,29 +1849,29 @@ public type TaxIdVerification record { # Related guide: [Tax Rates](https://stripe.com/docs/billing/taxes/tax-rates). public type TaxRate record { # Defaults to `true`. When set to `false`, this tax rate cannot be used with new applications or Checkout Sessions, but will still work for subscriptions and invoices that already have it set. - boolean active; + boolean? active; # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). string? country?; # Time at which the object was created. Measured in seconds since the Unix epoch. - int created; + int? created; # An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers. string? description?; # The display name of the tax rates as it will appear to your customer on their receipt email, PDF, and the hosted invoice page. - string display_name; + string? display_name; # Unique identifier for the object. - string id; + string? id; # This specifies if the tax rate is inclusive or exclusive. - boolean inclusive; + boolean? inclusive; # The jurisdiction for the tax rate. You can use this label field for tax reporting purposes. It also appears on your customer’s invoice. string? jurisdiction?; # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. - boolean livemode; + boolean? livemode; # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. record {} metadata?; # String representing the object's type. Objects of the same type share the same value. - string 'object; + string? 'object; # This represents the tax rate percent out of 100. - decimal percentage; + decimal? percentage; # [ISO 3166-2 subdivision code](https://en.wikipedia.org/wiki/ISO_3166-2:US), without country prefix. For example, "NY" for New York, United States. string? state?; # The high-level tax type, such as `vat` or `sales_tax`. @@ -1895,7 +1879,7 @@ public type TaxRate record { }; public type Shipping record { - Address address?; + Address? address?; # The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc. string? carrier?; # Recipient name. @@ -1915,11 +1899,11 @@ public type AccountDashboardSettings record { public type SourceMandateNotificationSepaDebitData record { # SEPA creditor ID. - string creditor_identifier?; + string? creditor_identifier?; # Last 4 digits of the account number associated with the debit. - string last4?; + string? last4?; # Mandate reference associated with the debit. - string mandate_reference?; + string? mandate_reference?; }; # A coupon contains information about a percent-off or amount-off discount you @@ -1929,19 +1913,19 @@ public type Coupon record { # Amount (in the `currency` specified) that will be taken off the subtotal of any invoices for this customer. int? amount_off?; # Contains information about what this coupon applies to - CouponAppliesTo applies_to?; + CouponAppliesTo? applies_to?; # Time at which the object was created. Measured in seconds since the Unix epoch. - int created; + int? created; # If `amount_off` has been set, the three-letter [ISO code for the currency](https://stripe.com/docs/currencies) of the amount to take off. string? currency?; # One of `forever`, `once`, and `repeating`. Describes how long a customer who applies this coupon will get the discount. - string duration; + string? duration; # If `duration` is `repeating`, the number of months the coupon applies. Null if coupon `duration` is `forever` or `once`. int? duration_in_months?; # Unique identifier for the object. - string id; + string? id; # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. - boolean livemode; + boolean? livemode; # Maximum number of times this coupon can be redeemed, in total, across all customers, before it is no longer valid. int? max_redemptions?; # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. @@ -1949,15 +1933,15 @@ public type Coupon record { # Name of the coupon displayed to customers on for instance invoices or receipts. string? name?; # String representing the object's type. Objects of the same type share the same value. - string 'object; + string? 'object; # Percent that will be taken off the subtotal of any invoices for this customer for the duration of the coupon. For example, a coupon with percent_off of 50 will make a %s100 invoice %s50 instead. decimal? percent_off?; # Date after which the coupon can no longer be redeemed. int? redeem_by?; # Number of times this coupon has been applied to a customer. - int times_redeemed; + int? times_redeemed; # Taking account of the above properties, whether this coupon can still be applied to a customer. - boolean valid; + boolean? valid; }; public type PaymentMethodDetailsCardWalletSamsungPay record { @@ -1972,11 +1956,11 @@ public type QuotesResourceSubscriptionData record { public type DeletedAccount record { # Always true for a deleted object - boolean deleted; + boolean? deleted; # Unique identifier for the object. - string id; + string? id; # String representing the object's type. Objects of the same type share the same value. - string 'object; + string? 'object; }; public type PaymentMethodDetailsWechatPay record { @@ -1991,53 +1975,53 @@ public type PaymentMethodBancontact record { public type PlatformTaxFee record { # The Connected account that incurred this charge. - string account; + string? account; # Unique identifier for the object. - string id; + string? id; # String representing the object's type. Objects of the same type share the same value. - string 'object; + string? 'object; # The payment object that caused this tax to be inflicted. - string source_transaction; + string? source_transaction; # The type of tax (VAT). - string 'type; + string? 'type; }; public type IssuingAuthorizationVerificationData record { # Whether the cardholder provided an address first line and if it matched the cardholder’s `billing.address.line1`. - string address_line1_check; + string? address_line1_check; # Whether the cardholder provided a postal code and if it matched the cardholder’s `billing.address.postal_code`. - string address_postal_code_check; + string? address_postal_code_check; # Whether the cardholder provided a CVC and if it matched Stripe’s record. - string cvc_check; + string? cvc_check; # Whether the cardholder provided an expiry date and if it matched Stripe’s record. - string expiry_check; + string? expiry_check; }; public type AlipayAccount record { # Time at which the object was created. Measured in seconds since the Unix epoch. - int created; + int? created; # The ID of the customer associated with this Alipay Account. string|Customer|DeletedCustomer? customer?; # Uniquely identifies the account and will be the same across all Alipay account objects that are linked to the same Alipay account. - string fingerprint; + string? fingerprint; # Unique identifier for the object. - string id; + string? id; # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. - boolean livemode; + boolean? livemode; # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. record {} metadata?; # String representing the object's type. Objects of the same type share the same value. - string 'object; + string? 'object; # If the Alipay account object is not reusable, the exact amount that you can create a charge for. int? payment_amount?; # If the Alipay account object is not reusable, the exact currency that you can create a charge for. string? payment_currency?; # True if you can create multiple payments using this account. If the account is reusable, then you can freely choose the amount of each payment. - boolean reusable; + boolean? reusable; # Whether this Alipay account object has ever been used for a payment. - boolean used; + boolean? used; # The username for the Alipay account. - string username; + string? username; }; public type IssuingDisputeFraudulentEvidence record { @@ -2065,16 +2049,16 @@ public type AccountRequirements record { }; public type CreatedFilterOptions record { - int gt?; - int gte?; - int lt?; - int lte?; + int? gt?; + int? gte?; + int? lt?; + int? lte?; }; public type PaymentIntentPaymentMethodOptionsAcssDebit record { - PaymentIntentPaymentMethodOptionsMandateOptionsAcssDebit mandate_options?; + PaymentIntentPaymentMethodOptionsMandateOptionsAcssDebit? mandate_options?; # Bank account verification method. - string verification_method?; + string? verification_method?; }; public type PaymentMethodDetailsCardInstallmentsPlan record { @@ -2084,52 +2068,52 @@ public type PaymentMethodDetailsCardInstallmentsPlan record { # One of `month`. string? interval?; # Type of installment plan, one of `fixed_count`. - string 'type; + string? 'type; }; public type OptionalFieldsAddress record { - string city?; - string country?; - string line1?; - string line2?; - string postal_code?; - string state?; + string? city?; + string? country?; + string? line1?; + string? line2?; + string? postal_code?; + string? state?; }; public type PortalBusinessProfile record { # The messaging shown to customers in the portal. string? headline?; # A link to the business’s publicly available privacy policy. - string privacy_policy_url; + string? privacy_policy_url; # A link to the business’s publicly available terms of service. - string terms_of_service_url; + string? terms_of_service_url; }; # If this is an `au_becs_debit` PaymentMethod, this hash contains details about the bank account. public type Param record { # The account number for the bank account - string account_number; + string? account_number; # Bank-State-Branch number of the bank account - string bsb_number; + string? bsb_number; }; public type BitcoinReceiver record { # True when this bitcoin receiver has received a non-zero amount of bitcoin. - boolean active; + boolean? active; # The amount of `currency` that you are collecting as payment. - int amount; + int? amount; # The amount of `currency` to which `bitcoin_amount_received` has been converted. - int amount_received; + int? amount_received; # The amount of bitcoin that the customer should send to fill the receiver. The `bitcoin_amount` is denominated in Satoshi: there are 10^8 Satoshi in one bitcoin. - int bitcoin_amount; + int? bitcoin_amount; # The amount of bitcoin that has been sent by the customer to this receiver. - int bitcoin_amount_received; + int? bitcoin_amount_received; # This URI can be displayed to the customer as a clickable link (to activate their bitcoin client) or as a QR code (for mobile wallets). - string bitcoin_uri; + string? bitcoin_uri; # Time at which the object was created. Measured in seconds since the Unix epoch. - int created; + int? created; # Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) to which the bitcoin will be converted. - string currency; + string? currency; # The customer ID of the bitcoin receiver. string? customer?; # An arbitrary string attached to the object. Often useful for displaying to users. @@ -2137,36 +2121,36 @@ public type BitcoinReceiver record { # The customer's email address, set by the API call that creates the receiver. string? email?; # This flag is initially false and updates to true when the customer sends the `bitcoin_amount` to this receiver. - boolean filled; + boolean? filled; # Unique identifier for the object. - string id; + string? id; # A bitcoin address that is specific to this receiver. The customer can send bitcoin to this address to fill the receiver. - string inbound_address; + string? inbound_address; # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. - boolean livemode; + boolean? livemode; # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. record {} metadata?; # String representing the object's type. Objects of the same type share the same value. - string 'object; + string? 'object; # The ID of the payment created from the receiver, if any. Hidden when viewing the receiver with a publishable key. string? payment?; # The refund address of this bitcoin receiver. string? refund_address?; # A list with one entry for each time that the customer sent bitcoin to the receiver. Hidden when viewing the receiver with a publishable key. - BitcoinTransactionList transactions?; + BitcoinTransactionList? transactions?; # This receiver contains uncaptured funds that can be used for a payment or refunded. - boolean uncaptured_funds; + boolean? uncaptured_funds; # Indicate if this source is used for payment. boolean? used_for_payment?; }; public type PortalFeatures record { - PortalCustomerUpdate customer_update; - PortalInvoiceList invoice_history; - PortalPaymentMethodUpdate payment_method_update; - PortalSubscriptionCancel subscription_cancel; - PortalSubscriptionPause subscription_pause; - PortalSubscriptionUpdate subscription_update; + PortalCustomerUpdate? customer_update; + PortalInvoiceList? invoice_history; + PortalPaymentMethodUpdate? payment_method_update; + PortalSubscriptionCancel? subscription_cancel; + PortalSubscriptionPause? subscription_pause; + PortalSubscriptionUpdate? subscription_update; }; # Stores representations of [stock keeping units](http://en.wikipedia.org/wiki/Stock_keeping_unit). @@ -2179,48 +2163,48 @@ public type PortalFeatures record { # Related guide: [Tax, Shipping, and Inventory](https://stripe.com/docs/orders). public type Sku record { # Whether the SKU is available for purchase. - boolean active; + boolean? active; # A dictionary of attributes and values for the attributes defined by the product. If, for example, a product's attributes are `["size", "gender"]`, a valid SKU has the following dictionary of attributes: `{"size": "Medium", "gender": "Unisex"}`. record {} attributes; # Time at which the object was created. Measured in seconds since the Unix epoch. - int created; + int? created; # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). - string currency; + string? currency; # Unique identifier for the object. - string id; + string? id; # The URL of an image for this SKU, meant to be displayable to the customer. string? image?; # Description of the SKU’s inventory - SkuInventory inventory; + SkuInventory? inventory; # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. - boolean livemode; + boolean? livemode; # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. record {} metadata; # String representing the object's type. Objects of the same type share the same value. - string 'object; + string? 'object; # The dimensions of this SKU for shipping purposes. PackageDimensions? package_dimensions?; # The cost of the item as a positive integer in the smallest currency unit (that is, 100 cents to charge $1.00, or 100 to charge ¥100, Japanese Yen being a zero-decimal currency). - int price; + int? price; # The ID of the product this SKU is associated with. The product must be currently active. - string|Product product; + string|Product? product; # Time at which the object was last updated. Measured in seconds since the Unix epoch. - int updated; + int? updated; }; public type DisputeEvidenceDetails record { # Date by which evidence must be submitted in order to successfully challenge dispute. Will be null if the customer's bank or credit card company doesn't allow a response for this particular dispute. int? due_by?; # Whether evidence has been staged for this dispute. - boolean has_evidence; + boolean? has_evidence; # Whether the last evidence submission was submitted past the due date. Defaults to `false` if no evidence submissions have occurred. If `true`, then delivery of the latest evidence is *not* guaranteed. - boolean past_due; + boolean? past_due; # The number of times evidence has been submitted. Typically, you may only submit evidence once. - int submission_count; + int? submission_count; }; public type PaymentIntentPaymentMethodOptionsSepaDebit record { - PaymentIntentPaymentMethodOptionsMandateOptionsSepaDebit mandate_options?; + PaymentIntentPaymentMethodOptionsMandateOptionsSepaDebit? mandate_options?; }; public type PaymentMethodDetailsAfterpayClearpay record { @@ -2230,12 +2214,12 @@ public type PaymentMethodDetailsAfterpayClearpay record { public type SourceMandateNotificationAcssDebitData record { # The statement descriptor associate with the debit. - string statement_descriptor?; + string? statement_descriptor?; }; public type SigmaScheduledQueryRunError record { # Information about the run failure. - string message; + string? message; }; public type GelatoReportIdNumberOptions record { @@ -2259,26 +2243,26 @@ public type Address record { # Automatic tax settings for this subscription. public type AutomaticTaxConfig record { # Enabled - boolean enabled; + boolean? enabled; }; public type UsageRecordSummary record { # Unique identifier for the object. - string id; + string? id; # The invoice in which this usage period has been billed for. string? invoice?; # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. - boolean livemode; + boolean? livemode; # String representing the object's type. Objects of the same type share the same value. - string 'object; - Period period; + string? 'object; + Period? period; # The ID of the subscription item this summary is describing. - string subscription_item; + string? subscription_item; # The total usage within this usage period. - int total_usage; + int? total_usage; }; -public type PaymentSource Account|AlipayAccount|BankAccount|BitcoinReceiver|Card|Source; +public type PaymentSource Account|AlipayAccount|BankAccount|BitcoinReceiver|Card|Source?; # Tokenization is the process Stripe uses to collect sensitive card or bank # account details, or personally identifiable information (PII), directly from @@ -2310,55 +2294,55 @@ public type Token record { # They can be bank accounts or debit cards as well, and are documented in the links above. # # Related guide: [Bank Debits and Transfers](https://stripe.com/docs/payments/bank-debits-transfers). - BankAccount bank_account?; + BankAccount? bank_account?; # You can store multiple cards on a customer in order to charge the customer # later. You can also store multiple debit cards on a recipient in order to # transfer to those cards later. # # Related guide: [Card Payments with Sources](https://stripe.com/docs/sources/cards). - Card card?; + Card? card?; # IP address of the client that generated the token. string? client_ip?; # Time at which the object was created. Measured in seconds since the Unix epoch. - int created; + int? created; # Unique identifier for the object. - string id; + string? id; # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. - boolean livemode; + boolean? livemode; # String representing the object's type. Objects of the same type share the same value. - string 'object; + string? 'object; # Type of the token: `account`, `bank_account`, `card`, or `pii`. - string 'type; + string? 'type; # Whether this token has already been used (tokens can be used only once). - boolean used; + boolean? used; }; public type CustomerCardDetails record { - string address_city?; - string address_country?; - string address_line1?; - string address_line2?; - string address_state?; - string address_zip?; - string cvc?; - int exp_month; - int exp_year; + string? address_city?; + string? address_country?; + string? address_line1?; + string? address_line2?; + string? address_state?; + string? address_zip?; + string? cvc?; + int? exp_month; + int? exp_year; record {} metadata?; - string name?; - string number; - string 'object?; + string? name?; + string? number; + string? 'object?; }; -public type SubscriptionCancelAt1 int|string; +public type SubscriptionCancelAt1 int|string?; # A phase describes the plans, coupon, and trialing status of a subscription for a predefined time period. public type SubscriptionSchedulePhaseConfiguration record { # A list of prices and quantities that will generate invoice items appended to the first invoice for this phase. - SubscriptionScheduleAddInvoiceItem[] add_invoice_items; + SubscriptionScheduleAddInvoiceItem[]? add_invoice_items; # A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the application owner's Stripe account during this phase of the schedule. decimal? application_fee_percent?; # Automatic tax configuration details - SchedulesPhaseAutomaticTax automatic_tax?; + SchedulesPhaseAutomaticTax? automatic_tax?; # Possible values are `phase_start` or `automatic`. If `phase_start` then billing cycle anchor of the subscription is set to the start of the phase when entering the phase. If `automatic` then the billing cycle anchor is automatically modified as needed when entering the phase. For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle). string? billing_cycle_anchor?; # Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period @@ -2372,15 +2356,15 @@ public type SubscriptionSchedulePhaseConfiguration record { # The default tax rates to apply to the subscription during this phase of the subscription schedule. TaxRate[]? default_tax_rates?; # The end of this phase of the subscription schedule. - int end_date; + int? end_date; # The invoice settings applicable during this phase. InvoiceSettingSubscriptionScheduleSetting? invoice_settings?; # Subscription items to configure the subscription to during this phase of the subscription schedule. - SubscriptionScheduleConfigurationItem[] items; + SubscriptionScheduleConfigurationItem[]? items; # If the subscription schedule will prorate when transitioning to this phase. Possible values are `create_prorations` and `none`. - string proration_behavior; + string? proration_behavior; # The start of this phase of the subscription schedule. - int start_date; + int? start_date; # The account (if any) the associated 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. SubscriptionTransferData? transfer_data?; # When the trial ends within the phase. @@ -2423,53 +2407,53 @@ public type IssuingCardholderIndividual record { # The date of birth of this cardholder. IssuingCardholderIndividualDob? dob?; # The first name of this cardholder. - string first_name; + string? first_name; # The last name of this cardholder. - string last_name; + string? last_name; # Government-issued ID document for this cardholder. IssuingCardholderVerification? verification?; }; public type OneTimePriceData record { - string currency; - string product; - string tax_behavior?; - int unit_amount?; - string unit_amount_decimal?; + string? currency; + string? product; + string? tax_behavior?; + int? unit_amount?; + string? unit_amount_decimal?; }; # Payment settings to pass to invoices created by the subscription. public type PaymentSettings2 record { - PaymentMethodOptions payment_method_options?; - string[]|string payment_method_types?; + PaymentMethodOptions? payment_method_options?; + string[]|string? payment_method_types?; }; # Payment settings to pass to invoices created by the subscription. public type PaymentSettings1 record { - PaymentMethodOptions1 payment_method_options?; - PaymentMethodTypesArray|string payment_method_types?; + PaymentMethodOptions1? payment_method_options?; + PaymentMethodTypesArray|string? payment_method_types?; }; public type BillingDetailsAddress record { - string city?; - string country?; - string line1?; - string line2?; - string postal_code?; - string state?; + string? city?; + string? country?; + string? line1?; + string? line2?; + string? postal_code?; + string? state?; }; # Evidence for the dispute. Evidence contains exactly two non-null fields: the reason for the dispute and the associated evidence field for the selected reason public type IssuingDisputeEvidence record { - IssuingDisputeCanceledEvidence canceled?; - IssuingDisputeDuplicateEvidence duplicate?; - IssuingDisputeFraudulentEvidence fraudulent?; - IssuingDisputeMerchandiseNotAsDescribedEvidence merchandise_not_as_described?; - IssuingDisputeNotReceivedEvidence not_received?; - IssuingDisputeOtherEvidence other?; + IssuingDisputeCanceledEvidence? canceled?; + IssuingDisputeDuplicateEvidence? duplicate?; + IssuingDisputeFraudulentEvidence? fraudulent?; + IssuingDisputeMerchandiseNotAsDescribedEvidence? merchandise_not_as_described?; + IssuingDisputeNotReceivedEvidence? not_received?; + IssuingDisputeOtherEvidence? other?; # The reason for filing the dispute. Its value will match the field containing the evidence. - string reason; - IssuingDisputeServiceNotAsDescribedEvidence service_not_as_described?; + string? reason; + IssuingDisputeServiceNotAsDescribedEvidence? service_not_as_described?; }; public type AccountBrandingSettings record { @@ -2484,17 +2468,17 @@ public type AccountBrandingSettings record { }; public type SetupAttemptPaymentMethodDetails record { - SetupAttemptPaymentMethodDetailsAcssDebit acss_debit?; - SetupAttemptPaymentMethodDetailsAuBecsDebit au_becs_debit?; - SetupAttemptPaymentMethodDetailsBacsDebit bacs_debit?; - SetupAttemptPaymentMethodDetailsBancontact bancontact?; - SetupAttemptPaymentMethodDetailsCard card?; - SetupAttemptPaymentMethodDetailsCardPresent card_present?; - SetupAttemptPaymentMethodDetailsIdeal ideal?; - SetupAttemptPaymentMethodDetailsSepaDebit sepa_debit?; - SetupAttemptPaymentMethodDetailsSofort sofort?; + SetupAttemptPaymentMethodDetailsAcssDebit? acss_debit?; + SetupAttemptPaymentMethodDetailsAuBecsDebit? au_becs_debit?; + SetupAttemptPaymentMethodDetailsBacsDebit? bacs_debit?; + SetupAttemptPaymentMethodDetailsBancontact? bancontact?; + SetupAttemptPaymentMethodDetailsCard? card?; + SetupAttemptPaymentMethodDetailsCardPresent? card_present?; + SetupAttemptPaymentMethodDetailsIdeal? ideal?; + SetupAttemptPaymentMethodDetailsSepaDebit? sepa_debit?; + SetupAttemptPaymentMethodDetailsSofort? sofort?; # The type of the payment method used in the SetupIntent (e.g., `card`). An additional hash is included on `payment_method_details` with a name matching this value. It contains confirmation-specific information for the payment method. - string 'type; + string? 'type; }; # This is an object representing a capability for a Stripe account. @@ -2502,35 +2486,35 @@ public type SetupAttemptPaymentMethodDetails record { # Related guide: [Account capabilities](https://stripe.com/docs/connect/account-capabilities). public type Capability record { # The account for which the capability enables functionality. - string|Account account; + string|Account? account; # The identifier for the capability. - string id; + string? id; # String representing the object's type. Objects of the same type share the same value. - string 'object; + string? 'object; # Whether the capability has been requested. - boolean requested; + boolean? requested; # Time at which the capability was requested. Measured in seconds since the Unix epoch. int? requested_at?; - AccountCapabilityRequirements requirements?; + AccountCapabilityRequirements? requirements?; # The status of the capability. Can be `active`, `inactive`, `pending`, or `unrequested`. - string status; + string? status; }; public type PaymentMethodOptions record { - record {string preferred_language?;}|string bancontact?; - record {string request_three_d_secure?;}|string card?; + record {string? preferred_language?;}|string? bancontact?; + record {string? request_three_d_secure?;}|string? card?; }; # A list of returns that have taken place for this order. public type OrdersResourceOrderReturnList record { # Details about each object. - OrderReturn[] data; + OrderReturn[]? data; # True if this list has another page of items after this one that can be fetched. - boolean has_more; + boolean? has_more; # String representing the object's type. Objects of the same type share the same value. Always has the value `list`. - string 'object; + string? 'object; # The URL where this list can be accessed. - string url; + string? url; }; # Point in Time @@ -2543,31 +2527,31 @@ public type GelatoDataDocumentReportExpirationDate record { int? year?; }; -public type CreatedDetails CreatedFilterOptions|int; +public type CreatedDetails CreatedFilterOptions|int?; public type LineItemsTaxAmount record { # Amount of tax applied for this rate. - int amount; + int? amount; # Tax rates can be applied to [invoices](https://stripe.com/docs/billing/invoices/tax-rates), [subscriptions](https://stripe.com/docs/billing/subscriptions/taxes) and [Checkout Sessions](https://stripe.com/docs/payments/checkout/set-up-a-subscription#tax-rates) to collect tax. # # Related guide: [Tax Rates](https://stripe.com/docs/billing/taxes/tax-rates). - TaxRate rate; + TaxRate? rate; }; public type SetupIntentPaymentMethodOptionsAcssDebit record { # Currency supported by the bank account string? currency?; - SetupIntentPaymentMethodOptionsMandateOptionsAcssDebit mandate_options?; + SetupIntentPaymentMethodOptionsMandateOptionsAcssDebit? mandate_options?; # Bank account verification method. - string verification_method?; + string? verification_method?; }; public type SetupAttemptPaymentMethodDetailsAcssDebit record { }; public type DataParams record { - string 'type; - string value; + string? 'type; + string? value; }; public type IssuingCardholderIdDocument record { @@ -2594,11 +2578,11 @@ public type IssuingDisputeDuplicateEvidence record { public type Application record { # Unique identifier for the object. - string id; + string? id; # The name of the application. string? name?; # String representing the object's type. Objects of the same type share the same value. - string 'object; + string? 'object; }; # This is an object representing a person associated with a Stripe account. @@ -2609,13 +2593,13 @@ public type Application record { # Related guide: [Handling Identity Verification with the API](https://stripe.com/docs/connect/identity-verification-api#person-information). public type Person record { # The account the person is associated with. - string account; - Address address?; + string? account; + Address? address?; LegalEntityJapanAddress? address_kana?; LegalEntityJapanAddress? address_kanji?; # Time at which the object was created. Measured in seconds since the Unix epoch. - int created; - LegalEntityDob dob?; + int? created; + LegalEntityDob? dob?; # The person's email address. string? email?; # The person's first name. @@ -2627,9 +2611,9 @@ public type Person record { # The person's gender (International regulations require either "male" or "female"). string? gender?; # Unique identifier for the object. - string id; + string? id; # Whether the person's `id_number` was provided. - boolean id_number_provided?; + boolean? id_number_provided?; # The person's last name. string? last_name?; # The Kana variation of the person's last name (Japan only). @@ -2643,16 +2627,16 @@ public type Person record { # The country where the person is a national. string? nationality?; # String representing the object's type. Objects of the same type share the same value. - string 'object; + string? 'object; # The person's phone number. string? phone?; # 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. - string political_exposure?; - PersonRelationship relationship?; + string? political_exposure?; + PersonRelationship? relationship?; PersonRequirements? requirements?; # Whether the last four digits of the person's Social Security number have been provided (U.S. only). - boolean ssn_last_4_provided?; - LegalEntityPersonVerification verification?; + boolean? ssn_last_4_provided?; + LegalEntityPersonVerification? verification?; }; public type QuotesResourceStatusTransitions record { @@ -2666,7 +2650,7 @@ public type QuotesResourceStatusTransitions record { public type InvoiceVoidBody record { # Specifies which fields in the response should be expanded. - string[] expand?; + string[]? expand?; }; # A discount represents the actual application of a coupon to a particular @@ -2680,23 +2664,23 @@ public type Discount record { # A coupon contains information about a percent-off or amount-off discount you # might want to apply to a customer. Coupons may be applied to [invoices](https://stripe.com/docs/api#invoices) or # [orders](https://stripe.com/docs/api#create_order-coupon). Coupons do not work with conventional one-off [charges](https://stripe.com/docs/api#create_charge). - Coupon coupon; + Coupon? coupon; # The ID of the customer associated with this discount. string|Customer|DeletedCustomer? customer?; # 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. int? end?; # The ID of the discount object. Discounts cannot be fetched by ID. Use `expand[]=discounts` in API calls to expand discount IDs in an array. - string id; + string? id; # The invoice that the discount's coupon was applied to, if it was applied directly to a particular invoice. string? invoice?; # The invoice item `id` (or invoice line item `id` for invoice line items of type='subscription') that the discount's coupon was applied to, if it was applied directly to a particular invoice item or invoice line item. string? invoice_item?; # String representing the object's type. Objects of the same type share the same value. - string 'object; + string? 'object; # The promotion code applied to create this discount. string|PromotionCode? promotion_code?; # Date that the coupon was applied. - int 'start; + int? 'start; # The subscription that this coupon is applied to, if it is applied to a particular subscription. string? subscription?; }; @@ -2712,7 +2696,7 @@ public type PaymentMethodDetailsBacsDebit record { string? sort_code?; }; -public type CurrentPeriodStart RangeQuerySpecs|int; +public type CurrentPeriodStart RangeQuerySpecs|int?; # Result from a document check public type GelatoDocumentReport record { @@ -2737,35 +2721,35 @@ public type GelatoDocumentReport record { # Document ID number. string? number?; # Status of this `document` check. - string status; + string? status; # Type of the document. string? 'type?; }; public type SourceTypeCardPresent record { - string application_cryptogram?; - string application_preferred_name?; + string? application_cryptogram?; + string? application_preferred_name?; string? authorization_code?; - string authorization_response_code?; + string? authorization_response_code?; string? brand?; string? country?; - string cvm_type?; + string? cvm_type?; string? data_type?; - string dedicated_file_name?; - string emv_auth_data?; + string? dedicated_file_name?; + string? emv_auth_data?; string? evidence_customer_signature?; string? evidence_transaction_certificate?; int? exp_month?; int? exp_year?; - string fingerprint?; + string? fingerprint?; string? funding?; string? last4?; string? pos_device_id?; - string pos_entry_mode?; + string? pos_entry_mode?; string? read_method?; string? reader?; - string terminal_verification_results?; - string transaction_status_information?; + string? terminal_verification_results?; + string? transaction_status_information?; }; public type RadarReviewResourceSession record { @@ -2781,30 +2765,30 @@ public type RadarReviewResourceSession record { public type TransferSchedule record { # The number of days charges for the account will be held before being paid out. - int delay_days; + int? delay_days; # How frequently funds will be paid out. One of `manual` (payouts only created via API call), `daily`, `weekly`, or `monthly`. - string interval; + string? interval; # The day of the month funds will be paid out. Only shown if `interval` is monthly. Payouts scheduled between the 29th and 31st of the month are sent on the last day of shorter months. - int monthly_anchor?; + int? monthly_anchor?; # The day of the week funds will be paid out, of the style 'monday', 'tuesday', etc. Only shown if `interval` is weekly. - string weekly_anchor?; + string? weekly_anchor?; }; # If specified, the funds from the invoice will be transferred to the destination and the ID of the resulting transfer will be found on the invoice's charge. public type TransferDataSpecs1 record { - int amount?; - string destination; + int? amount?; + string? destination; }; # If specified, the funds from the subscription's invoices will be transferred to the destination and the ID of the resulting transfers will be found on the resulting charges. public type TransferDataSpecs2 record { - decimal amount_percent?; - string destination; + decimal? amount_percent?; + string? destination; }; public type CheckoutAcssDebitMandateOptions record { # A URL for custom mandate text - string custom_mandate_url?; + string? custom_mandate_url?; # Description of the interval. Only required if the 'payment_schedule' parameter is 'interval' or 'combined'. string? interval_description?; # Payment schedule for the mandate. @@ -2816,7 +2800,7 @@ public type CheckoutAcssDebitMandateOptions record { # An Add Invoice Item describes the prices and quantities that will be added as pending invoice items when entering a phase. public type SubscriptionScheduleAddInvoiceItem record { # ID of the price used to generate the invoice item. - string|Price|DeletedPrice price; + string|Price|DeletedPrice? price; # The quantity of the invoice item. int? quantity?; # The tax rates which apply to the item. When set, the `default_tax_rates` do not apply to this item. @@ -2824,8 +2808,8 @@ public type SubscriptionScheduleAddInvoiceItem record { }; public type TransferDataSpecs3 record { - decimal amount_percent?; - string destination; + decimal? amount_percent?; + string? destination; }; public type SourceTypeSofort record { @@ -2839,31 +2823,31 @@ public type SourceTypeSofort record { }; public type PhaseConfigurationParams1 record { - AddInvoiceItemEntry1[] add_invoice_items?; - decimal application_fee_percent?; - AutomaticTaxConfig3 automatic_tax?; - string billing_cycle_anchor?; - BillingThresholdParams|string billing_thresholds?; - string collection_method?; - string coupon?; - string default_payment_method?; - string[]|string default_tax_rates?; - int|string end_date?; - SubscriptionSchedulesParam1 invoice_settings?; - ConfigurationItemParams[] items; - int iterations?; - string proration_behavior?; - int|string start_date?; - TransferDataSpecs3 transfer_data?; - boolean trial?; - int|string trial_end?; + AddInvoiceItemEntry1[]? add_invoice_items?; + decimal? application_fee_percent?; + AutomaticTaxConfig3? automatic_tax?; + string? billing_cycle_anchor?; + BillingThresholdParams|string? billing_thresholds?; + string? collection_method?; + string? coupon?; + string? default_payment_method?; + string[]|string? default_tax_rates?; + int|string? end_date?; + SubscriptionSchedulesParam1? invoice_settings?; + ConfigurationItemParams[]? items; + int? iterations?; + string? proration_behavior?; + int|string? start_date?; + TransferDataSpecs3? transfer_data?; + boolean? trial?; + int|string? trial_end?; }; public type SourceCodeVerificationFlow record { # The number of attempts remaining to authenticate the source object with a verification code. - int attempts_remaining; + int? attempts_remaining; # The status of the code verification, either `pending` (awaiting verification, `attempts_remaining` should be greater than 0), `succeeded` (successful verification) or `failed` (failed verification, cannot be verified anymore as `attempts_remaining` should be 0). - string status; + string? status; }; # This resource has been renamed to [Early Fraud @@ -2871,35 +2855,35 @@ public type SourceCodeVerificationFlow record { # version. public type IssuerFraudRecord record { # An IFR is actionable if it has not received a dispute and has not been fully refunded. You may wish to proactively refund a charge that receives an IFR, in order to avoid receiving a dispute later. - boolean actionable; + boolean? actionable; # ID of the charge this issuer fraud record is for, optionally expanded. - string|Charge charge; + string|Charge? charge; # Time at which the object was created. Measured in seconds since the Unix epoch. - int created; + int? created; # The type of fraud labelled by the issuer. One of `card_never_received`, `fraudulent_card_application`, `made_with_counterfeit_card`, `made_with_lost_card`, `made_with_stolen_card`, `misc`, `unauthorized_use_of_card`. - string fraud_type; + string? fraud_type; # If true, the associated charge is subject to [liability shift](https://stripe.com/docs/payments/3d-secure#disputed-payments). - boolean has_liability_shift; + boolean? has_liability_shift; # Unique identifier for the object. - string id; + string? id; # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. - boolean livemode; + boolean? livemode; # String representing the object's type. Objects of the same type share the same value. - string 'object; + string? 'object; # The timestamp at which the card issuer posted the issuer fraud record. - int post_date; + int? post_date; }; public type ThreeDSecureUsage record { # Whether 3D Secure is supported on this card. - boolean supported; + boolean? supported; }; public type RangeQuerySpecs record { - int gt?; - int gte?; - int lt?; - int lte?; + int? gt?; + int? gte?; + int? lt?; + int? lte?; }; public type SepaDebitGeneratedFrom record { @@ -2926,11 +2910,11 @@ public type PaymentIntentNextActionRedirectToUrl record { # Related guide: [Fleet Management](https://stripe.com/docs/terminal/creating-locations). public type TerminalConnectionToken record { # The id of the location that this connection token is scoped to. Note that location scoping only applies to internet-connected readers. For more details, see [the docs on scoping connection tokens](https://stripe.com/docs/terminal/readers/fleet-management#connection-tokens). - string location?; + string? location?; # String representing the object's type. Objects of the same type share the same value. - string 'object; + string? 'object; # Your application should pass this token to the Stripe Terminal SDK. - string secret; + string? secret; }; public type PaymentMethodDetailsAchDebit record { @@ -2966,32 +2950,32 @@ public type SetupIntentNextActionRedirectToUrl record { }; public type CustomerDetailsParam1 record { - CustomerAdresss|string address?; - CustomerAddressWithName|string shipping?; - TaxParam1 tax?; - string tax_exempt?; - DataParams[] tax_ids?; + CustomerAdresss|string? address?; + CustomerAddressWithName|string? shipping?; + TaxParam1? tax?; + string? tax_exempt?; + DataParams[]? tax_ids?; }; public type PaymentMethodOptionsCardPresent record { }; -public type CurrentPeriodEnd RangeQuerySpecs|int; +public type CurrentPeriodEnd RangeQuerySpecs|int?; public type PaymentIntentPaymentMethodOptions record { - PaymentIntentPaymentMethodOptionsAcssDebit acss_debit?; - PaymentMethodOptionsAfterpayClearpay afterpay_clearpay?; - PaymentMethodOptionsAlipay alipay?; - PaymentMethodOptionsBancontact bancontact?; - PaymentMethodOptionsBoleto boleto?; - PaymentIntentPaymentMethodOptionsCard card?; - PaymentMethodOptionsCardPresent card_present?; - PaymentMethodOptionsIdeal ideal?; - PaymentMethodOptionsOxxo oxxo?; - PaymentMethodOptionsP24 p24?; - PaymentIntentPaymentMethodOptionsSepaDebit sepa_debit?; - PaymentMethodOptionsSofort sofort?; - PaymentMethodOptionsWechatPay wechat_pay?; + PaymentIntentPaymentMethodOptionsAcssDebit? acss_debit?; + PaymentMethodOptionsAfterpayClearpay? afterpay_clearpay?; + PaymentMethodOptionsAlipay? alipay?; + PaymentMethodOptionsBancontact? bancontact?; + PaymentMethodOptionsBoleto? boleto?; + PaymentIntentPaymentMethodOptionsCard? card?; + PaymentMethodOptionsCardPresent? card_present?; + PaymentMethodOptionsIdeal? ideal?; + PaymentMethodOptionsOxxo? oxxo?; + PaymentMethodOptionsP24? p24?; + PaymentIntentPaymentMethodOptionsSepaDebit? sepa_debit?; + PaymentMethodOptionsSofort? sofort?; + PaymentMethodOptionsWechatPay? wechat_pay?; }; # `Application Fee Refund` objects allow you to refund an application fee that @@ -3001,57 +2985,57 @@ public type PaymentIntentPaymentMethodOptions record { # Related guide: [Refunding Application Fees](https://stripe.com/docs/connect/destination-charges#refunding-app-fee). public type FeeRefund record { # Amount, in %s. - int amount; + int? amount; # Balance transaction that describes the impact on your account balance. string|BalanceTransaction? balance_transaction?; # Time at which the object was created. Measured in seconds since the Unix epoch. - int created; + int? created; # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). - string currency; + string? currency; # ID of the application fee that was refunded. - string|ApplicationFee fee; + string|ApplicationFee? fee; # Unique identifier for the object. - string id; + string? id; # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. record {} metadata?; # String representing the object's type. Objects of the same type share the same value. - string 'object; + string? 'object; }; public type CardInvoicePaymentMethodOptionsParam record { - string request_three_d_secure?; + string? request_three_d_secure?; }; public type CustomerBankAccountDetails record { - string account_holder_name?; - string account_holder_type?; - string account_number; - string country; - string currency?; - string 'object?; - string routing_number?; + string? account_holder_name?; + string? account_holder_type?; + string? account_number; + string? country; + string? currency?; + string? 'object?; + string? routing_number?; }; public type PersonRequirements record { # Fields that need to be collected to keep the person's account enabled. If not collected by the account's `current_deadline`, these fields appear in `past_due` as well, and the account is disabled. - string[] currently_due; + string[]? currently_due; # Fields that are `currently_due` and need to be collected again because validation or verification failed. - AccountRequirementsError[] errors; + AccountRequirementsError[]? errors; # Fields that need to be collected assuming all volume thresholds are reached. As they become required, they appear in `currently_due` as well, and the account's `current_deadline` becomes set. - string[] eventually_due; + string[]? eventually_due; # Fields that weren't collected by the account's `current_deadline`. These fields need to be collected to enable the person's account. - string[] past_due; + string[]? past_due; # Fields that may become required depending on the results of verification or review. Will be an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due`, `currently_due`, or `past_due`. - string[] pending_verification; + string[]? pending_verification; }; public type AccountRequirementsError record { # The code for the type of error. - string code; + string? code; # An informative message that indicates the error type and provides additional details about the error. - string reason; + string? reason; # The specific user onboarding requirement field (in the requirements hash) that needs to be resolved. - string requirement; + string? requirement; }; public type PaymentMethodOxxo record { @@ -3066,11 +3050,11 @@ public type GelatoDocumentReportError record { public type DeletedApplePayDomain record { # Always true for a deleted object - boolean deleted; + boolean? deleted; # Unique identifier for the object. - string id; + string? id; # String representing the object's type. Objects of the same type share the same value. - string 'object; + string? 'object; }; public type PaymentMethodDetailsAchCreditTransfer record { @@ -3089,16 +3073,16 @@ public type SubscriptionScheduleConfigurationItem record { # Define thresholds at which an invoice will be sent, and the related subscription advanced to a new billing period SubscriptionItemBillingThresholds? billing_thresholds?; # ID of the price to which the customer should be subscribed. - string|Price|DeletedPrice price; + string|Price|DeletedPrice? price; # Quantity of the plan to which the customer should be subscribed. - int quantity?; + int? quantity?; # The tax rates which apply to this `phase_item`. When set, the `default_tax_rates` on the phase do not apply to this `phase_item`. TaxRate[]? tax_rates?; }; public type PaymentMethodDetailsInteracPresentReceipt record { # The type of account being debited or credited - string account_type?; + string? account_type?; # EMV tag 9F26, cryptogram generated by the integrated circuit chip. string? application_cryptogram?; # Mnenomic of the Application Identifier. @@ -3128,7 +3112,7 @@ public type SourceTypeBancontact record { public type SubscriptionAutomaticTax record { # Whether Stripe automatically computes tax on this subscription. - boolean enabled; + boolean? enabled; }; public type PaymentMethodOptionsWechatPay record { @@ -3139,36 +3123,36 @@ public type PaymentMethodOptionsWechatPay record { }; public type RecurringAdhoc record { - string interval; - int interval_count?; + string? interval; + int? interval_count?; }; public type ScheduleCancelBody record { # Specifies which fields in the response should be expanded. - string[] expand?; + string[]? expand?; # If the subscription schedule is `active`, indicates if a final invoice will be generated that contains any un-invoiced metered usage and new/pending proration invoice items. Defaults to `true`. - boolean invoice_now?; + boolean? invoice_now?; # If the subscription schedule is `active`, indicates if the cancellation should be prorated. Defaults to `true`. - boolean prorate?; + boolean? prorate?; }; public type QuotesResourceUpfront record { # Total before any discounts or taxes are applied. - int amount_subtotal; + int? amount_subtotal; # Total after discounts and taxes are applied. - int amount_total; + int? amount_total; # The line items that will appear on the next invoice after this quote is accepted. This does not include pending invoice items that exist on the customer but may still be included in the next invoice. - Quotesresourcelistlineitems1 line_items?; - QuotesResourceTotalDetails total_details; + Quotesresourcelistlineitems1? line_items?; + QuotesResourceTotalDetails? total_details; }; public type DeletedAlipayAccount record { # Always true for a deleted object - boolean deleted; + boolean? deleted; # Unique identifier for the object. - string id; + string? id; # String representing the object's type. Objects of the same type share the same value. - string 'object; + string? 'object; }; public type PaymentIntentNextActionAlipayHandleRedirect record { @@ -3193,13 +3177,13 @@ public type SourceTypeIdeal record { }; public type CustomerResourceCustomerList record { - Customer[] data; + Customer[]? data; # True if this list has another page of items after this one that can be fetched. - boolean has_more; + boolean? has_more; # String representing the object's type. Objects of the same type share the same value. Always has the value `list`. - string 'object; + string? 'object; # The URL where this list can be accessed. - string url; + string? url; }; public type AccountPaymentsSettings record { @@ -3213,25 +3197,25 @@ public type AccountPaymentsSettings record { public type PortalCustomerUpdate record { # The types of customer updates that are supported. When empty, customers are not updateable. - string[] allowed_updates; + string[]? allowed_updates; # Whether the feature is enabled. - boolean enabled; + boolean? enabled; }; public type InvoiceTransferData record { # The amount in %s that will be transferred to the destination account when the invoice is paid. By default, the entire amount is transferred to the destination. int? amount?; # The account where funds from the payment will be transferred to upon payment success. - string|Account destination; + string|Account? destination; }; public type MandateBacsDebit record { # The status of the mandate on the Bacs network. Can be one of `pending`, `revoked`, `refused`, or `accepted`. - string network_status; + string? network_status; # The unique reference identifying the mandate on the Bacs network. - string reference; + string? reference; # The URL that will contain the mandate that the customer has signed. - string url; + string? url; }; # With `Recipient` objects, you can transfer money from your Stripe account to a @@ -3249,16 +3233,16 @@ public type Recipient record { BankAccount? active_account?; CardList? cards?; # Time at which the object was created. Measured in seconds since the Unix epoch. - int created; + int? created; # The default card to use for creating transfers to this recipient. string|Card? default_card?; # An arbitrary string attached to the object. Often useful for displaying to users. string? description?; string? email?; # Unique identifier for the object. - string id; + string? id; # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. - boolean livemode; + boolean? livemode; # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. record {} metadata; # The ID of the [Custom account](https://stripe.com/docs/connect/custom-accounts) this recipient was migrated to. If set, the recipient can no longer be updated, nor can transfers be made to it: use the Custom account instead. @@ -3266,10 +3250,10 @@ public type Recipient record { # Full, legal name of the recipient. string? name?; # String representing the object's type. Objects of the same type share the same value. - string 'object; - string|Account rolled_back_from?; + string? 'object; + string|Account? rolled_back_from?; # Type of the recipient, one of `individual` or `corporation`. - string 'type; + string? 'type; }; public type ChargeOutcome record { @@ -3278,49 +3262,49 @@ public type ChargeOutcome record { # An enumerated value providing a more detailed explanation of the outcome's `type`. Charges blocked by Radar's default block rule have the value `highest_risk_level`. Charges placed in review by Radar's default review rule have the value `elevated_risk_level`. Charges authorized, blocked, or placed in review by custom rules have the value `rule`. See [understanding declines](https://stripe.com/docs/declines) for more details. string? reason?; # Stripe Radar's evaluation of the riskiness of the payment. Possible values for evaluated payments are `normal`, `elevated`, `highest`. For non-card payments, and card-based payments predating the public assignment of risk levels, this field will have the value `not_assessed`. In the event of an error in the evaluation, this field will have the value `unknown`. This field is only available with Radar. - string risk_level?; + string? risk_level?; # Stripe Radar's evaluation of the riskiness of the payment. Possible values for evaluated payments are between 0 and 100. For non-card payments, card-based payments predating the public assignment of risk scores, or in the event of an error during evaluation, this field will not be present. This field is only available with Radar for Fraud Teams. - int risk_score?; + int? risk_score?; # The ID of the Radar rule that matched the payment, if applicable. - string|Rule rule?; + string|Rule? rule?; # A human-readable description of the outcome type and reason, designed for you (the recipient of the payment), not your customer. string? seller_message?; # Possible values are `authorized`, `manual_review`, `issuer_declined`, `blocked`, and `invalid`. See [understanding declines](https://stripe.com/docs/declines) and [Radar reviews](https://stripe.com/docs/radar/reviews) for details. - string 'type; + string? 'type; }; # You can [create physical or virtual cards](https://stripe.com/docs/issuing/cards) that are issued to cardholders. public type IssuingCard record { # The brand of the card. - string brand; + string? brand; # The reason why the card was canceled. string? cancellation_reason?; # An Issuing `Cardholder` object represents an individual or business entity who is [issued](https://stripe.com/docs/issuing) cards. # # Related guide: [How to create a Cardholder](https://stripe.com/docs/issuing/cards#create-cardholder) - IssuingCardholder cardholder; + IssuingCardholder? cardholder; # Time at which the object was created. Measured in seconds since the Unix epoch. - int created; + int? created; # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). - string currency; + string? currency; # The card's CVC. For security reasons, this is only available for virtual cards, and will be omitted unless you explicitly request it with [the `expand` parameter](https://stripe.com/docs/api/expanding_objects). Additionally, it's only available via the ["Retrieve a card" endpoint](https://stripe.com/docs/api/issuing/cards/retrieve), not via "List all cards" or any other endpoint. - string cvc?; + string? cvc?; # The expiration month of the card. - int exp_month; + int? exp_month; # The expiration year of the card. - int exp_year; + int? exp_year; # Unique identifier for the object. - string id; + string? id; # The last 4 digits of the card number. - string last4; + string? last4; # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. - boolean livemode; + boolean? livemode; # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. record {} metadata; # The full unredacted card number. For security reasons, this is only available for virtual cards, and will be omitted unless you explicitly request it with [the `expand` parameter](https://stripe.com/docs/api/expanding_objects). Additionally, it's only available via the ["Retrieve a card" endpoint](https://stripe.com/docs/api/issuing/cards/retrieve), not via "List all cards" or any other endpoint. - string number?; + string? number?; # String representing the object's type. Objects of the same type share the same value. - string 'object; + string? 'object; # The latest card that replaces this card, if any. string|IssuingCard? replaced_by?; # The card this card replaces, if any. @@ -3329,32 +3313,32 @@ public type IssuingCard record { string? replacement_reason?; # Where and how the card will be shipped. IssuingCardShipping? shipping?; - IssuingCardAuthorizationControls spending_controls; + IssuingCardAuthorizationControls? spending_controls; # Whether authorizations can be approved on this card. - string status; + string? status; # The type of the card. - string 'type; + string? 'type; }; public type ScheduleReleaseBody record { # Specifies which fields in the response should be expanded. - string[] expand?; + string[]? expand?; # Keep any cancellation on the subscription that the schedule has set - boolean preserve_cancel_date?; + boolean? preserve_cancel_date?; }; public type CustomerAcceptance record { # The time at which the customer accepted the Mandate. int? accepted_at?; - OfflineAcceptance offline?; - OnlineAcceptance online?; + OfflineAcceptance? offline?; + OnlineAcceptance? online?; # The type of customer acceptance information included with the Mandate. One of `online` or `offline`. - string 'type; + string? 'type; }; public type PromotionCodesResourceRestrictions record { # A Boolean indicating if the Promotion Code should only be redeemed for Customers without any successful payments or invoices - boolean first_time_transaction; + boolean? first_time_transaction; # Minimum amount required to redeem this Promotion Code into a Coupon (e.g., a purchase must be $100 or more to work). int? minimum_amount?; # Three-letter [ISO code](https://stripe.com/docs/currencies) for minimum_amount @@ -3367,37 +3351,37 @@ public type PromotionCodesResourceRestrictions record { # retrieve the query results. public type ScheduledQueryRun record { # Time at which the object was created. Measured in seconds since the Unix epoch. - int created; + int? created; # When the query was run, Sigma contained a snapshot of your Stripe data at this time. - int data_load_time; - SigmaScheduledQueryRunError _error?; + int? data_load_time; + SigmaScheduledQueryRunError? _error?; # The file object representing the results of the query. File? file?; # Unique identifier for the object. - string id; + string? id; # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. - boolean livemode; + boolean? livemode; # String representing the object's type. Objects of the same type share the same value. - string 'object; + string? 'object; # Time at which the result expires and is no longer available for download. - int result_available_until; + int? result_available_until; # SQL for the query. - string sql; + string? sql; # The query's execution status, which will be `completed` for successful runs, and `canceled`, `failed`, or `timed_out` otherwise. - string status; + string? status; # Title of the query. - string title; + string? title; }; public type SubscriptionItemUsageRecordsBody record { # Valid values are `increment` (default) or `set`. When using `increment` the specified `quantity` will be added to the usage at the specified timestamp. The `set` action will overwrite the usage quantity at that timestamp. If the subscription has [billing thresholds](https://stripe.com/docs/api/subscriptions/object#subscription_object-billing_thresholds), `increment` is the only allowed value. - string action?; + string? action?; # Specifies which fields in the response should be expanded. - string[] expand?; + string[]? expand?; # The usage quantity for the specified timestamp. - int quantity; + int? quantity; # The timestamp for the usage event. This timestamp must be within the current billing period of the subscription of the provided `subscription_item`. - int timestamp; + int? timestamp; }; # Prices define the unit cost, currency, and (optional) billing cycle for both recurring and one-time purchases of products. @@ -3408,17 +3392,17 @@ public type SubscriptionItemUsageRecordsBody record { # Related guides: [Set up a subscription](https://stripe.com/docs/billing/subscriptions/set-up-subscription), [create an invoice](https://stripe.com/docs/billing/invoices/create), and more about [products and prices](https://stripe.com/docs/billing/prices-guide). public type Price record { # Whether the price can be used for new purchases. - boolean active; + boolean? active; # Describes 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. - string billing_scheme; + string? billing_scheme; # Time at which the object was created. Measured in seconds since the Unix epoch. - int created; + int? created; # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). - string currency; + string? currency; # Unique identifier for the object. - string id; + string? id; # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. - boolean livemode; + boolean? livemode; # A lookup key used to retrieve prices dynamically from a static string. string? lookup_key?; # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. @@ -3426,21 +3410,21 @@ public type Price record { # A brief description of the price, hidden from customers. string? nickname?; # String representing the object's type. Objects of the same type share the same value. - string 'object; + string? 'object; # The ID of the product this price is associated with. - string|Product|DeletedProduct product; + string|Product|DeletedProduct? product; # The recurring components of a price such as `interval` and `usage_type`. Recurring? recurring?; # 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. string? tax_behavior?; # Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`. - PriceTier[] tiers?; + PriceTier[]? tiers?; # 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. string? tiers_mode?; # Apply a transformation to the reported usage or set quantity before computing the amount billed. Cannot be combined with `tiers`. TransformQuantity? transform_quantity?; # One of `one_time` or `recurring` depending on whether the price is for a one-time purchase or a recurring (subscription) purchase. - string 'type; + string? 'type; # The unit amount in %s to be charged, represented as a whole integer if possible. Only set if `billing_scheme=per_unit`. int? unit_amount?; # The unit amount in %s to be charged, represented as a decimal string with at most 12 decimal places. Only set if `billing_scheme=per_unit`. @@ -3450,29 +3434,29 @@ public type Price record { # Automatic tax configuration details public type SchedulesPhaseAutomaticTax record { # Whether Stripe automatically computes tax on invoices created during this phase. - boolean enabled; + boolean? enabled; }; public type SetupIntentPaymentMethodOptions record { - SetupIntentPaymentMethodOptionsAcssDebit acss_debit?; - SetupIntentPaymentMethodOptionsCard card?; - SetupIntentPaymentMethodOptionsSepaDebit sepa_debit?; + SetupIntentPaymentMethodOptionsAcssDebit? acss_debit?; + SetupIntentPaymentMethodOptionsCard? card?; + SetupIntentPaymentMethodOptionsSepaDebit? sepa_debit?; }; public type CustomerAdresss record { - string city?; - string country?; - string line1?; - string line2?; - string postal_code?; - string state?; + string? city?; + string? country?; + string? line1?; + string? line2?; + string? postal_code?; + string? state?; }; public type TransformUsage record { # Divide usage by this number. - int divide_by; + int? divide_by; # After division, either round the result `up` or `down`. - string round; + string? round; }; public type PaymentMethodDetailsCardWalletVisaCheckout record { @@ -3488,69 +3472,69 @@ public type PaymentMethodDetailsCardWalletVisaCheckout record { public type TaxDeductedAtSource record { # Unique identifier for the object. - string id; + string? id; # String representing the object's type. Objects of the same type share the same value. - string 'object; + string? 'object; # The end of the invoicing period. This TDS applies to Stripe fees collected during this invoicing period. - int period_end; + int? period_end; # The start of the invoicing period. This TDS applies to Stripe fees collected during this invoicing period. - int period_start; + int? period_start; # The TAN that was supplied to Stripe when TDS was assessed - string tax_deduction_account_number; + string? tax_deduction_account_number; }; # Tax details about the customer. public type TaxParam record { - string|string ip_address?; + string|string? ip_address?; }; public type V1ProductsBody record { # Whether the product is currently available for purchase. Defaults to `true`. - boolean active?; + boolean? active?; # 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. - string description?; + string? description?; # Specifies which fields in the response should be expanded. - string[] expand?; + string[]? expand?; # An identifier will be randomly generated by Stripe. You can optionally override this ID, but the ID must be unique across all products in your Stripe account. - string id?; + string? id?; # A list of up to 8 URLs of images for this product, meant to be displayable to the customer. - string[] images?; + string[]? images?; # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. record {} metadata?; # The product's name, meant to be displayable to the customer. Whenever this product is sold via a subscription, name will show up on associated invoice line item descriptions. - string name; + string? name; # The dimensions of this product for shipping purposes. - PackageDimensionsSpecs package_dimensions?; + PackageDimensionsSpecs? package_dimensions?; # Whether this product is shipped (i.e., physical goods). - boolean shippable?; + boolean? shippable?; # An arbitrary string to be displayed on your customer's credit card or bank statement. While most banks display this information consistently, some may display it incorrectly or not at all. # # This may be up to 22 characters. The statement description may not include `<`, `>`, `\`, `"`, `'` characters, and will appear on your customer's statement in capital letters. Non-ASCII characters are automatically stripped. # It must contain at least one letter. - string statement_descriptor?; + string? statement_descriptor?; # A [tax code](https://stripe.com/docs/tax/tax-codes) ID. - string tax_code?; + string? tax_code?; # 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. - string unit_label?; + string? unit_label?; # A URL of a publicly-accessible webpage for this product. - string url?; + string? url?; }; public type InvoiceItemPreviewParams record { - int amount?; - string currency?; - string description?; - boolean discountable?; - DiscountsDataParam|string discounts?; - string invoiceitem?; - record {}|string metadata?; - Period1 period?; - string price?; - OneTimePriceData price_data?; - int quantity?; - string[]|string tax_rates?; - int unit_amount?; - string unit_amount_decimal?; + int? amount?; + string? currency?; + string? description?; + boolean? discountable?; + DiscountsDataParam|string? discounts?; + string? invoiceitem?; + record {}|string? metadata?; + Period1? period?; + string? price?; + OneTimePriceData? price_data?; + int? quantity?; + string[]|string? tax_rates?; + int? unit_amount?; + string? unit_amount_decimal?; }; # This is an object representing your Stripe balance. You can retrieve it to see @@ -3566,18 +3550,18 @@ public type InvoiceItemPreviewParams record { # Related guide: [Understanding Connect Account Balances](https://stripe.com/docs/connect/account-balances). public type Balance record { # Funds that are available to be transferred or paid out, whether automatically by Stripe or explicitly via the [Transfers API](https://stripe.com/docs/api#transfers) or [Payouts API](https://stripe.com/docs/api#payouts). The available balance for each currency and payment type can be found in the `source_types` property. - BalanceAmount[] available; + BalanceAmount[]? available; # Funds held due to negative balances on connected Custom accounts. The connect reserve balance for each currency and payment type can be found in the `source_types` property. - BalanceAmount[] connect_reserved?; + BalanceAmount[]? connect_reserved?; # Funds that can be paid out using Instant Payouts. - BalanceAmount[] instant_available?; - BalanceDetail issuing?; + BalanceAmount[]? instant_available?; + BalanceDetail? issuing?; # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. - boolean livemode; + boolean? livemode; # String representing the object's type. Objects of the same type share the same value. - string 'object; + string? 'object; # Funds that are not yet available in the balance, due to the 7-day rolling pay cycle. The pending balance for each currency, and for each payment type, can be found in the `source_types` property. - BalanceAmount[] pending; + BalanceAmount[]? pending; }; # This is an object representing a file hosted on Stripe's servers. The @@ -3589,21 +3573,21 @@ public type Balance record { # Related guide: [File Upload Guide](https://stripe.com/docs/file-upload). public type File record { # Time at which the object was created. Measured in seconds since the Unix epoch. - int created; + int? created; # The time at which the file expires and is no longer available in epoch seconds. int? expires_at?; # A filename for the file, suitable for saving to a filesystem. string? filename?; # Unique identifier for the object. - string id; + string? id; # A list of [file links](https://stripe.com/docs/api#file_links) that point at this file. FileFileLinkList? links?; # String representing the object's type. Objects of the same type share the same value. - string 'object; + string? 'object; # The [purpose](https://stripe.com/docs/file-upload#uploading-a-file) of the uploaded file. - string purpose; + string? purpose; # The size in bytes of the file object. - int size; + int? size; # A user friendly title for the document. string? title?; # The type of the file returned (e.g., `csv`, `pdf`, `jpg`, or `png`). @@ -3626,7 +3610,7 @@ public type AccountCapabilityRequirements record { # Date by which the fields in `currently_due` must be collected to keep the capability enabled for the account. These fields may disable the capability sooner if the next threshold is reached before they are collected. int? current_deadline?; # Fields that need to be collected to keep the capability enabled. If not collected by `current_deadline`, these fields appear in `past_due` as well, and the capability is disabled. - string[] currently_due; + string[]? currently_due; # If the capability is disabled, this string describes why. Can be `requirements.past_due`, `requirements.pending_verification`, `listed`, `platform_paused`, `rejected.fraud`, `rejected.listed`, `rejected.terms_of_service`, `rejected.other`, `under_review`, or `other`. # # `rejected.unsupported_business` means that the account's business is not supported by the capability. For example, payment methods may restrict the businesses they support in their terms of service: @@ -3636,24 +3620,24 @@ public type AccountCapabilityRequirements record { # If you believe that the rejection is in error, please contact support@stripe.com for assistance. string? disabled_reason?; # Fields that are `currently_due` and need to be collected again because validation or verification failed. - AccountRequirementsError[] errors; + AccountRequirementsError[]? errors; # Fields that need to be collected assuming all volume thresholds are reached. As they become required, they appear in `currently_due` as well, and `current_deadline` becomes set. - string[] eventually_due; + string[]? eventually_due; # Fields that weren't collected by `current_deadline`. These fields need to be collected to enable the capability on the account. - string[] past_due; + string[]? past_due; # Fields that may become required depending on the results of verification or review. Will be an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due`, `currently_due`, or `past_due`. - string[] pending_verification; + string[]? pending_verification; }; public type SourceTransactionAchCreditTransferData record { # Customer data associated with the transfer. - string customer_data?; + string? customer_data?; # Bank account fingerprint associated with the transfer. - string fingerprint?; + string? fingerprint?; # Last 4 digits of the account number associated with the transfer. - string last4?; + string? last4?; # Routing number associated with the transfer. - string routing_number?; + string? routing_number?; }; public type SetupAttemptPaymentMethodDetailsCard record { @@ -3663,34 +3647,34 @@ public type SetupAttemptPaymentMethodDetailsCard record { # The recurring components of a price such as `interval` and `usage_type`. public type Recurring1 record { - string aggregate_usage?; - string interval; - int interval_count?; - string usage_type?; + string? aggregate_usage?; + string? interval; + int? interval_count?; + string? usage_type?; }; public type InlineResponse200 record { - Coupon[] data; + Coupon[]? data; # True if this list has another page of items after this one that can be fetched. - boolean has_more; + boolean? has_more; # String representing the object's type. Objects of the same type share the same value. Always has the value `list`. - string 'object; + string? 'object; # The URL where this list can be accessed. - string url; + string? url; }; public type PaymentMethodDetachBody record { # Specifies which fields in the response should be expanded. - string[] expand?; + string[]? expand?; }; public type IssuingCardholderSpendingLimit record { # Maximum amount allowed to spend per interval. - int amount; + int? amount; # Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) this limit applies to. Omitting this field will apply the limit to all categories. string[]? categories?; # Interval (or event) to which the amount applies. - string interval; + string? interval; }; public type InvoicesPaymentMethodOptions record { @@ -3710,161 +3694,161 @@ public type InvoicesPaymentMethodOptions record { # data), and will error when queried without a [live-mode API key](https://stripe.com/docs/keys#test-live-modes). public type ReportingReportType record { # Most recent time for which this Report Type is available. Measured in seconds since the Unix epoch. - int data_available_end; + int? data_available_end; # Earliest time for which this Report Type is available. Measured in seconds since the Unix epoch. - int data_available_start; + int? data_available_start; # 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.) string[]? default_columns?; # The [ID of the Report Type](https://stripe.com/docs/reporting/statements/api#available-report-types), such as `balance.summary.1`. - string id; + string? id; # Human-readable name of the Report Type - string name; + string? name; # String representing the object's type. Objects of the same type share the same value. - string 'object; + string? 'object; # When this Report Type was latest updated. Measured in seconds since the Unix epoch. - int updated; + int? updated; # 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. - int 'version; + int? 'version; }; # Default invoice settings for this customer. public type CustomerParam record { - record {string name; string value;}[]|string custom_fields?; - string default_payment_method?; - string footer?; + record {string? name; string? value;}[]|string? custom_fields?; + string? default_payment_method?; + string? footer?; }; public type PaymentMethodCardWallet record { - PaymentMethodCardWalletAmexExpressCheckout amex_express_checkout?; - PaymentMethodCardWalletApplePay apple_pay?; + PaymentMethodCardWalletAmexExpressCheckout? amex_express_checkout?; + PaymentMethodCardWalletApplePay? apple_pay?; # (For tokenized numbers only.) The last four digits of the device account number. string? dynamic_last4?; - PaymentMethodCardWalletGooglePay google_pay?; - PaymentMethodCardWalletMasterpass masterpass?; - PaymentMethodCardWalletSamsungPay samsung_pay?; + PaymentMethodCardWalletGooglePay? google_pay?; + PaymentMethodCardWalletMasterpass? masterpass?; + PaymentMethodCardWalletSamsungPay? samsung_pay?; # The type of the card wallet, one of `amex_express_checkout`, `apple_pay`, `google_pay`, `masterpass`, `samsung_pay`, or `visa_checkout`. 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. - string 'type; - PaymentMethodCardWalletVisaCheckout visa_checkout?; + string? 'type; + PaymentMethodCardWalletVisaCheckout? visa_checkout?; }; public type AccountCapabilities record { # The status of the ACSS Direct Debits payments capability of the account, or whether the account can directly process ACSS Direct Debits charges. - string acss_debit_payments?; + string? acss_debit_payments?; # The status of the Afterpay Clearpay capability of the account, or whether the account can directly process Afterpay Clearpay charges. - string afterpay_clearpay_payments?; + string? afterpay_clearpay_payments?; # The status of the BECS Direct Debit (AU) payments capability of the account, or whether the account can directly process BECS Direct Debit (AU) charges. - string au_becs_debit_payments?; + string? au_becs_debit_payments?; # The status of the Bacs Direct Debits payments capability of the account, or whether the account can directly process Bacs Direct Debits charges. - string bacs_debit_payments?; + string? bacs_debit_payments?; # The status of the Bancontact payments capability of the account, or whether the account can directly process Bancontact charges. - string bancontact_payments?; + string? bancontact_payments?; # The status of the boleto payments capability of the account, or whether the account can directly process boleto charges. - string boleto_payments?; + string? boleto_payments?; # The status of the card issuing capability of the account, or whether you can use Issuing to distribute funds on cards - string card_issuing?; + string? card_issuing?; # The status of the card payments capability of the account, or whether the account can directly process credit and debit card charges. - string card_payments?; + string? card_payments?; # The status of the Cartes Bancaires payments capability of the account, or whether the account can directly process Cartes Bancaires card charges in EUR currency. - string cartes_bancaires_payments?; + string? cartes_bancaires_payments?; # The status of the EPS payments capability of the account, or whether the account can directly process EPS charges. - string eps_payments?; + string? eps_payments?; # The status of the FPX payments capability of the account, or whether the account can directly process FPX charges. - string fpx_payments?; + string? fpx_payments?; # The status of the giropay payments capability of the account, or whether the account can directly process giropay charges. - string giropay_payments?; + string? giropay_payments?; # The status of the GrabPay payments capability of the account, or whether the account can directly process GrabPay charges. - string grabpay_payments?; + string? grabpay_payments?; # The status of the iDEAL payments capability of the account, or whether the account can directly process iDEAL charges. - string ideal_payments?; + string? ideal_payments?; # The status of the JCB payments capability of the account, or whether the account (Japan only) can directly process JCB credit card charges in JPY currency. - string jcb_payments?; + string? jcb_payments?; # The status of the legacy payments capability of the account. - string legacy_payments?; + string? legacy_payments?; # The status of the OXXO payments capability of the account, or whether the account can directly process OXXO charges. - string oxxo_payments?; + string? oxxo_payments?; # The status of the P24 payments capability of the account, or whether the account can directly process P24 charges. - string p24_payments?; + string? p24_payments?; # The status of the SEPA Direct Debits payments capability of the account, or whether the account can directly process SEPA Direct Debits charges. - string sepa_debit_payments?; + string? sepa_debit_payments?; # The status of the Sofort payments capability of the account, or whether the account can directly process Sofort charges. - string sofort_payments?; + string? sofort_payments?; # The status of the tax reporting 1099-K (US) capability of the account. - string tax_reporting_us_1099_k?; + string? tax_reporting_us_1099_k?; # The status of the tax reporting 1099-MISC (US) capability of the account. - string tax_reporting_us_1099_misc?; + string? tax_reporting_us_1099_misc?; # The status of the transfers capability of the account, or whether your platform can transfer funds to the account. - string transfers?; + string? transfers?; }; public type SetupIntentNextActionVerifyWithMicrodeposits record { # The timestamp when the microdeposits are expected to land. - int arrival_date; + int? arrival_date; # The URL for the hosted verification page, which allows customers to verify their bank account. - string hosted_verification_url; + string? hosted_verification_url; }; # Line items that make up the credit note public type CreditNoteLinesList record { # Details about each object. - CreditNoteLineItem[] data; + CreditNoteLineItem[]? data; # True if this list has another page of items after this one that can be fetched. - boolean has_more; + boolean? has_more; # String representing the object's type. Objects of the same type share the same value. Always has the value `list`. - string 'object; + string? 'object; # The URL where this list can be accessed. - string url; + string? url; }; public type V1InvoicesBody record { # The account tax IDs associated with the invoice. Only editable when the invoice is a draft. - string[]|string account_tax_ids?; + string[]|string? account_tax_ids?; # A fee in %s that will be applied to the invoice and transferred to the application owner's Stripe account. The request must be made with an OAuth key or the Stripe-Account header in order to take an application fee. For more information, see the application fees [documentation](https://stripe.com/docs/billing/invoices/connect#collecting-fees). - int application_fee_amount?; + int? application_fee_amount?; # Controls whether Stripe will perform [automatic collection](https://stripe.com/docs/billing/invoices/workflow/#auto_advance) of the invoice. When `false`, the invoice's state will not automatically advance without an explicit action. - boolean auto_advance?; + boolean? auto_advance?; # Settings for automatic tax lookup for this invoice. - AutomaticTaxParam automatic_tax?; + AutomaticTaxParam? automatic_tax?; # 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. Defaults to `charge_automatically`. - string collection_method?; + string? collection_method?; # A list of up to 4 custom fields to be displayed on the invoice. - InvoiceSettingsCustomFields|string custom_fields?; + InvoiceSettingsCustomFields|string? custom_fields?; # The ID of the customer who will be billed. - string customer; + string? customer; # The number of days from when the invoice is created until it is due. Valid only for invoices where `collection_method=send_invoice`. - int days_until_due?; + int? days_until_due?; # ID of the default payment method for the invoice. It must belong to the customer associated with the invoice. If not set, defaults to the subscription's default payment method, if any, or to the default payment method in the customer's invoice settings. - string default_payment_method?; + string? default_payment_method?; # ID of the default payment source for the invoice. It must belong to the customer associated with the invoice and be in a chargeable state. If not set, defaults to the subscription's default source, if any, or to the customer's default source. - string default_source?; + string? default_source?; # The tax rates that will apply to any line item that does not have `tax_rates` set. - string[] default_tax_rates?; + string[]? default_tax_rates?; # An arbitrary string attached to the object. Often useful for displaying to users. Referenced as 'memo' in the Dashboard. - string description?; + string? description?; # The coupons to redeem into discounts for the invoice. If not specified, inherits the discount from the invoice's customer. Pass an empty string to avoid inheriting any discounts. - DiscountsDataParam|string discounts?; + DiscountsDataParam|string? discounts?; # The date on which payment for this invoice is due. Valid only for invoices where `collection_method=send_invoice`. - int due_date?; + int? due_date?; # Specifies which fields in the response should be expanded. - string[] expand?; + string[]? expand?; # Footer to be displayed on the invoice. - string footer?; + string? footer?; # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. - record {}|string metadata?; + record {}|string? metadata?; # The account (if any) for which the funds of the invoice payment are intended. If set, the invoice will be presented with the branding and support information of the specified account. See the [Invoices with Connect](https://stripe.com/docs/billing/invoices/connect) documentation for details. - string on_behalf_of?; + string? on_behalf_of?; # Configuration settings for the PaymentIntent that is generated when the invoice is finalized. - PaymentSettings payment_settings?; + PaymentSettings? payment_settings?; # Extra information about a charge for the customer's credit card statement. It must contain at least one letter. If not specified and this invoice is part of a subscription, the default `statement_descriptor` will be set to the first subscription item's product's `statement_descriptor`. - string statement_descriptor?; + string? statement_descriptor?; # The ID of the subscription to invoice, if any. If not set, the created invoice will include all pending invoice items for the customer. If set, the created invoice will only include pending invoice items for that subscription and pending invoice items not associated with any subscription. The subscription's billing cycle and regular subscription events won't be affected. - string subscription?; + string? subscription?; # If specified, the funds from the invoice will be transferred to the destination and the ID of the resulting transfer will be found on the invoice's charge. - TransferDataSpecs1 transfer_data?; + TransferDataSpecs1? transfer_data?; }; -public type SubscriptionDefaultTaxRates string[]|string; +public type SubscriptionDefaultTaxRates string[]|string?; -public type DueDate RangeQuerySpecs|int; +public type DueDate RangeQuerySpecs|int?; # Point in Time public type GelatoDataVerifiedOutputsDate record { @@ -3878,7 +3862,7 @@ public type GelatoDataVerifiedOutputsDate record { public type InvoiceSendBody record { # Specifies which fields in the response should be expanded. - string[] expand?; + string[]? expand?; }; # Pending Updates store the changes pending from a previous update that will be applied @@ -3887,7 +3871,7 @@ public type SubscriptionsResourcePendingUpdate record { # If the update is applied, determines the date of the first full invoice, and, for plans with `month` or `year` intervals, the day of the month for subsequent invoices. int? billing_cycle_anchor?; # The point after which the changes reflected by this update will be discarded and no longer applied. - int expires_at; + int? expires_at; # List of subscription items, each with an attached plan, that will be set if the update is applied. SubscriptionItem[]? subscription_items?; # Unix timestamp representing the end of the trial period the customer will get before being charged for the first time, if the update is applied. @@ -3904,13 +3888,13 @@ public type SetupAttemptPaymentMethodDetailsCardPresent record { # A list of reversals that have been applied to the transfer. public type TransferReversalList record { # Details about each object. - TransferReversal[] data; + TransferReversal[]? data; # True if this list has another page of items after this one that can be fetched. - boolean has_more; + boolean? has_more; # String representing the object's type. Objects of the same type share the same value. Always has the value `list`. - string 'object; + string? 'object; # The URL where this list can be accessed. - string url; + string? url; }; public type IssuingCardholderAuthorizationControls record { @@ -3926,9 +3910,9 @@ public type IssuingCardholderAuthorizationControls record { public type CountrySpecVerificationFieldDetails record { # Additional fields which are only required for some users. - string[] additional; + string[]? additional; # Fields which every account must eventually provide. - string[] minimum; + string[]? minimum; }; # A Reader represents a physical device for accepting payment details. @@ -3938,39 +3922,39 @@ public type TerminalReader record { # The current software version of the reader. string? device_sw_version?; # Type of reader, one of `bbpos_chipper2x` or `verifone_P400`. - string device_type; + string? device_type; # Unique identifier for the object. - string id; + string? id; # The local IP address of the reader. string? ip_address?; # Custom label given to the reader for easier identification. - string label; + string? label; # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. - boolean livemode; + boolean? livemode; # The location identifier of the reader. string|TerminalLocation? location?; # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. record {} metadata; # String representing the object's type. Objects of the same type share the same value. - string 'object; + string? 'object; # Serial number of the reader. - string serial_number; + string? serial_number; # The networking status of the reader. string? status?; }; # An error response from the Stripe API public type Error record { - ApiErrors _error; + ApiErrors? _error; }; public type DeletedWebhookEndpoint record { # Always true for a deleted object - boolean deleted; + boolean? deleted; # Unique identifier for the object. - string id; + string? id; # String representing the object's type. Objects of the same type share the same value. - string 'object; + string? 'object; }; public type IssuingTransactionPurchaseDetails record { @@ -3995,17 +3979,17 @@ public type PaymentMethodBacsDebit record { string? sort_code?; }; -public type Discounts1 DiscountsDataParam|string; +public type Discounts1 DiscountsDataParam|string?; public type AccountSettings record { - AccountBacsDebitPaymentsSettings bacs_debit_payments?; - AccountBrandingSettings branding; - AccountCardIssuingSettings card_issuing?; - AccountCardPaymentsSettings card_payments; - AccountDashboardSettings dashboard; - AccountPaymentsSettings payments; - AccountPayoutSettings payouts?; - AccountSepaDebitPaymentsSettings sepa_debit_payments?; + AccountBacsDebitPaymentsSettings? bacs_debit_payments?; + AccountBrandingSettings? branding; + AccountCardIssuingSettings? card_issuing?; + AccountCardPaymentsSettings? card_payments; + AccountDashboardSettings? dashboard; + AccountPaymentsSettings? payments; + AccountPayoutSettings? payouts?; + AccountSepaDebitPaymentsSettings? sepa_debit_payments?; }; public type OfflineAcceptance record { @@ -4030,24 +4014,24 @@ public type SourceTypeSepaDebit record { # The dimensions of this product for shipping purposes. public type PackageDimensionsSpecs record { - decimal height; - decimal length; - decimal weight; - decimal width; + decimal? height; + decimal? length; + decimal? weight; + decimal? width; }; public type TransformQuantity record { # Divide usage by this number. - int divide_by; + int? divide_by; # After division, either round the result `up` or `down`. - string round; + string? round; }; public type InvoiceSettingCustomField record { # The name of the custom field. - string name; + string? name; # The value of the custom field. - string value; + string? value; }; public type IssuingTransactionFlightData record { @@ -4065,16 +4049,16 @@ public type IssuingTransactionFlightData record { public type DeletedPlan record { # Always true for a deleted object - boolean deleted; + boolean? deleted; # Unique identifier for the object. - string id; + string? id; # String representing the object's type. Objects of the same type share the same value. - string 'object; + string? 'object; }; public type Networks record { # All available networks for the card. - string[] available; + string[]? available; # The preferred network for the card. string? preferred?; }; @@ -4093,8 +4077,8 @@ public type PaymentMethodCardChecks record { public type AccountPayoutSettings record { # A Boolean indicating if Stripe should try to reclaim negative balances from an attached bank account. See our [Understanding Connect Account Balances](https://stripe.com/docs/connect/account-balances) documentation for details. Default value is `true` for Express accounts and `false` for Custom accounts. - boolean debit_negative_balances; - TransferSchedule schedule; + boolean? debit_negative_balances; + TransferSchedule? schedule; # The text that appears on the bank account statement for payouts. If not set, this defaults to the platform's bank descriptor as set in the Dashboard. string? statement_descriptor?; }; @@ -4103,7 +4087,7 @@ public type InvoiceThresholdReason record { # The total invoice amount threshold boundary if it triggered the threshold invoice. int? amount_gte?; # Indicates which line items triggered a threshold invoice. - InvoiceItemThresholdReason[] item_reasons; + InvoiceItemThresholdReason[]? item_reasons; }; public type LegalEntityPersonVerificationDocument record { @@ -4126,35 +4110,35 @@ public type PaymentMethodSofort record { }; public type ConfigurationItemParams record { - ItemBillingThresholdsParam|string billing_thresholds?; - string price?; - RecurringPriceData1 price_data?; - int quantity?; - string[]|string tax_rates?; + ItemBillingThresholdsParam|string? billing_thresholds?; + string? price?; + RecurringPriceData1? price_data?; + int? quantity?; + string[]|string? tax_rates?; }; public type DeletedTerminalLocation record { # Always true for a deleted object - boolean deleted; + boolean? deleted; # Unique identifier for the object. - string id; + string? id; # String representing the object's type. Objects of the same type share the same value. - string 'object; + string? 'object; }; public type SubscriptionSchedulesScheduleBody record { # Object representing the subscription schedule's default settings. - DefaultSettingsParams1 default_settings?; + DefaultSettingsParams1? default_settings?; # Configures how the subscription schedule behaves when it ends. Possible values are `release` or `cancel` with the default being `release`. `release` will end the subscription schedule and keep the underlying subscription running.`cancel` will end the subscription schedule and cancel the underlying subscription. - string end_behavior?; + string? end_behavior?; # Specifies which fields in the response should be expanded. - string[] expand?; + string[]? expand?; # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. - record {}|string metadata?; + record {}|string? metadata?; # List representing phases of the subscription schedule. Each phase can be customized to have different durations, plans, and coupons. If there are multiple phases, the `end_date` of one phase will always equal the `start_date` of the next phase. Note that past phases can be omitted. - PhaseConfigurationParams1[] phases?; + PhaseConfigurationParams1[]? phases?; # If the update changes the current phase, indicates if the changes should be prorated. Possible values are `create_prorations` or `none`, and the default value is `create_prorations`. - string proration_behavior?; + string? proration_behavior?; }; public type QuotesResourceTransferData record { @@ -4163,7 +4147,7 @@ public type QuotesResourceTransferData record { # 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 destination account. By default, the entire amount will be transferred to the destination. decimal? amount_percent?; # The account where funds from the payment will be transferred to upon payment success. - string|Account destination; + string|Account? destination; }; public type SubscriptionBillingThresholds record { @@ -4177,11 +4161,11 @@ public type DeletedCard record { # Three-letter [ISO code for the currency](https://stripe.com/docs/payouts) paid out to the bank account. string? currency?; # Always true for a deleted object - boolean deleted; + boolean? deleted; # Unique identifier for the object. - string id; + string? id; # String representing the object's type. Objects of the same type share the same value. - string 'object; + string? 'object; }; public type PriceTier record { @@ -4199,20 +4183,20 @@ public type PriceTier record { public type LoginLink record { # Time at which the object was created. Measured in seconds since the Unix epoch. - int created; + int? created; # String representing the object's type. Objects of the same type share the same value. - string 'object; + string? 'object; # The URL for the login link. - string url; + string? url; }; public type DeletedTaxId record { # Always true for a deleted object - boolean deleted; + boolean? deleted; # Unique identifier for the object. - string id; + string? id; # String representing the object's type. Objects of the same type share the same value. - string 'object; + string? 'object; }; public type IssuingDisputeNotReceivedEvidence record { @@ -4233,46 +4217,46 @@ public type SkuInventory record { # The count of inventory available. Will be present if and only if `type` is `finite`. int? quantity?; # Inventory type. Possible values are `finite`, `bucket` (not quantified), and `infinite`. - string 'type; + string? 'type; # An indicator of the inventory available. Possible values are `in_stock`, `limited`, and `out_of_stock`. Will be present if and only if `type` is `bucket`. string? value?; }; public type CountrySpecVerificationFields record { - CountrySpecVerificationFieldDetails company; - CountrySpecVerificationFieldDetails individual; + CountrySpecVerificationFieldDetails? company; + CountrySpecVerificationFieldDetails? individual; }; public type PaymentMethodDetailsCardWallet record { - PaymentMethodDetailsCardWalletAmexExpressCheckout amex_express_checkout?; - PaymentMethodDetailsCardWalletApplePay apple_pay?; + PaymentMethodDetailsCardWalletAmexExpressCheckout? amex_express_checkout?; + PaymentMethodDetailsCardWalletApplePay? apple_pay?; # (For tokenized numbers only.) The last four digits of the device account number. string? dynamic_last4?; - PaymentMethodDetailsCardWalletGooglePay google_pay?; - PaymentMethodDetailsCardWalletMasterpass masterpass?; - PaymentMethodDetailsCardWalletSamsungPay samsung_pay?; + PaymentMethodDetailsCardWalletGooglePay? google_pay?; + PaymentMethodDetailsCardWalletMasterpass? masterpass?; + PaymentMethodDetailsCardWalletSamsungPay? samsung_pay?; # The type of the card wallet, one of `amex_express_checkout`, `apple_pay`, `google_pay`, `masterpass`, `samsung_pay`, or `visa_checkout`. 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. - string 'type; - PaymentMethodDetailsCardWalletVisaCheckout visa_checkout?; + string? 'type; + PaymentMethodDetailsCardWalletVisaCheckout? visa_checkout?; }; public type Tier record { - int flat_amount?; - string flat_amount_decimal?; - int unit_amount?; - string unit_amount_decimal?; - string|int up_to; + int? flat_amount?; + string? flat_amount_decimal?; + int? unit_amount?; + string? unit_amount_decimal?; + string|int? up_to; }; # Default invoice settings for this customer. public type CustomerParam1 record { - InvoiceSettingsCustomFields|string custom_fields?; - string default_payment_method?; - string footer?; + InvoiceSettingsCustomFields|string? custom_fields?; + string? default_payment_method?; + string? footer?; }; public type BillingThresholds record { - int usage_gte; + int? usage_gte; }; # [Stripe Connect](https://stripe.com/docs/connect) platforms can reverse transfers made to a @@ -4290,25 +4274,25 @@ public type BillingThresholds record { # Related guide: [Reversing Transfers](https://stripe.com/docs/connect/charges-transfers#reversing-transfers). public type TransferReversal record { # Amount, in %s. - int amount; + int? amount; # Balance transaction that describes the impact on your account balance. string|BalanceTransaction? balance_transaction?; # Time at which the object was created. Measured in seconds since the Unix epoch. - int created; + int? created; # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). - string currency; + string? currency; # Linked payment refund for the transfer reversal. string|Refund? destination_payment_refund?; # Unique identifier for the object. - string id; + string? id; # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. record {} metadata?; # String representing the object's type. Objects of the same type share the same value. - string 'object; + string? 'object; # ID of the refund responsible for the transfer reversal. string|Refund? source_refund?; # ID of the transfer that was reversed. - string|Transfer transfer; + string|Transfer? transfer; }; public type PaymentIntentNextActionBoleto record { @@ -4324,32 +4308,32 @@ public type PaymentIntentNextActionBoleto record { public type EphemeralKey record { # Time at which the object was created. Measured in seconds since the Unix epoch. - int created; + int? created; # Time at which the key will expire. Measured in seconds since the Unix epoch. - int expires; + int? expires; # Unique identifier for the object. - string id; + string? id; # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. - boolean livemode; + boolean? livemode; # String representing the object's type. Objects of the same type share the same value. - string 'object; + string? 'object; # The key's secret. You can use this value to make authorized requests to the Stripe API. - string secret?; + string? secret?; }; -public type Created2 RangeQuerySpecs|int; +public type Created2 RangeQuerySpecs|int?; -public type Created1 RangeQuerySpecs|int; +public type Created1 RangeQuerySpecs|int?; public type PaymentMethodsPaymentMethodBody record { # Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods. - BillingDetailsInnerParams billing_details?; + BillingDetailsInnerParams? billing_details?; # If this is a `card` PaymentMethod, this hash contains the user's card details. - UpdateApiParam card?; + UpdateApiParam? card?; # Specifies which fields in the response should be expanded. - string[] expand?; + string[]? expand?; # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. - record {}|string metadata?; + record {}|string? metadata?; }; # `Refund` objects allow you to refund a charge that has previously been created @@ -4359,27 +4343,27 @@ public type PaymentMethodsPaymentMethodBody record { # Related guide: [Refunds](https://stripe.com/docs/refunds). public type Refund record { # Amount, in %s. - int amount; + int? amount; # Balance transaction that describes the impact on your account balance. string|BalanceTransaction? balance_transaction?; # ID of the charge that was refunded. string|Charge? charge?; # Time at which the object was created. Measured in seconds since the Unix epoch. - int created; + int? created; # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). - string currency; + string? currency; # An arbitrary string attached to the object. Often useful for displaying to users. (Available on non-card refunds only) - string description?; + string? description?; # If the refund failed, this balance transaction describes the adjustment made on your account balance that reverses the initial balance transaction. - string|BalanceTransaction failure_balance_transaction?; + string|BalanceTransaction? failure_balance_transaction?; # If the refund failed, the reason for refund failure if known. Possible values are `lost_or_stolen_card`, `expired_or_canceled_card`, or `unknown`. - string failure_reason?; + string? failure_reason?; # Unique identifier for the object. - string id; + string? id; # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. record {} metadata?; # String representing the object's type. Objects of the same type share the same value. - string 'object; + string? 'object; # ID of the PaymentIntent that was refunded. string|PaymentIntent? payment_intent?; # Reason for the refund, either user-provided (`duplicate`, `fraudulent`, or `requested_by_customer`) or generated by Stripe internally (`expired_uncaptured_charge`). @@ -4401,81 +4385,81 @@ public type SourceTypeP24 record { # The customer's tax IDs. public type TaxIDsList record { # Details about each object. - TaxId[] data; + TaxId[]? data; # True if this list has another page of items after this one that can be fetched. - boolean has_more; + boolean? has_more; # String representing the object's type. Objects of the same type share the same value. Always has the value `list`. - string 'object; + string? 'object; # The URL where this list can be accessed. - string url; + string? url; }; public type SourceRedirectFlow record { # The failure reason for the redirect, either `user_abort` (the customer aborted or dropped out of the redirect flow), `declined` (the authentication failed or the transaction was declined), or `processing_error` (the redirect failed due to a technical error). Present only if the redirect status is `failed`. string? failure_reason?; # The URL you provide to redirect the customer to after they authenticated their payment. - string return_url; + string? return_url; # The status of the redirect, either `pending` (ready to be used by your customer to authenticate the transaction), `succeeded` (succesful authentication, cannot be reused) or `not_required` (redirect should not be used) or `failed` (failed authentication, cannot be reused). - string status; + string? status; # The URL provided to you to redirect a customer to as part of a `redirect` authentication flow. - string url; + string? url; }; public type SubscriptionItemUpdateParams record { - record {int usage_gte;}|string billing_thresholds?; - boolean clear_usage?; - boolean deleted?; - string id?; - record {}|string metadata?; - string price?; - RecurringPriceData1 price_data?; - int quantity?; - string[]|string tax_rates?; + record {int? usage_gte;}|string? billing_thresholds?; + boolean? clear_usage?; + boolean? deleted?; + string? id?; + record {}|string? metadata?; + string? price?; + RecurringPriceData1? price_data?; + int? quantity?; + string[]|string? tax_rates?; }; public type PortalSubscriptionPause record { # Whether the feature is enabled. - boolean enabled; + boolean? enabled; }; public type SetupIntentNextAction record { - SetupIntentNextActionRedirectToUrl redirect_to_url?; + SetupIntentNextActionRedirectToUrl? redirect_to_url?; # Type of the next action to perform, one of `redirect_to_url`, `use_stripe_sdk`, `alipay_handle_redirect`, or `oxxo_display_details`. - string 'type; + string? 'type; # When confirming a SetupIntent with Stripe.js, Stripe.js depends on the contents of this dictionary to invoke authentication flows. The shape of the contents is subject to change and is only intended to be used by Stripe.js. record {} use_stripe_sdk?; - SetupIntentNextActionVerifyWithMicrodeposits verify_with_microdeposits?; + SetupIntentNextActionVerifyWithMicrodeposits? verify_with_microdeposits?; }; public type PaymentMethodOptionsCardInstallments record { # Installment plans that may be selected for this PaymentIntent. PaymentMethodDetailsCardInstallmentsPlan[]? available_plans?; # Whether Installments are enabled for this PaymentIntent. - boolean enabled; + boolean? enabled; # Installment plan selected for this PaymentIntent. PaymentMethodDetailsCardInstallmentsPlan? plan?; }; public type AddInvoiceItemEntry record { - string price?; - OneTimePriceData price_data?; - int quantity?; - TaxRateArray|string tax_rates?; + string? price?; + OneTimePriceData? price_data?; + int? quantity?; + TaxRateArray|string? tax_rates?; }; public type PaymentPagesPaymentPageResourcesShippingAddressCollection record { # An array of two-letter ISO country codes representing which countries Checkout should provide as options for # shipping locations. Unsupported country codes: `AS, CX, CC, CU, HM, IR, KP, MH, FM, NF, MP, PW, SD, SY, UM, VI`. - string[] allowed_countries; + string[]? allowed_countries; }; public type SourceTransactionSepaCreditTransferData record { # Reference associated with the transfer. - string reference?; + string? reference?; # Sender's bank account IBAN. - string sender_iban?; + string? sender_iban?; # Sender's name. - string sender_name?; + string? sender_name?; }; # To top up your Stripe balance, you create a top-up object. You can retrieve @@ -4485,13 +4469,13 @@ public type SourceTransactionSepaCreditTransferData record { # Related guide: [Topping Up your Platform Account](https://stripe.com/docs/connect/top-ups). public type Topup record { # Amount transferred. - int amount; + int? amount; # ID of the balance transaction that describes the impact of this top-up on your account balance. May not be specified depending on status of top-up. string|BalanceTransaction? balance_transaction?; # Time at which the object was created. Measured in seconds since the Unix epoch. - int created; + int? created; # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). - string currency; + string? currency; # An arbitrary string attached to the object. Often useful for displaying to users. string? description?; # Date the funds are expected to arrive in your Stripe account for payouts. This factors in delays like weekends or bank holidays. May not be specified depending on status of top-up. @@ -4501,32 +4485,32 @@ public type Topup record { # Message to user further explaining reason for top-up failure if available. string? failure_message?; # Unique identifier for the object. - string id; + string? id; # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. - boolean livemode; + boolean? livemode; # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. record {} metadata; # String representing the object's type. Objects of the same type share the same value. - string 'object; + string? 'object; # `Source` objects allow you to accept a variety of payment methods. They # represent a customer's payment instrument, and can be used with the Stripe API # just like a `Card` object: once chargeable, they can be charged, or can be # attached to customers. # # Related guides: [Sources API](https://stripe.com/docs/sources) and [Sources & Customers](https://stripe.com/docs/sources/customers). - Source 'source; + Source? 'source; # Extra information about a top-up. This will appear on your source's bank statement. It must contain at least one letter. string? statement_descriptor?; # The status of the top-up is either `canceled`, `failed`, `pending`, `reversed`, or `succeeded`. - string status; + string? status; # A string that identifies this top-up as part of a group. string? transfer_group?; }; public type CustomerShippingAddress record { - OptionalFieldsAddress address; - string name; - string phone?; + OptionalFieldsAddress? address; + string? name; + string? phone?; }; public type SourceOwner record { @@ -4550,62 +4534,62 @@ public type SourceOwner record { public type PaymentMethodDetailsBoleto record { # Uniquely identifies this customer tax_id (CNPJ or CPF) - string tax_id; + string? tax_id; }; -public type DiscountsDataParam DiscountsDataParam1[]; +public type DiscountsDataParam DiscountsDataParam1[]?; # Contains information about what this coupon applies to public type CouponAppliesTo record { # A list of product IDs this coupon applies to - string[] products; + string[]? products; }; # The line items purchased by the customer. public type PaymentPagesCheckoutSessionListLineItems record { # Details about each object. - Item[] data; + Item[]? data; # True if this list has another page of items after this one that can be fetched. - boolean has_more; + boolean? has_more; # String representing the object's type. Objects of the same type share the same value. Always has the value `list`. - string 'object; + string? 'object; # The URL where this list can be accessed. - string url; + string? url; }; public type V1PaymentMethodsBody record { # If this is an `acss_debit` PaymentMethod, this hash contains details about the ACSS Debit payment method. - PaymentMethodParam acss_debit?; + PaymentMethodParam? acss_debit?; # If this is an `AfterpayClearpay` PaymentMethod, this hash contains details about the AfterpayClearpay payment method. record {} afterpay_clearpay?; # If this is an `Alipay` PaymentMethod, this hash contains details about the Alipay payment method. record {} alipay?; # If this is an `au_becs_debit` PaymentMethod, this hash contains details about the bank account. - Param au_becs_debit?; + Param? au_becs_debit?; # If this is a `bacs_debit` PaymentMethod, this hash contains details about the Bacs Direct Debit bank account. - Param1 bacs_debit?; + Param1? bacs_debit?; # If this is a `bancontact` PaymentMethod, this hash contains details about the Bancontact payment method. record {} bancontact?; # Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods. - BillingDetailsInnerParams billing_details?; + BillingDetailsInnerParams? billing_details?; # If this is a `boleto` PaymentMethod, this hash contains details about the Boleto payment method. - Param2 boleto?; + Param2? boleto?; # If this is a `card` PaymentMethod, this hash contains the user's card details. For backwards compatibility, you can alternatively provide a Stripe token (e.g., for Apple Pay, Amex Express Checkout, or legacy Checkout) into the card hash with format `card: {token: "tok_visa"}`. When providing a card number, you must meet the requirements for [PCI compliance](https://stripe.com/docs/security#validating-pci-compliance). We strongly recommend using Stripe.js instead of interacting with this API directly. - CardDetailsParams|TokenParamas card?; + CardDetailsParams|TokenParamas? card?; # The `Customer` to whom the original PaymentMethod is attached. - string customer?; + string? customer?; # If this is an `eps` PaymentMethod, this hash contains details about the EPS payment method. - Param3 eps?; + Param3? eps?; # Specifies which fields in the response should be expanded. - string[] expand?; + string[]? expand?; # If this is an `fpx` PaymentMethod, this hash contains details about the FPX payment method. - Param4 fpx?; + Param4? fpx?; # If this is a `giropay` PaymentMethod, this hash contains details about the Giropay payment method. record {} giropay?; # If this is a `grabpay` PaymentMethod, this hash contains details about the GrabPay payment method. record {} grabpay?; # If this is an `ideal` PaymentMethod, this hash contains details about the iDEAL payment method. - Param5 ideal?; + Param5? ideal?; # If this is an `interac_present` PaymentMethod, this hash contains details about the Interac Present payment method. record {} interac_present?; # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. @@ -4613,86 +4597,86 @@ public type V1PaymentMethodsBody record { # If this is an `oxxo` PaymentMethod, this hash contains details about the OXXO payment method. record {} oxxo?; # If this is a `p24` PaymentMethod, this hash contains details about the P24 payment method. - Param6 p24?; + Param6? p24?; # The PaymentMethod to share. - string payment_method?; + string? payment_method?; # If this is a `sepa_debit` PaymentMethod, this hash contains details about the SEPA debit bank account. - Param7 sepa_debit?; + Param7? sepa_debit?; # If this is a `sofort` PaymentMethod, this hash contains details about the SOFORT payment method. - Param8 sofort?; + Param8? sofort?; # The type of the PaymentMethod. An additional hash is included on the PaymentMethod with a name matching this value. It contains additional information specific to the PaymentMethod type. - string 'type?; + string? 'type?; # If this is an `wechat_pay` PaymentMethod, this hash contains details about the wechat_pay payment method. record {} wechat_pay?; }; public type PaymentPagesCheckoutSessionTotalDetails record { # This is the sum of all the line item discounts. - int amount_discount; + int? amount_discount; # This is the sum of all the line item shipping amounts. int? amount_shipping?; # This is the sum of all the line item tax amounts. - int amount_tax; - PaymentPagesCheckoutSessionTotalDetailsResourceBreakdown breakdown?; + int? amount_tax; + PaymentPagesCheckoutSessionTotalDetailsResourceBreakdown? breakdown?; }; public type Created record { # Minimum value to filter by (exclusive) - int gt?; + int? gt?; # Minimum value to filter by (inclusive) - int gte?; + int? gte?; # Maximum value to filter by (exclusive) - int lt?; + int? lt?; # Maximum value to filter by (inclusive) - int lte?; -}|int; + int? lte?; +}|int?; # Value lists allow you to group values together which can then be referenced in rules. # # Related guide: [Default Stripe Lists](https://stripe.com/docs/radar/lists#managing-list-items). public type RadarValueList record { # The name of the value list for use in rules. - string alias; + string? alias; # Time at which the object was created. Measured in seconds since the Unix epoch. - int created; + int? created; # The name or email address of the user who created this value list. - string created_by; + string? created_by; # Unique identifier for the object. - string id; + string? id; # The type of items in the value list. One of `card_fingerprint`, `card_bin`, `email`, `ip_address`, `country`, `string`, or `case_sensitive_string`. - string item_type; + string? item_type; # List of items contained within this value list. - RadarListListItemList list_items; + RadarListListItemList? list_items; # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. - boolean livemode; + boolean? livemode; # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. record {} metadata; # The name of the value list. - string name; + string? name; # String representing the object's type. Objects of the same type share the same value. - string 'object; + string? 'object; }; public type Recurring record { # Specifies a usage aggregation strategy for prices of `usage_type=metered`. Allowed values are `sum` for summing up all usage during a period, `last_during_period` for using the last usage record reported within a period, `last_ever` for using the last usage record ever (across period bounds) or `max` which uses the usage record with the maximum reported usage during a period. Defaults to `sum`. string? aggregate_usage?; # The frequency at which a subscription is billed. One of `day`, `week`, `month` or `year`. - string interval; + string? interval; # The number of intervals (specified in the `interval` attribute) between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. - int interval_count; + int? interval_count; # Configures how the quantity per period should be determined. Can be either `metered` or `licensed`. `licensed` automatically bills the `quantity` set when adding it to a subscription. `metered` aggregates the total usage based on usage records. Defaults to `licensed`. - string usage_type; + string? usage_type; }; public type PackageDimensions record { # Height, in inches. - decimal height; + decimal? height; # Length, in inches. - decimal length; + decimal? length; # Weight, in ounces. - decimal weight; + decimal? weight; # Width, in inches. - decimal width; + decimal? width; }; public type SetupAttemptPaymentMethodDetailsBacsDebit record { @@ -4704,13 +4688,13 @@ public type PaymentMethodDetailsWechat record { # The customer's payment sources, if any. public type ApmsSourcesSourceList record { # Details about each object. - (AlipayAccount|BankAccount|BitcoinReceiver|Card|Source)[] data; + (AlipayAccount|BankAccount|BitcoinReceiver|Card|Source?)[]? data; # True if this list has another page of items after this one that can be fetched. - boolean has_more; + boolean? has_more; # String representing the object's type. Objects of the same type share the same value. Always has the value `list`. - string 'object; + string? 'object; # The URL where this list can be accessed. - string url; + string? url; }; # Point in Time @@ -4748,11 +4732,11 @@ public type CheckoutSession record { int? amount_subtotal?; # Total of all items after discounts and taxes are applied. int? amount_total?; - PaymentPagesCheckoutSessionAutomaticTax automatic_tax; + PaymentPagesCheckoutSessionAutomaticTax? automatic_tax; # Describes whether Checkout should collect the customer's billing address. string? billing_address_collection?; # The URL the customer will be directed to if they decide to cancel payment and return to your website. - string cancel_url; + string? cancel_url; # A unique string to reference the Checkout Session. This can be a # customer ID, a cart ID, or similar, and can be used to reconcile the # Session with your internal systems. @@ -4775,29 +4759,29 @@ public type CheckoutSession record { string? customer_email?; # Unique identifier for the object. Used to pass to `redirectToCheckout` # in Stripe.js. - string id; + string? id; # The line items purchased by the customer. - PaymentPagesCheckoutSessionListLineItems line_items?; + PaymentPagesCheckoutSessionListLineItems? line_items?; # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. - boolean livemode; + boolean? livemode; # The IETF language tag of the locale Checkout is displayed in. If blank or `auto`, the browser's locale is used. string? locale?; # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. record {} metadata?; # The mode of the Checkout Session. - string mode; + string? mode; # String representing the object's type. Objects of the same type share the same value. - string 'object; + string? 'object; # The ID of the PaymentIntent for Checkout Sessions in `payment` mode. string|PaymentIntent? payment_intent?; # Payment-method-specific configuration for the PaymentIntent or SetupIntent of this CheckoutSession. CheckoutSessionPaymentMethodOptions? payment_method_options?; # A list of the types of payment methods (e.g. card) this Checkout # Session is allowed to accept. - string[] payment_method_types; + string[]? payment_method_types; # The payment status of the Checkout Session, one of `paid`, `unpaid`, or `no_payment_required`. # You can use this value to decide when to fulfill your customer's order. - string payment_status; + string? payment_status; # The ID of the SetupIntent for Checkout Sessions in `setup` mode. string|SetupIntent? setup_intent?; # Shipping information for this Checkout Session. @@ -4813,8 +4797,8 @@ public type CheckoutSession record { string|Subscription? subscription?; # The URL the customer will be directed to after the payment or # subscription creation is successful. - string success_url; - PaymentPagesCheckoutSessionTaxIdCollection tax_id_collection?; + string? success_url; + PaymentPagesCheckoutSessionTaxIdCollection? tax_id_collection?; # Tax and discount details for the computed total amount. PaymentPagesCheckoutSessionTotalDetails? total_details?; # The URL to the Checkout Session. @@ -4823,59 +4807,59 @@ public type CheckoutSession record { public type DeletedSku record { # Always true for a deleted object - boolean deleted; + boolean? deleted; # Unique identifier for the object. - string id; + string? id; # String representing the object's type. Objects of the same type share the same value. - string 'object; + string? 'object; }; public type PhaseConfigurationParams record { - AddInvoiceItemEntry1[] add_invoice_items?; - decimal application_fee_percent?; - AutomaticTaxConfig3 automatic_tax?; - string billing_cycle_anchor?; - record {int amount_gte?; boolean reset_billing_cycle_anchor?;}|string billing_thresholds?; - string collection_method?; - string coupon?; - string default_payment_method?; - string[]|string default_tax_rates?; - int end_date?; - SubscriptionSchedulesParam1 invoice_settings?; - ConfigurationItemParams[] items; - int iterations?; - string proration_behavior?; - TransferDataSpecs3 transfer_data?; - boolean trial?; - int trial_end?; + AddInvoiceItemEntry1[]? add_invoice_items?; + decimal? application_fee_percent?; + AutomaticTaxConfig3? automatic_tax?; + string? billing_cycle_anchor?; + record {int? amount_gte?; boolean? reset_billing_cycle_anchor?;}|string? billing_thresholds?; + string? collection_method?; + string? coupon?; + string? default_payment_method?; + string[]|string? default_tax_rates?; + int? end_date?; + SubscriptionSchedulesParam1? invoice_settings?; + ConfigurationItemParams[]? items; + int? iterations?; + string? proration_behavior?; + TransferDataSpecs3? transfer_data?; + boolean? trial?; + int? trial_end?; }; public type InvoicesList record { - Invoice[] data; + Invoice[]? data; # True if this list has another page of items after this one that can be fetched. - boolean has_more; + boolean? has_more; # String representing the object's type. Objects of the same type share the same value. Always has the value `list`. - string 'object; + string? 'object; # The URL where this list can be accessed. - string url; + string? url; }; # If this is a `card` PaymentMethod, this hash contains the user's card details. public type UpdateApiParam record { - int exp_month?; - int exp_year?; + int? exp_month?; + int? exp_year?; }; public type LegalEntityCompany record { - Address address?; + Address? address?; # The Kana variation of the company's primary address (Japan only). LegalEntityJapanAddress? address_kana?; # The Kanji variation of the company's primary address (Japan only). LegalEntityJapanAddress? address_kanji?; # Whether the company's directors have been provided. This Boolean will be `true` if you've manually indicated that all directors are provided via [the `directors_provided` parameter](https://stripe.com/docs/api/accounts/update#update_account-company-directors_provided). - boolean directors_provided?; + boolean? directors_provided?; # Whether the company's executives have been provided. This Boolean will be `true` if you've manually indicated that all executives are provided via [the `executives_provided` parameter](https://stripe.com/docs/api/accounts/update#update_account-company-executives_provided), or if Stripe determined that sufficient executives were provided. - boolean executives_provided?; + boolean? executives_provided?; # The company's legal name. string? name?; # The Kana variation of the company's legal name (Japan only). @@ -4883,17 +4867,17 @@ public type LegalEntityCompany record { # The Kanji variation of the company's legal name (Japan only). string? name_kanji?; # Whether the company's owners have been provided. This Boolean will be `true` if you've manually indicated that all owners are provided via [the `owners_provided` parameter](https://stripe.com/docs/api/accounts/update#update_account-company-owners_provided), or if Stripe determined that sufficient owners were provided. Stripe determines ownership requirements using both the number of owners provided and their total percent ownership (calculated by adding the `percent_ownership` of each owner together). - boolean owners_provided?; + boolean? owners_provided?; # The company's phone number (used for verification). string? phone?; # The category identifying the legal structure of the company or legal entity. See [Business structure](https://stripe.com/docs/connect/identity-verification#business-structure) for more details. - string structure?; + string? structure?; # Whether the company's business ID number was provided. - boolean tax_id_provided?; + boolean? tax_id_provided?; # The jurisdiction in which the `tax_id` is registered (Germany-based companies only). - string tax_id_registrar?; + string? tax_id_registrar?; # Whether the company's business VAT number was provided. - boolean vat_id_provided?; + boolean? vat_id_provided?; # Information on the verification state of the company. LegalEntityCompanyVerification? verification?; }; @@ -4903,21 +4887,21 @@ public type SetupIntentPaymentMethodOptionsCard record { string? request_three_d_secure?; }; -public type SubscriptionBillingCycleAnchor string|int; +public type SubscriptionBillingCycleAnchor string|int?; public type AutomaticTaxParam2 record { - boolean enabled; + boolean? enabled; }; public type SubscriptionPendingInvoiceItemInterval record { # Specifies invoicing frequency. Either `day`, `week`, `month` or `year`. - string interval; + string? interval; # The number of intervals between invoices. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks). - int interval_count; + int? interval_count; }; public type AutomaticTaxParam1 record { - boolean enabled; + boolean? enabled; }; # A dispute occurs when a customer questions your charge with their card issuer. @@ -4929,33 +4913,33 @@ public type AutomaticTaxParam1 record { # Related guide: [Disputes and Fraud](https://stripe.com/docs/disputes). public type Dispute record { # Disputed amount. Usually the amount of the charge, but can differ (usually because of currency fluctuation or because only part of the order is disputed). - int amount; + int? amount; # List of zero, one, or two balance transactions that show funds withdrawn and reinstated to your Stripe account as a result of this dispute. - BalanceTransaction[] balance_transactions; + BalanceTransaction[]? balance_transactions; # ID of the charge that was disputed. - string|Charge charge; + string|Charge? charge; # Time at which the object was created. Measured in seconds since the Unix epoch. - int created; + int? created; # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). - string currency; - DisputeEvidence evidence; - DisputeEvidenceDetails evidence_details; + string? currency; + DisputeEvidence? evidence; + DisputeEvidenceDetails? evidence_details; # Unique identifier for the object. - string id; + string? id; # If true, it is still possible to refund the disputed payment. Once the payment has been fully refunded, no further funds will be withdrawn from your Stripe account as a result of this dispute. - boolean is_charge_refundable; + boolean? is_charge_refundable; # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. - boolean livemode; + boolean? livemode; # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. record {} metadata; # String representing the object's type. Objects of the same type share the same value. - string 'object; + string? 'object; # ID of the PaymentIntent that was disputed. string|PaymentIntent? payment_intent?; # Reason given by cardholder for dispute. Possible values are `bank_cannot_process`, `check_returned`, `credit_not_processed`, `customer_initiated`, `debit_not_authorized`, `duplicate`, `fraudulent`, `general`, `incorrect_account_details`, `insufficient_funds`, `product_not_received`, `product_unacceptable`, `subscription_canceled`, or `unrecognized`. Read more about [dispute reasons](https://stripe.com/docs/disputes/categories). - string reason; + string? reason; # Current status of dispute. Possible values are `warning_needs_response`, `warning_under_review`, `warning_closed`, `needs_response`, `under_review`, `charge_refunded`, `won`, or `lost`. - string status; + string? status; }; # Events are our way of letting you know when something interesting happens in @@ -4989,24 +4973,24 @@ public type Dispute record { # guaranteed only for 30 days. public type Event record { # The connected account that originated the event. - string account?; + string? account?; # The Stripe API version used to render `data`. *Note: This property is populated only for events on or after October 31, 2014*. string? api_version?; # Time at which the object was created. Measured in seconds since the Unix epoch. - int created; - NotificationEventData data; + int? created; + NotificationEventData? data; # Unique identifier for the object. - string id; + string? id; # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. - boolean livemode; + boolean? livemode; # String representing the object's type. Objects of the same type share the same value. - string 'object; + string? 'object; # Number of webhooks that have yet to be successfully delivered (i.e., to return a 20x response) to the URLs you've specified. - int pending_webhooks; + int? pending_webhooks; # Information on the API request that instigated the event. NotificationEventRequest? request?; # Description of the event (e.g., `invoice.created` or `charge.refunded`). - string 'type; + string? 'type; }; public type PaymentMethodDetailsOxxo record { @@ -5019,42 +5003,42 @@ public type PaymentMethodOptionsP24 record { # Configuration settings for the PaymentIntent that is generated when the invoice is finalized. public type PaymentSettings record { - PaymentMethodOptions payment_method_options?; - string[]|string payment_method_types?; + PaymentMethodOptions? payment_method_options?; + string[]|string? payment_method_types?; }; # The line items that will appear on the next invoice after this quote is accepted. This does not include pending invoice items that exist on the customer but may still be included in the next invoice. public type Quotesresourcelistlineitems1 record { # Details about each object. - Item[] data; + Item[]? data; # True if this list has another page of items after this one that can be fetched. - boolean has_more; + boolean? has_more; # String representing the object's type. Objects of the same type share the same value. Always has the value `list`. - string 'object; + string? 'object; # The URL where this list can be accessed. - string url; + string? url; }; public type BitcoinTransaction record { # The amount of `currency` that the transaction was converted to in real-time. - int amount; + int? amount; # The amount of bitcoin contained in the transaction. - int bitcoin_amount; + int? bitcoin_amount; # Time at which the object was created. Measured in seconds since the Unix epoch. - int created; + int? created; # Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) to which this transaction was converted. - string currency; + string? currency; # Unique identifier for the object. - string id; + string? id; # String representing the object's type. Objects of the same type share the same value. - string 'object; + string? 'object; # The receiver to which this transaction was sent. - string receiver; + string? receiver; }; public type PaymentPagesCheckoutSessionTaxId record { # The type of the tax ID, one of `eu_vat`, `br_cnpj`, `br_cpf`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `li_uid`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, or `unknown` - string 'type; + string? 'type; # The value of the tax ID. string? value?; }; @@ -5090,15 +5074,15 @@ public type GelatoSessionIdNumberOptions record { public type CheckoutAcssDebitPaymentMethodOptions record { # Currency supported by the bank account. Returned when the Session is in `setup` mode. - string currency?; - CheckoutAcssDebitMandateOptions mandate_options?; + string? currency?; + CheckoutAcssDebitMandateOptions? mandate_options?; # Bank account verification method. - string verification_method?; + string? verification_method?; }; public type PortalPaymentMethodUpdate record { # Whether the feature is enabled. - boolean enabled; + boolean? enabled; }; public type PaymentMethodInteracPresent record { @@ -5147,7 +5131,7 @@ public type PaymentMethodDetailsSofort record { public type InvoiceMarkUncollectibleBody record { # Specifies which fields in the response should be expanded. - string[] expand?; + string[]? expand?; }; public type IssuingTransactionAmountDetails record { @@ -5157,36 +5141,36 @@ public type IssuingTransactionAmountDetails record { public type PaymentPagesCheckoutSessionTaxIdCollection record { # Indicates whether tax ID collection is enabled for the session - boolean enabled; + boolean? enabled; }; public type LineItemsDiscountAmount record { # The amount discounted. - int amount; + int? amount; # A discount represents the actual application of a coupon to a particular # customer. It contains information about when the discount began and when it # will end. # # Related guide: [Applying Discounts to Subscriptions](https://stripe.com/docs/billing/subscriptions/discounts). - Discount discount; + Discount? discount; }; -public type SubscriptionTrialEnd1 string|int; +public type SubscriptionTrialEnd1 string|int?; public type InvoicesResourceInvoiceTaxId record { # The type of the tax ID, one of `eu_vat`, `br_cnpj`, `br_cpf`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `li_uid`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, or `unknown` - string 'type; + string? 'type; # The value of the tax ID. string? value?; }; public type IssuingCardSpendingLimit record { # Maximum amount allowed to spend per interval. - int amount; + int? amount; # Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) this limit applies to. Omitting this field will apply the limit to all categories. string[]? categories?; # Interval (or event) to which the amount applies. - string interval; + string? interval; }; public type PaymentMethodDetailsAcssDebit record { @@ -5199,28 +5183,28 @@ public type PaymentMethodDetailsAcssDebit record { # Last four digits of the bank account number. string? last4?; # ID of the mandate used to make this payment. - string mandate?; + string? mandate?; # Transit number of the bank account. string? transit_number?; }; public type SourceOrder record { # A positive integer in the smallest currency unit (that is, 100 cents for $1.00, or 1 for ¥1, Japanese Yen being a zero-decimal currency) representing the total amount for the order. - int amount; + int? amount; # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). - string currency; + string? currency; # The email address of the customer placing the order. - string email?; + string? email?; # List of items constituting the order. SourceOrderItem[]? items?; - Shipping shipping?; + Shipping? shipping?; }; public type QuotesResourceTotalDetailsResourceBreakdown record { # The aggregated line item discounts. - LineItemsDiscountAmount[] discounts; + LineItemsDiscountAmount[]? discounts; # The aggregated line item tax amounts by rate. - LineItemsTaxAmount[] taxes; + LineItemsTaxAmount[]? taxes; }; public type PaymentMethodDetailsGiropay record { @@ -5237,7 +5221,7 @@ public type PaymentMethodDetailsGiropay record { }; public type SetupIntentPaymentMethodOptionsSepaDebit record { - SetupIntentPaymentMethodOptionsMandateOptionsSepaDebit mandate_options?; + SetupIntentPaymentMethodOptionsMandateOptionsSepaDebit? mandate_options?; }; public type SourceTypeMultibanco record { @@ -5266,57 +5250,57 @@ public type WebhookEndpoint record { # The ID of the associated Connect application. string? application?; # Time at which the object was created. Measured in seconds since the Unix epoch. - int created; + int? created; # An optional description of what the webhook is used for. string? description?; # The list of events to enable for this endpoint. `['*']` indicates that all events are enabled, except those that require explicit selection. - string[] enabled_events; + string[]? enabled_events; # Unique identifier for the object. - string id; + string? id; # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. - boolean livemode; + boolean? livemode; # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. record {} metadata; # String representing the object's type. Objects of the same type share the same value. - string 'object; + string? 'object; # The endpoint's secret, used to generate [webhook signatures](https://stripe.com/docs/webhooks/signatures). Only returned at creation. - string secret?; + string? secret?; # The status of the webhook. It can be `enabled` or `disabled`. - string status; + string? status; # The URL of the webhook endpoint. - string url; + string? url; }; -public type SubscriptionDefaultTaxRates1 string[]|string; +public type SubscriptionDefaultTaxRates1 string[]|string?; public type ProductsIdBody record { # Whether the product is available for purchase. - boolean active?; + boolean? active?; # 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. - string description?; + string? description?; # Specifies which fields in the response should be expanded. - string[] expand?; + string[]? expand?; # A list of up to 8 URLs of images for this product, meant to be displayable to the customer. - string[]|string images?; + string[]|string? images?; # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. - AdditionalProperties|string metadata?; + AdditionalProperties|string? metadata?; # The product's name, meant to be displayable to the customer. Whenever this product is sold via a subscription, name will show up on associated invoice line item descriptions. - string name?; + string? name?; # The dimensions of this product for shipping purposes. - PackageDimentionsSpecs|string package_dimensions?; + PackageDimentionsSpecs|string? package_dimensions?; # Whether this product is shipped (i.e., physical goods). - boolean shippable?; + boolean? shippable?; # An arbitrary string to be displayed on your customer's credit card or bank statement. While most banks display this information consistently, some may display it incorrectly or not at all. # # This may be up to 22 characters. The statement description may not include `<`, `>`, `\`, `"`, `'` characters, and will appear on your customer's statement in capital letters. Non-ASCII characters are automatically stripped. # It must contain at least one letter. May only be set if `type=service`. - string statement_descriptor?; + string? statement_descriptor?; # A [tax code](https://stripe.com/docs/tax/tax-codes) ID. - string|string tax_code?; + string|string? tax_code?; # 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. May only be set if `type=service`. - string unit_label?; + string? unit_label?; # A URL of a publicly-accessible webpage for this product. - string url?; + string? url?; }; # Any use of an [issued card](https://stripe.com/docs/issuing) that results in funds entering or leaving @@ -5326,7 +5310,7 @@ public type ProductsIdBody record { # Related guide: [Issued Card Transactions](https://stripe.com/docs/issuing/purchases/transactions). public type IssuingTransaction record { # The transaction amount, which will be reflected in your balance. This amount is in your currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). - int amount; + int? amount; # Detailed breakdown of amount components. These amounts are denominated in `currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). IssuingTransactionAmountDetails? amount_details?; # The `Authorization` object that led to this transaction. @@ -5334,60 +5318,60 @@ public type IssuingTransaction record { # ID of the [balance transaction](https://stripe.com/docs/api/balance_transactions) associated with this transaction. string|BalanceTransaction? balance_transaction?; # The card used to make this transaction. - string|IssuingCard card; + string|IssuingCard? card; # The cardholder to whom this transaction belongs. string|IssuingCardholder? cardholder?; # Time at which the object was created. Measured in seconds since the Unix epoch. - int created; + int? created; # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). - string currency; + string? currency; # If you've disputed the transaction, the ID of the dispute. string|IssuingDispute? dispute?; # Unique identifier for the object. - string id; + string? id; # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. - boolean livemode; + boolean? livemode; # The amount that the merchant will receive, denominated in `merchant_currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). It will be different from `amount` if the merchant is taking payment in a different currency. - int merchant_amount; + int? merchant_amount; # The currency with which the merchant is taking payment. - string merchant_currency; - IssuingAuthorizationMerchantData merchant_data; + string? merchant_currency; + IssuingAuthorizationMerchantData? merchant_data; # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. record {} metadata; # String representing the object's type. Objects of the same type share the same value. - string 'object; + string? 'object; # Additional purchase information that is optionally provided by the merchant. IssuingTransactionPurchaseDetails? purchase_details?; # The nature of the transaction. - string 'type; + string? 'type; # The digital wallet used for this transaction. One of `apple_pay`, `google_pay`, or `samsung_pay`. string? wallet?; }; public type FinancialReportingFinanceReportRunRunParameters record { # The set of output columns requested for inclusion in the report run. - string[] columns?; + string[]? columns?; # Connected account ID by which to filter the report run. - string connected_account?; + string? connected_account?; # Currency of objects to be included in the report run. - string currency?; + string? currency?; # Ending timestamp of data to be included in the report run (exclusive). - int interval_end?; + int? interval_end?; # Starting timestamp of data to be included in the report run. - int interval_start?; + int? interval_start?; # Payout ID by which to filter the report run. - string payout?; + string? payout?; # Category of balance transactions to be included in the report run. - string reporting_category?; + string? reporting_category?; # Defaults to `Etc/UTC`. The output timezone for all timestamps in the report. A list of possible time zone values is maintained at the [IANA Time Zone Database](http://www.iana.org/time-zones). Has no effect on `interval_start` or `interval_end`. - string timezone?; + string? timezone?; }; public type IssuingAuthorizationMerchantData record { # A categorization of the seller's type of business. See our [merchant categories guide](https://stripe.com/docs/issuing/merchant-categories) for a list of possible values. - string category; + string? category; # The merchant category code for the seller’s business - string category_code; + string? category_code; # City where the seller is located string? city?; # Country where the seller is located @@ -5395,7 +5379,7 @@ public type IssuingAuthorizationMerchantData record { # Name of the seller string? name?; # Identifier assigned to the seller by the card brand - string network_id; + string? network_id; # Postal code where the seller is located string? postal_code?; # State where the seller is located @@ -5419,18 +5403,18 @@ public type PaymentMethodDetailsSepaDebit record { # All invoices will be billed using the specified settings public type SubscriptionSchedulesParam record { - int days_until_due?; + int? days_until_due?; }; public type GelatoSessionDocumentOptions record { # Array of strings of allowed identity document types. If the provided identity document isn’t one of the allowed types, the verification check will fail with a document_type_not_allowed error code. - string[] allowed_types?; + string[]? allowed_types?; # Collect an ID number and perform an [ID number check](https://stripe.com/docs/identity/verification-checks?type=id-number) with the document’s extracted name and date of birth. - boolean require_id_number?; + boolean? require_id_number?; # Disable image uploads, identity document images have to be captured using the device’s camera. - boolean require_live_capture?; + boolean? require_live_capture?; # Capture a face image and perform a [selfie check](https://stripe.com/docs/identity/verification-checks?type=selfie) comparing a photo ID and a picture of your user’s face. [Learn more](https://stripe.com/docs/identity/selfie). - boolean require_matching_selfie?; + boolean? require_matching_selfie?; }; # `Exchange Rate` objects allow you to determine the rates that Stripe is @@ -5446,20 +5430,20 @@ public type GelatoSessionDocumentOptions record { # details. public type ExchangeRate record { # Unique identifier for the object. Represented as the three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) in lowercase. - string id; + string? id; # String representing the object's type. Objects of the same type share the same value. - string 'object; + string? 'object; # Hash where the keys are supported currencies and the values are the exchange rate at which the base id currency converts to the key currency. record {} rates; }; public type IssuingTransactionFuelData record { # The type of fuel that was purchased. One of `diesel`, `unleaded_plus`, `unleaded_regular`, `unleaded_super`, or `other`. - string 'type; + string? 'type; # The units for `volume_decimal`. One of `us_gallon` or `liter`. - string unit; + string? unit; # The cost in cents per each unit of fuel, represented as a decimal string with at most 12 decimal places. - string unit_cost_decimal; + string? unit_cost_decimal; # The volume of the fuel that was pumped, represented as a decimal string with at most 12 decimal places. string? volume_decimal?; }; @@ -5470,23 +5454,23 @@ public type DeletedDiscount record { # A coupon contains information about a percent-off or amount-off discount you # might want to apply to a customer. Coupons may be applied to [invoices](https://stripe.com/docs/api#invoices) or # [orders](https://stripe.com/docs/api#create_order-coupon). Coupons do not work with conventional one-off [charges](https://stripe.com/docs/api#create_charge). - Coupon coupon; + Coupon? coupon; # The ID of the customer associated with this discount. string|Customer|DeletedCustomer? customer?; # Always true for a deleted object - boolean deleted; + boolean? deleted; # The ID of the discount object. Discounts cannot be fetched by ID. Use `expand[]=discounts` in API calls to expand discount IDs in an array. - string id; + string? id; # The invoice that the discount's coupon was applied to, if it was applied directly to a particular invoice. string? invoice?; # The invoice item `id` (or invoice line item `id` for invoice line items of type='subscription') that the discount's coupon was applied to, if it was applied directly to a particular invoice item or invoice line item. string? invoice_item?; # String representing the object's type. Objects of the same type share the same value. - string 'object; + string? 'object; # The promotion code applied to create this discount. string|PromotionCode? promotion_code?; # Date that the coupon was applied. - int 'start; + int? 'start; # The subscription that this coupon is applied to, if it is applied to a particular subscription. string? subscription?; }; @@ -5507,43 +5491,43 @@ public type PaymentMethodAfterpayClearpay record { public type V1SubscriptionsBody record { # A list of prices and quantities that will generate invoice items appended to the first invoice for this subscription. You may pass up to 20 items. - AddInvoiceItemEntry[] add_invoice_items?; + AddInvoiceItemEntry[]? add_invoice_items?; # A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the application owner's Stripe account. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions). - decimal application_fee_percent?; + decimal? application_fee_percent?; # Automatic tax settings for this subscription. - AutomaticTaxConfig automatic_tax?; + AutomaticTaxConfig? automatic_tax?; # For new subscriptions, a past timestamp to backdate the subscription's start date to. If set, the first invoice will contain a proration for the timespan between the start date and the current time. Can be combined with trials and the billing cycle anchor. - int backdate_start_date?; + int? backdate_start_date?; # A future timestamp to anchor the subscription's [billing cycle](https://stripe.com/docs/subscriptions/billing-cycle). This is used to determine the date of the first full invoice, and, for plans with `month` or `year` intervals, the day of the month for subsequent invoices. - int billing_cycle_anchor?; + int? billing_cycle_anchor?; # Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds. - BillingThresholdParams|string billing_thresholds?; + BillingThresholdParams|string? billing_thresholds?; # A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using `proration_behavior`. If set during a future period, this will always cause a proration for that period. - int cancel_at?; + int? cancel_at?; # Boolean indicating whether this subscription should cancel at the end of the current period. - boolean cancel_at_period_end?; + boolean? cancel_at_period_end?; # 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. When sending an invoice, Stripe will email your customer an invoice with payment instructions. Defaults to `charge_automatically`. - string collection_method?; + string? collection_method?; # The ID of the coupon to apply to this subscription. A coupon applied to a subscription will only affect invoices created for that particular subscription. - string coupon?; + string? coupon?; # The identifier of the customer to subscribe. - string customer; + string? customer; # Number of days a customer has to pay invoices generated by this subscription. Valid only for subscriptions where `collection_method` is set to `send_invoice`. - int days_until_due?; + int? days_until_due?; # ID of the default payment method for the subscription. It must belong to the customer associated with the subscription. This takes precedence over `default_source`. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://stripe.com/docs/api/customers/object#customer_object-default_source). - string default_payment_method?; + string? default_payment_method?; # ID of the default payment source for the subscription. It must belong to the customer associated with the subscription and be in a chargeable state. If `default_payment_method` is also set, `default_payment_method` will take precedence. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://stripe.com/docs/api/customers/object#customer_object-default_source). - string default_source?; + string? default_source?; # 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. - TaxRateArray|string default_tax_rates?; + TaxRateArray|string? default_tax_rates?; # Specifies which fields in the response should be expanded. - string[] expand?; + string[]? expand?; # A list of up to 20 subscription items, each with an attached price. - SubscriptionItemCreateParams[] items?; + SubscriptionItemCreateParams[]? items?; # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. - AdditionalProperties|string metadata?; + AdditionalProperties|string? metadata?; # Indicates if a customer is on or off-session while an invoice payment is attempted. - boolean off_session?; + boolean? off_session?; # Use `allow_incomplete` to create subscriptions with `status=incomplete` if the first invoice cannot be paid. Creating subscriptions with this status allows you to manage scenarios where additional user actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the [SCA Migration Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior. # # Use `default_incomplete` to create Subscriptions with `status=incomplete` when the first invoice requires payment, otherwise start as active. Subscriptions transition to `status=active` when successfully confirming the payment intent on the first invoice. This allows simpler management of scenarios where additional user actions are needed to pay a subscription’s invoice. Such as failed payments, [SCA regulation](https://stripe.com/docs/billing/migration/strong-customer-authentication), or collecting a mandate for a bank debit payment method. If the payment intent is not confirmed within 23 hours subscriptions transition to `status=incomplete_expired`, which is a terminal state. @@ -5551,30 +5535,30 @@ public type V1SubscriptionsBody record { # Use `error_if_incomplete` if you want Stripe to return an HTTP 402 status code if a subscription's first invoice cannot be paid. For example, if a payment method requires 3DS authentication due to SCA regulation and further user action is needed, this parameter does not create a subscription and returns an error instead. This was the default behavior for API versions prior to 2019-03-14. See the [changelog](https://stripe.com/docs/upgrades#2019-03-14) to learn more. # # `pending_if_incomplete` is only used with updates and cannot be passed when creating a subscription. - string payment_behavior?; + string? payment_behavior?; # Payment settings to pass to invoices created by the subscription. - PaymentSettings1 payment_settings?; + PaymentSettings1? payment_settings?; # Specifies an interval for how often to bill for any pending invoice items. It is analogous to calling [Create an invoice](https://stripe.com/docs/api#create_invoice) for the given subscription at the specified interval. - PendingInvoiceItemIntervalParams|string pending_invoice_item_interval?; + PendingInvoiceItemIntervalParams|string? pending_invoice_item_interval?; # The API ID of a promotion code to apply to this subscription. A promotion code applied to a subscription will only affect invoices created for that particular subscription. - string promotion_code?; + string? promotion_code?; # Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#prorations) resulting from the `billing_cycle_anchor`. Valid values are `create_prorations` or `none`. # # Passing `create_prorations` will cause proration invoice items to be created when applicable. Prorations can be disabled by passing `none`. If no value is passed, the default is `create_prorations`. - string proration_behavior?; + string? proration_behavior?; # If specified, the funds from the subscription's invoices will be transferred to the destination and the ID of the resulting transfers will be found on the resulting charges. - TransferDataSpecs2 transfer_data?; + TransferDataSpecs2? transfer_data?; # Unix timestamp representing the end of the trial period the customer will get before being charged for the first time. This will always overwrite any trials that might apply via a subscribed plan. If set, trial_end will override the default trial period of the plan the customer is being subscribed to. The special value `now` can be provided to end the customer's trial immediately. Can be at most two years from `billing_cycle_anchor`. - string|int trial_end?; + string|int? trial_end?; # Indicates if a plan's `trial_period_days` should be applied to the subscription. Setting `trial_end` per subscription is preferred, and this defaults to `false`. Setting this flag to `true` together with `trial_end` is not allowed. - boolean trial_from_plan?; + boolean? trial_from_plan?; # Integer representing the number of trial period days before the customer is charged for the first time. This will always overwrite any trials that might apply via a subscribed plan. - int trial_period_days?; + int? trial_period_days?; }; public type PaymentIntentPaymentMethodOptionsMandateOptionsAcssDebit record { # A URL for custom mandate text - string custom_mandate_url?; + string? custom_mandate_url?; # Description of the interval. Only required if the 'payment_schedule' parameter is 'interval' or 'combined'. string? interval_description?; # Payment schedule for the mandate. @@ -5595,25 +5579,25 @@ public type Review record { # The reason the review was closed, or null if it has not yet been closed. One of `approved`, `refunded`, `refunded_as_fraud`, `disputed`, or `redacted`. string? closed_reason?; # Time at which the object was created. Measured in seconds since the Unix epoch. - int created; + int? created; # Unique identifier for the object. - string id; + string? id; # The IP address where the payment originated. string? ip_address?; # Information related to the location of the payment. Note that this information is an approximation and attempts to locate the nearest population center - it should not be used to determine a specific address. RadarReviewResourceLocation? ip_address_location?; # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. - boolean livemode; + boolean? livemode; # String representing the object's type. Objects of the same type share the same value. - string 'object; + string? 'object; # If `true`, the review needs action. - boolean open; + boolean? open; # The reason the review was opened. One of `rule` or `manual`. - string opened_reason; + string? opened_reason; # The PaymentIntent ID associated with this review, if one exists. - string|PaymentIntent payment_intent?; + string|PaymentIntent? payment_intent?; # The reason the review is currently open or closed. One of `rule`, `manual`, `approved`, `refunded`, `refunded_as_fraud`, `disputed`, or `redacted`. - string reason; + string? reason; # Information related to the browsing session of the user who initiated the payment. RadarReviewResourceSession? session?; }; @@ -5626,19 +5610,19 @@ public type TaxId record { # Two-letter ISO code representing the country of the tax ID. string? country?; # Time at which the object was created. Measured in seconds since the Unix epoch. - int created; + int? created; # ID of the customer. string|Customer? customer?; # Unique identifier for the object. - string id; + string? id; # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. - boolean livemode; + boolean? livemode; # String representing the object's type. Objects of the same type share the same value. - string 'object; + string? 'object; # Type of the tax ID, one of `ae_trn`, `au_abn`, `au_arn`, `br_cnpj`, `br_cpf`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_vat`, `cl_tin`, `es_cif`, `eu_vat`, `gb_vat`, `hk_br`, `id_npwp`, `il_vat`, `in_gst`, `jp_cn`, `jp_rn`, `kr_brn`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `no_vat`, `nz_gst`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `th_vat`, `tw_vat`, `us_ein`, or `za_vat`. Note that some legacy tax IDs have type `unknown` - string 'type; + string? 'type; # Value of the tax ID. - string value; + string? value; # Tax ID verification information. TaxIdVerification? verification?; }; @@ -5646,37 +5630,37 @@ public type TaxId record { # When a non-stripe BIN is used, any use of an [issued card](https://stripe.com/docs/issuing) must be settled directly with the card network. The net amount owed is represented by an Issuing `Settlement` object. public type IssuingSettlement record { # The Bank Identification Number reflecting this settlement record. - string bin; + string? bin; # The date that the transactions are cleared and posted to user's accounts. - int clearing_date; + int? clearing_date; # Time at which the object was created. Measured in seconds since the Unix epoch. - int created; + int? created; # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). - string currency; + string? currency; # Unique identifier for the object. - string id; + string? id; # The total interchange received as reimbursement for the transactions. - int interchange_fees; + int? interchange_fees; # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. - boolean livemode; + boolean? livemode; # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. record {} metadata; # The total net amount required to settle with the network. - int net_total; + int? net_total; # The card network for this settlement report. One of ["visa"] - string network; + string? network; # The total amount of fees owed to the network. - int network_fees; + int? network_fees; # The Settlement Identification Number assigned by the network. - string network_settlement_identifier; + string? network_settlement_identifier; # String representing the object's type. Objects of the same type share the same value. - string 'object; + string? 'object; # One of `international` or `uk_national_net`. - string settlement_service; + string? settlement_service; # The total number of transactions reflected in this settlement. - int transaction_count; + int? transaction_count; # The total transaction amount reflected in this settlement. - int transaction_volume; + int? transaction_volume; }; public type PaymentMethodCardWalletGooglePay record { @@ -5684,25 +5668,25 @@ public type PaymentMethodCardWalletGooglePay record { public type PaymentMethodCard record { # Card brand. Can be `amex`, `diners`, `discover`, `jcb`, `mastercard`, `unionpay`, `visa`, or `unknown`. - string brand; + string? brand; # Checks on Card address and CVC if provided. PaymentMethodCardChecks? checks?; # Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected. string? country?; # Two-digit number representing the card's expiration month. - int exp_month; + int? exp_month; # Four-digit number representing the card's expiration year. - int exp_year; + int? exp_year; # Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number. # # *Starting May 1, 2021, card fingerprint in India for Connect will change to allow two fingerprints for the same card --- one for India and one for the rest of the world.* string? fingerprint?; # Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`. - string funding; + string? funding; # Details of the original PaymentMethod that created this object. PaymentMethodCardGeneratedCard? generated_from?; # The last four digits of the card. - string last4; + string? last4; # Contains information about card networks that can be used to process the payment. Networks? networks?; # Contains details on how this Card maybe be used for 3D Secure authentication. @@ -5717,13 +5701,13 @@ public type PaymentMethodDetailsCardInstallments record { }; public type PaymentFlowsPaymentMethodList record { - PaymentMethod[] data; + PaymentMethod[]? data; # True if this list has another page of items after this one that can be fetched. - boolean has_more; + boolean? has_more; # String representing the object's type. Objects of the same type share the same value. Always has the value `list`. - string 'object; + string? 'object; # The URL where this list can be accessed. - string url; + string? url; }; # An early fraud warning indicates that the card issuer has notified us that a @@ -5732,21 +5716,21 @@ public type PaymentFlowsPaymentMethodList record { # Related guide: [Early Fraud Warnings](https://stripe.com/docs/disputes/measuring#early-fraud-warnings). public type RadarEarlyFraudWarning record { # An EFW is actionable if it has not received a dispute and has not been fully refunded. You may wish to proactively refund a charge that receives an EFW, in order to avoid receiving a dispute later. - boolean actionable; + boolean? actionable; # ID of the charge this early fraud warning is for, optionally expanded. - string|Charge charge; + string|Charge? charge; # Time at which the object was created. Measured in seconds since the Unix epoch. - int created; + int? created; # The type of fraud labelled by the issuer. One of `card_never_received`, `fraudulent_card_application`, `made_with_counterfeit_card`, `made_with_lost_card`, `made_with_stolen_card`, `misc`, `unauthorized_use_of_card`. - string fraud_type; + string? fraud_type; # Unique identifier for the object. - string id; + string? id; # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. - boolean livemode; + boolean? livemode; # String representing the object's type. Objects of the same type share the same value. - string 'object; + string? 'object; # ID of the Payment Intent this early fraud warning is for, optionally expanded. - string|PaymentIntent payment_intent?; + string|PaymentIntent? payment_intent?; }; # When an [issued card](https://stripe.com/docs/issuing) is used to make a purchase, an Issuing `Authorization` @@ -5756,45 +5740,45 @@ public type RadarEarlyFraudWarning record { # Related guide: [Issued Card Authorizations](https://stripe.com/docs/issuing/purchases/authorizations). public type IssuingAuthorization record { # The total amount that was authorized or rejected. This amount is in the card's currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). - int amount; + int? amount; # Detailed breakdown of amount components. These amounts are denominated in `currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). IssuingAuthorizationAmountDetails? amount_details?; # Whether the authorization has been approved. - boolean approved; + boolean? approved; # How the card details were provided. - string authorization_method; + string? authorization_method; # List of balance transactions associated with this authorization. - BalanceTransaction[] balance_transactions; + BalanceTransaction[]? balance_transactions; # You can [create physical or virtual cards](https://stripe.com/docs/issuing/cards) that are issued to cardholders. - IssuingCard card; + IssuingCard? card; # The cardholder to whom this authorization belongs. string|IssuingCardholder? cardholder?; # Time at which the object was created. Measured in seconds since the Unix epoch. - int created; + int? created; # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). - string currency; + string? currency; # Unique identifier for the object. - string id; + string? id; # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. - boolean livemode; + boolean? livemode; # The total amount that was authorized or rejected. This amount is in the `merchant_currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). - int merchant_amount; + int? merchant_amount; # The currency that was presented to the cardholder for the authorization. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). - string merchant_currency; - IssuingAuthorizationMerchantData merchant_data; + string? merchant_currency; + IssuingAuthorizationMerchantData? merchant_data; # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. record {} metadata; # String representing the object's type. Objects of the same type share the same value. - string 'object; + string? 'object; # The pending authorization request. This field will only be non-null during an `issuing_authorization.request` webhook. IssuingAuthorizationPendingRequest? pending_request?; # History of every time `pending_request` was approved/denied, either by you directly or by Stripe (e.g. based on your `spending_controls`). If the merchant changes the authorization by performing an [incremental authorization](https://stripe.com/docs/issuing/purchases/authorizations), you can look at this field to see the previous requests for the authorization. - IssuingAuthorizationRequest[] request_history; + IssuingAuthorizationRequest[]? request_history; # The current status of the authorization in its lifecycle. - string status; + string? status; # List of [transactions](https://stripe.com/docs/api/issuing/transactions) associated with this authorization. - IssuingTransaction[] transactions; - IssuingAuthorizationVerificationData verification_data; + IssuingTransaction[]? transactions; + IssuingAuthorizationVerificationData? verification_data; # The digital wallet used for this authorization. One of `apple_pay`, `google_pay`, or `samsung_pay`. string? wallet?; }; @@ -5804,58 +5788,58 @@ public type IssuingAuthorization record { # cardholder and create a charge. public type ThreeDSecure record { # Amount of the charge that you will create when authentication completes. - int amount; + int? amount; # True if the cardholder went through the authentication flow and their bank indicated that authentication succeeded. - boolean authenticated; + boolean? authenticated; # You can store multiple cards on a customer in order to charge the customer # later. You can also store multiple debit cards on a recipient in order to # transfer to those cards later. # # Related guide: [Card Payments with Sources](https://stripe.com/docs/sources/cards). - Card card; + Card? card; # Time at which the object was created. Measured in seconds since the Unix epoch. - int created; + int? created; # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). - string currency; + string? currency; # Unique identifier for the object. - string id; + string? id; # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. - boolean livemode; + boolean? livemode; # String representing the object's type. Objects of the same type share the same value. - string 'object; + string? 'object; # If present, this is the URL that you should send the cardholder to for authentication. If you are going to use Stripe.js to display the authentication page in an iframe, you should use the value "_callback". string? redirect_url?; # Possible values are `redirect_pending`, `succeeded`, or `failed`. When the cardholder can be authenticated, the object starts with status `redirect_pending`. When liability will be shifted to the cardholder's bank (either because the cardholder was successfully authenticated, or because the bank has not implemented 3D Secure, the object wlil be in status `succeeded`. `failed` indicates that authentication was attempted unsuccessfully. - string status; + string? status; }; public type InvoicePayBody record { # Specifies which fields in the response should be expanded. - string[] expand?; + string[]? expand?; # In cases where the source used to pay the invoice has insufficient funds, passing `forgive=true` controls whether a charge should be attempted for the full amount available on the source, up to the amount to fully pay the invoice. This effectively forgives the difference between the amount available on the source and the amount due. # # Passing `forgive=false` will fail the charge if the source hasn't been pre-funded with the right amount. An example for this case is with ACH Credit Transfers and wires: if the amount wired is less than the amount due by a small amount, you might want to forgive the difference. Defaults to `false`. - boolean forgive?; + boolean? forgive?; # Indicates if a customer is on or off-session while an invoice payment is attempted. Defaults to `true` (off-session). - boolean off_session?; + boolean? off_session?; # Boolean representing whether an invoice is paid outside of Stripe. This will result in no charge being made. Defaults to `false`. - boolean paid_out_of_band?; + boolean? paid_out_of_band?; # A PaymentMethod to be charged. The PaymentMethod must be the ID of a PaymentMethod belonging to the customer associated with the invoice being paid. - string payment_method?; + string? payment_method?; # 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. - string 'source?; + string? 'source?; }; public type CustomerAddressWithName record { - OptionalFieldsAddress address; - string name; - string phone?; + OptionalFieldsAddress? address; + string? name; + string? phone?; }; public type CheckoutSessionPaymentMethodOptions record { - CheckoutAcssDebitPaymentMethodOptions acss_debit?; - PaymentMethodOptionsBoleto boleto?; - PaymentMethodOptionsOxxo oxxo?; + CheckoutAcssDebitPaymentMethodOptions? acss_debit?; + PaymentMethodOptionsBoleto? boleto?; + PaymentMethodOptionsOxxo? oxxo?; }; public type PaymentMethodOptionsAlipay record { @@ -5863,15 +5847,15 @@ public type PaymentMethodOptionsAlipay record { # Settings for automatic tax lookup for this invoice. public type AutomaticTaxParam record { - boolean enabled; + boolean? enabled; }; public type SubscriptionSchedulesParam1 record { - int days_until_due?; + int? days_until_due?; }; public type ItemBillingThresholdsParam record { - int usage_gte; + int? usage_gte; }; public type PaymentMethodDetailsKlarna record { @@ -5879,11 +5863,11 @@ public type PaymentMethodDetailsKlarna record { public type DeletedInvoice record { # Always true for a deleted object - boolean deleted; + boolean? deleted; # Unique identifier for the object. - string id; + string? id; # String representing the object's type. Objects of the same type share the same value. - string 'object; + string? 'object; }; public type InvoiceSettingQuoteSetting record { @@ -5893,7 +5877,7 @@ public type InvoiceSettingQuoteSetting record { public type PaymentMethodOptionsBancontact record { # Preferred language of the Bancontact authorization page that the customer is redirected to. - string preferred_language; + string? preferred_language; }; # To charge a credit or a debit card, you create a `Charge` object. You can @@ -5903,11 +5887,11 @@ public type PaymentMethodOptionsBancontact record { # Related guide: [Accept a payment with the Charges API](https://stripe.com/docs/payments/accept-a-payment-charges). public type Charge record { # Amount intended to be collected by this payment. A positive integer representing how much to charge in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The minimum amount is $0.50 US or [equivalent in charge currency](https://stripe.com/docs/currencies#minimum-and-maximum-charge-amounts). The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99). - int amount; + int? amount; # Amount in %s captured (can be less than the amount attribute on the charge if a partial capture was made). - int amount_captured; + int? amount_captured; # Amount in %s refunded (can be less than the amount attribute on the charge if a partial refund was issued). - int amount_refunded; + int? amount_refunded; # ID of the Connect application that created the charge. string|Application? application?; # The application fee (if any) for the charge. [See the Connect documentation](https://stripe.com/docs/connect/direct-charges#collecting-fees) for details. @@ -5916,21 +5900,21 @@ public type Charge record { int? application_fee_amount?; # ID of the balance transaction that describes the impact of this charge on your account balance (not including refunds or disputes). string|BalanceTransaction? balance_transaction?; - BillingDetails billing_details; + BillingDetails? billing_details; # 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. string? calculated_statement_descriptor?; # If the charge was created without capturing, this Boolean represents whether it is still uncaptured or has since been captured. - boolean captured; + boolean? captured; # Time at which the object was created. Measured in seconds since the Unix epoch. - int created; + int? created; # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). - string currency; + string? currency; # ID of the customer this charge is for if one exists. string|Customer|DeletedCustomer? customer?; # An arbitrary string attached to the object. Often useful for displaying to users. string? description?; # Whether the charge has been disputed. - boolean disputed; + boolean? disputed; # Error code explaining reason for charge failure if available (see [the errors section](https://stripe.com/docs/api#errors) for a list of codes). string? failure_code?; # Message to user further explaining reason for charge failure if available. @@ -5938,15 +5922,15 @@ public type Charge record { # Information on fraud assessments for the charge. ChargeFraudDetails? fraud_details?; # Unique identifier for the object. - string id; + string? id; # ID of the invoice this charge is for if one exists. string|Invoice? invoice?; # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. - boolean livemode; + boolean? livemode; # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. record {} metadata; # String representing the object's type. Objects of the same type share the same value. - string 'object; + string? 'object; # The account (if any) the charge was made on behalf of without triggering an automatic transfer. See the [Connect documentation](https://stripe.com/docs/connect/charges-transfers) for details. string|Account? on_behalf_of?; # ID of the order this charge is for if one exists. @@ -5954,7 +5938,7 @@ public type Charge record { # Details about whether the payment was accepted, and why. See [understanding declines](https://stripe.com/docs/declines) for details. ChargeOutcome? outcome?; # `true` if the charge succeeded, or was successfully authorized for later capture. - boolean paid; + boolean? paid; # ID of the PaymentIntent associated with this charge, if one exists. string|PaymentIntent? payment_intent?; # ID of the payment method used in this charge. @@ -5968,9 +5952,9 @@ public type Charge record { # 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 will be stylized as an Invoice receipt. string? receipt_url?; # Whether the charge has been fully refunded. If the charge is only partially refunded, this attribute will still be false. - boolean refunded; + boolean? refunded; # A list of refunds that have been applied to the charge. - RefundList refunds; + RefundList? refunds; # ID of the review associated with this charge if one exists. string|Review? review?; # Shipping information for the charge. @@ -5982,9 +5966,9 @@ public type Charge record { # Provides information about the charge that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters for the concatenated descriptor. string? statement_descriptor_suffix?; # The status of the payment is either `succeeded`, `pending`, or `failed`. - string status; + string? status; # ID of the transfer to the `destination` account (only applicable if the charge was created using the `destination` parameter). - string|Transfer transfer?; + string|Transfer? transfer?; # An optional dictionary including the account to automatically transfer to as part of a destination charge. [See the Connect documentation](https://stripe.com/docs/connect/destination-charges) for details. ChargeTransferData? transfer_data?; # A string that identifies this transaction as part of a group. See the [Connect documentation](https://stripe.com/docs/connect/charges-transfers#transfer-options) for details. @@ -5993,22 +5977,22 @@ public type Charge record { # A Mandate is a record of the permission a customer has given you to debit their payment method. public type Mandate record { - CustomerAcceptance customer_acceptance; + CustomerAcceptance? customer_acceptance; # Unique identifier for the object. - string id; + string? id; # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. - boolean livemode; - MandateMultiUse multi_use?; + boolean? livemode; + MandateMultiUse? multi_use?; # String representing the object's type. Objects of the same type share the same value. - string 'object; + string? 'object; # ID of the payment method associated with this mandate. - string|PaymentMethod payment_method; - MandatePaymentMethodDetails payment_method_details; - MandateSingleUse single_use?; + string|PaymentMethod? payment_method; + MandatePaymentMethodDetails? payment_method_details; + MandateSingleUse? single_use?; # The status of the mandate, which indicates whether it can be used to initiate a payment. - string status; + string? status; # The type of the mandate. - string 'type; + string? 'type; }; public type PaymentMethodDetailsCard record { @@ -6019,9 +6003,9 @@ public type PaymentMethodDetailsCard record { # Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected. string? country?; # Two-digit number representing the card's expiration month. - int exp_month; + int? exp_month; # Four-digit number representing the card's expiration year. - int exp_year; + int? exp_year; # Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number. # # *Starting May 1, 2021, card fingerprint in India for Connect will change to allow two fingerprints for the same card --- one for India and one for the rest of the world.* @@ -6067,31 +6051,31 @@ public type MandateMultiUse record { # Once accepted, it will automatically create an invoice, subscription or subscription schedule. public type Quote record { # Total before any discounts or taxes are applied. - int amount_subtotal; + int? amount_subtotal; # Total after discounts and taxes are applied. - int amount_total; + int? amount_total; # The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. Only applicable if there are no line items with recurring prices on the quote. int? application_fee_amount?; # A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the application owner's Stripe account. Only applicable if there are line items with recurring prices on the quote. decimal? application_fee_percent?; - QuotesResourceAutomaticTax automatic_tax; + QuotesResourceAutomaticTax? automatic_tax; # Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay invoices at the end of the subscription cycle or on finalization using the default payment method attached to the subscription or customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions. Defaults to `charge_automatically`. - string collection_method; - QuotesResourceComputed computed; + string? collection_method; + QuotesResourceComputed? computed; # Time at which the object was created. Measured in seconds since the Unix epoch. - int created; + int? created; # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). string? currency?; # The customer which this quote belongs to. A customer is required before finalizing the quote. Once specified, it cannot be changed. string|Customer|DeletedCustomer? customer?; # The tax rates applied to this quote. - (string|TaxRate)[] default_tax_rates?; + (string|TaxRate?)[]? default_tax_rates?; # A description that will be displayed on the quote PDF. string? description?; # The discounts applied to this quote. - (string|Discount)[] discounts; + (string|Discount?)[]? discounts; # The date on which the quote will be canceled if in `open` or `draft` status. Measured in seconds since the Unix epoch. - int expires_at; + int? expires_at; # A footer that will be displayed on the quote PDF. string? footer?; # Details of the quote that was cloned. See the [cloning documentation](https://stripe.com/docs/quotes/clone) for more details. @@ -6099,32 +6083,32 @@ public type Quote record { # A header that will be displayed on the quote PDF. string? header?; # Unique identifier for the object. - string id; + string? id; # The invoice that was created from this quote. string|Invoice|DeletedInvoice? invoice?; # All invoices will be billed using the specified settings. InvoiceSettingQuoteSetting? invoice_settings?; # A list of items the customer is being quoted for. - QuotesResourceListLineItems line_items?; + QuotesResourceListLineItems? line_items?; # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. - boolean livemode; + boolean? livemode; # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. record {} metadata; # A unique number that identifies this particular quote. This number is assigned once the quote is [finalized](https://stripe.com/docs/quotes/overview#finalize). string? number?; # String representing the object's type. Objects of the same type share the same value. - string 'object; + string? 'object; # The account on behalf of which to charge. See the [Connect documentation](https://support.stripe.com/questions/sending-invoices-on-behalf-of-connected-accounts) for details. string|Account? on_behalf_of?; # The status of the quote. - string status; - QuotesResourceStatusTransitions status_transitions; + string? status; + QuotesResourceStatusTransitions? status_transitions; # The subscription that was created or updated from this quote. string|Subscription? subscription?; - QuotesResourceSubscriptionData subscription_data; + QuotesResourceSubscriptionData? subscription_data; # The subscription schedule that was created or updated from this quote. string|SubscriptionSchedule? subscription_schedule?; - QuotesResourceTotalDetails total_details; + QuotesResourceTotalDetails? total_details; # The account (if any) the payments will be attributed to for tax reporting, and where funds from each payment will be transferred to for each of the invoices. QuotesResourceTransferData? transfer_data?; }; @@ -6135,29 +6119,29 @@ public type SubscriptionItem record { # Define thresholds at which an invoice will be sent, and the related subscription advanced to a new billing period SubscriptionItemBillingThresholds? billing_thresholds?; # Time at which the object was created. Measured in seconds since the Unix epoch. - int created; + int? created; # Unique identifier for the object. - string id; + string? id; # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. record {} metadata; # String representing the object's type. Objects of the same type share the same value. - string 'object; + string? 'object; # Prices define the unit cost, currency, and (optional) billing cycle for both recurring and one-time purchases of products. # [Products](https://stripe.com/docs/api#products) help you track inventory or provisioning, and prices help you track payment terms. Different physical goods or levels of service should be represented by products, and pricing options should be represented by prices. This approach lets you change prices without having to change your provisioning scheme. # # For example, you might have a single "gold" product that has prices for $10/month, $100/year, and €9 once. # # Related guides: [Set up a subscription](https://stripe.com/docs/billing/subscriptions/set-up-subscription), [create an invoice](https://stripe.com/docs/billing/invoices/create), and more about [products and prices](https://stripe.com/docs/billing/prices-guide). - Price price; + Price? price; # The [quantity](https://stripe.com/docs/subscriptions/quantities) of the plan to which the customer should be subscribed. - int quantity?; + int? quantity?; # The `subscription` this `subscription_item` belongs to. - string subscription; + string? subscription; # 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`. TaxRate[]? tax_rates?; }; -public type DeletedPaymentSource DeletedAlipayAccount|DeletedBankAccount|DeletedBitcoinReceiver|DeletedCard; +public type DeletedPaymentSource DeletedAlipayAccount|DeletedBankAccount|DeletedBitcoinReceiver|DeletedCard?; public type SourceTypeAuBecsDebit record { string? bsb_number?; @@ -6168,13 +6152,13 @@ public type SourceTypeAuBecsDebit record { # External accounts (bank accounts and debit cards) currently attached to this account public type ExternalAccountList record { # The list contains all external accounts that have been attached to the Stripe account. These may be bank accounts or cards. - (BankAccount|Card)[] data; + (BankAccount|Card?)[]? data; # True if this list has another page of items after this one that can be fetched. - boolean has_more; + boolean? has_more; # String representing the object's type. Objects of the same type share the same value. Always has the value `list`. - string 'object; + string? 'object; # The URL where this list can be accessed. - string url; + string? url; }; public type OnlineAcceptance record { @@ -6190,27 +6174,27 @@ public type SubscriptionItemBillingThresholds record { }; public type AccountCardPaymentsSettings record { - AccountDeclineChargeOn decline_on?; + AccountDeclineChargeOn? decline_on?; # The default text that appears on credit card statements when a charge is made. This field prefixes any dynamic `statement_descriptor` specified on the charge. `statement_descriptor_prefix` is useful for maximizing descriptor space for the dynamic portion. string? statement_descriptor_prefix?; }; public type SourceTransactionPaperCheckData record { # Time at which the deposited funds will be available for use. Measured in seconds since the Unix epoch. - string available_at?; + string? available_at?; # Comma-separated list of invoice IDs associated with the paper check. - string invoices?; + string? invoices?; }; public type GelatoReportDocumentOptions record { # Array of strings of allowed identity document types. If the provided identity document isn’t one of the allowed types, the verification check will fail with a document_type_not_allowed error code. - string[] allowed_types?; + string[]? allowed_types?; # Collect an ID number and perform an [ID number check](https://stripe.com/docs/identity/verification-checks?type=id-number) with the document’s extracted name and date of birth. - boolean require_id_number?; + boolean? require_id_number?; # Disable image uploads, identity document images have to be captured using the device’s camera. - boolean require_live_capture?; + boolean? require_live_capture?; # Capture a face image and perform a [selfie check](https://stripe.com/docs/identity/verification-checks?type=selfie) comparing a photo ID and a picture of your user’s face. [Learn more](https://stripe.com/docs/identity/selfie). - boolean require_matching_selfie?; + boolean? require_matching_selfie?; }; # This is an object representing a Stripe account. You can retrieve it to see @@ -6224,44 +6208,44 @@ public type Account record { AccountBusinessProfile? business_profile?; # The business type. string? business_type?; - AccountCapabilities capabilities?; + AccountCapabilities? capabilities?; # Whether the account can create live charges. - boolean charges_enabled?; - LegalEntityCompany company?; - AccountController controller?; + boolean? charges_enabled?; + LegalEntityCompany? company?; + AccountController? controller?; # The account's country. - string country?; + string? country?; # Time at which the object was created. Measured in seconds since the Unix epoch. - int created?; + int? created?; # Three-letter ISO currency code representing the default currency for the account. This must be a currency that [Stripe supports in the account's country](https://stripe.com/docs/payouts). - string default_currency?; + string? default_currency?; # Whether account details have been submitted. Standard accounts cannot receive payouts before this is true. - boolean details_submitted?; + boolean? details_submitted?; # An email address associated with the account. You can treat this as metadata: it is not used for authentication or messaging account holders. string? email?; # External accounts (bank accounts and debit cards) currently attached to this account - ExternalAccountList external_accounts?; + ExternalAccountList? external_accounts?; # Unique identifier for the object. - string id; + string? id; # This is an object representing a person associated with a Stripe account. # # A platform cannot access a Standard or Express account's persons after the account starts onboarding, such as after generating an account link for the account. # See the [Standard onboarding](https://stripe.com/docs/connect/standard-accounts) or [Express onboarding documentation](https://stripe.com/docs/connect/express-accounts) for information about platform pre-filling and account onboarding steps. # # Related guide: [Handling Identity Verification with the API](https://stripe.com/docs/connect/identity-verification-api#person-information). - Person individual?; + Person? individual?; # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. record {} metadata?; # String representing the object's type. Objects of the same type share the same value. - string 'object; + string? 'object; # Whether Stripe can send payouts to this account. - boolean payouts_enabled?; - AccountRequirements requirements?; + boolean? payouts_enabled?; + AccountRequirements? requirements?; # Options for customizing how the account functions within Stripe. AccountSettings? settings?; - AccountTosAcceptance tos_acceptance?; + AccountTosAcceptance? tos_acceptance?; # The Stripe account type. Can be `standard`, `express`, or `custom`. - string 'type?; + string? 'type?; }; # Invoices are statements of amounts owed by a customer, and are either @@ -6302,32 +6286,32 @@ public type Invoice record { # The public name of the business associated with this invoice, most often the business creating the invoice. string? account_name?; # The account tax IDs associated with the invoice. Only editable when the invoice is a draft. - (string|TaxId|DeletedTaxId)[]? account_tax_ids?; + (string|TaxId|DeletedTaxId?)[]? account_tax_ids?; # Final amount due at this time for this invoice. If the invoice's total is smaller than the minimum charge amount, for example, or if there is account credit that can be applied to the invoice, the `amount_due` may be 0. If there is a positive `starting_balance` for the invoice (the customer owes money), the `amount_due` will also take that into account. The charge that gets generated for the invoice will be for the amount specified in `amount_due`. - int amount_due; + int? amount_due; # The amount, in %s, that was paid. - int amount_paid; + int? amount_paid; # The amount remaining, in %s, that is due. - int amount_remaining; + int? amount_remaining; # The fee in %s that will be applied to the invoice and transferred to the application owner's Stripe account when the invoice is paid. int? application_fee_amount?; # Number of payment attempts made for this invoice, from the perspective of the payment retry schedule. Any payment attempt counts as the first attempt, and subsequently only automatic retries increment the attempt count. In other words, manual payment attempts after the first attempt do not affect the retry schedule. - int attempt_count; + int? attempt_count; # Whether an attempt has been made to pay the invoice. An invoice is not attempted until 1 hour after the `invoice.created` webhook, for example, so you might not want to display that invoice as unpaid to your users. - boolean attempted; + boolean? attempted; # Controls whether Stripe will perform [automatic collection](https://stripe.com/docs/billing/invoices/workflow/#auto_advance) of the invoice. When `false`, the invoice's state will not automatically advance without an explicit action. - boolean auto_advance?; - AutomaticTax automatic_tax; + boolean? auto_advance?; + AutomaticTax? automatic_tax; # Indicates the reason why the invoice was created. `subscription_cycle` indicates an invoice created by a subscription advancing into a new period. `subscription_create` indicates an invoice created due to creating a subscription. `subscription_update` indicates an invoice created due to updating a subscription. `subscription` is set for all old invoices to indicate either a change to a subscription or a period advancement. `manual` is set for all invoices unrelated to a subscription (for example: created via the invoice editor). The `upcoming` value is reserved for simulated invoices per the upcoming invoice endpoint. `subscription_threshold` indicates an invoice created due to a billing threshold being reached. string? billing_reason?; # ID of the latest charge generated for this invoice, if any. string|Charge? charge?; # 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. - string collection_method; + string? collection_method; # Time at which the object was created. Measured in seconds since the Unix epoch. - int created; + int? created; # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). - string currency; + string? currency; # Custom fields displayed on the invoice. InvoiceSettingCustomField[]? custom_fields?; # The ID of the customer who will be billed. @@ -6351,13 +6335,13 @@ public type Invoice record { # ID of the default payment source for the invoice. It must belong to the customer associated with the invoice and be in a chargeable state. If not set, defaults to the subscription's default source, if any, or to the customer's default source. string|AlipayAccount|BankAccount|BitcoinReceiver|Card|Source? default_source?; # The tax rates applied to this invoice, if any. - TaxRate[] default_tax_rates; + TaxRate[]? default_tax_rates; # An arbitrary string attached to the object. Often useful for displaying to users. Referenced as 'memo' in the Dashboard. string? description?; # Describes the current discount applied to this invoice, if there is one. Not populated if there are multiple discounts. Discount? discount?; # The discounts applied to the invoice. Line item discounts are applied before invoice discounts. Use `expand[]=discounts` to expand each discount. - (string|Discount|DeletedDiscount)[]? discounts?; + (string|Discount|DeletedDiscount?)[]? discounts?; # The date on which payment for this invoice is due. This value will be `null` for invoices where `collection_method=charge_automatically`. int? due_date?; # Ending customer balance after the invoice is finalized. Invoices are finalized approximately an hour after successful webhook delivery or when payment collection is attempted for the invoice. If the invoice has not been finalized yet, this will be null. @@ -6367,15 +6351,15 @@ public type Invoice record { # The URL for the hosted invoice page, which allows customers to view and pay an invoice. If the invoice has not been finalized yet, this will be null. string? hosted_invoice_url?; # Unique identifier for the object. - string id?; + string? id?; # The link to download the PDF for the invoice. If the invoice has not been finalized yet, this will be null. string? invoice_pdf?; # The error encountered during the previous attempt to finalize the invoice. This field is cleared when the invoice is successfully finalized. ApiErrors? last_finalization_error?; # The individual line items that make up the invoice. `lines` is sorted as follows: invoice items in reverse chronological order, followed by the subscription, if any. - Invoicelineslist1 lines; + Invoicelineslist1? lines; # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. - boolean livemode; + boolean? livemode; # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. record {} metadata?; # The time at which payment will next be attempted. This value will be `null` for invoices where `collection_method=send_invoice`. @@ -6383,48 +6367,48 @@ public type Invoice record { # A unique, identifying string that appears on emails sent to the customer for this invoice. This starts with the customer's unique invoice_prefix if it is specified. string? number?; # String representing the object's type. Objects of the same type share the same value. - string 'object; + string? 'object; # The account (if any) for which the funds of the invoice payment are intended. If set, the invoice will be presented with the branding and support information of the specified account. See the [Invoices with Connect](https://stripe.com/docs/billing/invoices/connect) documentation for details. string|Account? on_behalf_of?; # 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. - boolean paid; + boolean? paid; # The PaymentIntent associated with this invoice. The PaymentIntent is generated when the invoice is finalized, and can then be used to pay the invoice. Note that voiding an invoice will cancel the PaymentIntent. string|PaymentIntent? payment_intent?; - InvoicesPaymentSettings payment_settings; + InvoicesPaymentSettings? payment_settings; # End of the usage period during which invoice items were added to this invoice. - int period_end; + int? period_end; # Start of the usage period during which invoice items were added to this invoice. - int period_start; + int? period_start; # Total amount of all post-payment credit notes issued for this invoice. - int post_payment_credit_notes_amount; + int? post_payment_credit_notes_amount; # Total amount of all pre-payment credit notes issued for this invoice. - int pre_payment_credit_notes_amount; + int? pre_payment_credit_notes_amount; # The quote this invoice was generated from. string|Quote? quote?; # This is the transaction number that appears on email receipts sent for this invoice. string? receipt_number?; # Starting customer balance before the invoice is finalized. If the invoice has not been finalized yet, this will be the current customer balance. - int starting_balance; + int? starting_balance; # Extra information about an invoice for the customer's credit card statement. string? statement_descriptor?; # The status of the invoice, one of `draft`, `open`, `paid`, `uncollectible`, or `void`. [Learn more](https://stripe.com/docs/billing/invoices/workflow#workflow-overview) string? status?; - InvoicesStatusTransitions status_transitions; + InvoicesStatusTransitions? status_transitions; # The subscription that this invoice was prepared for, if any. string|Subscription? subscription?; # Only set for upcoming invoices that preview prorations. The time used to calculate prorations. - int subscription_proration_date?; + int? subscription_proration_date?; # Total of all subscriptions, invoice items, and prorations on the invoice before any invoice level discount or tax is applied. Item discounts are already incorporated - int subtotal; + int? subtotal; # The amount of tax on this invoice. This is the sum of all the tax amounts on this invoice. int? tax?; - InvoiceThresholdReason threshold_reason?; + InvoiceThresholdReason? threshold_reason?; # Total after discounts and taxes. - int total; + int? total; # The aggregate amounts calculated per discount across all line items. DiscountsResourceDiscountAmount[]? total_discount_amounts?; # The aggregate amounts calculated per tax rate for all line items. - InvoiceTaxAmount[] total_tax_amounts; + InvoiceTaxAmount[]? total_tax_amounts; # The account (if any) the payment will be attributed to for tax reporting, and where funds from the payment will be transferred to for the invoice. InvoiceTransferData? transfer_data?; # Invoices are automatically paid or sent 1 hour after webhooks are delivered, or until all webhook delivery attempts have [been exhausted](https://stripe.com/docs/billing/webhooks#understand). This field tracks the time when webhooks for this invoice were successfully delivered. If the invoice had no webhooks to deliver, this will be set while the invoice is being created. @@ -6433,7 +6417,7 @@ public type Invoice record { public type CustomerTax record { # Surfaces if automatic tax computation is possible given the current customer location information. - string automatic_tax; + string? automatic_tax; # A recent IP address of the customer used for tax reporting and tax location inference. string? ip_address?; # The customer's location as identified by Stripe Tax. @@ -6442,26 +6426,26 @@ public type CustomerTax record { public type DeletedTerminalReader record { # Always true for a deleted object - boolean deleted; + boolean? deleted; # Unique identifier for the object. - string id; + string? id; # String representing the object's type. Objects of the same type share the same value. - string 'object; + string? 'object; }; public type ConnectCollectionTransfer record { # Amount transferred, in %s. - int amount; + int? amount; # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). - string currency; + string? currency; # ID of the account that funds are being collected for. - string|Account destination; + string|Account? destination; # Unique identifier for the object. - string id; + string? id; # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. - boolean livemode; + boolean? livemode; # String representing the object's type. Objects of the same type share the same value. - string 'object; + string? 'object; }; public type PaymentMethodDetailsAuBecsDebit record { @@ -6472,10 +6456,10 @@ public type PaymentMethodDetailsAuBecsDebit record { # Last four digits of the bank account number. string? last4?; # ID of the mandate used to make this payment. - string mandate?; + string? mandate?; }; -public type Discounts DiscountsDataParam|string; +public type Discounts DiscountsDataParam|string?; public type SourceTypeAcssDebit record { string? bank_address_city?; @@ -6492,77 +6476,77 @@ public type SourceTypeAcssDebit record { public type PaymentPagesCheckoutSessionAutomaticTax record { # Indicates whether automatic tax is enabled for the session - boolean enabled; + boolean? enabled; # The status of the most recent automated tax calculation for this session. string? status?; }; public type TransferDataSpecs record { - decimal amount_percent?; - string destination; + decimal? amount_percent?; + string? destination; }; # A line item. public type Item record { # Total before any discounts or taxes are applied. - int amount_subtotal; + int? amount_subtotal; # Total after discounts and taxes. - int amount_total; + int? amount_total; # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). - string currency; + string? currency; # An arbitrary string attached to the object. Often useful for displaying to users. Defaults to product name. - string description; + string? description; # The discounts applied to the line item. - LineItemsDiscountAmount[] discounts?; + LineItemsDiscountAmount[]? discounts?; # Unique identifier for the object. - string id; + string? id; # String representing the object's type. Objects of the same type share the same value. - string 'object; + string? 'object; # The price used to generate the line item. Price? price?; # The quantity of products being purchased. int? quantity?; # The taxes applied to the line item. - LineItemsTaxAmount[] taxes?; + LineItemsTaxAmount[]? taxes?; }; public type CreditNoteTaxAmount record { # The amount, in %s, of the tax. - int amount; + int? amount; # Whether this tax amount is inclusive or exclusive. - boolean inclusive; + boolean? inclusive; # The tax rate that was applied to get this tax amount. - string|TaxRate tax_rate; + string|TaxRate? tax_rate; }; public type CardGeneratedFromPaymentMethodDetails record { - PaymentMethodDetailsCardPresent card_present?; + PaymentMethodDetailsCardPresent? card_present?; # The type of payment method transaction-specific details from the transaction that generated this `card` payment method. Always `card_present`. - string 'type; + string? 'type; }; public type V1SubscriptionSchedulesBody record { # The identifier of the customer to create the subscription schedule for. - string customer?; + string? customer?; # Object representing the subscription schedule's default settings. - DefaultSettingsParams default_settings?; + DefaultSettingsParams? default_settings?; # Configures how the subscription schedule behaves when it ends. Possible values are `release` or `cancel` with the default being `release`. `release` will end the subscription schedule and keep the underlying subscription running.`cancel` will end the subscription schedule and cancel the underlying subscription. - string end_behavior?; + string? end_behavior?; # Specifies which fields in the response should be expanded. - string[] expand?; + string[]? expand?; # Migrate an existing subscription to be managed by a subscription schedule. If this parameter is set, a subscription schedule will be created using the subscription's item(s), set to auto-renew using the subscription's interval. When using this parameter, other parameters (such as phase values) cannot be set. To create a subscription schedule with other modifications, we recommend making two separate API calls. - string from_subscription?; + string? from_subscription?; # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. - record {}|string metadata?; + record {}|string? metadata?; # List representing phases of the subscription schedule. Each phase can be customized to have different durations, plans, and coupons. If there are multiple phases, the `end_date` of one phase will always equal the `start_date` of the next phase. - PhaseConfigurationParams[] phases?; + PhaseConfigurationParams[]? phases?; # When the subscription schedule starts. We recommend using `now` so that it starts the subscription immediately. You can also use a Unix timestamp to backdate the subscription so that it starts on a past date, or set a future date for the subscription to start on. - int|string start_date?; + int|string? start_date?; }; public type PortalInvoiceList record { # Whether the feature is enabled. - boolean enabled; + boolean? enabled; }; # Subscriptions allow you to charge a customer on a recurring basis. @@ -6571,27 +6555,27 @@ public type PortalInvoiceList record { public type Subscription record { # A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the application owner's Stripe account. decimal? application_fee_percent?; - SubscriptionAutomaticTax automatic_tax; + SubscriptionAutomaticTax? automatic_tax; # Determines the date of the first full invoice, and, for plans with `month` or `year` intervals, the day of the month for subsequent invoices. - int billing_cycle_anchor; + int? billing_cycle_anchor; # Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period SubscriptionBillingThresholds? billing_thresholds?; # A date in the future at which the subscription will automatically get canceled int? cancel_at?; # 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. - boolean cancel_at_period_end; + boolean? cancel_at_period_end; # If the subscription has been canceled, the date of that cancellation. If the subscription was canceled with `cancel_at_period_end`, `canceled_at` will reflect the time of the most recent update request, not the end of the subscription period when the subscription is automatically moved to a canceled state. int? canceled_at?; # 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. When sending an invoice, Stripe will email your customer an invoice with payment instructions. - string collection_method; + string? collection_method; # Time at which the object was created. Measured in seconds since the Unix epoch. - int created; + int? created; # End of the current period that the subscription has been invoiced for. At the end of this period, a new invoice will be created. - int current_period_end; + int? current_period_end; # Start of the current period that the subscription has been invoiced for. - int current_period_start; + int? current_period_start; # ID of the customer who owns the subscription. - string|Customer|DeletedCustomer customer; + string|Customer|DeletedCustomer? customer; # Number of days a customer has to pay invoices generated by this subscription. This value will be `null` for subscriptions where `collection_method=charge_automatically`. int? days_until_due?; # ID of the default payment method for the subscription. It must belong to the customer associated with the subscription. This takes precedence over `default_source`. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://stripe.com/docs/api/customers/object#customer_object-default_source). @@ -6605,19 +6589,19 @@ public type Subscription record { # If the subscription has ended, the date the subscription ended. int? ended_at?; # Unique identifier for the object. - string id; + string? id; # List of subscription items, each with an attached price. - SubscriptionItemList items; + SubscriptionItemList? items; # The most recent invoice this subscription has generated. string|Invoice? latest_invoice?; # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. - boolean livemode; + boolean? livemode; # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. record {} metadata; # Specifies the approximate timestamp on which any pending invoice items will be billed according to the schedule provided at `pending_invoice_item_interval`. int? next_pending_invoice_item_invoice?; # String representing the object's type. Objects of the same type share the same value. - string 'object; + string? 'object; # If specified, payment collection for this subscription will be paused. SubscriptionsResourcePauseCollection? pause_collection?; # Payment settings passed on to invoices created by the subscription. @@ -6631,7 +6615,7 @@ public type Subscription record { # The schedule attached to the subscription string|SubscriptionSchedule? schedule?; # Date when the subscription was first created. The date might differ from the `created` date due to backdating. - int start_date; + int? start_date; # Possible values are `incomplete`, `incomplete_expired`, `trialing`, `active`, `past_due`, `canceled`, or `unpaid`. # # For `collection_method=charge_automatically` a subscription moves into `incomplete` if the initial payment attempt fails. A subscription in this state can only have metadata and default_source updated. Once the first invoice is paid, the subscription moves into an `active` state. If the first invoice is not paid within 23 hours, the subscription transitions to `incomplete_expired`. This is a terminal state, the open invoice will be voided and no further invoices will be generated. @@ -6641,7 +6625,7 @@ public type Subscription record { # If subscription `collection_method=charge_automatically` it becomes `past_due` when payment to renew it fails and `canceled` or `unpaid` (depending on your subscriptions settings) when Stripe has exhausted all payment retry attempts. # # If subscription `collection_method=send_invoice` it becomes `past_due` when its invoice is not paid by the due date, and `canceled` or `unpaid` if it is still not paid by an additional deadline after that. Note that when a subscription has a status of `unpaid`, no subsequent invoices will be attempted (invoices will be created, but then immediately automatically closed). After receiving updated payment information from a customer, you may choose to reopen and pay their closed invoices. - string status; + string? status; # 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. SubscriptionTransferData? transfer_data?; # If the subscription has a trial, the end of that trial. @@ -6657,42 +6641,42 @@ public type PaymentMethodCardPresent record { # create multiple codes for a single coupon. public type PromotionCode record { # Whether the promotion code is currently active. A promotion code is only active if the coupon is also valid. - boolean active; + boolean? active; # The customer-facing code. Regardless of case, this code must be unique across all active promotion codes for each customer. - string code; + string? code; # A coupon contains information about a percent-off or amount-off discount you # might want to apply to a customer. Coupons may be applied to [invoices](https://stripe.com/docs/api#invoices) or # [orders](https://stripe.com/docs/api#create_order-coupon). Coupons do not work with conventional one-off [charges](https://stripe.com/docs/api#create_charge). - Coupon coupon; + Coupon? coupon; # Time at which the object was created. Measured in seconds since the Unix epoch. - int created; + int? created; # The customer that this promotion code can be used by. string|Customer|DeletedCustomer? customer?; # Date at which the promotion code can no longer be redeemed. int? expires_at?; # Unique identifier for the object. - string id; + string? id; # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. - boolean livemode; + boolean? livemode; # Maximum number of times this promotion code can be redeemed. int? max_redemptions?; # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. record {} metadata?; # String representing the object's type. Objects of the same type share the same value. - string 'object; - PromotionCodesResourceRestrictions restrictions; + string? 'object; + PromotionCodesResourceRestrictions? restrictions; # Number of times this promotion code has been used. - int times_redeemed; + int? times_redeemed; }; public type AccountBacsDebitPaymentsSettings record { # The Bacs Direct Debit Display Name for this account. For payments made with Bacs Direct Debit, this will appear on the mandate, and as the statement descriptor. - string display_name?; + string? display_name?; }; public type IssuingCardholderCompany record { # Whether the company's business ID number was provided. - boolean tax_id_provided; + boolean? tax_id_provided; }; public type SetupAttemptPaymentMethodDetailsSepaDebit record { @@ -6702,18 +6686,18 @@ public type SubscriptionTransferData record { # 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 destination account. By default, the entire amount is transferred to the destination. decimal? amount_percent?; # The account where funds from the payment will be transferred to upon payment success. - string|Account destination; + string|Account? destination; }; public type InvoiceLinesList record { # Details about each object. - LineItem[] data; + LineItem[]? data; # True if this list has another page of items after this one that can be fetched. - boolean has_more; + boolean? has_more; # String representing the object's type. Objects of the same type share the same value. Always has the value `list`. - string 'object; + string? 'object; # The URL where this list can be accessed. - string url; + string? url; }; # You can store multiple cards on a customer in order to charge the customer @@ -6743,7 +6727,7 @@ public type Card record { # A set of available payout methods for this card. Only values from this set should be passed as the `method` when creating a payout. string[]? available_payout_methods?; # Card brand. Can be `American Express`, `Diners Club`, `Discover`, `JCB`, `MasterCard`, `UnionPay`, `Visa`, or `Unknown`. - string brand; + string? brand; # Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected. string? country?; # Three-letter [ISO code for currency](https://stripe.com/docs/payouts). Only applicable on accounts (not customers or recipients). The card can be used as a transfer destination for funds in this currency. @@ -6757,25 +6741,25 @@ public type Card record { # (For tokenized numbers only.) The last four digits of the device account number. string? dynamic_last4?; # Two-digit number representing the card's expiration month. - int exp_month; + int? exp_month; # Four-digit number representing the card's expiration year. - int exp_year; + int? exp_year; # Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number. # # *Starting May 1, 2021, card fingerprint in India for Connect will change to allow two fingerprints for the same card --- one for India and one for the rest of the world.* string? fingerprint?; # Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`. - string funding; + string? funding; # Unique identifier for the object. - string id; + string? id; # The last four digits of the card. - string last4; + string? last4; # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. record {} metadata?; # Cardholder name. string? name?; # String representing the object's type. Objects of the same type share the same value. - string 'object; + string? 'object; # The recipient that this card belongs to. This attribute will not be in the card object if the card belongs to a customer or account instead. string|Recipient? recipient?; # If the card number is tokenized, this is the method that was used. Can be `android_pay` (includes Google Pay), `apple_pay`, `masterpass`, `visa_checkout`, or null. @@ -6785,7 +6769,7 @@ public type Card record { public type QuotesResourceComputed record { # The definitive totals and line items the customer will be charged on a recurring basis. Takes into account the line items with recurring prices and discounts with `duration=forever` coupons only. Defaults to `null` if no inputted line items with recurring prices. QuotesResourceRecurring? recurring?; - QuotesResourceUpfront upfront; + QuotesResourceUpfront? upfront; }; # Stripe needs to collect certain pieces of information about each account @@ -6796,20 +6780,20 @@ public type QuotesResourceComputed record { # guide](/docs/connect/required-verification-information). public type CountrySpec record { # The default currency for this country. This applies to both payment methods and bank accounts. - string default_currency; + string? default_currency; # Unique identifier for the object. Represented as the ISO country code for this country. - string id; + string? id; # String representing the object's type. Objects of the same type share the same value. - string 'object; + string? 'object; # Currencies that can be accepted in the specific country (for transfers). record {} supported_bank_account_currencies; # Currencies that can be accepted in the specified country (for payments). - string[] supported_payment_currencies; + string[]? supported_payment_currencies; # Payment methods available in the specified country. You may need to enable some payment methods (e.g., [ACH](https://stripe.com/docs/ach)) on your account before they appear in this list. The `stripe` payment method refers to [charging through your platform](https://stripe.com/docs/connect/destination-charges). - string[] supported_payment_methods; + string[]? supported_payment_methods; # Countries that can accept transfers from the specified country. - string[] supported_transfer_countries; - CountrySpecVerificationFields verification_fields; + string[]? supported_transfer_countries; + CountrySpecVerificationFields? verification_fields; }; public type PaymentMethodEps record { @@ -6819,11 +6803,11 @@ public type PaymentMethodEps record { public type Rule record { # The action taken on the payment. - string action; + string? action; # Unique identifier for the object. - string id; + string? id; # The predicate to evaluate the payment against. - string predicate; + string? predicate; }; # Balance transactions represent funds moving through your Stripe account. @@ -6832,35 +6816,35 @@ public type Rule record { # Related guide: [Balance Transaction Types](https://stripe.com/docs/reports/balance-transaction-types). public type BalanceTransaction record { # Gross amount of the transaction, in %s. - int amount; + int? amount; # The date the transaction's net funds will become available in the Stripe balance. - int available_on; + int? available_on; # Time at which the object was created. Measured in seconds since the Unix epoch. - int created; + int? created; # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). - string currency; + string? currency; # An arbitrary string attached to the object. Often useful for displaying to users. string? description?; # The exchange rate used, if applicable, for this transaction. Specifically, if money was converted from currency A to currency B, then the `amount` in currency A, times `exchange_rate`, would be the `amount` in currency B. For example, suppose you charged a customer 10.00 EUR. Then the PaymentIntent's `amount` would be `1000` and `currency` would be `eur`. Suppose this was converted into 12.34 USD in your Stripe account. Then the BalanceTransaction's `amount` would be `1234`, `currency` would be `usd`, and `exchange_rate` would be `1.234`. decimal? exchange_rate?; # Fees (in %s) paid for this transaction. - int fee; + int? fee; # Detailed breakdown of fees (in %s) paid for this transaction. - Fee[] fee_details; + Fee[]? fee_details; # Unique identifier for the object. - string id; + string? id; # Net amount of the transaction, in %s. - int net; + int? net; # String representing the object's type. Objects of the same type share the same value. - string 'object; + string? 'object; # [Learn more](https://stripe.com/docs/reports/reporting-categories) about how reporting categories can help you understand balance transactions from an accounting perspective. - string reporting_category; + string? reporting_category; # The Stripe object to which this transaction is related. string|ApplicationFee|Charge|ConnectCollectionTransfer|Dispute|FeeRefund|IssuingAuthorization|IssuingDispute|IssuingTransaction|Payout|PlatformTaxFee|Refund|ReserveTransaction|TaxDeductedAtSource|Topup|Transfer|TransferReversal? 'source?; # If the transaction's net funds are available in the Stripe balance yet. Either `available` or `pending`. - string status; + string? status; # Transaction type: `adjustment`, `advance`, `advance_funding`, `anticipation_repayment`, `application_fee`, `application_fee_refund`, `charge`, `connect_collection_transfer`, `contribution`, `issuing_authorization_hold`, `issuing_authorization_release`, `issuing_dispute`, `issuing_transaction`, `payment`, `payment_failure_refund`, `payment_refund`, `payout`, `payout_cancel`, `payout_failure`, `refund`, `refund_failure`, `reserve_transaction`, `reserved_funds`, `stripe_fee`, `stripe_fx_fee`, `tax_fee`, `topup`, `topup_reversal`, `transfer`, `transfer_cancel`, `transfer_failure`, or `transfer_refund`. [Learn more](https://stripe.com/docs/reports/balance-transaction-types) about balance transaction types and what they represent. If you are looking to classify transactions for accounting purposes, you might want to consider `reporting_category` instead. - string 'type; + string? 'type; }; # Result from an id_number check @@ -6878,20 +6862,20 @@ public type GelatoIdNumberReport record { # Last name. string? last_name?; # Status of this `id_number` check. - string status; + string? status; }; public type AccountCardIssuingSettings record { - CardIssuingAccountTermsOfService tos_acceptance?; + CardIssuingAccountTermsOfService? tos_acceptance?; }; # Object representing the subscription schedule’s default settings public type SubscriptionSchedulesResourceDefaultSettings record { # A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the application owner's Stripe account during this phase of the schedule. decimal? application_fee_percent?; - SubscriptionSchedulesResourceDefaultSettingsAutomaticTax automatic_tax?; + SubscriptionSchedulesResourceDefaultSettingsAutomaticTax? automatic_tax?; # Possible values are `phase_start` or `automatic`. If `phase_start` then billing cycle anchor of the subscription is set to the start of the phase when entering the phase. If `automatic` then the billing cycle anchor is automatically modified as needed when entering the phase. For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle). - string billing_cycle_anchor; + string? billing_cycle_anchor; # Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period SubscriptionBillingThresholds? billing_thresholds?; # Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay the underlying subscription at the end of each billing cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions. @@ -6905,8 +6889,8 @@ public type SubscriptionSchedulesResourceDefaultSettings record { }; public type GelatoVerificationSessionOptions record { - GelatoSessionDocumentOptions document?; - GelatoSessionIdNumberOptions id_number?; + GelatoSessionDocumentOptions? document?; + GelatoSessionIdNumberOptions? id_number?; }; public type PaymentMethodCardGeneratedCard record { @@ -6931,23 +6915,23 @@ public type SourceTypeAchCreditTransfer record { public type PortalSubscriptionUpdate record { # The types of subscription updates that are supported for items listed in the `products` attribute. When empty, subscriptions are not updateable. - string[] default_allowed_updates; + string[]? default_allowed_updates; # Whether the feature is enabled. - boolean enabled; + boolean? enabled; # The list of products that support subscription updates. PortalSubscriptionUpdateProduct[]? products?; # Determines how to handle prorations resulting from subscription updates. Valid values are `none`, `create_prorations`, and `always_invoice`. - string proration_behavior; + string? proration_behavior; }; public type PaymentMethodOptionsOxxo record { # The number of calendar days before an OXXO invoice expires. For example, if you create an OXXO invoice on Monday and you set expires_after_days to 2, the OXXO invoice will expire on Wednesday at 23:59 America/Mexico_City time. - int expires_after_days; + int? expires_after_days; }; public type PendingInvoiceItemIntervalParams record { - string interval; - int interval_count?; + string? interval; + int? interval_count?; }; public type LegalEntityDob record { @@ -6960,13 +6944,13 @@ public type LegalEntityDob record { }; public type BillingThresholdParams record { - int amount_gte?; - boolean reset_billing_cycle_anchor?; + int? amount_gte?; + boolean? reset_billing_cycle_anchor?; }; public type SetupIntentPaymentMethodOptionsMandateOptionsAcssDebit record { # A URL for custom mandate text - string custom_mandate_url?; + string? custom_mandate_url?; # Description of the interval. Only required if the 'payment_schedule' parameter is 'interval' or 'combined'. string? interval_description?; # Payment schedule for the mandate. @@ -6977,11 +6961,11 @@ public type SetupIntentPaymentMethodOptionsMandateOptionsAcssDebit record { public type DeletedPrice record { # Always true for a deleted object - boolean deleted; + boolean? deleted; # Unique identifier for the object. - string id; + string? id; # String representing the object's type. Objects of the same type share the same value. - string 'object; + string? 'object; }; public type DisputeEvidence record { @@ -7070,29 +7054,29 @@ public type PaymentMethodDetailsBancontact record { public type CreditNoteLineItem record { # The integer amount in %s representing the gross amount being credited for this line item, excluding (exclusive) tax and discounts. - int amount; + int? amount; # Description of the item being credited. string? description?; # The integer amount in %s representing the discount being credited for this line item. - int discount_amount; + int? discount_amount; # The amount of discount calculated per discount for this line item - DiscountsResourceDiscountAmount[] discount_amounts; + DiscountsResourceDiscountAmount[]? discount_amounts; # Unique identifier for the object. - string id; + string? id; # ID of the invoice line item being credited - string invoice_line_item?; + string? invoice_line_item?; # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. - boolean livemode; + boolean? livemode; # String representing the object's type. Objects of the same type share the same value. - string 'object; + string? 'object; # The number of units of product being credited. int? quantity?; # The amount of tax calculated per tax rate for this line item - CreditNoteTaxAmount[] tax_amounts; + CreditNoteTaxAmount[]? tax_amounts; # The tax rates which apply to the line item. - TaxRate[] tax_rates; + TaxRate[]? tax_rates; # 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. - string 'type; + string? 'type; # The cost of each unit of product being credited. int? unit_amount?; # Same as `unit_amount`, but contains a decimal value with at most 12 decimal places. @@ -7114,74 +7098,74 @@ public type IssuingCardholderIndividualDob record { # A list with one entry for each time that the customer sent bitcoin to the receiver. Hidden when viewing the receiver with a publishable key. public type BitcoinTransactionList record { # Details about each object. - BitcoinTransaction[] data; + BitcoinTransaction[]? data; # True if this list has another page of items after this one that can be fetched. - boolean has_more; + boolean? has_more; # String representing the object's type. Objects of the same type share the same value. Always has the value `list`. - string 'object; + string? 'object; # The URL where this list can be accessed. - string url; + string? url; }; # If this is a `sofort` PaymentMethod, this hash contains details about the SOFORT payment method. public type Param8 record { - string country; + string? country; }; # If this is a `sepa_debit` PaymentMethod, this hash contains details about the SEPA debit bank account. public type Param7 record { - string iban; + string? iban; }; # If this is a `p24` PaymentMethod, this hash contains details about the P24 payment method. public type Param6 record { - string bank?; + string? bank?; }; public type Fee record { # Amount of the fee, in cents. - int amount; + int? amount; # ID of the Connect application that earned the fee. string? application?; # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). - string currency; + string? currency; # An arbitrary string attached to the object. Often useful for displaying to users. string? description?; # Type of the fee, one of: `application_fee`, `stripe_fee` or `tax`. - string 'type; + string? 'type; }; # If this is an `ideal` PaymentMethod, this hash contains details about the iDEAL payment method. public type Param5 record { - string bank?; + string? bank?; }; # If this is an `fpx` PaymentMethod, this hash contains details about the FPX payment method. public type Param4 record { - string bank; + string? bank; }; # If this is an `eps` PaymentMethod, this hash contains details about the EPS payment method. public type Param3 record { - string bank?; + string? bank?; }; # If this is a `boleto` PaymentMethod, this hash contains details about the Boleto payment method. public type Param2 record { - string tax_id; + string? tax_id; }; # If this is a `bacs_debit` PaymentMethod, this hash contains details about the Bacs Direct Debit bank account. public type Param1 record { - string account_number?; - string sort_code?; + string? account_number?; + string? sort_code?; }; public type PackageDimentionsSpecs record { - decimal height; - decimal length; - decimal weight; - decimal width; + decimal? height; + decimal? length; + decimal? weight; + decimal? width; }; # You can now model subscriptions more flexibly using the [Prices API](https://stripe.com/docs/api#prices). It replaces the Plans API and is backwards compatible to simplify your migration. @@ -7194,7 +7178,7 @@ public type PackageDimentionsSpecs record { # Related guides: [Set up a subscription](https://stripe.com/docs/billing/subscriptions/set-up-subscription) and more about [products and prices](https://stripe.com/docs/billing/prices-guide). public type Plan record { # Whether the plan can be used for new purchases. - boolean active; + boolean? active; # Specifies a usage aggregation strategy for plans of `usage_type=metered`. Allowed values are `sum` for summing up all usage during a period, `last_during_period` for using the last usage record reported within a period, `last_ever` for using the last usage record ever (across period bounds) or `max` which uses the usage record with the maximum reported usage during a period. Defaults to `sum`. string? aggregate_usage?; # The unit amount in %s to be charged, represented as a whole integer if possible. Only set if `billing_scheme=per_unit`. @@ -7202,29 +7186,29 @@ public type Plan record { # The unit amount in %s to be charged, represented as a decimal string with at most 12 decimal places. Only set if `billing_scheme=per_unit`. string? amount_decimal?; # Describes how to compute the price per period. Either `per_unit` or `tiered`. `per_unit` indicates that the fixed amount (specified in `amount`) will be charged per unit in `quantity` (for plans with `usage_type=licensed`), or per unit of total usage (for plans 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. - string billing_scheme; + string? billing_scheme; # Time at which the object was created. Measured in seconds since the Unix epoch. - int created; + int? created; # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). - string currency; + string? currency; # Unique identifier for the object. - string id; + string? id; # The frequency at which a subscription is billed. One of `day`, `week`, `month` or `year`. - string interval; + string? interval; # The number of intervals (specified in the `interval` attribute) between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. - int interval_count; + int? interval_count; # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. - boolean livemode; + boolean? livemode; # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. record {} metadata?; # A brief description of the plan, hidden from customers. string? nickname?; # String representing the object's type. Objects of the same type share the same value. - string 'object; + string? 'object; # The product whose pricing this plan determines. string|Product|DeletedProduct? product?; # Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`. - PlanTier[] tiers?; + PlanTier[]? tiers?; # 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. string? tiers_mode?; # Apply a transformation to the reported usage or set quantity before computing the amount billed. Cannot be combined with `tiers`. @@ -7232,7 +7216,7 @@ public type Plan record { # Default number of trial days when subscribing a customer to this plan using [`trial_from_plan=true`](https://stripe.com/docs/api#create_subscription-trial_from_plan). int? trial_period_days?; # Configures how the quantity per period should be determined. Can be either `metered` or `licensed`. `licensed` automatically bills the `quantity` set when adding it to a subscription. `metered` aggregates the total usage based on usage records. Defaults to `licensed`. - string usage_type; + string? usage_type; }; # A SetupAttempt describes one attempted confirmation of a SetupIntent, @@ -7243,61 +7227,61 @@ public type SetupAttempt record { # The value of [application](https://stripe.com/docs/api/setup_intents/object#setup_intent_object-application) on the SetupIntent at the time of this confirmation. string|Application? application?; # Time at which the object was created. Measured in seconds since the Unix epoch. - int created; + int? created; # The value of [customer](https://stripe.com/docs/api/setup_intents/object#setup_intent_object-customer) on the SetupIntent at the time of this confirmation. string|Customer|DeletedCustomer? customer?; # Unique identifier for the object. - string id; + string? id; # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. - boolean livemode; + boolean? livemode; # String representing the object's type. Objects of the same type share the same value. - string 'object; + string? 'object; # The value of [on_behalf_of](https://stripe.com/docs/api/setup_intents/object#setup_intent_object-on_behalf_of) on the SetupIntent at the time of this confirmation. string|Account? on_behalf_of?; # ID of the payment method used with this SetupAttempt. - string|PaymentMethod payment_method; - SetupAttemptPaymentMethodDetails payment_method_details; + string|PaymentMethod? payment_method; + SetupAttemptPaymentMethodDetails? payment_method_details; # The error encountered during this attempt to confirm the SetupIntent, if any. ApiErrors? setup_error?; # ID of the SetupIntent that this attempt belongs to. - string|SetupIntent setup_intent; + string|SetupIntent? setup_intent; # Status of this SetupAttempt, one of `requires_confirmation`, `requires_action`, `processing`, `succeeded`, `failed`, or `abandoned`. - string status; + string? status; # The value of [usage](https://stripe.com/docs/api/setup_intents/object#setup_intent_object-usage) on the SetupIntent at the time of this confirmation, one of `off_session` or `on_session`. - string usage; + string? usage; }; # A portal configuration describes the functionality and behavior of a portal session. public type BillingPortalConfiguration record { # Whether the configuration is active and can be used to create portal sessions. - boolean active; + boolean? active; # ID of the Connect Application that created the configuration. string? application?; - PortalBusinessProfile business_profile; + PortalBusinessProfile? business_profile; # Time at which the object was created. Measured in seconds since the Unix epoch. - int created; + int? created; # The default URL to redirect customers to when they click on the portal's link to return to your website. This can be [overriden](https://stripe.com/docs/api/customer_portal/sessions/create#create_portal_session-return_url) when creating the session. string? default_return_url?; - PortalFeatures features; + PortalFeatures? features; # Unique identifier for the object. - string id; + string? id; # Whether the configuration is the default. If `true`, this configuration can be managed in the Dashboard and portal sessions will use this configuration unless it is overriden when creating the session. - boolean is_default; + boolean? is_default; # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. - boolean livemode; + boolean? livemode; # String representing the object's type. Objects of the same type share the same value. - string 'object; + string? 'object; # Time at which the object was last updated. Measured in seconds since the Unix epoch. - int updated; + int? updated; }; public type DeletedRecipient record { # Always true for a deleted object - boolean deleted; + boolean? deleted; # Unique identifier for the object. - string id; + string? id; # String representing the object's type. Objects of the same type share the same value. - string 'object; + string? 'object; }; public type InvoicesStatusTransitions record { @@ -7313,71 +7297,71 @@ public type InvoicesStatusTransitions record { public type CustomersCustomerBody record { # The customer's address. - CustomerAdresss|string address?; + CustomerAdresss|string? address?; # An integer amount in %s that represents the customer's current balance, which affect the customer's future invoices. A negative amount represents a credit that decreases the amount due on an invoice; a positive amount increases the amount due on an invoice. - int balance?; + int? balance?; # Either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/js), or a dictionary containing a user's bank account details. - CustomerBankAccountDetails|string bank_account?; + CustomerBankAccountDetails|string? bank_account?; # A token, like the ones returned by [Stripe.js](https://stripe.com/docs/js). - CustomerCardDetails|string card?; - string coupon?; + CustomerCardDetails|string? card?; + string? coupon?; # ID of Alipay account to make the customer's new default for invoice payments. - string default_alipay_account?; + string? default_alipay_account?; # ID of bank account to make the customer's new default for invoice payments. - string default_bank_account?; + string? default_bank_account?; # ID of card to make the customer's new default for invoice payments. - string default_card?; + string? default_card?; # If you are using payment methods created via the PaymentMethods API, see the [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/update#update_customer-invoice_settings-default_payment_method) parameter. # # Provide the ID of a payment source already attached to this customer to make it this customer's default payment source. # # If you want to add a new payment source and make it the default, see the [source](https://stripe.com/docs/api/customers/update#update_customer-source) property. - string default_source?; + string? default_source?; # An arbitrary string that you can attach to a customer object. It is displayed alongside the customer in the dashboard. - string description?; + string? description?; # Customer's email address. It's displayed alongside the customer in your dashboard and can be useful for searching and tracking. This may be up to *512 characters*. - string email?; + string? email?; # Specifies which fields in the response should be expanded. - string[] expand?; + string[]? expand?; # The prefix for the customer used to generate unique invoice numbers. Must be 3–12 uppercase letters or numbers. - string invoice_prefix?; + string? invoice_prefix?; # Default invoice settings for this customer. - CustomerParam1 invoice_settings?; + CustomerParam1? invoice_settings?; # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. - record {}|string metadata?; + record {}|string? metadata?; # The customer's full name or business name. - string name?; + string? name?; # The sequence to be used on the customer's next invoice. Defaults to 1. - int next_invoice_sequence?; + int? next_invoice_sequence?; # The customer's phone number. - string phone?; + string? phone?; # Customer's preferred languages, ordered by preference. - string[] preferred_locales?; + string[]? preferred_locales?; # The API ID of a promotion code to apply to the customer. The customer will have a discount applied on all recurring payments. Charges you create through the API will not have the discount. - string promotion_code?; + string? promotion_code?; # The customer's shipping information. Appears on invoices emailed to this customer. - CustomerShippingAddress|string shipping?; - string 'source?; + CustomerShippingAddress|string? shipping?; + string? 'source?; # Tax details about the customer. - TaxParam tax?; + TaxParam? tax?; # The customer's tax exemption. One of `none`, `exempt`, or `reverse`. - string tax_exempt?; + string? tax_exempt?; # Unix timestamp representing the end of the trial period the customer will get before being charged for the first time. This will always overwrite any trials that might apply via a subscribed plan. If set, trial_end will override the default trial period of the plan the customer is being subscribed to. The special value `now` can be provided to end the customer's trial immediately. Can be at most two years from `billing_cycle_anchor`. - string|int trial_end?; + string|int? trial_end?; }; public type PortalSubscriptionUpdateProduct record { # The list of price IDs which, when subscribed to, a subscription can be updated. - string[] prices; + string[]? prices; # The product ID. - string product; + string? product; }; public type AccountDeclineChargeOn record { # Whether Stripe automatically declines charges with an incorrect ZIP or postal code. This setting only applies when a ZIP or postal code is provided and they fail bank verification. - boolean avs_failure; + boolean? avs_failure; # Whether Stripe automatically declines charges with an incorrect CVC. This setting only applies when a CVC is provided and it fails bank verification. - boolean cvc_failure; + boolean? cvc_failure; }; # A representation of the constituent items of any given order. Can be used to @@ -7386,87 +7370,87 @@ public type AccountDeclineChargeOn record { # Related guide: [Orders](https://stripe.com/docs/orders/guide). public type OrderItem record { # A positive integer in the smallest currency unit (that is, 100 cents for $1.00, or 1 for ¥1, Japanese Yen being a zero-decimal currency) representing the total amount for the line item. - int amount; + int? amount; # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). - string currency; + string? currency; # Description of the line item, meant to be displayable to the user (e.g., `"Express shipping"`). - string description; + string? description; # String representing the object's type. Objects of the same type share the same value. - string 'object; + string? 'object; # The ID of the associated object for this line item. Expandable if not null (e.g., expandable to a SKU). string|Sku? parent?; # A positive integer representing the number of instances of `parent` that are included in this order item. Applicable/present only if `type` is `sku`. int? quantity?; # The type of line item. One of `sku`, `tax`, `shipping`, or `discount`. - string 'type; + string? 'type; }; public type LegalEntityCompanyVerification record { - LegalEntityCompanyVerificationDocument document; + LegalEntityCompanyVerificationDocument? document; }; # Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods. public type BillingDetailsInnerParams record { - BillingDetailsAddress|string address?; - string email?; - string name?; - string phone?; + BillingDetailsAddress|string? address?; + string? email?; + string? name?; + string? phone?; }; public type MandateSepaDebit record { # The unique reference of the mandate. - string reference; + string? reference; # The URL of the mandate. This URL generally contains sensitive information about the customer and should be shared with them exclusively. - string url; + string? url; }; public type PaymentMethodFpx record { # The customer's bank, if provided. Can be one of `affin_bank`, `alliance_bank`, `ambank`, `bank_islam`, `bank_muamalat`, `bank_rakyat`, `bsn`, `cimb`, `hong_leong_bank`, `hsbc`, `kfh`, `maybank2u`, `ocbc`, `public_bank`, `rhb`, `standard_chartered`, `uob`, `deutsche_bank`, `maybank2e`, or `pb_enterprise`. - string bank; + string? bank; }; # Source mandate notifications should be created when a notification related to # a source mandate must be sent to the payer. They will trigger a webhook or # deliver an email to the customer. public type SourceMandateNotification record { - SourceMandateNotificationAcssDebitData acss_debit?; + SourceMandateNotificationAcssDebitData? acss_debit?; # A positive integer in the smallest currency unit (that is, 100 cents for $1.00, or 1 for ¥1, Japanese Yen being a zero-decimal currency) representing the amount associated with the mandate notification. The amount is expressed in the currency of the underlying source. Required if the notification type is `debit_initiated`. int? amount?; - SourceMandateNotificationBacsDebitData bacs_debit?; + SourceMandateNotificationBacsDebitData? bacs_debit?; # Time at which the object was created. Measured in seconds since the Unix epoch. - int created; + int? created; # Unique identifier for the object. - string id; + string? id; # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. - boolean livemode; + boolean? livemode; # String representing the object's type. Objects of the same type share the same value. - string 'object; + string? 'object; # The reason of the mandate notification. Valid reasons are `mandate_confirmed` or `debit_initiated`. - string reason; - SourceMandateNotificationSepaDebitData sepa_debit?; + string? reason; + SourceMandateNotificationSepaDebitData? sepa_debit?; # `Source` objects allow you to accept a variety of payment methods. They # represent a customer's payment instrument, and can be used with the Stripe API # just like a `Card` object: once chargeable, they can be charged, or can be # attached to customers. # # Related guides: [Sources API](https://stripe.com/docs/sources) and [Sources & Customers](https://stripe.com/docs/sources/customers). - Source 'source; + Source? 'source; # The status of the mandate notification. Valid statuses are `pending` or `submitted`. - string status; + string? status; # The type of source this mandate notification is attached to. Should be the source type identifier code for the payment method, such as `three_d_secure`. - string 'type; + string? 'type; }; public type ReserveTransaction record { - int amount; + int? amount; # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). - string currency; + string? currency; # An arbitrary string attached to the object. Often useful for displaying to users. string? description?; # Unique identifier for the object. - string id; + string? id; # String representing the object's type. Objects of the same type share the same value. - string 'object; + string? 'object; }; # Issue a credit note to adjust an invoice's amount after the invoice is finalized. @@ -7474,53 +7458,53 @@ public type ReserveTransaction record { # Related guide: [Credit Notes](https://stripe.com/docs/billing/invoices/credit-notes). public type CreditNote record { # The integer amount in %s representing the total amount of the credit note, including tax. - int amount; + int? amount; # Time at which the object was created. Measured in seconds since the Unix epoch. - int created; + int? created; # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). - string currency; + string? currency; # ID of the customer. - string|Customer|DeletedCustomer customer; + string|Customer|DeletedCustomer? customer; # Customer balance transaction related to this credit note. string|CustomerBalanceTransaction? customer_balance_transaction?; # The integer amount in %s representing the total amount of discount that was credited. - int discount_amount; + int? discount_amount; # The aggregate amounts calculated per discount for all line items. - DiscountsResourceDiscountAmount[] discount_amounts; + DiscountsResourceDiscountAmount[]? discount_amounts; # Unique identifier for the object. - string id; + string? id; # ID of the invoice. - string|Invoice invoice; + string|Invoice? invoice; # Line items that make up the credit note - CreditNoteLinesList lines; + CreditNoteLinesList? lines; # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. - boolean livemode; + boolean? livemode; # Customer-facing text that appears on the credit note PDF. string? memo?; # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. record {} metadata?; # A unique number that identifies this particular credit note and appears on the PDF of the credit note and its associated invoice. - string number; + string? number; # String representing the object's type. Objects of the same type share the same value. - string 'object; + string? 'object; # Amount that was credited outside of Stripe. int? out_of_band_amount?; # The link to download the PDF of the credit note. - string pdf; + string? pdf; # Reason for issuing this credit note, one of `duplicate`, `fraudulent`, `order_change`, or `product_unsatisfactory` string? reason?; # Refund related to this credit note. string|Refund? refund?; # Status of this credit note, one of `issued` or `void`. Learn more about [voiding credit notes](https://stripe.com/docs/billing/invoices/credit-notes#voiding). - string status; + string? status; # The integer amount in %s representing the amount of the credit note, excluding tax and invoice level discounts. - int subtotal; + int? subtotal; # The aggregate amounts calculated per tax rate for all line items. - CreditNoteTaxAmount[] tax_amounts; + CreditNoteTaxAmount[]? tax_amounts; # The integer amount in %s representing the total amount of the credit note, including tax and all discount. - int total; + int? total; # Type of this credit note, one of `pre_payment` or `post_payment`. A `pre_payment` credit note means it was issued when the invoice was open. A `post_payment` credit note means it was issued when the invoice was paid. - string 'type; + string? 'type; # The time that the credit note was voided. int? voided_at?; }; @@ -7529,17 +7513,17 @@ public type CreditNote record { # # Related guide: [Fleet Management](https://stripe.com/docs/terminal/creating-locations). public type TerminalLocation record { - Address address; + Address? address; # The display name of the location. - string display_name; + string? display_name; # Unique identifier for the object. - string id; + string? id; # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. - boolean livemode; + boolean? livemode; # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. record {} metadata; # String representing the object's type. Objects of the same type share the same value. - string 'object; + string? 'object; }; # Some payment methods have no required amount that a customer must send. @@ -7547,29 +7531,29 @@ public type TerminalLocation record { # multiple transactions. As such, sources can have multiple associated # transactions. public type SourceTransaction record { - SourceTransactionAchCreditTransferData ach_credit_transfer?; + SourceTransactionAchCreditTransferData? ach_credit_transfer?; # A positive integer in the smallest currency unit (that is, 100 cents for $1.00, or 1 for ¥1, Japanese Yen being a zero-decimal currency) representing the amount your customer has pushed to the receiver. - int amount; - SourceTransactionChfCreditTransferData chf_credit_transfer?; + int? amount; + SourceTransactionChfCreditTransferData? chf_credit_transfer?; # Time at which the object was created. Measured in seconds since the Unix epoch. - int created; + int? created; # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). - string currency; - SourceTransactionGbpCreditTransferData gbp_credit_transfer?; + string? currency; + SourceTransactionGbpCreditTransferData? gbp_credit_transfer?; # Unique identifier for the object. - string id; + string? id; # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. - boolean livemode; + boolean? livemode; # String representing the object's type. Objects of the same type share the same value. - string 'object; - SourceTransactionPaperCheckData paper_check?; - SourceTransactionSepaCreditTransferData sepa_credit_transfer?; + string? 'object; + SourceTransactionPaperCheckData? paper_check?; + SourceTransactionSepaCreditTransferData? sepa_credit_transfer?; # The ID of the source this transaction is attached to. - string 'source; + string? 'source; # The status of the transaction, one of `succeeded`, `pending`, or `failed`. - string status; + string? status; # The type of source this transaction is attached to. - string 'type; + string? 'type; }; public type PaymentMethodWechatPay record { @@ -7586,7 +7570,7 @@ public type PaymentIntentNextActionDisplayOxxoDetails record { public type PaymentMethodDetailsCardPresentReceipt record { # The type of account being debited or credited - string account_type?; + string? account_type?; # EMV tag 9F26, cryptogram generated by the integrated circuit chip. string? application_cryptogram?; # Mnenomic of the Application Identifier. @@ -7607,11 +7591,11 @@ public type PaymentMethodDetailsCardPresentReceipt record { public type DeletedBitcoinReceiver record { # Always true for a deleted object - boolean deleted; + boolean? deleted; # Unique identifier for the object. - string id; + string? id; # String representing the object's type. Objects of the same type share the same value. - string 'object; + string? 'object; }; # Order objects are created to handle end customers' purchases of previously @@ -7621,7 +7605,7 @@ public type DeletedBitcoinReceiver record { # Related guide: [Tax, Shipping, and Inventory](https://stripe.com/docs/orders). public type Order record { # A positive integer in the smallest currency unit (that is, 100 cents for $1.00, or 1 for ¥1, Japanese Yen being a zero-decimal currency) representing the total amount for the order. - int amount; + int? amount; # The total amount that was returned to the customer. int? amount_returned?; # ID of the Connect Application that created the order. @@ -7631,25 +7615,25 @@ public type Order record { # The ID of the payment used to pay for the order. Present if the order status is `paid`, `fulfilled`, or `refunded`. string|Charge? charge?; # Time at which the object was created. Measured in seconds since the Unix epoch. - int created; + int? created; # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). - string currency; + string? currency; # The customer used for the order. string|Customer|DeletedCustomer? customer?; # The email address of the customer placing the order. string? email?; # External coupon code to load for this order. - string external_coupon_code?; + string? external_coupon_code?; # Unique identifier for the object. - string id; + string? id; # List of items constituting the order. An order can have up to 25 items. - OrderItem[] items; + OrderItem[]? items; # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. - boolean livemode; + boolean? livemode; # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. record {} metadata?; # String representing the object's type. Objects of the same type share the same value. - string 'object; + string? 'object; # A list of returns that have taken place for this order. OrdersResourceOrderReturnList? 'returns?; # The shipping method that is currently selected for this order, if any. If present, it is equal to one of the `id`s of shipping methods in the `shipping_methods` array. At order creation time, if there are multiple shipping methods, Stripe will automatically selected the first method. @@ -7659,39 +7643,39 @@ public type Order record { # A list of supported shipping methods for this order. The desired shipping method can be specified either by updating the order, or when paying it. ShippingMethod[]? shipping_methods?; # Current order status. One of `created`, `paid`, `canceled`, `fulfilled`, or `returned`. More details in the [Orders Guide](https://stripe.com/docs/orders/guide#understanding-order-statuses). - string status; + string? status; # The timestamps at which the order status was updated. StatusTransitions? status_transitions?; # Time at which the object was last updated. Measured in seconds since the Unix epoch. int? updated?; # The user's order ID if it is different from the Stripe order ID. - string upstream_id?; + string? upstream_id?; }; public type BancontactInvoicePaymentMethodOptionsParam record { - string preferred_language?; + string? preferred_language?; }; # A list of items the customer is being quoted for. public type QuotesResourceListLineItems record { # Details about each object. - Item[] data; + Item[]? data; # True if this list has another page of items after this one that can be fetched. - boolean has_more; + boolean? has_more; # String representing the object's type. Objects of the same type share the same value. Always has the value `list`. - string 'object; + string? 'object; # The URL where this list can be accessed. - string url; + string? url; }; # Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. public type RecurringPriceData record { - string currency; - string product; - RecurringAdhoc recurring; - string tax_behavior?; - int unit_amount?; - string unit_amount_decimal?; + string? currency; + string? product; + RecurringAdhoc? recurring; + string? tax_behavior?; + int? unit_amount?; + string? unit_amount_decimal?; }; public type PaymentMethodDetailsCardPresent record { @@ -7704,9 +7688,9 @@ public type PaymentMethodDetailsCardPresent record { # Authorization response cryptogram. string? emv_auth_data?; # Two-digit number representing the card's expiration month. - int exp_month; + int? exp_month; # Four-digit number representing the card's expiration year. - int exp_year; + int? exp_year; # Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number. # # *Starting May 1, 2021, card fingerprint in India for Connect will change to allow two fingerprints for the same card --- one for India and one for the rest of the world.* @@ -7727,7 +7711,7 @@ public type PaymentMethodDetailsCardPresent record { # Automatic tax settings for this subscription. public type AutomaticTaxConfig1 record { - boolean enabled; + boolean? enabled; }; public type Period record { @@ -7750,11 +7734,11 @@ public type Period record { # Related guide: [Payment Intents API](https://stripe.com/docs/payments/payment-intents). public type PaymentIntent record { # Amount intended to be collected by this PaymentIntent. A positive integer representing how much to charge in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The minimum amount is $0.50 US or [equivalent in charge currency](https://stripe.com/docs/currencies#minimum-and-maximum-charge-amounts). The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99). - int amount; + int? amount; # Amount that can be captured from this PaymentIntent. - int amount_capturable?; + int? amount_capturable?; # Amount that was collected by this PaymentIntent. - int amount_received?; + int? amount_received?; # ID of the Connect application that created the PaymentIntent. string|Application? application?; # The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. The amount of the application fee collected will be capped at the total payment amount. For more information, see the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts). @@ -7764,20 +7748,20 @@ public type PaymentIntent record { # 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`). string? cancellation_reason?; # Controls when the funds will be captured from the customer's account. - string capture_method; + string? capture_method; # Charges that were created by this PaymentIntent, if any. - PaymentFlowsPaymentIntentResourceChargeList charges?; + PaymentFlowsPaymentIntentResourceChargeList? charges?; # The client secret of this PaymentIntent. Used for client-side retrieval using a publishable key. # # The client secret can be used to complete a payment from your frontend. It should not be stored, logged, embedded in URLs, or exposed to anyone other than the customer. Make sure that you have TLS enabled on any page that includes the client secret. # # Refer to our docs to [accept a payment](https://stripe.com/docs/payments/accept-a-payment?integration=elements) and learn about how `client_secret` should be handled. string? client_secret?; - string confirmation_method; + string? confirmation_method; # Time at which the object was created. Measured in seconds since the Unix epoch. - int created; + int? created; # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). - string currency; + string? currency; # ID of the Customer this PaymentIntent belongs to, if one exists. # # Payment methods attached to other Customers cannot be used with this PaymentIntent. @@ -7787,19 +7771,19 @@ public type PaymentIntent record { # An arbitrary string attached to the object. Often useful for displaying to users. string? description?; # Unique identifier for the object. - string id; + string? id; # ID of the invoice that created this PaymentIntent, if it exists. string|Invoice? invoice?; # The payment error encountered in the previous PaymentIntent confirmation. It will be cleared if the PaymentIntent is later updated for any reason. ApiErrors? last_payment_error?; # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. - boolean livemode; + boolean? livemode; # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. For more information, see the [documentation](https://stripe.com/docs/payments/payment-intents/creating-payment-intents#storing-information-in-metadata). record {} metadata?; # 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. PaymentIntentNextAction? next_action?; # String representing the object's type. Objects of the same type share the same value. - string 'object; + string? 'object; # The account (if any) for which the funds of the PaymentIntent are intended. See the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts) for details. string|Account? on_behalf_of?; # ID of the payment method used in this PaymentIntent. @@ -7807,7 +7791,7 @@ public type PaymentIntent record { # Payment-method-specific configuration for this PaymentIntent. PaymentIntentPaymentMethodOptions? payment_method_options?; # The list of payment method types (e.g. card) that this PaymentIntent is allowed to use. - string[] payment_method_types; + string[]? payment_method_types; # Email address that the receipt for the resulting payment will be sent to. If `receipt_email` is specified for a payment in live mode, a receipt will be sent regardless of your [email settings](https://dashboard.stripe.com/account/emails). string? receipt_email?; # ID of the review associated with this PaymentIntent, if any. @@ -7825,7 +7809,7 @@ public type PaymentIntent record { # Provides information about a card payment that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters for the concatenated descriptor. string? statement_descriptor_suffix?; # 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](https://stripe.com/docs/payments/intents#intent-statuses). - string status; + string? status; # The data with which to automatically create a Transfer when the payment is finalized. See the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts) for details. TransferData? transfer_data?; # A string that identifies the resulting payment as part of a group. See the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts) for details. @@ -7845,34 +7829,34 @@ public type PaymentIntent record { # Related guides: [Accessing verification results](https://stripe.com/docs/identity/verification-sessions#results). public type IdentityVerificationReport record { # Time at which the object was created. Measured in seconds since the Unix epoch. - int created; + int? created; # Result from a document check - GelatoDocumentReport document?; + GelatoDocumentReport? document?; # Unique identifier for the object. - string id; + string? id; # Result from an id_number check - GelatoIdNumberReport id_number?; + GelatoIdNumberReport? id_number?; # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. - boolean livemode; + boolean? livemode; # String representing the object's type. Objects of the same type share the same value. - string 'object; - GelatoVerificationReportOptions options; + string? 'object; + GelatoVerificationReportOptions? options; # Result from a selfie check - GelatoSelfieReport selfie?; + GelatoSelfieReport? selfie?; # Type of report. - string 'type; + string? 'type; # ID of the VerificationSession that created this report. string? verification_session?; }; public type MandateAuBecsDebit record { # The URL of the mandate. This URL generally contains sensitive information about the customer and should be shared with them exclusively. - string url; + string? url; }; public type PaymentMethodBoleto record { # Uniquely identifies the customer tax id (CNPJ or CPF) - string tax_id; + string? tax_id; }; public type PaymentMethodDetailsEps record { @@ -7894,26 +7878,26 @@ public type PaymentMethodDetailsEps record { # data), and will error when queried without a [live-mode API key](https://stripe.com/docs/keys#test-live-modes). public type ReportingReportRun record { # Time at which the object was created. Measured in seconds since the Unix epoch. - int created; + int? created; # If something should go wrong during the run, a message about the failure (populated when # `status=failed`). string? _error?; # Unique identifier for the object. - string id; + string? id; # `true` if the report is run on live mode data and `false` if it is run on test mode data. - boolean livemode; + boolean? livemode; # String representing the object's type. Objects of the same type share the same value. - string 'object; - FinancialReportingFinanceReportRunRunParameters parameters; + string? 'object; + FinancialReportingFinanceReportRunRunParameters? parameters; # The ID of the [report type](https://stripe.com/docs/reports/report-types) to run, such as `"balance.summary.1"`. - string report_type; + string? report_type; # The file object representing the result of the report run (populated when # `status=succeeded`). File? result?; # 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. - string status; + string? status; # Timestamp at which this run successfully finished (populated when # `status=succeeded`). Measured in seconds since the Unix epoch. int? succeeded_at?; @@ -7928,40 +7912,40 @@ public type ReportingReportRun record { # Related guide: [Subscription Invoices](https://stripe.com/docs/billing/invoices/subscription#adding-upcoming-invoice-items). public type Invoiceitem record { # Amount (in the `currency` specified) of the invoice item. This should always be equal to `unit_amount * quantity`. - int amount; + int? amount; # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). - string currency; + string? currency; # The ID of the customer who will be billed when this invoice item is billed. - string|Customer|DeletedCustomer customer; + string|Customer|DeletedCustomer? customer; # Time at which the object was created. Measured in seconds since the Unix epoch. - int date; + int? date; # An arbitrary string attached to the object. Often useful for displaying to users. string? description?; # If true, discounts will apply to this invoice item. Always false for prorations. - boolean discountable; + boolean? discountable; # The discounts which apply to the invoice item. Item discounts are applied before invoice discounts. Use `expand[]=discounts` to expand each discount. - (string|Discount)[]? discounts?; + (string|Discount?)[]? discounts?; # Unique identifier for the object. - string id; + string? id; # The ID of the invoice this invoice item belongs to. string|Invoice? invoice?; # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. - boolean livemode; + boolean? livemode; # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. record {} metadata?; # String representing the object's type. Objects of the same type share the same value. - string 'object; - InvoiceLineItemPeriod period; + string? 'object; + InvoiceLineItemPeriod? period; # The price of the invoice item. Price? price?; # Whether the invoice item was created automatically as a proration adjustment when the customer switched plans. - boolean proration; + boolean? proration; # Quantity of units for the invoice item. If the invoice item is a proration, the quantity of the subscription that the proration was computed for. - int quantity; + int? quantity; # The subscription that this invoice item has been created for, if any. string|Subscription? subscription?; # The subscription item that this invoice item has been created for, if any. - string subscription_item?; + string? subscription_item?; # 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. TaxRate[]? tax_rates?; # Unit amount (in the `currency` specified) of the invoice item. @@ -7971,8 +7955,8 @@ public type Invoiceitem record { }; public type PaymentMethodOptions1 record { - BancontactInvoicePaymentMethodOptionsParam|string bancontact?; - CardInvoicePaymentMethodOptionsParam|string card?; + BancontactInvoicePaymentMethodOptionsParam|string? bancontact?; + CardInvoicePaymentMethodOptionsParam|string? card?; }; # Each customer has a [`balance`](https://stripe.com/docs/api/customers/object#customer_object-balance) value, @@ -7983,88 +7967,88 @@ public type PaymentMethodOptions1 record { # Related guide: [Customer Balance](https://stripe.com/docs/billing/customer/balance) to learn more. public type CustomerBalanceTransaction record { # The amount of the transaction. A negative value is a credit for the customer's balance, and a positive value is a debit to the customer's `balance`. - int amount; + int? amount; # Time at which the object was created. Measured in seconds since the Unix epoch. - int created; + int? created; # The ID of the credit note (if any) related to the transaction. string|CreditNote? credit_note?; # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). - string currency; + string? currency; # The ID of the customer the transaction belongs to. - string|Customer customer; + string|Customer? customer; # An arbitrary string attached to the object. Often useful for displaying to users. string? description?; # The customer's `balance` after the transaction was applied. A negative value decreases the amount due on the customer's next invoice. A positive value increases the amount due on the customer's next invoice. - int ending_balance; + int? ending_balance; # Unique identifier for the object. - string id; + string? id; # The ID of the invoice (if any) related to the transaction. string|Invoice? invoice?; # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. - boolean livemode; + boolean? livemode; # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. record {} metadata?; # String representing the object's type. Objects of the same type share the same value. - string 'object; + string? 'object; # Transaction type: `adjustment`, `applied_to_invoice`, `credit_note`, `initial`, `invoice_too_large`, `invoice_too_small`, `unspent_receiver_credit`, or `unapplied_from_invoice`. See the [Customer Balance page](https://stripe.com/docs/billing/customer/balance#types) to learn more about transaction types. - string 'type; + string? 'type; }; public type AutomaticTaxConfig3 record { - boolean enabled; + boolean? enabled; }; public type DeletedCoupon record { # Always true for a deleted object - boolean deleted; + boolean? deleted; # Unique identifier for the object. - string id; + string? id; # String representing the object's type. Objects of the same type share the same value. - string 'object; + string? 'object; }; # Default settings for automatic tax computation public type AutomaticTaxConfig2 record { # Enabled automatic tax calculation which will automatically compute tax rates on all invoices generated by the subscription - boolean enabled; + boolean? enabled; }; public type ApplicationFee record { # ID of the Stripe account this fee was taken from. - string|Account account; + string|Account? account; # Amount earned, in %s. - int amount; + int? amount; # Amount in %s refunded (can be less than the amount attribute on the fee if a partial refund was issued) - int amount_refunded; + int? amount_refunded; # ID of the Connect application that earned the fee. - string|Application application; + string|Application? application; # Balance transaction that describes the impact of this collected application fee on your account balance (not including refunds). string|BalanceTransaction? balance_transaction?; # ID of the charge that the application fee was taken from. - string|Charge charge; + string|Charge? charge; # Time at which the object was created. Measured in seconds since the Unix epoch. - int created; + int? created; # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). - string currency; + string? currency; # Unique identifier for the object. - string id; + string? id; # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. - boolean livemode; + boolean? livemode; # String representing the object's type. Objects of the same type share the same value. - string 'object; + string? 'object; # ID of the corresponding charge on the platform account, if this fee was the result of a charge using the `destination` parameter. string|Charge? originating_transaction?; # Whether the fee has been fully refunded. If the fee is only partially refunded, this attribute will still be false. - boolean refunded; + boolean? refunded; # A list of refunds that have been applied to the fee. - FeeRefundList refunds; + FeeRefundList? refunds; }; public type PaymentIntentNextActionWechatPayDisplayQrCode record { # The data being used to generate QR code - string data; + string? data; # The base64 image data for a pre-generated QR code - string image_data_url; + string? image_data_url; }; # PaymentMethod objects represent your customer's payment instruments. @@ -8073,41 +8057,41 @@ public type PaymentIntentNextActionWechatPayDisplayQrCode record { # # Related guides: [Payment Methods](https://stripe.com/docs/payments/payment-methods) and [More Payment Scenarios](https://stripe.com/docs/payments/more-payment-scenarios). public type PaymentMethod record { - PaymentMethodAcssDebit acss_debit?; - PaymentMethodAfterpayClearpay afterpay_clearpay?; - PaymentFlowsPrivatePaymentMethodsAlipay alipay?; - PaymentMethodAuBecsDebit au_becs_debit?; - PaymentMethodBacsDebit bacs_debit?; - PaymentMethodBancontact bancontact?; - BillingDetails billing_details; - PaymentMethodBoleto boleto?; - PaymentMethodCard card?; - PaymentMethodCardPresent card_present?; + PaymentMethodAcssDebit? acss_debit?; + PaymentMethodAfterpayClearpay? afterpay_clearpay?; + PaymentFlowsPrivatePaymentMethodsAlipay? alipay?; + PaymentMethodAuBecsDebit? au_becs_debit?; + PaymentMethodBacsDebit? bacs_debit?; + PaymentMethodBancontact? bancontact?; + BillingDetails? billing_details; + PaymentMethodBoleto? boleto?; + PaymentMethodCard? card?; + PaymentMethodCardPresent? card_present?; # Time at which the object was created. Measured in seconds since the Unix epoch. - int created; + int? created; # The ID of the Customer to which this PaymentMethod is saved. This will not be set when the PaymentMethod has not been saved to a Customer. string|Customer? customer?; - PaymentMethodEps eps?; - PaymentMethodFpx fpx?; - PaymentMethodGiropay giropay?; - PaymentMethodGrabpay grabpay?; + PaymentMethodEps? eps?; + PaymentMethodFpx? fpx?; + PaymentMethodGiropay? giropay?; + PaymentMethodGrabpay? grabpay?; # Unique identifier for the object. - string id; - PaymentMethodIdeal ideal?; - PaymentMethodInteracPresent interac_present?; + string? id; + PaymentMethodIdeal? ideal?; + PaymentMethodInteracPresent? interac_present?; # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. - boolean livemode; + boolean? livemode; # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. record {} metadata?; # String representing the object's type. Objects of the same type share the same value. - string 'object; - PaymentMethodOxxo oxxo?; - PaymentMethodP24 p24?; - PaymentMethodSepaDebit sepa_debit?; - PaymentMethodSofort sofort?; + string? 'object; + PaymentMethodOxxo? oxxo?; + PaymentMethodP24? p24?; + PaymentMethodSepaDebit? sepa_debit?; + PaymentMethodSofort? sofort?; # The type of the PaymentMethod. An additional hash is included on the PaymentMethod with a name matching this value. It contains additional information specific to the PaymentMethod type. - string 'type; - PaymentMethodWechatPay wechat_pay?; + string? 'type; + PaymentMethodWechatPay? wechat_pay?; }; public type LegalEntityJapanAddress record { @@ -8129,41 +8113,41 @@ public type LegalEntityJapanAddress record { public type SubscriptionsSubscriptionExposedIdBody record { # A list of prices and quantities that will generate invoice items appended to the first invoice for this subscription. You may pass up to 20 items. - AddInvoiceItemEntry1[] add_invoice_items?; + AddInvoiceItemEntry1[]? add_invoice_items?; # A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the application owner's Stripe account. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions). - decimal application_fee_percent?; + decimal? application_fee_percent?; # Automatic tax settings for this subscription. - AutomaticTaxConfig1 automatic_tax?; + AutomaticTaxConfig1? automatic_tax?; # Either `now` or `unchanged`. Setting the value to `now` resets the subscription's billing cycle anchor to the current time. For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle). - string billing_cycle_anchor?; + string? billing_cycle_anchor?; # Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds. - record {int amount_gte?; boolean reset_billing_cycle_anchor?;}|string billing_thresholds?; + record {int? amount_gte?; boolean? reset_billing_cycle_anchor?;}|string? billing_thresholds?; # A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using `proration_behavior`. If set during a future period, this will always cause a proration for that period. - int|string cancel_at?; + int|string? cancel_at?; # Boolean indicating whether this subscription should cancel at the end of the current period. - boolean cancel_at_period_end?; + boolean? cancel_at_period_end?; # 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. When sending an invoice, Stripe will email your customer an invoice with payment instructions. Defaults to `charge_automatically`. - string collection_method?; + string? collection_method?; # The ID of the coupon to apply to this subscription. A coupon applied to a subscription will only affect invoices created for that particular subscription. - string coupon?; + string? coupon?; # Number of days a customer has to pay invoices generated by this subscription. Valid only for subscriptions where `collection_method` is set to `send_invoice`. - int days_until_due?; + int? days_until_due?; # ID of the default payment method for the subscription. It must belong to the customer associated with the subscription. This takes precedence over `default_source`. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://stripe.com/docs/api/customers/object#customer_object-default_source). - string default_payment_method?; + string? default_payment_method?; # ID of the default payment source for the subscription. It must belong to the customer associated with the subscription and be in a chargeable state. If `default_payment_method` is also set, `default_payment_method` will take precedence. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://stripe.com/docs/api/customers/object#customer_object-default_source). - string default_source?; + string? default_source?; # 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. Pass an empty string to remove previously-defined tax rates. - string[]|string default_tax_rates?; + string[]|string? default_tax_rates?; # Specifies which fields in the response should be expanded. - string[] expand?; + string[]? expand?; # A list of up to 20 subscription items, each with an attached price. - SubscriptionItemUpdateParams[] items?; + SubscriptionItemUpdateParams[]? items?; # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. - record {}|string metadata?; + record {}|string? metadata?; # Indicates if a customer is on or off-session while an invoice payment is attempted. - boolean off_session?; + boolean? off_session?; # If specified, payment collection for this subscription will be paused. - record {string behavior; int resumes_at?;}|string pause_collection?; + record {string? behavior; int? resumes_at?;}|string? pause_collection?; # 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. For example, SCA regulation may require 3DS authentication to complete payment. See the [SCA Migration Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior. # # Use `default_incomplete` to transition the subscription to `status=past_due` when payment is required and await explicit confirmation of the invoice's payment intent. This allows simpler management of scenarios where additional user actions are needed to pay a subscription’s invoice. Such as failed payments, [SCA regulation](https://stripe.com/docs/billing/migration/strong-customer-authentication), or collecting a mandate for a bank debit payment method. @@ -8171,27 +8155,27 @@ public type SubscriptionsSubscriptionExposedIdBody record { # Use `pending_if_incomplete` to update the subscription using [pending updates](https://stripe.com/docs/billing/subscriptions/pending-updates). When you use `pending_if_incomplete` you can only pass the parameters [supported by pending updates](https://stripe.com/docs/billing/pending-updates-reference#supported-attributes). # # Use `error_if_incomplete` if you want Stripe to return an HTTP 402 status code if a subscription's invoice cannot be paid. For example, if a payment method requires 3DS authentication due to SCA regulation and further user action is needed, this parameter does not update the subscription and returns an error instead. This was the default behavior for API versions prior to 2019-03-14. See the [changelog](https://stripe.com/docs/upgrades#2019-03-14) to learn more. - string payment_behavior?; + string? payment_behavior?; # Payment settings to pass to invoices created by the subscription. - PaymentSettings2 payment_settings?; + PaymentSettings2? payment_settings?; # Specifies an interval for how often to bill for any pending invoice items. It is analogous to calling [Create an invoice](https://stripe.com/docs/api#create_invoice) for the given subscription at the specified interval. - record {string interval; int interval_count?;}|string pending_invoice_item_interval?; + record {string? interval; int? interval_count?;}|string? pending_invoice_item_interval?; # The promotion code to apply to this subscription. A promotion code applied to a subscription will only affect invoices created for that particular subscription. - string promotion_code?; + string? promotion_code?; # Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#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. Valid values are `create_prorations`, `none`, or `always_invoice`. # # Passing `create_prorations` will cause proration invoice items to be created when applicable. These proration items will only be invoiced immediately under [certain conditions](https://stripe.com/docs/subscriptions/upgrading-downgrading#immediate-payment). In order to always invoice immediately for prorations, pass `always_invoice`. # # Prorations can be disabled by passing `none`. - string proration_behavior?; + string? proration_behavior?; # If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply exactly the same proration that was previewed with [upcoming invoice](https://stripe.com/docs/api#retrieve_customer_invoice) endpoint. 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. - int proration_date?; + int? proration_date?; # If specified, the funds from the subscription's invoices will be transferred to the destination and the ID of the resulting transfers will be found on the resulting charges. This will be unset if you POST an empty value. - record {decimal amount_percent?; string destination;}|string transfer_data?; + record {decimal? amount_percent?; string? destination;}|string? transfer_data?; # Unix timestamp representing the end of the trial period the customer will get before being charged for the first time. This will always overwrite any trials that might apply via a subscribed plan. If set, trial_end will override the default trial period of the plan the customer is being subscribed to. The special value `now` can be provided to end the customer's trial immediately. Can be at most two years from `billing_cycle_anchor`. - string|int trial_end?; + string|int? trial_end?; # Indicates if a plan's `trial_period_days` should be applied to the subscription. Setting `trial_end` per subscription is preferred, and this defaults to `false`. Setting this flag to `true` together with `trial_end` is not allowed. - boolean trial_from_plan?; + boolean? trial_from_plan?; }; public type RadarReviewResourceLocation record { @@ -8208,43 +8192,43 @@ public type RadarReviewResourceLocation record { }; public type PaymentMethodDetails record { - PaymentMethodDetailsAchCreditTransfer ach_credit_transfer?; - PaymentMethodDetailsAchDebit ach_debit?; - PaymentMethodDetailsAcssDebit acss_debit?; - PaymentMethodDetailsAfterpayClearpay afterpay_clearpay?; - PaymentFlowsPrivatePaymentMethodsAlipayDetails alipay?; - PaymentMethodDetailsAuBecsDebit au_becs_debit?; - PaymentMethodDetailsBacsDebit bacs_debit?; - PaymentMethodDetailsBancontact bancontact?; - PaymentMethodDetailsBoleto boleto?; - PaymentMethodDetailsCard card?; - PaymentMethodDetailsCardPresent card_present?; - PaymentMethodDetailsEps eps?; - PaymentMethodDetailsFpx fpx?; - PaymentMethodDetailsGiropay giropay?; - PaymentMethodDetailsGrabpay grabpay?; - PaymentMethodDetailsIdeal ideal?; - PaymentMethodDetailsInteracPresent interac_present?; - PaymentMethodDetailsKlarna klarna?; - PaymentMethodDetailsMultibanco multibanco?; - PaymentMethodDetailsOxxo oxxo?; - PaymentMethodDetailsP24 p24?; - PaymentMethodDetailsSepaDebit sepa_debit?; - PaymentMethodDetailsSofort sofort?; - PaymentMethodDetailsStripeAccount stripe_account?; + PaymentMethodDetailsAchCreditTransfer? ach_credit_transfer?; + PaymentMethodDetailsAchDebit? ach_debit?; + PaymentMethodDetailsAcssDebit? acss_debit?; + PaymentMethodDetailsAfterpayClearpay? afterpay_clearpay?; + PaymentFlowsPrivatePaymentMethodsAlipayDetails? alipay?; + PaymentMethodDetailsAuBecsDebit? au_becs_debit?; + PaymentMethodDetailsBacsDebit? bacs_debit?; + PaymentMethodDetailsBancontact? bancontact?; + PaymentMethodDetailsBoleto? boleto?; + PaymentMethodDetailsCard? card?; + PaymentMethodDetailsCardPresent? card_present?; + PaymentMethodDetailsEps? eps?; + PaymentMethodDetailsFpx? fpx?; + PaymentMethodDetailsGiropay? giropay?; + PaymentMethodDetailsGrabpay? grabpay?; + PaymentMethodDetailsIdeal? ideal?; + PaymentMethodDetailsInteracPresent? interac_present?; + PaymentMethodDetailsKlarna? klarna?; + PaymentMethodDetailsMultibanco? multibanco?; + PaymentMethodDetailsOxxo? oxxo?; + PaymentMethodDetailsP24? p24?; + PaymentMethodDetailsSepaDebit? sepa_debit?; + PaymentMethodDetailsSofort? sofort?; + PaymentMethodDetailsStripeAccount? stripe_account?; # The type of transaction-specific details of the payment method used in the payment, one of `ach_credit_transfer`, `ach_debit`, `acss_debit`, `alipay`, `au_becs_debit`, `bancontact`, `card`, `card_present`, `eps`, `giropay`, `ideal`, `klarna`, `multibanco`, `p24`, `sepa_debit`, `sofort`, `stripe_account`, or `wechat`. # An additional hash is included on `payment_method_details` with a name matching this value. # It contains information specific to the payment method. - string 'type; - PaymentMethodDetailsWechat wechat?; - PaymentMethodDetailsWechatPay wechat_pay?; + string? 'type; + PaymentMethodDetailsWechat? wechat?; + PaymentMethodDetailsWechatPay? wechat_pay?; }; public type AccountController record { # `true` if the Connect application retrieving the resource controls the account and can therefore exercise [platform controls](https://stripe.com/docs/connect/platform-controls-for-standard-accounts). Otherwise, this field is null. - boolean is_controller?; + boolean? is_controller?; # The controller type. Can be `application`, if a Connect application controls the account, or `account`, if the account controls itself. - string 'type?; + string? 'type?; }; public type GelatoIdNumberReportError record { @@ -8256,7 +8240,7 @@ public type GelatoIdNumberReportError record { public type QuotesResourceAutomaticTax record { # Automatically calculate taxes - boolean enabled; + boolean? enabled; # The status of the most recent automated tax calculation for this quote. string? status?; }; @@ -8267,34 +8251,34 @@ public type QuotesResourceAutomaticTax record { # Related guide: [Metered Billing](https://stripe.com/docs/billing/subscriptions/metered-billing). public type UsageRecord record { # Unique identifier for the object. - string id; + string? id; # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. - boolean livemode; + boolean? livemode; # String representing the object's type. Objects of the same type share the same value. - string 'object; + string? 'object; # The usage quantity for the specified date. - int quantity; + int? quantity; # The ID of the subscription item this usage record contains data for. - string subscription_item; + string? subscription_item; # The timestamp when this usage occurred. - int timestamp; + int? timestamp; }; # A list of refunds that have been applied to the fee. public type FeeRefundList record { # Details about each object. - FeeRefund[] data; + FeeRefund[]? data; # True if this list has another page of items after this one that can be fetched. - boolean has_more; + boolean? has_more; # String representing the object's type. Objects of the same type share the same value. Always has the value `list`. - string 'object; + string? 'object; # The URL where this list can be accessed. - string url; + string? url; }; public type InvoicePaymentMethodOptionsBancontact record { # Preferred language of the Bancontact authorization page that the customer is redirected to. - string preferred_language; + string? preferred_language; }; public type PaymentPagesCheckoutSessionCustomerDetails record { @@ -8313,58 +8297,58 @@ public type PaymentPagesCheckoutSessionCustomerDetails record { # # Related guides: [Sources API](https://stripe.com/docs/sources) and [Sources & Customers](https://stripe.com/docs/sources/customers). public type Source record { - SourceTypeAchCreditTransfer ach_credit_transfer?; - SourceTypeAchDebit ach_debit?; - SourceTypeAcssDebit acss_debit?; - SourceTypeAlipay alipay?; + SourceTypeAchCreditTransfer? ach_credit_transfer?; + SourceTypeAchDebit? ach_debit?; + SourceTypeAcssDebit? acss_debit?; + SourceTypeAlipay? alipay?; # A positive integer in the smallest currency unit (that is, 100 cents for $1.00, or 1 for ¥1, Japanese Yen being a zero-decimal currency) representing the total amount associated with the source. This is the amount for which the source will be chargeable once ready. Required for `single_use` sources. int? amount?; - SourceTypeAuBecsDebit au_becs_debit?; - SourceTypeBancontact bancontact?; - SourceTypeCard card?; - SourceTypeCardPresent card_present?; + SourceTypeAuBecsDebit? au_becs_debit?; + SourceTypeBancontact? bancontact?; + SourceTypeCard? card?; + SourceTypeCardPresent? card_present?; # The client secret of the source. Used for client-side retrieval using a publishable key. - string client_secret; - SourceCodeVerificationFlow code_verification?; + string? client_secret; + SourceCodeVerificationFlow? code_verification?; # Time at which the object was created. Measured in seconds since the Unix epoch. - int created; + int? created; # Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) associated with the source. This is the currency for which the source will be chargeable once ready. Required for `single_use` sources. string? currency?; # The ID of the customer to which this source is attached. This will not be present when the source has not been attached to a customer. - string customer?; - SourceTypeEps eps?; + string? customer?; + SourceTypeEps? eps?; # The authentication `flow` of the source. `flow` is one of `redirect`, `receiver`, `code_verification`, `none`. - string flow; - SourceTypeGiropay giropay?; + string? flow; + SourceTypeGiropay? giropay?; # Unique identifier for the object. - string id; - SourceTypeIdeal ideal?; - SourceTypeKlarna klarna?; + string? id; + SourceTypeIdeal? ideal?; + SourceTypeKlarna? klarna?; # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. - boolean livemode; + boolean? livemode; # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. record {} metadata?; - SourceTypeMultibanco multibanco?; + SourceTypeMultibanco? multibanco?; # String representing the object's type. Objects of the same type share the same value. - string 'object; + string? 'object; # Information about the owner of the payment instrument that may be used or required by particular source types. SourceOwner? owner?; - SourceTypeP24 p24?; - SourceReceiverFlow receiver?; - SourceRedirectFlow redirect?; - SourceTypeSepaDebit sepa_debit?; - SourceTypeSofort sofort?; - SourceOrder source_order?; + SourceTypeP24? p24?; + SourceReceiverFlow? receiver?; + SourceRedirectFlow? redirect?; + SourceTypeSepaDebit? sepa_debit?; + SourceTypeSofort? sofort?; + SourceOrder? source_order?; # Extra information about a source. This will appear on your customer's statement every time you charge the source. string? statement_descriptor?; # The status of the source, one of `canceled`, `chargeable`, `consumed`, `failed`, or `pending`. Only `chargeable` sources can be used to create a charge. - string status; - SourceTypeThreeDSecure three_d_secure?; + string? status; + SourceTypeThreeDSecure? three_d_secure?; # The `type` of the source. The `type` is a payment method, one of `ach_credit_transfer`, `ach_debit`, `alipay`, `bancontact`, `card`, `card_present`, `eps`, `giropay`, `ideal`, `multibanco`, `klarna`, `p24`, `sepa_debit`, `sofort`, `three_d_secure`, or `wechat`. An additional hash is included on the source with a name matching this value. It contains additional information specific to the [payment method](https://stripe.com/docs/sources) used. - string 'type; + string? 'type; # Either `reusable` or `single_use`. Whether this source should be reusable or not. Some source types may or may not be reusable by construction, while others may leave the option at creation. If an incompatible value is passed, an error will be returned. string? usage?; - SourceTypeWechat wechat?; + SourceTypeWechat? wechat?; }; public type SubscriptionsResourcePaymentMethodOptions record { @@ -8384,32 +8368,32 @@ public type InvoiceSettingCustomerSetting record { }; public type PaymentIntentNextAction record { - PaymentIntentNextActionAlipayHandleRedirect alipay_handle_redirect?; - PaymentIntentNextActionBoleto boleto_display_details?; - PaymentIntentNextActionDisplayOxxoDetails oxxo_display_details?; - PaymentIntentNextActionRedirectToUrl redirect_to_url?; + PaymentIntentNextActionAlipayHandleRedirect? alipay_handle_redirect?; + PaymentIntentNextActionBoleto? boleto_display_details?; + PaymentIntentNextActionDisplayOxxoDetails? oxxo_display_details?; + PaymentIntentNextActionRedirectToUrl? redirect_to_url?; # Type of the next action to perform, one of `redirect_to_url`, `use_stripe_sdk`, `alipay_handle_redirect`, or `oxxo_display_details`. - string 'type; + string? 'type; # When confirming a PaymentIntent with Stripe.js, Stripe.js depends on the contents of this dictionary to invoke authentication flows. The shape of the contents is subject to change and is only intended to be used by Stripe.js. record {} use_stripe_sdk?; - PaymentIntentNextActionVerifyWithMicrodeposits verify_with_microdeposits?; - PaymentIntentNextActionWechatPayDisplayQrCode wechat_pay_display_qr_code?; - PaymentIntentNextActionWechatPayRedirectToAndroidApp wechat_pay_redirect_to_android_app?; - PaymentIntentNextActionWechatPayRedirectToIosApp wechat_pay_redirect_to_ios_app?; + PaymentIntentNextActionVerifyWithMicrodeposits? verify_with_microdeposits?; + PaymentIntentNextActionWechatPayDisplayQrCode? wechat_pay_display_qr_code?; + PaymentIntentNextActionWechatPayRedirectToAndroidApp? wechat_pay_redirect_to_android_app?; + PaymentIntentNextActionWechatPayRedirectToIosApp? wechat_pay_redirect_to_ios_app?; }; -public type SubscriptionTrialEnd string|int; +public type SubscriptionTrialEnd string|int?; public type MandateSingleUse record { # On a single use mandate, the amount of the payment. - int amount; + int? amount; # On a single use mandate, the currency of the payment. - string currency; + string? currency; }; public type PaymentIntentNextActionWechatPayRedirectToIosApp record { # An universal link that redirect to Wechat Pay APP - string native_url; + string? native_url; }; public type SourceTypeAchDebit record { @@ -8421,18 +8405,18 @@ public type SourceTypeAchDebit record { string? 'type?; }; -public type SubscriptionBillingCycleAnchor1 string|int; +public type SubscriptionBillingCycleAnchor1 string|int?; # [Tax codes](https://stripe.com/docs/tax/tax-codes) classify goods and services for tax purposes. public type TaxCode record { # A detailed description of which types of products the tax code represents. - string description; + string? description; # Unique identifier for the object. - string id; + string? id; # A short name for the tax code. - string name; + string? name; # String representing the object's type. Objects of the same type share the same value. - string 'object; + string? 'object; }; # A `Payout` object is created when you receive funds from Stripe, or when you @@ -8445,17 +8429,17 @@ public type TaxCode record { # Related guide: [Receiving Payouts](https://stripe.com/docs/payouts). public type Payout record { # Amount (in %s) to be transferred to your bank account or debit card. - int amount; + int? amount; # Date the payout is expected to arrive in the bank. This factors in delays like weekends or bank holidays. - int arrival_date; + int? arrival_date; # Returns `true` if the payout was created by an [automated payout schedule](https://stripe.com/docs/payouts#payout-schedule), and `false` if it was [requested manually](https://stripe.com/docs/payouts#manual-payouts). - boolean automatic; + boolean? automatic; # ID of the balance transaction that describes the impact of this payout on your account balance. string|BalanceTransaction? balance_transaction?; # Time at which the object was created. Measured in seconds since the Unix epoch. - int created; + int? created; # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). - string currency; + string? currency; # An arbitrary string attached to the object. Often useful for displaying to users. string? description?; # ID of the bank account or card the payout was sent to. @@ -8467,87 +8451,87 @@ public type Payout record { # Message to user further explaining reason for payout failure if available. string? failure_message?; # Unique identifier for the object. - string id; + string? id; # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. - boolean livemode; + boolean? livemode; # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. record {} metadata?; # The method used to send this payout, which can be `standard` or `instant`. `instant` is only supported for payouts to debit cards. (See [Instant payouts for marketplaces](https://stripe.com/blog/instant-payouts-for-marketplaces) for more information.) - string method; + string? method; # String representing the object's type. Objects of the same type share the same value. - string 'object; + string? 'object; # If the payout reverses another, this is the ID of the original payout. string|Payout? original_payout?; # If the payout was reversed, this is the ID of the payout that reverses this payout. string|Payout? reversed_by?; # The source balance this payout came from. One of `card`, `fpx`, or `bank_account`. - string source_type; + string? source_type; # Extra information about a payout to be displayed on the user's bank statement. string? statement_descriptor?; # Current status of the payout: `paid`, `pending`, `in_transit`, `canceled` or `failed`. A payout is `pending` until it is submitted to the bank, when it becomes `in_transit`. The status then changes to `paid` if the transaction goes through, or to `failed` or `canceled` (within 5 business days). Some failed payouts may initially show as `paid` but then change to `failed`. - string status; + string? status; # Can be `bank_account` or `card`. - string 'type; + string? 'type; }; public type IssuingAuthorizationRequest record { # The `pending_request.amount` at the time of the request, presented in your card's currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). Stripe held this amount from your account to fund the authorization if the request was approved. - int amount; + int? amount; # Detailed breakdown of amount components. These amounts are denominated in `currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). IssuingAuthorizationAmountDetails? amount_details?; # Whether this request was approved. - boolean approved; + boolean? approved; # Time at which the object was created. Measured in seconds since the Unix epoch. - int created; + int? created; # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). - string currency; + string? currency; # The `pending_request.merchant_amount` at the time of the request, presented in the `merchant_currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). - int merchant_amount; + int? merchant_amount; # The currency that was collected by the merchant and presented to the cardholder for the authorization. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). - string merchant_currency; + string? merchant_currency; # The reason for the approval or decline. - string reason; + string? reason; }; public type SourceTransactionGbpCreditTransferData record { # Bank account fingerprint associated with the Stripe owned bank account receiving the transfer. - string fingerprint?; + string? fingerprint?; # The credit transfer rails the sender used to push this transfer. The possible rails are: Faster Payments, BACS, CHAPS, and wire transfers. Currently only Faster Payments is supported. - string funding_method?; + string? funding_method?; # Last 4 digits of sender account number associated with the transfer. - string last4?; + string? last4?; # Sender entered arbitrary information about the transfer. - string reference?; + string? reference?; # Sender account number associated with the transfer. - string sender_account_number?; + string? sender_account_number?; # Sender name associated with the transfer. - string sender_name?; + string? sender_name?; # Sender sort code associated with the transfer. - string sender_sort_code?; + string? sender_sort_code?; }; public type ApplePayDomain record { # Time at which the object was created. Measured in seconds since the Unix epoch. - int created; - string domain_name; + int? created; + string? domain_name; # Unique identifier for the object. - string id; + string? id; # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. - boolean livemode; + boolean? livemode; # String representing the object's type. Objects of the same type share the same value. - string 'object; + string? 'object; }; public type VerificationSessionRedaction record { # Indicates whether this object and its related objects have been redacted or not. - string status; + string? status; }; public type CardDetailsParams record { - string cvc?; - int exp_month; - int exp_year; - string number; + string? cvc?; + int? exp_month; + int? exp_year; + string? number; }; public type GelatoSelfieReportError record { @@ -8560,13 +8544,13 @@ public type GelatoSelfieReportError record { # Charges that were created by this PaymentIntent, if any. public type PaymentFlowsPaymentIntentResourceChargeList record { # This list only contains the latest charge, even if there were previously multiple unsuccessful charges. To view all previous charges for a PaymentIntent, you can filter the charges list using the `payment_intent` [parameter](https://stripe.com/docs/api/charges/list#list_charges-payment_intent). - Charge[] data; + Charge[]? data; # True if this list has another page of items after this one that can be fetched. - boolean has_more; + boolean? has_more; # String representing the object's type. Objects of the same type share the same value. Always has the value `list`. - string 'object; + string? 'object; # The URL where this list can be accessed. - string url; + string? url; }; # Result from a selfie check @@ -8578,64 +8562,64 @@ public type GelatoSelfieReport record { # ID of the [File](https://stripe.com/docs/api/files) holding the image of the selfie used in this check. string? selfie?; # Status of this `selfie` check. - string status; + string? status; }; public type BalanceAmount record { # Balance amount. - int amount; + int? amount; # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). - string currency; - BalanceAmountBySourceType source_types?; + string? currency; + BalanceAmountBySourceType? source_types?; }; public type InvoiceLineItemPeriod record { # End of the line item's billing period - int end; + int? end; # Start of the line item's billing period - int 'start; + int? 'start; }; public type LineItem record { # The amount, in %s. - int amount; + int? amount; # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). - string currency; + string? currency; # An arbitrary string attached to the object. Often useful for displaying to users. string? description?; # The amount of discount calculated per discount for this line item. DiscountsResourceDiscountAmount[]? discount_amounts?; # If true, discounts will apply to this line item. Always false for prorations. - boolean discountable; + boolean? discountable; # The discounts applied to the invoice line item. Line item discounts are applied before invoice discounts. Use `expand[]=discounts` to expand each discount. - (string|Discount)[]? discounts?; + (string|Discount?)[]? discounts?; # Unique identifier for the object. - string id; + string? id; # The ID of the [invoice item](https://stripe.com/docs/api/invoiceitems) associated with this line item if any. - string invoice_item?; + string? invoice_item?; # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. - boolean livemode; + boolean? livemode; # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Note that for line items with `type=subscription` this will reflect the metadata of the subscription that caused the line item to be created. record {} metadata; # String representing the object's type. Objects of the same type share the same value. - string 'object; - InvoiceLineItemPeriod period; + string? 'object; + InvoiceLineItemPeriod? period; # The price of the line item. Price? price?; # Whether this is a proration. - boolean proration; + boolean? proration; # The quantity of the subscription, if the line item is a subscription or a proration. int? quantity?; # The subscription that the invoice item pertains to, if any. string? subscription?; # The subscription item that generated this invoice item. Left empty if the line item is not an explicit result of a subscription. - string subscription_item?; + string? subscription_item?; # The amount of tax calculated per tax rate for this line item - InvoiceTaxAmount[] tax_amounts?; + InvoiceTaxAmount[]? tax_amounts?; # The tax rates which apply to the line item. - TaxRate[] tax_rates?; + TaxRate[]? tax_rates?; # A string identifying the type of the source of this line item, either an `invoiceitem` or a `subscription`. - string 'type; + string? 'type; }; public type NotificationEventData record { @@ -8651,19 +8635,19 @@ public type NotificationEventData record { # Related guide: [Handling Returns](https://stripe.com/docs/orders/guide#handling-returns). public type OrderReturn record { # A positive integer in the smallest currency unit (that is, 100 cents for $1.00, or 1 for ¥1, Japanese Yen being a zero-decimal currency) representing the total amount for the returned line item. - int amount; + int? amount; # Time at which the object was created. Measured in seconds since the Unix epoch. - int created; + int? created; # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). - string currency; + string? currency; # Unique identifier for the object. - string id; + string? id; # The items included in this order return. - OrderItem[] items; + OrderItem[]? items; # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. - boolean livemode; + boolean? livemode; # String representing the object's type. Objects of the same type share the same value. - string 'object; + string? 'object; # The order that this return includes items from. string|Order? 'order?; # The ID of the refund issued for this return. @@ -8672,23 +8656,23 @@ public type OrderReturn record { public type DeletedRadarValueListItem record { # Always true for a deleted object - boolean deleted; + boolean? deleted; # Unique identifier for the object. - string id; + string? id; # String representing the object's type. Objects of the same type share the same value. - string 'object; + string? 'object; }; public type IssuingCardShipping record { - Address address; + Address? address; # The delivery company that shipped a card. string? carrier?; # A unix timestamp representing a best estimate of when the card will be delivered. int? eta?; # Recipient name. - string name; + string? name; # Shipment service, such as `standard` or `express`. - string 'service; + string? 'service; # The delivery status of the card. string? status?; # A tracking number for a card shipment. @@ -8696,12 +8680,12 @@ public type IssuingCardShipping record { # A link to the shipping carrier's site where you can view detailed information about a card shipment. string? tracking_url?; # Packaging options. - string 'type; + string? 'type; }; public type PaymentMethodDetailsFpx record { # The customer's bank. Can be one of `affin_bank`, `alliance_bank`, `ambank`, `bank_islam`, `bank_muamalat`, `bank_rakyat`, `bsn`, `cimb`, `hong_leong_bank`, `hsbc`, `kfh`, `maybank2u`, `ocbc`, `public_bank`, `rhb`, `standard_chartered`, `uob`, `deutsche_bank`, `maybank2e`, or `pb_enterprise`. - string bank; + string? bank; # Unique transaction id generated by FPX for every request from the merchant string? transaction_id?; }; @@ -8721,26 +8705,26 @@ public type PlanTier record { public type PricesPriceBody record { # Whether the price can be used for new purchases. Defaults to `true`. - boolean active?; + boolean? active?; # Specifies which fields in the response should be expanded. - string[] expand?; + string[]? expand?; # A lookup key used to retrieve prices dynamically from a static string. - string lookup_key?; + string? lookup_key?; # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. - AdditionalProperties|string metadata?; + AdditionalProperties|string? metadata?; # A brief description of the price, hidden from customers. - string nickname?; + string? nickname?; # 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. - string tax_behavior?; + string? tax_behavior?; # If set to true, will atomically remove the lookup key from the existing price, and assign it to this price. - boolean transfer_lookup_key?; + boolean? transfer_lookup_key?; }; public type AddInvoiceItemEntry1 record { - string price?; - OneTimePriceData price_data?; - int quantity?; - string[]|string tax_rates?; + string? price?; + OneTimePriceData? price_data?; + int? quantity?; + string[]|string? tax_rates?; }; public type IssuingAuthorizationAmountDetails record { @@ -8749,23 +8733,23 @@ public type IssuingAuthorizationAmountDetails record { }; public type MandatePaymentMethodDetails record { - MandateAcssDebit acss_debit?; - MandateAuBecsDebit au_becs_debit?; - MandateBacsDebit bacs_debit?; - CardMandatePaymentMethodDetails card?; - MandateSepaDebit sepa_debit?; + MandateAcssDebit? acss_debit?; + MandateAuBecsDebit? au_becs_debit?; + MandateBacsDebit? bacs_debit?; + CardMandatePaymentMethodDetails? card?; + MandateSepaDebit? sepa_debit?; # The type of the payment method associated with this mandate. An additional hash is included on `payment_method_details` with a name matching this value. It contains mandate information specific to the payment method. - string 'type; + string? 'type; }; public type PaymentMethodOptionsBoleto record { # The number of calendar days before a Boleto voucher expires. For example, if you create a Boleto voucher on Monday and you set expires_after_days to 2, the Boleto voucher will expire on Wednesday at 23:59 America/Sao_Paulo time. - int expires_after_days; + int? expires_after_days; }; public type DiscountsDataParam1 record { - string coupon?; - string discount?; + string? coupon?; + string? discount?; }; public type SourceTypeGiropay record { @@ -8777,6 +8761,6 @@ public type SourceTypeGiropay record { # Apply a transformation to the reported usage or set quantity before computing the billed price. Cannot be combined with `tiers`. public type TransformUsageParam record { - int divide_by; - string round; + int? divide_by; + string? round; }; diff --git a/openapi/stripe/utils.bal b/openapi/stripe/utils.bal index 5e116e0ce..4aa75c9a5 100644 --- a/openapi/stripe/utils.bal +++ b/openapi/stripe/utils.bal @@ -1,19 +1,3 @@ -// Copyright (c) 2021 WSO2 Inc. (http://www.wso2.org) All Rights Reserved. -// -// WSO2 Inc. licenses this file to you under the Apache License, -// Version 2.0 (the "License"); you may not use this file except -// in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, -// software distributed under the License is distributed on an -// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -// KIND, either express or implied. See the License for the -// specific language governing permissions and limitations -// under the License. - import ballerina/url; type SimpleBasicType string|boolean|int|float|decimal; From 41a805bd2ec2630bf05469b2b615837dccc02a27 Mon Sep 17 00:00:00 2001 From: ayeshLK Date: Fri, 17 Nov 2023 15:15:18 +0530 Subject: [PATCH 4/6] Update licensing header --- openapi/stripe/client.bal | 16 ++++++++++++++++ openapi/stripe/types.bal | 16 ++++++++++++++++ openapi/stripe/utils.bal | 16 ++++++++++++++++ 3 files changed, 48 insertions(+) diff --git a/openapi/stripe/client.bal b/openapi/stripe/client.bal index 3b0fa5aaf..58ae87360 100644 --- a/openapi/stripe/client.bal +++ b/openapi/stripe/client.bal @@ -1,3 +1,19 @@ +// Copyright (c) 2021 WSO2 Inc. (http://www.wso2.org) All Rights Reserved. +// +// WSO2 Inc. licenses this file to you under the Apache License, +// Version 2.0 (the "License"); you may not use this file except +// in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, +// software distributed under the License is distributed on an +// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +// KIND, either express or implied. See the License for the +// specific language governing permissions and limitations +// under the License. + import ballerina/http; # Provides a set of configurations for controlling the behaviours when communicating with a remote HTTP endpoint. diff --git a/openapi/stripe/types.bal b/openapi/stripe/types.bal index 6bf768aea..ee2fe6944 100644 --- a/openapi/stripe/types.bal +++ b/openapi/stripe/types.bal @@ -1,3 +1,19 @@ +// Copyright (c) 2021 WSO2 Inc. (http://www.wso2.org) All Rights Reserved. +// +// WSO2 Inc. licenses this file to you under the Apache License, +// Version 2.0 (the "License"); you may not use this file except +// in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, +// software distributed under the License is distributed on an +// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +// KIND, either express or implied. See the License for the +// specific language governing permissions and limitations +// under the License. + public type NotificationEventRequest record { # ID of the API request that caused the event. If null, the event was automatic (e.g., Stripe's automatic subscription handling). Request logs are available in the [dashboard](https://dashboard.stripe.com/logs), but currently not in the API. string? id?; diff --git a/openapi/stripe/utils.bal b/openapi/stripe/utils.bal index 4aa75c9a5..5e116e0ce 100644 --- a/openapi/stripe/utils.bal +++ b/openapi/stripe/utils.bal @@ -1,3 +1,19 @@ +// Copyright (c) 2021 WSO2 Inc. (http://www.wso2.org) All Rights Reserved. +// +// WSO2 Inc. licenses this file to you under the Apache License, +// Version 2.0 (the "License"); you may not use this file except +// in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, +// software distributed under the License is distributed on an +// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +// KIND, either express or implied. See the License for the +// specific language governing permissions and limitations +// under the License. + import ballerina/url; type SimpleBasicType string|boolean|int|float|decimal; From fa671d13f2fe1577d53e2fbe84550950c1100a3f Mon Sep 17 00:00:00 2001 From: ayeshLK Date: Fri, 17 Nov 2023 15:16:56 +0530 Subject: [PATCH 5/6] Refactor open-api contract --- openapi/stripe/client.bal | 22 +++------------------- openapi/stripe/openapi.yaml | 18 +----------------- openapi/stripe/types.bal | 33 +++------------------------------ openapi/stripe/utils.bal | 16 ---------------- 4 files changed, 7 insertions(+), 82 deletions(-) diff --git a/openapi/stripe/client.bal b/openapi/stripe/client.bal index 58ae87360..9efbe85ad 100644 --- a/openapi/stripe/client.bal +++ b/openapi/stripe/client.bal @@ -1,19 +1,3 @@ -// Copyright (c) 2021 WSO2 Inc. (http://www.wso2.org) All Rights Reserved. -// -// WSO2 Inc. licenses this file to you under the Apache License, -// Version 2.0 (the "License"); you may not use this file except -// in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, -// software distributed under the License is distributed on an -// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -// KIND, either express or implied. See the License for the -// specific language governing permissions and limitations -// under the License. - import ballerina/http; # Provides a set of configurations for controlling the behaviours when communicating with a remote HTTP endpoint. @@ -102,7 +86,7 @@ public isolated client class Client { # + startingAfter - A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. # + testClock - Provides a list of customers that are associated with the specified test clock. The response will not include customers with test clocks if this parameter is not set. # + return - Successful response. - remote isolated function listCustomers(Created? created = (), string? email = (), string? endingBefore = (), string[]? expand = (), int? 'limit = (), string? startingAfter = (), string? testClock = ()) returns CustomerResourceCustomerList|error { + remote isolated function listCustomers(CreatedDetails? created = (), string? email = (), string? endingBefore = (), string[]? expand = (), int? 'limit = (), string? startingAfter = (), string? testClock = ()) returns CustomerResourceCustomerList|error { string resourcePath = string `/v1/customers`; map queryParam = {"created": created, "email": email, "ending_before": endingBefore, "expand": expand, "limit": 'limit, "starting_after": startingAfter, "test_clock": testClock}; map queryParamEncoding = {"created": {style: DEEPOBJECT, explode: true}, "expand": {style: DEEPOBJECT, explode: true}}; @@ -174,7 +158,7 @@ public isolated client class Client { # + status - The status of the invoice, one of `draft`, `open`, `paid`, `uncollectible`, or `void`. [Learn more](https://stripe.com/docs/billing/invoices/workflow#workflow-overview) # + subscription - Only return invoices for the subscription specified by this subscription ID. # + return - Successful response. - remote isolated function listInvoices(string? collectionMethod = (), Created1? created = (), string? customer = (), DueDate? dueDate = (), string? endingBefore = (), string[]? expand = (), int? 'limit = (), string? startingAfter = (), string? status = (), string? subscription = ()) returns InvoicesList|error { + remote isolated function listInvoices(string? collectionMethod = (), Created? created = (), string? customer = (), DueDate? dueDate = (), string? endingBefore = (), string[]? expand = (), int? 'limit = (), string? startingAfter = (), string? status = (), string? subscription = ()) returns InvoicesList|error { string resourcePath = string `/v1/invoices`; map queryParam = {"collection_method": collectionMethod, "created": created, "customer": customer, "due_date": dueDate, "ending_before": endingBefore, "expand": expand, "limit": 'limit, "starting_after": startingAfter, "status": status, "subscription": subscription}; map queryParamEncoding = {"created": {style: DEEPOBJECT, explode: true}, "due_date": {style: DEEPOBJECT, explode: true}, "expand": {style: DEEPOBJECT, explode: true}}; @@ -573,7 +557,7 @@ public isolated client class Client { # + startingAfter - A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. # + status - The status of the subscriptions to retrieve. Passing in a value of `canceled` will return all canceled subscriptions, including those belonging to deleted customers. Pass `ended` to find subscriptions that are canceled and subscriptions that are expired due to [incomplete payment](https://stripe.com/docs/billing/subscriptions/overview#subscription-statuses). Passing in a value of `all` will return subscriptions of all statuses. If no value is supplied, all subscriptions that have not been canceled are returned. # + return - Successful response. - remote isolated function listSubscriptions(string? collectionMethod = (), Created2? created = (), CurrentPeriodEnd? currentPeriodEnd = (), CurrentPeriodStart? currentPeriodStart = (), string? customer = (), string? endingBefore = (), string[]? expand = (), int? 'limit = (), string? price = (), string? startingAfter = (), string? status = ()) returns InlineResponse2002|error { + remote isolated function listSubscriptions(string? collectionMethod = (), Created1? created = (), CurrentPeriodEnd? currentPeriodEnd = (), CurrentPeriodStart? currentPeriodStart = (), string? customer = (), string? endingBefore = (), string[]? expand = (), int? 'limit = (), string? price = (), string? startingAfter = (), string? status = ()) returns InlineResponse2002|error { string resourcePath = string `/v1/subscriptions`; map queryParam = {"collection_method": collectionMethod, "created": created, "current_period_end": currentPeriodEnd, "current_period_start": currentPeriodStart, "customer": customer, "ending_before": endingBefore, "expand": expand, "limit": 'limit, "price": price, "starting_after": startingAfter, "status": status}; map queryParamEncoding = {"created": {style: DEEPOBJECT, explode: true}, "current_period_end": {style: DEEPOBJECT, explode: true}, "current_period_start": {style: DEEPOBJECT, explode: true}, "expand": {style: DEEPOBJECT, explode: true}}; diff --git a/openapi/stripe/openapi.yaml b/openapi/stripe/openapi.yaml index 45a31fce5..61c65680e 100644 --- a/openapi/stripe/openapi.yaml +++ b/openapi/stripe/openapi.yaml @@ -24623,23 +24623,7 @@ paths: name: created required: false schema: - anyOf: - - properties: - gt: - description: Minimum value to filter by (exclusive) - type: integer - gte: - description: Minimum value to filter by (inclusive) - type: integer - lt: - description: Maximum value to filter by (exclusive) - type: integer - lte: - description: Maximum value to filter by (inclusive) - type: integer - title: range_query_specs - type: object - - type: integer + $ref: '#/components/schemas/CreatedDetails' style: deepObject - description: >- A case-sensitive filter on the list based on the customer's `email` diff --git a/openapi/stripe/types.bal b/openapi/stripe/types.bal index ee2fe6944..b5a4dfd8d 100644 --- a/openapi/stripe/types.bal +++ b/openapi/stripe/types.bal @@ -1,19 +1,3 @@ -// Copyright (c) 2021 WSO2 Inc. (http://www.wso2.org) All Rights Reserved. -// -// WSO2 Inc. licenses this file to you under the Apache License, -// Version 2.0 (the "License"); you may not use this file except -// in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, -// software distributed under the License is distributed on an -// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -// KIND, either express or implied. See the License for the -// specific language governing permissions and limitations -// under the License. - public type NotificationEventRequest record { # ID of the API request that caused the event. If null, the event was automatic (e.g., Stripe's automatic subscription handling). Request logs are available in the [dashboard](https://dashboard.stripe.com/logs), but currently not in the API. string? id?; @@ -4337,10 +4321,6 @@ public type EphemeralKey record { string? secret?; }; -public type Created2 RangeQuerySpecs|int?; - -public type Created1 RangeQuerySpecs|int?; - public type PaymentMethodsPaymentMethodBody record { # Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods. BillingDetailsInnerParams? billing_details?; @@ -4352,6 +4332,8 @@ public type PaymentMethodsPaymentMethodBody record { record {}|string? metadata?; }; +public type Created1 RangeQuerySpecs|int?; + # `Refund` objects allow you to refund a charge that has previously been created # but not yet refunded. Funds will be refunded to the credit or debit card that # was originally charged. @@ -4636,16 +4618,7 @@ public type PaymentPagesCheckoutSessionTotalDetails record { PaymentPagesCheckoutSessionTotalDetailsResourceBreakdown? breakdown?; }; -public type Created record { - # Minimum value to filter by (exclusive) - int? gt?; - # Minimum value to filter by (inclusive) - int? gte?; - # Maximum value to filter by (exclusive) - int? lt?; - # Maximum value to filter by (inclusive) - int? lte?; -}|int?; +public type Created RangeQuerySpecs|int?; # Value lists allow you to group values together which can then be referenced in rules. # diff --git a/openapi/stripe/utils.bal b/openapi/stripe/utils.bal index 5e116e0ce..4aa75c9a5 100644 --- a/openapi/stripe/utils.bal +++ b/openapi/stripe/utils.bal @@ -1,19 +1,3 @@ -// Copyright (c) 2021 WSO2 Inc. (http://www.wso2.org) All Rights Reserved. -// -// WSO2 Inc. licenses this file to you under the Apache License, -// Version 2.0 (the "License"); you may not use this file except -// in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, -// software distributed under the License is distributed on an -// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -// KIND, either express or implied. See the License for the -// specific language governing permissions and limitations -// under the License. - import ballerina/url; type SimpleBasicType string|boolean|int|float|decimal; From 3ae16def7bcdec2e8d32cf05e7333366fe894585 Mon Sep 17 00:00:00 2001 From: ayeshLK Date: Fri, 17 Nov 2023 15:17:38 +0530 Subject: [PATCH 6/6] Update licensing header --- openapi/stripe/client.bal | 16 ++++++++++++++++ openapi/stripe/types.bal | 16 ++++++++++++++++ openapi/stripe/utils.bal | 16 ++++++++++++++++ 3 files changed, 48 insertions(+) diff --git a/openapi/stripe/client.bal b/openapi/stripe/client.bal index 9efbe85ad..cfc3d98a4 100644 --- a/openapi/stripe/client.bal +++ b/openapi/stripe/client.bal @@ -1,3 +1,19 @@ +// Copyright (c) 2021 WSO2 Inc. (http://www.wso2.org) All Rights Reserved. +// +// WSO2 Inc. licenses this file to you under the Apache License, +// Version 2.0 (the "License"); you may not use this file except +// in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, +// software distributed under the License is distributed on an +// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +// KIND, either express or implied. See the License for the +// specific language governing permissions and limitations +// under the License. + import ballerina/http; # Provides a set of configurations for controlling the behaviours when communicating with a remote HTTP endpoint. diff --git a/openapi/stripe/types.bal b/openapi/stripe/types.bal index b5a4dfd8d..967985364 100644 --- a/openapi/stripe/types.bal +++ b/openapi/stripe/types.bal @@ -1,3 +1,19 @@ +// Copyright (c) 2021 WSO2 Inc. (http://www.wso2.org) All Rights Reserved. +// +// WSO2 Inc. licenses this file to you under the Apache License, +// Version 2.0 (the "License"); you may not use this file except +// in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, +// software distributed under the License is distributed on an +// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +// KIND, either express or implied. See the License for the +// specific language governing permissions and limitations +// under the License. + public type NotificationEventRequest record { # ID of the API request that caused the event. If null, the event was automatic (e.g., Stripe's automatic subscription handling). Request logs are available in the [dashboard](https://dashboard.stripe.com/logs), but currently not in the API. string? id?; diff --git a/openapi/stripe/utils.bal b/openapi/stripe/utils.bal index 4aa75c9a5..5e116e0ce 100644 --- a/openapi/stripe/utils.bal +++ b/openapi/stripe/utils.bal @@ -1,3 +1,19 @@ +// Copyright (c) 2021 WSO2 Inc. (http://www.wso2.org) All Rights Reserved. +// +// WSO2 Inc. licenses this file to you under the Apache License, +// Version 2.0 (the "License"); you may not use this file except +// in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, +// software distributed under the License is distributed on an +// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +// KIND, either express or implied. See the License for the +// specific language governing permissions and limitations +// under the License. + import ballerina/url; type SimpleBasicType string|boolean|int|float|decimal;