Skip to content

Commit 865b8b9

Browse files
OpenAPI Update (#937)
Update OpenAPI for ee9def5dcab354735b5fd035e8ac07d8ed882b1b Co-authored-by: Stripe OpenAPI <105521251+stripe-openapi[bot]@users.noreply.github.com>
1 parent 9e024e7 commit 865b8b9

File tree

1 file changed

+121
-44
lines changed

1 file changed

+121
-44
lines changed

embedded/openapi/spec3.beta.sdk.json

Lines changed: 121 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -22537,26 +22537,6 @@
2253722537
"description": "Amount intended to be paid toward this invoice, in cents (or local equivalent)",
2253822538
"type": "integer"
2253922539
},
22540-
"charge": {
22541-
"anyOf": [
22542-
{
22543-
"maxLength": 5000,
22544-
"type": "string"
22545-
},
22546-
{
22547-
"$ref": "#/components/schemas/charge"
22548-
}
22549-
],
22550-
"description": "ID of the successful charge for this payment. This field is null when the payment is `open` or `canceled`.",
22551-
"nullable": true,
22552-
"x-expansionResources": {
22553-
"oneOf": [
22554-
{
22555-
"$ref": "#/components/schemas/charge"
22556-
}
22557-
]
22558-
}
22559-
},
2256022540
"created": {
2256122541
"description": "Time at which the object was created. Measured in seconds since the Unix epoch.",
2256222542
"format": "unix-time",
@@ -22613,25 +22593,8 @@
2261322593
],
2261422594
"type": "string"
2261522595
},
22616-
"payment_intent": {
22617-
"anyOf": [
22618-
{
22619-
"maxLength": 5000,
22620-
"type": "string"
22621-
},
22622-
{
22623-
"$ref": "#/components/schemas/payment_intent"
22624-
}
22625-
],
22626-
"description": "ID of the PaymentIntent associated with this payment. Note: This property is only populated for invoices finalized on or after March 15th, 2019.",
22627-
"nullable": true,
22628-
"x-expansionResources": {
22629-
"oneOf": [
22630-
{
22631-
"$ref": "#/components/schemas/payment_intent"
22632-
}
22633-
]
22634-
}
22596+
"payment": {
22597+
"$ref": "#/components/schemas/invoices_payments_invoice_payment_associated_payment"
2263522598
},
2263622599
"status": {
2263722600
"description": "The status of the payment, one of `open`, `paid`, or `canceled`.",
@@ -22646,24 +22609,22 @@
2264622609
"amount_overpaid",
2264722610
"amount_paid",
2264822611
"amount_requested",
22649-
"charge",
2265022612
"created",
2265122613
"currency",
2265222614
"id",
2265322615
"invoice",
2265422616
"is_default",
2265522617
"livemode",
2265622618
"object",
22657-
"payment_intent",
22619+
"payment",
2265822620
"status",
2265922621
"status_transitions"
2266022622
],
2266122623
"title": "InvoicesInvoicePayment",
2266222624
"type": "object",
2266322625
"x-expandableFields": [
22664-
"charge",
2266522626
"invoice",
22666-
"payment_intent",
22627+
"payment",
2266722628
"status_transitions"
2266822629
],
2266922630
"x-resourceId": "invoice_payment",
@@ -23898,6 +23859,71 @@
2389823859
"payment_method_options"
2389923860
]
2390023861
},
23862+
"invoices_payments_invoice_payment_associated_payment": {
23863+
"description": "",
23864+
"properties": {
23865+
"charge": {
23866+
"anyOf": [
23867+
{
23868+
"maxLength": 5000,
23869+
"type": "string"
23870+
},
23871+
{
23872+
"$ref": "#/components/schemas/charge"
23873+
}
23874+
],
23875+
"description": "ID of the successful charge for this payment when `type` is `charge`.",
23876+
"x-expansionResources": {
23877+
"oneOf": [
23878+
{
23879+
"$ref": "#/components/schemas/charge"
23880+
}
23881+
]
23882+
}
23883+
},
23884+
"out_of_band_payment": {
23885+
"$ref": "#/components/schemas/invoices_payments_out_of_band_payment"
23886+
},
23887+
"payment_intent": {
23888+
"anyOf": [
23889+
{
23890+
"maxLength": 5000,
23891+
"type": "string"
23892+
},
23893+
{
23894+
"$ref": "#/components/schemas/payment_intent"
23895+
}
23896+
],
23897+
"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.",
23898+
"x-expansionResources": {
23899+
"oneOf": [
23900+
{
23901+
"$ref": "#/components/schemas/payment_intent"
23902+
}
23903+
]
23904+
}
23905+
},
23906+
"type": {
23907+
"description": "Type of payment object associated with this invoice payment.",
23908+
"enum": [
23909+
"charge",
23910+
"out_of_band_payment",
23911+
"payment_intent"
23912+
],
23913+
"type": "string"
23914+
}
23915+
},
23916+
"required": [
23917+
"type"
23918+
],
23919+
"title": "InvoicesPaymentsInvoicePaymentAssociatedPayment",
23920+
"type": "object",
23921+
"x-expandableFields": [
23922+
"charge",
23923+
"out_of_band_payment",
23924+
"payment_intent"
23925+
]
23926+
},
2390123927
"invoices_payments_invoice_payment_status_transitions": {
2390223928
"description": "",
2390323929
"properties": {
@@ -23922,6 +23948,57 @@
2392223948
"type": "object",
2392323949
"x-expandableFields": []
2392423950
},
23951+
"invoices_payments_out_of_band_payment": {
23952+
"description": "",
23953+
"properties": {
23954+
"amount": {
23955+
"description": "Amount paid on this out of band payment, in cents (or local equivalent)",
23956+
"type": "integer"
23957+
},
23958+
"currency": {
23959+
"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).",
23960+
"maxLength": 5000,
23961+
"type": "string"
23962+
},
23963+
"metadata": {
23964+
"additionalProperties": {
23965+
"maxLength": 500,
23966+
"type": "string"
23967+
},
23968+
"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.",
23969+
"nullable": true,
23970+
"type": "object"
23971+
},
23972+
"money_movement_type": {
23973+
"description": "The type of money movement for this out of band payment record.",
23974+
"maxLength": 5000,
23975+
"type": "string"
23976+
},
23977+
"paid_at": {
23978+
"description": "The timestamp when this out of band payment was paid.",
23979+
"format": "unix-time",
23980+
"nullable": true,
23981+
"type": "integer"
23982+
},
23983+
"payment_reference": {
23984+
"description": "The reference for this out of band payment record.",
23985+
"maxLength": 5000,
23986+
"nullable": true,
23987+
"type": "string"
23988+
}
23989+
},
23990+
"required": [
23991+
"amount",
23992+
"currency",
23993+
"metadata",
23994+
"money_movement_type",
23995+
"paid_at",
23996+
"payment_reference"
23997+
],
23998+
"title": "InvoicesPaymentsOutOfBandPayment",
23999+
"type": "object",
24000+
"x-expandableFields": []
24001+
},
2392524002
"invoices_resource_from_invoice": {
2392624003
"description": "",
2392724004
"properties": {
@@ -73271,7 +73348,7 @@
7327173348
"description": "The Stripe REST API. Please see https://stripe.com/docs/api for more details.",
7327273349
"termsOfService": "https://stripe.com/us/terms/",
7327373350
"title": "Stripe API",
73274-
"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",
73351+
"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",
7327573352
"x-stripeSpecFilename": "spec3.beta.sdk"
7327673353
},
7327773354
"openapi": "3.0.0",

0 commit comments

Comments
 (0)