Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

OpenAPI Update #819

Merged
merged 1 commit into from
May 14, 2024
Merged

OpenAPI Update #819

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions embedded/openapi/fixtures3.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -229,7 +229,8 @@
"has_more": false,
"object": "list",
"url": "/v1/application_fees/fee_1OPounJN5vQBdWExWgwi95uU/refunds"
}
},
"fee_source": null
},
"apps.secret": {
"created": 1234567890,
Expand Down Expand Up @@ -3033,7 +3034,9 @@
"source_type": "card",
"statement_descriptor": null,
"status": "in_transit",
"type": "bank_account"
"type": "bank_account",
"application_fee": null,
"application_fee_amount": null
},
"person": {
"account": "acct_1OPouMJN5vQBdWEx",
Expand Down
102 changes: 102 additions & 0 deletions embedded/openapi/spec3.beta.sdk.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2794,6 +2794,15 @@
"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).",
"type": "string"
},
"fee_source": {
"anyOf": [
{
"$ref": "#/components/schemas/platform_earning_fee_source"
}
],
"description": "Polymorphic source of the application fee. Includes the ID of the object the application fee was created from.",
"nullable": true
},
"id": {
"description": "Unique identifier for the object.",
"maxLength": 5000,
Expand Down Expand Up @@ -2883,6 +2892,7 @@
"charge",
"created",
"currency",
"fee_source",
"id",
"livemode",
"object",
Expand All @@ -2897,6 +2907,7 @@
"application",
"balance_transaction",
"charge",
"fee_source",
"originating_transaction",
"refunds"
],
Expand Down Expand Up @@ -3260,6 +3271,13 @@
"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).",
"type": "string"
},
"net_available": {
"description": "Breakdown of balance by destination.",
"items": {
"$ref": "#/components/schemas/balance_net_available"
},
"type": "array"
},
"source_types": {
"$ref": "#/components/schemas/balance_amount_by_source_type"
}
Expand All @@ -3271,6 +3289,7 @@
"title": "BalanceAmountNet",
"type": "object",
"x-expandableFields": [
"net_available",
"source_types"
]
},
Expand All @@ -3294,6 +3313,32 @@
"available"
]
},
"balance_net_available": {
"description": "",
"properties": {
"amount": {
"description": "Net balance amount, subtracting fees from platform-set pricing.",
"type": "integer"
},
"destination": {
"description": "ID of the external account for this net balance (not expandable).",
"maxLength": 5000,
"type": "string"
},
"source_types": {
"$ref": "#/components/schemas/balance_amount_by_source_type"
}
},
"required": [
"amount",
"destination"
],
"title": "BalanceNetAvailable",
"type": "object",
"x-expandableFields": [
"source_types"
]
},
"balance_transaction": {
"description": "Balance transactions represent funds moving through your Stripe account.\nStripe creates them for every type of transaction that enters or leaves your Stripe account balance.\n\nRelated guide: [Balance transaction types](https://stripe.com/docs/reports/balance-transaction-types)",
"properties": {
Expand Down Expand Up @@ -45851,6 +45896,31 @@
"description": "The amount (in cents (or local equivalent)) that transfers to your bank account or debit card.",
"type": "integer"
},
"application_fee": {
"anyOf": [
{
"maxLength": 5000,
"type": "string"
},
{
"$ref": "#/components/schemas/application_fee"
}
],
"description": "The application fee (if any) for the payout. [See the Connect documentation](https://stripe.com/docs/connect/instant-payouts#monetization-and-fees) for details.",
"nullable": true,
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/application_fee"
}
]
}
},
"application_fee_amount": {
"description": "The amount of the application fee (if any) requested for the payout. [See the Connect documentation](https://stripe.com/docs/connect/instant-payouts#monetization-and-fees) for details.",
"nullable": true,
"type": "integer"
},
"arrival_date": {
"description": "Date that you can expect the payout to arrive in the bank. This factors in delays to account for weekends or bank holidays.",
"format": "unix-time",
Expand Down Expand Up @@ -46060,6 +46130,8 @@
},
"required": [
"amount",
"application_fee",
"application_fee_amount",
"arrival_date",
"automatic",
"balance_transaction",
Expand All @@ -46086,6 +46158,7 @@
"title": "Payout",
"type": "object",
"x-expandableFields": [
"application_fee",
"balance_transaction",
"destination",
"failure_balance_transaction",
Expand Down Expand Up @@ -47169,6 +47242,35 @@
"type": "object",
"x-expandableFields": []
},
"platform_earning_fee_source": {
"description": "",
"properties": {
"charge": {
"description": "Charge ID that created this application fee.",
"maxLength": 5000,
"type": "string"
},
"payout": {
"description": "Payout ID that created this application fee.",
"maxLength": 5000,
"type": "string"
},
"type": {
"description": "Type of object that created the application fee, either `charge` or `payout`.",
"enum": [
"charge",
"payout"
],
"type": "string"
}
},
"required": [
"type"
],
"title": "PlatformEarningFeeSource",
"type": "object",
"x-expandableFields": []
},
"platform_tax_fee": {
"description": "",
"properties": {
Expand Down
99 changes: 99 additions & 0 deletions embedded/openapi/spec3.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2020,6 +2020,15 @@
"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).",
"type": "string"
},
"fee_source": {
"anyOf": [
{
"$ref": "#/components/schemas/platform_earning_fee_source"
}
],
"description": "Polymorphic source of the application fee. Includes the ID of the object the application fee was created from.",
"nullable": true
},
"id": {
"description": "Unique identifier for the object.",
"maxLength": 5000,
Expand Down Expand Up @@ -2121,6 +2130,7 @@
"application",
"balance_transaction",
"charge",
"fee_source",
"originating_transaction",
"refunds"
],
Expand Down Expand Up @@ -2345,6 +2355,13 @@
"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).",
"type": "string"
},
"net_available": {
"description": "Breakdown of balance by destination.",
"items": {
"$ref": "#/components/schemas/balance_net_available"
},
"type": "array"
},
"source_types": {
"$ref": "#/components/schemas/balance_amount_by_source_type"
}
Expand All @@ -2356,6 +2373,7 @@
"title": "BalanceAmountNet",
"type": "object",
"x-expandableFields": [
"net_available",
"source_types"
]
},
Expand All @@ -2379,6 +2397,32 @@
"available"
]
},
"balance_net_available": {
"description": "",
"properties": {
"amount": {
"description": "Net balance amount, subtracting fees from platform-set pricing.",
"type": "integer"
},
"destination": {
"description": "ID of the external account for this net balance (not expandable).",
"maxLength": 5000,
"type": "string"
},
"source_types": {
"$ref": "#/components/schemas/balance_amount_by_source_type"
}
},
"required": [
"amount",
"destination"
],
"title": "BalanceNetAvailable",
"type": "object",
"x-expandableFields": [
"source_types"
]
},
"balance_transaction": {
"description": "Balance transactions represent funds moving through your Stripe account.\nStripe creates them for every type of transaction that enters or leaves your Stripe account balance.\n\nRelated guide: [Balance transaction types](https://stripe.com/docs/reports/balance-transaction-types)",
"properties": {
Expand Down Expand Up @@ -33182,6 +33226,31 @@
"description": "The amount (in cents (or local equivalent)) that transfers to your bank account or debit card.",
"type": "integer"
},
"application_fee": {
"anyOf": [
{
"maxLength": 5000,
"type": "string"
},
{
"$ref": "#/components/schemas/application_fee"
}
],
"description": "The application fee (if any) for the payout. [See the Connect documentation](https://stripe.com/docs/connect/instant-payouts#monetization-and-fees) for details.",
"nullable": true,
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/application_fee"
}
]
}
},
"application_fee_amount": {
"description": "The amount of the application fee (if any) requested for the payout. [See the Connect documentation](https://stripe.com/docs/connect/instant-payouts#monetization-and-fees) for details.",
"nullable": true,
"type": "integer"
},
"arrival_date": {
"description": "Date that you can expect the payout to arrive in the bank. This factors in delays to account for weekends or bank holidays.",
"format": "unix-time",
Expand Down Expand Up @@ -33420,6 +33489,7 @@
"title": "Payout",
"type": "object",
"x-expandableFields": [
"application_fee",
"balance_transaction",
"destination",
"failure_balance_transaction",
Expand Down Expand Up @@ -34114,6 +34184,35 @@
"type": "object",
"x-expandableFields": []
},
"platform_earning_fee_source": {
"description": "",
"properties": {
"charge": {
"description": "Charge ID that created this application fee.",
"maxLength": 5000,
"type": "string"
},
"payout": {
"description": "Payout ID that created this application fee.",
"maxLength": 5000,
"type": "string"
},
"type": {
"description": "Type of object that created the application fee, either `charge` or `payout`.",
"enum": [
"charge",
"payout"
],
"type": "string"
}
},
"required": [
"type"
],
"title": "PlatformEarningFeeSource",
"type": "object",
"x-expandableFields": []
},
"platform_tax_fee": {
"description": "",
"properties": {
Expand Down
Loading