diff --git a/openapi/spec3.beta.sdk.json b/openapi/spec3.beta.sdk.json index 8b881fa5..6cc86296 100644 --- a/openapi/spec3.beta.sdk.json +++ b/openapi/spec3.beta.sdk.json @@ -22537,26 +22537,6 @@ "description": "Amount intended to be paid toward this invoice, in cents (or local equivalent)", "type": "integer" }, - "charge": { - "anyOf": [ - { - "maxLength": 5000, - "type": "string" - }, - { - "$ref": "#/components/schemas/charge" - } - ], - "description": "ID of the successful charge for this payment. This field is null when the payment is `open` or `canceled`.", - "nullable": true, - "x-expansionResources": { - "oneOf": [ - { - "$ref": "#/components/schemas/charge" - } - ] - } - }, "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", @@ -22613,25 +22593,8 @@ ], "type": "string" }, - "payment_intent": { - "anyOf": [ - { - "maxLength": 5000, - "type": "string" - }, - { - "$ref": "#/components/schemas/payment_intent" - } - ], - "description": "ID of the PaymentIntent associated with this payment. Note: This property is only populated for invoices finalized on or after March 15th, 2019.", - "nullable": true, - "x-expansionResources": { - "oneOf": [ - { - "$ref": "#/components/schemas/payment_intent" - } - ] - } + "payment": { + "$ref": "#/components/schemas/invoices_payments_invoice_payment_associated_payment" }, "status": { "description": "The status of the payment, one of `open`, `paid`, or `canceled`.", @@ -22646,7 +22609,6 @@ "amount_overpaid", "amount_paid", "amount_requested", - "charge", "created", "currency", "id", @@ -22654,16 +22616,15 @@ "is_default", "livemode", "object", - "payment_intent", + "payment", "status", "status_transitions" ], "title": "InvoicesInvoicePayment", "type": "object", "x-expandableFields": [ - "charge", "invoice", - "payment_intent", + "payment", "status_transitions" ], "x-resourceId": "invoice_payment", @@ -23898,6 +23859,71 @@ "payment_method_options" ] }, + "invoices_payments_invoice_payment_associated_payment": { + "description": "", + "properties": { + "charge": { + "anyOf": [ + { + "maxLength": 5000, + "type": "string" + }, + { + "$ref": "#/components/schemas/charge" + } + ], + "description": "ID of the successful charge for this payment when `type` is `charge`.", + "x-expansionResources": { + "oneOf": [ + { + "$ref": "#/components/schemas/charge" + } + ] + } + }, + "out_of_band_payment": { + "$ref": "#/components/schemas/invoices_payments_out_of_band_payment" + }, + "payment_intent": { + "anyOf": [ + { + "maxLength": 5000, + "type": "string" + }, + { + "$ref": "#/components/schemas/payment_intent" + } + ], + "description": "ID of the PaymentIntent associated with this payment when `type` is `payment_intent`. Note: This property is only populated for invoices finalized on or after March 15th, 2019.", + "x-expansionResources": { + "oneOf": [ + { + "$ref": "#/components/schemas/payment_intent" + } + ] + } + }, + "type": { + "description": "Type of payment object associated with this invoice payment.", + "enum": [ + "charge", + "out_of_band_payment", + "payment_intent" + ], + "type": "string" + } + }, + "required": [ + "type" + ], + "title": "InvoicesPaymentsInvoicePaymentAssociatedPayment", + "type": "object", + "x-expandableFields": [ + "charge", + "out_of_band_payment", + "payment_intent" + ] + }, "invoices_payments_invoice_payment_status_transitions": { "description": "", "properties": { @@ -23922,6 +23948,57 @@ "type": "object", "x-expandableFields": [] }, + "invoices_payments_out_of_band_payment": { + "description": "", + "properties": { + "amount": { + "description": "Amount paid on this out of band payment, in cents (or local equivalent)", + "type": "integer" + }, + "currency": { + "description": "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).", + "maxLength": 5000, + "type": "string" + }, + "metadata": { + "additionalProperties": { + "maxLength": 500, + "type": "string" + }, + "description": "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.", + "nullable": true, + "type": "object" + }, + "money_movement_type": { + "description": "The type of money movement for this out of band payment record.", + "maxLength": 5000, + "type": "string" + }, + "paid_at": { + "description": "The timestamp when this out of band payment was paid.", + "format": "unix-time", + "nullable": true, + "type": "integer" + }, + "payment_reference": { + "description": "The reference for this out of band payment record.", + "maxLength": 5000, + "nullable": true, + "type": "string" + } + }, + "required": [ + "amount", + "currency", + "metadata", + "money_movement_type", + "paid_at", + "payment_reference" + ], + "title": "InvoicesPaymentsOutOfBandPayment", + "type": "object", + "x-expandableFields": [] + }, "invoices_resource_from_invoice": { "description": "", "properties": { @@ -73271,7 +73348,7 @@ "description": "The Stripe REST API. Please see https://stripe.com/docs/api for more details.", "termsOfService": "https://stripe.com/us/terms/", "title": "Stripe API", - "version": "2024-06-20; embedded_connect_beta=v2; server_side_confirmation_beta=v1; orders_beta=v4; gift_cards_beta=v1; unified_accounts_beta=v1; terminal_collect_inputs_beta=v1; terminal_collect_confirm_beta=v1; retrieve_tax_forms_beta=v1; financial_connections_transactions_beta=v1; invoice_partial_payments_beta=v1; invoice_payment_plans_beta=v1; payment_intent_with_tax_api_beta=v1", + "version": "2024-06-20; embedded_connect_beta=v2; server_side_confirmation_beta=v1; orders_beta=v4; gift_cards_beta=v1; unified_accounts_beta=v1; terminal_collect_inputs_beta=v1; terminal_collect_confirm_beta=v1; retrieve_tax_forms_beta=v1; financial_connections_transactions_beta=v1; invoice_partial_payments_beta=v2; invoice_payment_plans_beta=v1; payment_intent_with_tax_api_beta=v1", "x-stripeSpecFilename": "spec3.beta.sdk" }, "openapi": "3.0.0", diff --git a/openapi/spec3.beta.sdk.yaml b/openapi/spec3.beta.sdk.yaml index db5c584f..239bd784 100644 --- a/openapi/spec3.beta.sdk.yaml +++ b/openapi/spec3.beta.sdk.yaml @@ -20762,18 +20762,6 @@ components: Amount intended to be paid toward this invoice, in cents (or local equivalent) type: integer - charge: - anyOf: - - maxLength: 5000 - type: string - - $ref: '#/components/schemas/charge' - description: >- - ID of the successful charge for this payment. This field is null - when the payment is `open` or `canceled`. - nullable: true - x-expansionResources: - oneOf: - - $ref: '#/components/schemas/charge' created: description: >- Time at which the object was created. Measured in seconds since the @@ -20823,19 +20811,9 @@ components: enum: - invoice_payment type: string - payment_intent: - anyOf: - - maxLength: 5000 - type: string - - $ref: '#/components/schemas/payment_intent' - description: >- - ID of the PaymentIntent associated with this payment. Note: This - property is only populated for invoices finalized on or after March - 15th, 2019. - nullable: true - x-expansionResources: - oneOf: - - $ref: '#/components/schemas/payment_intent' + payment: + $ref: >- + #/components/schemas/invoices_payments_invoice_payment_associated_payment status: description: 'The status of the payment, one of `open`, `paid`, or `canceled`.' maxLength: 5000 @@ -20847,7 +20825,6 @@ components: - amount_overpaid - amount_paid - amount_requested - - charge - created - currency - id @@ -20855,15 +20832,14 @@ components: - is_default - livemode - object - - payment_intent + - payment - status - status_transitions title: InvoicesInvoicePayment type: object x-expandableFields: - - charge - invoice - - payment_intent + - payment - status_transitions x-resourceId: invoice_payment x-stripeOperations: @@ -21899,6 +21875,49 @@ components: type: object x-expandableFields: - payment_method_options + invoices_payments_invoice_payment_associated_payment: + description: '' + properties: + charge: + anyOf: + - maxLength: 5000 + type: string + - $ref: '#/components/schemas/charge' + description: >- + ID of the successful charge for this payment when `type` is + `charge`. + x-expansionResources: + oneOf: + - $ref: '#/components/schemas/charge' + out_of_band_payment: + $ref: '#/components/schemas/invoices_payments_out_of_band_payment' + payment_intent: + anyOf: + - maxLength: 5000 + type: string + - $ref: '#/components/schemas/payment_intent' + description: >- + ID of the PaymentIntent associated with this payment when `type` is + `payment_intent`. Note: This property is only populated for invoices + finalized on or after March 15th, 2019. + x-expansionResources: + oneOf: + - $ref: '#/components/schemas/payment_intent' + type: + description: Type of payment object associated with this invoice payment. + enum: + - charge + - out_of_band_payment + - payment_intent + type: string + required: + - type + title: InvoicesPaymentsInvoicePaymentAssociatedPayment + type: object + x-expandableFields: + - charge + - out_of_band_payment + - payment_intent invoices_payments_invoice_payment_status_transitions: description: '' properties: @@ -21918,6 +21937,56 @@ components: title: InvoicesPaymentsInvoicePaymentStatusTransitions type: object x-expandableFields: [] + invoices_payments_out_of_band_payment: + description: '' + properties: + amount: + description: >- + Amount paid on this out of band payment, in cents (or local + equivalent) + type: integer + currency: + description: >- + 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). + maxLength: 5000 + type: string + metadata: + additionalProperties: + maxLength: 500 + type: string + description: >- + 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. + nullable: true + type: object + money_movement_type: + description: The type of money movement for this out of band payment record. + maxLength: 5000 + type: string + paid_at: + description: The timestamp when this out of band payment was paid. + format: unix-time + nullable: true + type: integer + payment_reference: + description: The reference for this out of band payment record. + maxLength: 5000 + nullable: true + type: string + required: + - amount + - currency + - metadata + - money_movement_type + - paid_at + - payment_reference + title: InvoicesPaymentsOutOfBandPayment + type: object + x-expandableFields: [] invoices_resource_from_invoice: description: '' properties: @@ -66213,7 +66282,7 @@ info: orders_beta=v4; gift_cards_beta=v1; unified_accounts_beta=v1; terminal_collect_inputs_beta=v1; terminal_collect_confirm_beta=v1; retrieve_tax_forms_beta=v1; financial_connections_transactions_beta=v1; - invoice_partial_payments_beta=v1; invoice_payment_plans_beta=v1; + invoice_partial_payments_beta=v2; invoice_payment_plans_beta=v1; payment_intent_with_tax_api_beta=v1 x-stripeSpecFilename: spec3.beta.sdk openapi: 3.0.0