From 47aa53e3bdf8bdbee416e0d17764594bcd7b5197 Mon Sep 17 00:00:00 2001 From: Brandur Date: Thu, 18 May 2017 15:56:50 -0700 Subject: [PATCH] Update OpenAPI and fixtures --- openapi/fixtures.json | 80 +- openapi/fixtures.yaml | 72 +- openapi/spec2.json | 6958 +++++++++++++++++++++++++++++++++-------- openapi/spec2.yaml | 4632 +++++++++++++++++++++------ 4 files changed, 9333 insertions(+), 2409 deletions(-) diff --git a/openapi/fixtures.json b/openapi/fixtures.json index 2a2a0db4..83cedafb 100644 --- a/openapi/fixtures.json +++ b/openapi/fixtures.json @@ -4,8 +4,6 @@ "active_payment_methods": [ ], - "bank_accounts": { - }, "business_logo": "", "business_name": "", "business_primary_color": "", @@ -15,7 +13,7 @@ "debit_negative_balances": true, "decline_charge_on": { "avs_failure": true, - "cvc_failure": true + "cvc_failure": false }, "default_currency": "usd", "details_submitted": false, @@ -96,6 +94,7 @@ "ip": null, "user_agent": null }, + "type": "", "verification": { "disabled_reason": "fields_needed", "due_by": null, @@ -109,12 +108,14 @@ ] } }, + "account_debit_account": { + "id": "acct_1A7AbkBbzgiusCZl", + "object": "account" + }, "account_with_keys": { "active_payment_methods": [ ], - "bank_accounts": { - }, "business_logo": "", "business_name": "", "business_primary_color": "", @@ -160,6 +161,7 @@ "timezone": "Etc/UTC", "tos_acceptance": { }, + "type": "", "verification": { } }, @@ -174,7 +176,7 @@ "object": "alipay_account", "payment_amount": 1000, "payment_currency": "usd", - "reusable": false, + "reusable": true, "used": false, "username": "test@example.com" }, @@ -182,7 +184,7 @@ "created": 1234567890, "domain_name": "example.com", "id": "apwc_19zuugDSlTMT26MkaEqesPjq", - "livemode": true, + "livemode": false, "object": "apple_pay_domain" }, "balance": { @@ -260,7 +262,7 @@ "used": false }, "bitcoin_receiver": { - "active": false, + "active": true, "amount": 100, "amount_received": 0, "bitcoin_amount": 1757908, @@ -271,7 +273,7 @@ "customer": "", "description": "Receiver for John Doe", "email": "test@example.com", - "filled": false, + "filled": true, "id": "btcrcv_19zYqFDSlTMT26Mk31J1pMex", "inbound_address": "test_7i9Fo4b5wXcUAuoVBFrc7nc9HDxD1", "livemode": false, @@ -281,8 +283,15 @@ "payment": "", "refund_address": "", "transactions": { + "data": [ + + ], + "has_more": false, + "object": "list", + "total_count": 1, + "url": "/v1/bitcoin/receivers/btcrcv_1AGMTU2eZvKYlo2CK7mXHmc8/transactions" }, - "uncaptured_funds": false, + "uncaptured_funds": true, "used_for_payment": false }, "bitcoin_transaction": { @@ -349,10 +358,8 @@ "application_fees_refunded": 0, "authorization_code": "", "balance_transaction": "txn_19zuuhDSlTMT26Mk2gJnG0ti", - "captured": true, + "captured": false, "captured_at": 1234567890, - "card": { - }, "created": 1234567890, "currency": "usd", "customer": "", @@ -377,7 +384,7 @@ "order": "", "outcome": { }, - "paid": true, + "paid": false, "receipt_email": "", "receipt_number": "", "refunded": false, @@ -409,6 +416,7 @@ "dynamic_last4": null, "exp_month": 8, "exp_year": 2018, + "fingerprint": "Xt5EWLLDS7FJjR1c", "funding": "unknown", "id": "card_19tLKYDSlTMT26Mkl7bixGYc", "last4": "4242", @@ -519,20 +527,18 @@ "bank_accounts": { }, "business_vat_id": "", - "cards": { - }, "created": 1234567890, "currency": "usd", "default_bank_account": "", - "default_card": "", "default_source": "", - "default_source_type": "", "delinquent": false, "description": "", "discount": { }, "email": "", "id": "cus_ADmuABetLS15eF", + "invoicing": { + }, "livemode": false, "metadata": { }, @@ -551,6 +557,13 @@ "subscription": { }, "subscriptions": { + "data": [ + + ], + "has_more": false, + "object": "list", + "total_count": 0, + "url": "/v1/customers/cus_AcaooY7ydINUy4/subscriptions" }, "trust": { } @@ -593,6 +606,8 @@ "balance_transactions": [ ], + "case_details": { + }, "charge": "ch_19zuuhDSlTMT26MkKLSiekJ9", "closed_at": 1234567890, "created": 1234567890, @@ -654,14 +669,14 @@ "data": { "object": { "account_balance": 0, - "created": 1488566449, + "created": 1494264431, "currency": "usd", "default_source": null, "delinquent": false, "description": null, "discount": null, "email": null, - "id": "cus_ADmuABetLS15eF", + "id": "sub_3dyJJwVHzv2Xya", "livemode": false, "metadata": { }, @@ -674,7 +689,7 @@ "has_more": false, "object": "list", "total_count": 0, - "url": "/v1/customers/cus_ADmuABetLS15eF/sources" + "url": "/v1/customers/cus_AcUc8AEn2iJ2jE/sources" }, "subscriptions": { "data": [ @@ -683,7 +698,7 @@ "has_more": false, "object": "list", "total_count": 0, - "url": "/v1/customers/cus_ADmuABetLS15eF/subscriptions" + "url": "/v1/customers/cus_AcUc8AEn2iJ2jE/subscriptions" } } }, @@ -728,10 +743,10 @@ "amount_due": 0, "application_fee": 0, "attempt_count": 0, - "attempted": false, + "attempted": true, "billing": "", "charge": "", - "closed": false, + "closed": true, "currency": "usd", "customer": "cus_ADmuABetLS15eF", "date": 1234567890, @@ -790,7 +805,7 @@ "next_payment_attempt": 1234567890, "number": "", "object": "invoice", - "paid": false, + "paid": true, "period_end": 1234567890, "period_start": 1234567890, "receipt_number": "", @@ -896,6 +911,11 @@ "type": "bank_account", "user_visible_date": 1234567890 }, + "login_link": { + "created": 1234567890, + "object": "login_link", + "url": "http://127.0.0.1:6090/express/xmkx6tsLZvoZ" + }, "order": { "amount": 1500, "amount_returned": 0, @@ -1000,6 +1020,7 @@ "failure_code": "", "failure_message": "", "id": "tr_1A5hBfDSlTMT26MkB9QceCEw", + "legacy_date": 1234567890, "livemode": false, "metadata": { }, @@ -1283,6 +1304,7 @@ "dynamic_last4": null, "exp_month": 8, "exp_year": 2018, + "fingerprint": "TUSZPuJK6frwQold", "funding": "unknown", "id": "card_19tLKYDSlTMT26Mkl7bixGYc", "last4": "4242", @@ -1322,6 +1344,7 @@ "dynamic_last4": null, "exp_month": 8, "exp_year": 2018, + "fingerprint": "Xt5EWLLDS7FJjR1c", "funding": "unknown", "id": "card_19tLKYDSlTMT26MkxAeJBsQn", "last4": "4242", @@ -1365,6 +1388,7 @@ "url": "/v1/transfers/tr_19zuujDSlTMT26Mk81npuLjT/reversals" }, "reversed": false, + "source_transaction": "ch_164xRv2eZvKYlo2Clu1sIJWB", "source_type": "card", "transfer_group": "" }, @@ -1421,10 +1445,10 @@ "amount_due": 0, "application_fee": 0, "attempt_count": 0, - "attempted": false, + "attempted": true, "billing": "", "charge": "", - "closed": false, + "closed": true, "currency": "usd", "customer": "cus_ADmuABetLS15eF", "date": 1234567890, @@ -1449,7 +1473,7 @@ "next_payment_attempt": 1234567890, "number": "", "object": "invoice", - "paid": false, + "paid": true, "period_end": 1234567890, "period_start": 1234567890, "receipt_number": "", diff --git a/openapi/fixtures.yaml b/openapi/fixtures.yaml index 90e083cb..7afc3011 100644 --- a/openapi/fixtures.yaml +++ b/openapi/fixtures.yaml @@ -2,7 +2,6 @@ resources: account: active_payment_methods: [] - bank_accounts: {} business_logo: '' business_name: '' business_primary_color: '' @@ -12,7 +11,7 @@ resources: debit_negative_balances: true decline_charge_on: avs_failure: true - cvc_failure: true + cvc_failure: false default_currency: usd details_submitted: false display_name: '' @@ -78,6 +77,7 @@ resources: date: ip: user_agent: + type: '' verification: disabled_reason: fields_needed due_by: @@ -88,9 +88,11 @@ resources: - support_phone - tos_acceptance.date - tos_acceptance.ip + account_debit_account: + id: acct_1A7AbkBbzgiusCZl + object: account account_with_keys: active_payment_methods: [] - bank_accounts: {} business_logo: '' business_name: '' business_primary_color: '' @@ -126,6 +128,7 @@ resources: support_url: '' timezone: Etc/UTC tos_acceptance: {} + type: '' verification: {} alipay_account: created: 1234567890 @@ -137,14 +140,14 @@ resources: object: alipay_account payment_amount: 1000 payment_currency: usd - reusable: false + reusable: true used: false username: test@example.com apple_pay_domain: created: 1234567890 domain_name: example.com id: apwc_19zuugDSlTMT26MkaEqesPjq - livemode: true + livemode: false object: apple_pay_domain balance: available: @@ -203,7 +206,7 @@ resources: status: new used: false bitcoin_receiver: - active: false + active: true amount: 100 amount_received: 0 bitcoin_amount: 1757908 @@ -214,7 +217,7 @@ resources: customer: '' description: Receiver for John Doe email: test@example.com - filled: false + filled: true id: btcrcv_19zYqFDSlTMT26Mk31J1pMex inbound_address: test_7i9Fo4b5wXcUAuoVBFrc7nc9HDxD1 livemode: false @@ -222,8 +225,13 @@ resources: object: bitcoin_receiver payment: '' refund_address: '' - transactions: {} - uncaptured_funds: false + transactions: + data: [] + has_more: false + object: list + total_count: 1 + url: "/v1/bitcoin/receivers/btcrcv_1AGMTU2eZvKYlo2CK7mXHmc8/transactions" + uncaptured_funds: true used_for_payment: false bitcoin_transaction: amount: 100 @@ -281,9 +289,8 @@ resources: application_fees_refunded: 0 authorization_code: '' balance_transaction: txn_19zuuhDSlTMT26Mk2gJnG0ti - captured: true + captured: false captured_at: 1234567890 - card: {} created: 1234567890 currency: usd customer: '' @@ -303,7 +310,7 @@ resources: on_behalf_of: '' order: '' outcome: {} - paid: true + paid: false receipt_email: '' receipt_number: '' refunded: false @@ -331,6 +338,7 @@ resources: dynamic_last4: exp_month: 8 exp_year: 2018 + fingerprint: Xt5EWLLDS7FJjR1c funding: unknown id: card_19tLKYDSlTMT26Mkl7bixGYc last4: '4242' @@ -420,18 +428,16 @@ resources: alipay_accounts: {} bank_accounts: {} business_vat_id: '' - cards: {} created: 1234567890 currency: usd default_bank_account: '' - default_card: '' default_source: '' - default_source_type: '' delinquent: false description: '' discount: {} email: '' id: cus_ADmuABetLS15eF + invoicing: {} livemode: false metadata: {} object: customer @@ -443,7 +449,12 @@ resources: total_count: 0 url: "/v1/customers/cus_ADmuABetLS15eF/sources" subscription: {} - subscriptions: {} + subscriptions: + data: [] + has_more: false + object: list + total_count: 0 + url: "/v1/customers/cus_AcaooY7ydINUy4/subscriptions" trust: {} customer_source: customer: '' @@ -476,6 +487,7 @@ resources: amount: 1000 balance_transaction: '' balance_transactions: [] + case_details: {} charge: ch_19zuuhDSlTMT26MkKLSiekJ9 closed_at: 1234567890 created: 1234567890 @@ -531,14 +543,14 @@ resources: data: object: account_balance: 0 - created: 1488566449 + created: 1494264431 currency: usd default_source: delinquent: false description: discount: email: - id: cus_ADmuABetLS15eF + id: sub_3dyJJwVHzv2Xya livemode: false metadata: {} object: customer @@ -548,13 +560,13 @@ resources: has_more: false object: list total_count: 0 - url: "/v1/customers/cus_ADmuABetLS15eF/sources" + url: "/v1/customers/cus_AcUc8AEn2iJ2jE/sources" subscriptions: data: [] has_more: false object: list total_count: 0 - url: "/v1/customers/cus_ADmuABetLS15eF/subscriptions" + url: "/v1/customers/cus_AcUc8AEn2iJ2jE/subscriptions" id: evt_19tLKfDSlTMT26MkKD3pohqX livemode: false object: event @@ -591,10 +603,10 @@ resources: amount_due: 0 application_fee: 0 attempt_count: 0 - attempted: false + attempted: true billing: '' charge: '' - closed: false + closed: true currency: usd customer: cus_ADmuABetLS15eF date: 1234567890 @@ -643,7 +655,7 @@ resources: next_payment_attempt: 1234567890 number: '' object: invoice - paid: false + paid: true period_end: 1234567890 period_start: 1234567890 receipt_number: '' @@ -733,6 +745,10 @@ resources: transfer_group: '' type: bank_account user_visible_date: 1234567890 + login_link: + created: 1234567890 + object: login_link + url: http://127.0.0.1:6090/express/xmkx6tsLZvoZ order: amount: 1500 amount_returned: 0 @@ -817,6 +833,7 @@ resources: failure_code: '' failure_message: '' id: tr_1A5hBfDSlTMT26MkB9QceCEw + legacy_date: 1234567890 livemode: false metadata: {} method: standard @@ -1053,6 +1070,7 @@ resources: dynamic_last4: exp_month: 8 exp_year: 2018 + fingerprint: TUSZPuJK6frwQold funding: unknown id: card_19tLKYDSlTMT26Mkl7bixGYc last4: '4242' @@ -1086,6 +1104,7 @@ resources: dynamic_last4: exp_month: 8 exp_year: 2018 + fingerprint: Xt5EWLLDS7FJjR1c funding: unknown id: card_19tLKYDSlTMT26MkxAeJBsQn last4: '4242' @@ -1122,6 +1141,7 @@ resources: total_count: 0 url: "/v1/transfers/tr_19zuujDSlTMT26Mk81npuLjT/reversals" reversed: false + source_transaction: ch_164xRv2eZvKYlo2Clu1sIJWB source_type: card transfer_group: '' transfer_recipient: @@ -1169,10 +1189,10 @@ resources: amount_due: 0 application_fee: 0 attempt_count: 0 - attempted: false + attempted: true billing: '' charge: '' - closed: false + closed: true currency: usd customer: cus_ADmuABetLS15eF date: 1234567890 @@ -1192,7 +1212,7 @@ resources: next_payment_attempt: 1234567890 number: '' object: invoice - paid: false + paid: true period_end: 1234567890 period_start: 1234567890 receipt_number: '' diff --git a/openapi/spec2.json b/openapi/spec2.json index 7a727e59..7b2e4984 100644 --- a/openapi/spec2.json +++ b/openapi/spec2.json @@ -5,12 +5,6 @@ "definitions": { "account": { "properties": { - "active_payment_methods": { - "description": "", - "type": [ - "array" - ] - }, "business_name": { "description": "The publicly visible name of the business.", "type": [ @@ -72,9 +66,7 @@ "properties": { "data": { "items": { - "type": [ - "object" - ] + "$ref": "#/definitions/bank_account" }, "type": [ "array" @@ -117,6 +109,9 @@ "title": "ExternalAccountList", "type": [ "object" + ], + "x-expandableFields": [ + "data" ] }, "id": { @@ -134,12 +129,6 @@ "boolean" ] }, - "mcc": { - "description": "", - "type": [ - "string" - ] - }, "metadata": { "description": "Set of key/value pairs that you can attach to an object. It can be useful for storing additional information about the object in a structured format.", "type": [ @@ -152,9 +141,6 @@ "string" ] }, - "orders": { - "$ref": "#/definitions/settings" - }, "payout_schedule": { "$ref": "#/definitions/transfer_schedule" }, @@ -208,7 +194,6 @@ } }, "required": [ - "active_payment_methods", "charges_enabled", "country", "debit_negative_balances", @@ -228,9 +213,40 @@ "title": "Account", "type": [ "object" + ], + "x-expandableFields": [ + ], "x-resourceId": "account" }, + "account_debit_account": { + "properties": { + "id": { + "description": "Unique identifier for the object.", + "type": [ + "string" + ] + }, + "object": { + "description": "String representing the object's type. Objects of the same type share the same value.", + "type": [ + "string" + ] + } + }, + "required": [ + "id", + "object" + ], + "title": "AccountDebitAccount", + "type": [ + "object" + ], + "x-expandableFields": [ + + ], + "x-resourceId": "account_debit_account" + }, "account_decline_charge_on": { "properties": { "avs_failure": { @@ -253,6 +269,9 @@ "title": "AccountDeclineChargeOn", "type": [ "object" + ], + "x-expandableFields": [ + ], "x-resourceId": "account_decline_charge_on" }, @@ -280,6 +299,9 @@ "title": "AccountTOSAcceptance", "type": [ "object" + ], + "x-expandableFields": [ + ], "x-resourceId": "account_tos_acceptance" }, @@ -310,17 +332,14 @@ "title": "AccountVerification", "type": [ "object" + ], + "x-expandableFields": [ + ], "x-resourceId": "account_verification" }, "account_with_keys": { "properties": { - "active_payment_methods": { - "description": "", - "type": [ - "array" - ] - }, "business_name": { "description": "The publicly visible name of the business.", "type": [ @@ -382,9 +401,7 @@ "properties": { "data": { "items": { - "type": [ - "object" - ] + "$ref": "#/definitions/bank_account" }, "type": [ "array" @@ -427,6 +444,9 @@ "title": "ExternalAccountList", "type": [ "object" + ], + "x-expandableFields": [ + "data" ] }, "id": { @@ -450,12 +470,6 @@ "boolean" ] }, - "mcc": { - "description": "", - "type": [ - "string" - ] - }, "metadata": { "description": "Set of key/value pairs that you can attach to an object. It can be useful for storing additional information about the object in a structured format.", "type": [ @@ -468,9 +482,6 @@ "string" ] }, - "orders": { - "$ref": "#/definitions/settings" - }, "payout_schedule": { "$ref": "#/definitions/transfer_schedule" }, @@ -524,7 +535,6 @@ } }, "required": [ - "active_payment_methods", "charges_enabled", "country", "debit_negative_balances", @@ -545,6 +555,9 @@ "title": "AccountWithKeys", "type": [ "object" + ], + "x-expandableFields": [ + ], "x-resourceId": "account_with_keys" }, @@ -590,6 +603,9 @@ "title": "Address", "type": [ "object" + ], + "x-expandableFields": [ + ], "x-resourceId": "address" }, @@ -605,7 +621,14 @@ "description": "", "type": [ "string" - ] + ], + "x-expansionResources": { + "oneOf": [ + { + "$ref": "#/definitions/customer" + } + ] + } }, "fingerprint": { "description": "Uniquely identifies the account and will be the same across all Alipay account objects that are linked to the same Alipay account.", @@ -683,6 +706,9 @@ "type": [ "object" ], + "x-expandableFields": [ + "customer" + ], "x-resourceId": "alipay_account" }, "apple_pay_domain": { @@ -728,38 +754,334 @@ "title": "ApplePayDomain", "type": [ "object" + ], + "x-expandableFields": [ + ], "x-resourceId": "apple_pay_domain" }, - "authorization_settings": { + "application": { "properties": { - "issuer": { - "description": "", + "id": { + "description": "Unique identifier for the object.", "type": [ "string" ] }, - "provider": { - "description": "", + "name": { + "description": "The name of the application.", "type": [ "string" ] }, - "type": { - "description": "", + "object": { + "description": "String representing the object's type. Objects of the same type share the same value.", "type": [ "string" ] } }, "required": [ - "type" + "id", + "object" ], - "title": "AuthorizationSettings", + "title": "Application", "type": [ "object" ], - "x-resourceId": "authorization_settings" + "x-expandableFields": [ + + ], + "x-resourceId": "application" + }, + "authorization": { + "properties": { + "amount": { + "description": "", + "type": [ + "integer" + ] + }, + "balance_transactions": { + "items": { + "$ref": "#/definitions/balance_transaction" + }, + "type": [ + "array" + ] + }, + "card": { + "description": "", + "type": [ + "string" + ], + "x-expansionResources": { + "oneOf": [ + { + "$ref": "#/definitions/issued_card" + } + ] + } + }, + "currency": { + "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://support.stripe.com/questions/which-currencies-does-stripe-support).", + "type": [ + "string" + ] + }, + "held_amount": { + "description": "", + "type": [ + "integer" + ] + }, + "held_currency": { + "description": "", + "type": [ + "string" + ] + }, + "id": { + "description": "Unique identifier for the object.", + "type": [ + "string" + ] + }, + "merchant_data": { + "$ref": "#/definitions/merchant_data" + }, + "metadata": { + "description": "Set of key/value pairs that you can attach to an object. It can be useful for storing additional information about the object in a structured format.", + "type": [ + "object" + ] + }, + "object": { + "description": "String representing the object's type. Objects of the same type share the same value.", + "type": [ + "string" + ] + } + }, + "required": [ + "amount", + "balance_transactions", + "card", + "currency", + "held_amount", + "held_currency", + "id", + "merchant_data", + "metadata", + "object" + ], + "title": "Authorization", + "type": [ + "object" + ], + "x-expandableFields": [ + "card" + ], + "x-resourceId": "authorization" + }, + "backwards_compatible_platform_earning": { + "properties": { + "account": { + "description": "ID of the Stripe account this fee was taken from.", + "type": [ + "string" + ], + "x-expansionResources": { + "oneOf": [ + { + "$ref": "#/definitions/account" + } + ] + } + }, + "amount": { + "description": "Amount earned, in %s.", + "type": [ + "integer" + ] + }, + "amount_refunded": { + "description": "Amount in %s refunded (can be less than the amount attribute on the fee if a partial refund was issued)", + "type": [ + "integer" + ] + }, + "application": { + "description": "ID of the Connect application that earned the fee.", + "type": [ + "string" + ], + "x-expansionResources": { + "oneOf": [ + { + "$ref": "#/definitions/application" + } + ] + } + }, + "balance_transaction": { + "description": "Balance transaction that describes the impact of this collected application fee on your account balance (not including refunds).", + "type": [ + "string" + ], + "x-expansionResources": { + "oneOf": [ + { + "$ref": "#/definitions/balance_transaction" + } + ] + } + }, + "charge": { + "description": "ID of the charge that the application fee was taken from.", + "type": [ + "string" + ], + "x-expansionResources": { + "oneOf": [ + { + "$ref": "#/definitions/charge" + } + ] + } + }, + "created": { + "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", + "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://support.stripe.com/questions/which-currencies-does-stripe-support).", + "type": [ + "string" + ] + }, + "id": { + "description": "Unique identifier for the object.", + "type": [ + "string" + ] + }, + "livemode": { + "description": "Flag indicating whether the object exists in live mode or test mode.", + "type": [ + "boolean" + ] + }, + "object": { + "description": "String representing the object's type. Objects of the same type share the same value.", + "type": [ + "string" + ] + }, + "originating_transaction": { + "description": "ID of the corresponding charge on the platform account, if this fee was the result of a charge using the `destination` parameter.", + "type": [ + "string" + ], + "x-expansionResources": { + "oneOf": [ + { + "$ref": "#/definitions/charge" + }, + { + "$ref": "#/definitions/transfer" + } + ] + } + }, + "refunded": { + "description": "Whether or not the fee has been fully refunded. If the fee is only partially refunded, this attribute will still be false.", + "type": [ + "boolean" + ] + }, + "refunds": { + "properties": { + "data": { + "items": { + "$ref": "#/definitions/fee_refund" + }, + "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" + ] + }, + "total_count": { + "description": "The total number of items available. This value is not included by default, but you can request it by specifying ?include[]=total_count.", + "type": [ + "integer" + ] + }, + "url": { + "description": "The URL where this list can be accessed.", + "type": [ + "string" + ] + } + }, + "required": [ + "data", + "has_more", + "object", + "url" + ], + "title": "FeeRefundList", + "type": [ + "object" + ], + "x-expandableFields": [ + + ] + } + }, + "required": [ + "account", + "amount", + "amount_refunded", + "application", + "balance_transaction", + "charge", + "created", + "currency", + "id", + "livemode", + "object", + "refunded", + "refunds" + ], + "title": "BackwardsCompatiblePlatformEarning", + "type": [ + "object" + ], + "x-expandableFields": [ + "account", + "application", + "balance_transaction", + "charge", + "originating_transaction" + ], + "x-resourceId": "backwards_compatible_platform_earning" }, "balance": { "properties": { @@ -803,6 +1125,9 @@ "title": "Balance", "type": [ "object" + ], + "x-expandableFields": [ + ], "x-resourceId": "balance" }, @@ -845,7 +1170,12 @@ ] }, "fee_details": { - "$ref": "#/definitions/fee" + "items": { + "$ref": "#/definitions/fee" + }, + "type": [ + "array" + ] }, "id": { "description": "Unique identifier for the object.", @@ -869,7 +1199,53 @@ "description": "The Stripe object this transaction is related to.", "type": [ "string" - ] + ], + "x-expansionResources": { + "oneOf": [ + { + "$ref": "#/definitions/bitcoin_transaction" + }, + { + "$ref": "#/definitions/charge" + }, + { + "$ref": "#/definitions/dispute" + }, + { + "$ref": "#/definitions/fee_refund" + }, + { + "$ref": "#/definitions/authorization" + }, + { + "$ref": "#/definitions/transaction" + }, + { + "$ref": "#/definitions/legacy_transfer" + }, + { + "$ref": "#/definitions/payout" + }, + { + "$ref": "#/definitions/platform_fee" + }, + { + "$ref": "#/definitions/refund" + }, + { + "$ref": "#/definitions/reserve_transaction" + }, + { + "$ref": "#/definitions/transfer" + }, + { + "$ref": "#/definitions/transfer_recipient_transfer" + }, + { + "$ref": "#/definitions/transfer_reversal" + } + ] + } }, "status": { "description": "If the transaction's net funds are available in the Stripe balance yet. Either `available` or `pending`.", @@ -878,7 +1254,7 @@ ] }, "type": { - "description": "Transaction type: `adjustment`, `application_fee`, `application_fee_refund`, `charge`, `payment`, `payment_failure_refund`, `payment_refund`, `refund`, `transfer`, `transfer_cancel`, `transfer_failure`, `transfer_refund`, or `validation`.", + "description": "Transaction type: `adjustment`, `application_fee`, `application_fee_refund`, `charge`, `payment`, `payment_failure_refund`, `payment_refund`, `refund`, `transfer`, `transfer_refund`, `payout`, `payout_cancel`, `payout_failure`, or `validation`.", "type": [ "string" ] @@ -901,6 +1277,9 @@ "type": [ "object" ], + "x-expandableFields": [ + "source" + ], "x-resourceId": "balance_transaction" }, "bank_account": { @@ -909,7 +1288,14 @@ "description": "", "type": [ "string" - ] + ], + "x-expansionResources": { + "oneOf": [ + { + "$ref": "#/definitions/account" + } + ] + } }, "account_holder_name": { "description": "The name of the person or business that owns the bank account.", @@ -923,42 +1309,6 @@ "string" ] }, - "address_city": { - "description": "", - "type": [ - "string" - ] - }, - "address_line1": { - "description": "", - "type": [ - "string" - ] - }, - "address_line2": { - "description": "", - "type": [ - "string" - ] - }, - "address_state": { - "description": "", - "type": [ - "string" - ] - }, - "address_zip": { - "description": "", - "type": [ - "string" - ] - }, - "allows_debits": { - "description": "", - "type": [ - "boolean" - ] - }, "bank_name": { "description": "Name of the bank associated with the routing number, e.g. `WELLS FARGO`.", "type": [ @@ -981,13 +1331,14 @@ "description": "", "type": [ "string" - ] - }, - "customer_reference": { - "description": "", - "type": [ - "string" - ] + ], + "x-expansionResources": { + "oneOf": [ + { + "$ref": "#/definitions/customer" + } + ] + } }, "default_for_currency": { "description": "Whether this external account is the default account for its currency.", @@ -1025,12 +1376,6 @@ "string" ] }, - "reusable": { - "description": "", - "type": [ - "boolean" - ] - }, "routing_number": { "description": "The routing transit number for the bank account.", "type": [ @@ -1042,12 +1387,6 @@ "type": [ "string" ] - }, - "used": { - "description": "", - "type": [ - "boolean" - ] } }, "required": [ @@ -1062,6 +1401,10 @@ "type": [ "object" ], + "x-expandableFields": [ + "account", + "customer" + ], "x-resourceId": "bank_account" }, "bitcoin_receiver": { @@ -1227,6 +1570,9 @@ "title": "BitcoinTransactionList", "type": [ "object" + ], + "x-expandableFields": [ + ] }, "uncaptured_funds": { @@ -1263,6 +1609,9 @@ "title": "BitcoinReceiver", "type": [ "object" + ], + "x-expandableFields": [ + ], "x-resourceId": "bitcoin_receiver" }, @@ -1323,6 +1672,9 @@ "title": "BitcoinTransaction", "type": [ "object" + ], + "x-expandableFields": [ + ], "x-resourceId": "bitcoin_transaction" }, @@ -1332,7 +1684,14 @@ "description": "The account this card belongs to. This attribute will not be in the card object if the card belongs to a customer or recipient instead.", "type": [ "string" - ] + ], + "x-expansionResources": { + "oneOf": [ + { + "$ref": "#/definitions/account" + } + ] + } }, "address_city": { "description": "City/District/Suburb/Town/Village.", @@ -1410,7 +1769,14 @@ "description": "The customer that this card belongs to. This attribute will not be in the card object if the card belongs to an account or recipient instead.", "type": [ "string" - ] + ], + "x-expansionResources": { + "oneOf": [ + { + "$ref": "#/definitions/customer" + } + ] + } }, "cvc_check": { "description": "If a CVC was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`.", @@ -1430,12 +1796,6 @@ "string" ] }, - "estimated_availability": { - "description": "", - "type": [ - "string" - ] - }, "exp_month": { "description": "Two digit number representing the card's expiration month.", "type": [ @@ -1460,12 +1820,6 @@ "string" ] }, - "google_reference": { - "description": "", - "type": [ - "string" - ] - }, "id": { "description": "Unique identifier for the object.", "type": [ @@ -1500,13 +1854,14 @@ "description": "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.", "type": [ "string" - ] - }, - "three_d_secure": { - "description": "", - "type": [ - "object" - ] + ], + "x-expansionResources": { + "oneOf": [ + { + "$ref": "#/definitions/transfer_recipient" + } + ] + } }, "tokenization_method": { "description": "If the card number is tokenized, this is the method that was used. Can be `apple_pay` or `android_pay`.", @@ -1529,19 +1884,12 @@ "type": [ "object" ], - "x-resourceId": "card" - }, - "channel_settings": { - "properties": { - "twitter": { - "$ref": "#/definitions/twitter_buy_now_settings" - } - }, - "title": "ChannelSettings", - "type": [ - "object" + "x-expandableFields": [ + "account", + "customer", + "recipient" ], - "x-resourceId": "channel_settings" + "x-resourceId": "card" }, "charge": { "properties": { @@ -1551,18 +1899,6 @@ "integer" ] }, - "amount_authorized": { - "description": "", - "type": [ - "integer" - ] - }, - "amount_captured": { - "description": "", - "type": [ - "integer" - ] - }, "amount_refunded": { "description": "Amount in %s refunded (can be less than the amount attribute on the charge if a partial refund was issued).", "type": [ @@ -1573,19 +1909,43 @@ "description": "ID of the Connect application that created the charge.", "type": [ "string" - ] + ], + "x-expansionResources": { + "oneOf": [ + { + "$ref": "#/definitions/application" + } + ] + } }, "application_fee": { "description": "The application fee (if any) for the charge. [See the Connect documentation](/docs/connect/direct-charges#collecting-fees) for details.", "type": [ "string" - ] + ], + "x-expansionResources": { + "oneOf": [ + { + "$ref": "#/definitions/backwards_compatible_platform_earning" + }, + { + "$ref": "#/definitions/platform_fee" + } + ] + } }, "balance_transaction": { "description": "ID of the balance transaction that describes the impact of this charge on your account balance (not including refunds or disputes).", "type": [ "string" - ] + ], + "x-expansionResources": { + "oneOf": [ + { + "$ref": "#/definitions/balance_transaction" + } + ] + } }, "captured": { "description": "If the charge was created without capturing, this boolean represents whether or not it is still uncaptured or has since been captured.", @@ -1593,9 +1953,6 @@ "boolean" ] }, - "card": { - "$ref": "#/definitions/card" - }, "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "type": [ @@ -1612,7 +1969,14 @@ "description": "ID of the customer this charge is for if one exists.", "type": [ "string" - ] + ], + "x-expansionResources": { + "oneOf": [ + { + "$ref": "#/definitions/customer" + } + ] + } }, "description": { "description": "An arbitrary string attached to the object. Often useful for displaying to users.", @@ -1624,13 +1988,27 @@ "description": "The account (if any) the charge was made on behalf of, with an automatic transfer. [See the Connect documentation](/docs/connect/destination-charges) for details.", "type": [ "string" - ] + ], + "x-expansionResources": { + "oneOf": [ + { + "$ref": "#/definitions/account" + } + ] + } }, "dispute": { "description": "Details about the dispute if the charge has been disputed.", "type": [ "string" - ] + ], + "x-expansionResources": { + "oneOf": [ + { + "$ref": "#/definitions/dispute" + } + ] + } }, "failure_code": { "description": "Error code explaining reason for charge failure if available (see [the errors section](/docs/api#errors) for a list of codes).", @@ -1660,7 +2038,14 @@ "description": "ID of the invoice this charge is for if one exists.", "type": [ "string" - ] + ], + "x-expansionResources": { + "oneOf": [ + { + "$ref": "#/definitions/invoice" + } + ] + } }, "livemode": { "description": "Flag indicating whether the object exists in live mode or test mode.", @@ -1684,13 +2069,27 @@ "description": "The account (if any) the charge was made on behalf of without triggering an automatic transfer. See the [Connect documentation](/docs/connect/charges-transfers) for details.", "type": [ "string" - ] + ], + "x-expansionResources": { + "oneOf": [ + { + "$ref": "#/definitions/account" + } + ] + } }, "order": { "description": "ID of the order this charge is for if one exists.", "type": [ "string" - ] + ], + "x-expansionResources": { + "oneOf": [ + { + "$ref": "#/definitions/order" + } + ] + } }, "outcome": { "$ref": "#/definitions/charge_outcome" @@ -1766,13 +2165,23 @@ "title": "RefundList", "type": [ "object" + ], + "x-expandableFields": [ + ] }, "review": { "description": "ID of the review associated with this charge if one exists.", "type": [ "string" - ] + ], + "x-expansionResources": { + "oneOf": [ + { + "$ref": "#/definitions/review" + } + ] + } }, "shipping": { "$ref": "#/definitions/shipping" @@ -1781,7 +2190,14 @@ "description": "The transfer ID which created this charge. Only present if the charge came from another Stripe account. [See the Connect documentation](/docs/connect/destination-charges) for details.", "type": [ "string" - ] + ], + "x-expansionResources": { + "oneOf": [ + { + "$ref": "#/definitions/transfer" + } + ] + } }, "statement_descriptor": { "description": "Extra information about a charge. This will appear on your customer's credit card statement.", @@ -1799,7 +2215,14 @@ "description": "ID of the transfer to the `destination` account (only applicable if the charge was created using the `destination` parameter).", "type": [ "string" - ] + ], + "x-expansionResources": { + "oneOf": [ + { + "$ref": "#/definitions/transfer" + } + ] + } }, "transfer_group": { "description": "A string that identifies this transaction as part of a group. See the [Connect documentation](/docs/connect/charges-transfers#grouping-transactions) for details.", @@ -1810,7 +2233,6 @@ }, "required": [ "amount", - "amount_captured", "amount_refunded", "captured", "created", @@ -1828,6 +2250,20 @@ "type": [ "object" ], + "x-expandableFields": [ + "application", + "application_fee", + "balance_transaction", + "customer", + "destination", + "dispute", + "invoice", + "on_behalf_of", + "order", + "review", + "source_transfer", + "transfer" + ], "x-resourceId": "charge" }, "charge_outcome": { @@ -1854,7 +2290,14 @@ "description": "The ID of the Radar rule that matched the payment.", "type": [ "string" - ] + ], + "x-expansionResources": { + "oneOf": [ + { + "$ref": "#/definitions/rule" + } + ] + } }, "seller_message": { "description": "A human-readable description of the outcome type and reason, designed for you (the recipient of the payment), not your customer.", @@ -1876,6 +2319,9 @@ "type": [ "object" ], + "x-expandableFields": [ + "rule" + ], "x-resourceId": "charge_outcome" }, "country_spec": { @@ -1935,6 +2381,9 @@ "title": "CountrySpec", "type": [ "object" + ], + "x-expandableFields": [ + ], "x-resourceId": "country_spec" }, @@ -2038,6 +2487,9 @@ "title": "Coupon", "type": [ "object" + ], + "x-expandableFields": [ + ], "x-resourceId": "coupon" }, @@ -2049,159 +2501,12 @@ "integer" ] }, - "alipay_accounts": { - "properties": { - "data": { - "items": { - "$ref": "#/definitions/alipay_account" - }, - "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" - ] - }, - "total_count": { - "description": "The total number of items available. This value is not included by default, but you can request it by specifying ?include[]=total_count.", - "type": [ - "integer" - ] - }, - "url": { - "description": "The URL where this list can be accessed.", - "type": [ - "string" - ] - } - }, - "required": [ - "data", - "has_more", - "object", - "url" - ], - "title": "AlipayAccountList", - "type": [ - "object" - ] - }, - "bank_accounts": { - "properties": { - "data": { - "items": { - "$ref": "#/definitions/bank_account" - }, - "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" - ] - }, - "total_count": { - "description": "The total number of items available. This value is not included by default, but you can request it by specifying ?include[]=total_count.", - "type": [ - "integer" - ] - }, - "url": { - "description": "The URL where this list can be accessed.", - "type": [ - "string" - ] - } - }, - "required": [ - "data", - "has_more", - "object", - "url" - ], - "title": "BankAccountList", - "type": [ - "object" - ] - }, "business_vat_id": { "description": "The customer's VAT identification number.", "type": [ "string" ] }, - "cards": { - "properties": { - "data": { - "items": { - "$ref": "#/definitions/card" - }, - "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" - ] - }, - "total_count": { - "description": "The total number of items available. This value is not included by default, but you can request it by specifying ?include[]=total_count.", - "type": [ - "integer" - ] - }, - "url": { - "description": "The URL where this list can be accessed.", - "type": [ - "string" - ] - } - }, - "required": [ - "data", - "has_more", - "object", - "url" - ], - "title": "CardList", - "type": [ - "object" - ] - }, "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "type": [ @@ -2214,23 +2519,33 @@ "string" ] }, - "default_bank_account": { - "description": "", - "type": [ - "string" - ] - }, - "default_card": { - "description": "", - "type": [ - "string" - ] - }, "default_source": { "description": "ID of the default source attached to this customer.", "type": [ "string" - ] + ], + "x-expansionResources": { + "oneOf": [ + { + "$ref": "#/definitions/account_debit_account" + }, + { + "$ref": "#/definitions/alipay_account" + }, + { + "$ref": "#/definitions/bank_account" + }, + { + "$ref": "#/definitions/bitcoin_receiver" + }, + { + "$ref": "#/definitions/card" + }, + { + "$ref": "#/definitions/source" + } + ] + } }, "delinquent": { "description": "Whether or not the latest charge for the customer's latest invoice has failed.", @@ -2284,9 +2599,7 @@ "properties": { "data": { "items": { - "type": [ - "object" - ] + "$ref": "#/definitions/account_debit_account" }, "type": [ "array" @@ -2329,6 +2642,9 @@ "title": "SourceList", "type": [ "object" + ], + "x-expandableFields": [ + "data" ] }, "subscriptions": { @@ -2378,12 +2694,14 @@ "title": "SubscriptionList", "type": [ "object" + ], + "x-expandableFields": [ + ] } }, "required": [ "account_balance", - "cards", "created", "id", "livemode", @@ -2396,6 +2714,9 @@ "type": [ "object" ], + "x-expandableFields": [ + "default_source" + ], "x-resourceId": "customer" }, "customer_shipping": { @@ -2423,6 +2744,9 @@ "title": "CustomerShipping", "type": [ "object" + ], + "x-expandableFields": [ + ], "x-resourceId": "customer_shipping" }, @@ -2432,7 +2756,14 @@ "description": "", "type": [ "string" - ] + ], + "x-expansionResources": { + "oneOf": [ + { + "$ref": "#/definitions/customer" + } + ] + } }, "id": { "description": "Unique identifier for the object.", @@ -2461,6 +2792,28 @@ "type": [ "object" ], + "x-expandableFields": [ + "customer" + ], + "x-polymorphicResources": { + "oneOf": [ + { + "$ref": "#/definitions/alipay_account" + }, + { + "$ref": "#/definitions/bank_account" + }, + { + "$ref": "#/definitions/bitcoin_receiver" + }, + { + "$ref": "#/definitions/card" + }, + { + "$ref": "#/definitions/source" + } + ] + }, "x-resourceId": "customer_source" }, "delivery_estimate": { @@ -2496,6 +2849,9 @@ "title": "DeliveryEstimate", "type": [ "object" + ], + "x-expandableFields": [ + ], "x-resourceId": "delivery_estimate" }, @@ -2508,7 +2864,14 @@ "description": "", "type": [ "string" - ] + ], + "x-expansionResources": { + "oneOf": [ + { + "$ref": "#/definitions/customer" + } + ] + } }, "end": { "description": "If the coupon has a duration of `once` or `repeating`, the date that this discount will end. If the coupon used has a `forever` duration, this attribute will be null.", @@ -2544,6 +2907,9 @@ "type": [ "object" ], + "x-expandableFields": [ + "customer" + ], "x-resourceId": "discount" }, "dispute": { @@ -2555,13 +2921,25 @@ ] }, "balance_transactions": { - "$ref": "#/definitions/balance_transaction" + "items": { + "$ref": "#/definitions/balance_transaction" + }, + "type": [ + "array" + ] }, "charge": { "description": "ID of the charge that was disputed.", "type": [ "string" - ] + ], + "x-expansionResources": { + "oneOf": [ + { + "$ref": "#/definitions/charge" + } + ] + } }, "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", @@ -2650,6 +3028,9 @@ "type": [ "object" ], + "x-expandableFields": [ + "charge" + ], "x-resourceId": "dispute" }, "error": { @@ -2710,7 +3091,7 @@ "event": { "properties": { "api_version": { - "description": "The Stripe API version used to render `data`. *Note: this property is populated for events on or after October 31, 2014.*.", + "description": "The Stripe API version used to render `data`. *Note: this property is populated for events on or after October 31, 2014*.", "type": [ "string" ] @@ -2749,7 +3130,7 @@ ] }, "request": { - "description": "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. *Note: this property is populated for events on or after April 23, 2013.*.", + "description": "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. *Note: this property is populated for events on or after April 23, 2013*.", "type": [ "string" ] @@ -2773,6 +3154,9 @@ "title": "Event", "type": [ "object" + ], + "x-expandableFields": [ + ], "x-resourceId": "event" }, @@ -2797,6 +3181,9 @@ "title": "EventData", "type": [ "object" + ], + "x-expandableFields": [ + ], "x-resourceId": "event_data" }, @@ -2806,37 +3193,14 @@ "description": "", "type": [ "string" - ] - }, - "address_city": { - "description": "", - "type": [ - "string" - ] - }, - "address_line1": { - "description": "", - "type": [ - "string" - ] - }, - "address_line2": { - "description": "", - "type": [ - "string" - ] - }, - "address_state": { - "description": "", - "type": [ - "string" - ] - }, - "address_zip": { - "description": "", - "type": [ - "string" - ] + ], + "x-expansionResources": { + "oneOf": [ + { + "$ref": "#/definitions/account" + } + ] + } }, "country": { "description": "Two-letter ISO code representing the country the bank account is located in.", @@ -2854,7 +3218,14 @@ "description": "", "type": [ "string" - ] + ], + "x-expansionResources": { + "oneOf": [ + { + "$ref": "#/definitions/customer" + } + ] + } }, "default_for_currency": { "description": "Whether this external account is the default account for its currency.", @@ -2904,6 +3275,20 @@ "type": [ "object" ], + "x-expandableFields": [ + "account", + "customer" + ], + "x-polymorphicResources": { + "oneOf": [ + { + "$ref": "#/definitions/bank_account" + }, + { + "$ref": "#/definitions/card" + } + ] + }, "x-resourceId": "external_account_source" }, "fee": { @@ -2947,6 +3332,9 @@ "title": "Fee", "type": [ "object" + ], + "x-expandableFields": [ + ], "x-resourceId": "fee" }, @@ -2962,7 +3350,14 @@ "description": "Balance transaction that describes the impact on your account balance.", "type": [ "string" - ] + ], + "x-expansionResources": { + "oneOf": [ + { + "$ref": "#/definitions/balance_transaction" + } + ] + } }, "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", @@ -2980,7 +3375,14 @@ "description": "ID of the application fee that was refunded.", "type": [ "string" - ] + ], + "x-expansionResources": { + "oneOf": [ + { + "$ref": "#/definitions/platform_fee" + } + ] + } }, "id": { "description": "Unique identifier for the object.", @@ -3014,8 +3416,73 @@ "type": [ "object" ], + "x-expandableFields": [ + "balance_transaction", + "fee" + ], "x-resourceId": "fee_refund" }, + "file": { + "properties": { + "created": { + "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", + "type": [ + "integer" + ] + }, + "id": { + "description": "Unique identifier for the object.", + "type": [ + "string" + ] + }, + "object": { + "description": "String representing the object's type. Objects of the same type share the same value.", + "type": [ + "string" + ] + }, + "purpose": { + "description": "The purpose of the uploaded file. Possible values are `business_logo`, `dispute_evidence`, `identity_document`, `incorporation_article`, `incorporation_document`, `invoice_statement`, `payment_provider_transfer`, or `product_feed`.", + "type": [ + "string" + ] + }, + "size": { + "description": "The size in bytes of the file upload object.", + "type": [ + "integer" + ] + }, + "type": { + "description": "The type of the file returned. Returns one of the following: `pdf`, `xml`, `jpg`, `png`, `csv`, or `tsv`.", + "type": [ + "string" + ] + }, + "url": { + "description": "A read-only URL where the uploaded file can be accessed. Will be nil unless the uploaded file has one of the following purposes: `business_logo`, `dispute_evidence`, `incorporation_document`, `invoice_statement`, `payment_provider_transfer`, or `product_feed`. Also nil if retrieved with the publishable API key.", + "type": [ + "string" + ] + } + }, + "required": [ + "created", + "id", + "object", + "purpose", + "size" + ], + "title": "File", + "type": [ + "object" + ], + "x-expandableFields": [ + + ], + "x-resourceId": "file" + }, "inventory": { "properties": { "quantity": { @@ -3043,6 +3510,9 @@ "title": "Inventory", "type": [ "object" + ], + "x-expandableFields": [ + ], "x-resourceId": "inventory" }, @@ -3072,17 +3542,18 @@ "boolean" ] }, - "billing": { - "description": "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.", - "type": [ - "string" - ] - }, "charge": { "description": "ID of the latest charge generated for this invoice, if any.", "type": [ "string" - ] + ], + "x-expansionResources": { + "oneOf": [ + { + "$ref": "#/definitions/charge" + } + ] + } }, "closed": { "description": "Whether or not the invoice is still trying to collect payment. An invoice is closed if it's either paid or it has been marked closed. A closed invoice will no longer attempt to collect payment.", @@ -3100,7 +3571,14 @@ "description": "", "type": [ "string" - ] + ], + "x-expansionResources": { + "oneOf": [ + { + "$ref": "#/definitions/customer" + } + ] + } }, "date": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", @@ -3117,12 +3595,6 @@ "discount": { "$ref": "#/definitions/discount" }, - "due_date": { - "description": "The date on which payment for this invoice is due.", - "type": [ - "integer" - ] - }, "ending_balance": { "description": "Ending customer balance after attempting to pay invoice. If the invoice has not been attempted yet, this will be null.", "type": [ @@ -3188,6 +3660,9 @@ "title": "InvoiceLinesList", "type": [ "object" + ], + "x-expandableFields": [ + ] }, "livemode": { @@ -3208,12 +3683,6 @@ "integer" ] }, - "number": { - "description": "A unique, identifying string that appears on emails sent to the customer for this invoice.", - "type": [ - "string" - ] - }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "type": [ @@ -3260,7 +3729,14 @@ "description": "The subscription that this invoice was prepared for, if any.", "type": [ "string" - ] + ], + "x-expansionResources": { + "oneOf": [ + { + "$ref": "#/definitions/subscription" + } + ] + } }, "subscription_proration_date": { "description": "Only set for upcoming invoices that preview prorations. The time used to calculate prorations.", @@ -3323,6 +3799,11 @@ "type": [ "object" ], + "x-expandableFields": [ + "charge", + "customer", + "subscription" + ], "x-resourceId": "invoice" }, "invoice_item": { @@ -3343,7 +3824,14 @@ "description": "The ID of the customer who will be billed when this invoice item is billed.", "type": [ "string" - ] + ], + "x-expansionResources": { + "oneOf": [ + { + "$ref": "#/definitions/customer" + } + ] + } }, "date": { "description": "", @@ -3373,7 +3861,14 @@ "description": "The ID of the invoice this invoice item belongs to.", "type": [ "string" - ] + ], + "x-expansionResources": { + "oneOf": [ + { + "$ref": "#/definitions/invoice" + } + ] + } }, "livemode": { "description": "Flag indicating whether the object exists in live mode or test mode.", @@ -3418,7 +3913,14 @@ "description": "The subscription that this invoice item has been created for, if any.", "type": [ "string" - ] + ], + "x-expansionResources": { + "oneOf": [ + { + "$ref": "#/definitions/subscription" + } + ] + } }, "subscription_item": { "description": "", @@ -3443,6 +3945,11 @@ "type": [ "object" ], + "x-expandableFields": [ + "customer", + "invoice", + "subscription" + ], "x-resourceId": "invoice_item" }, "invoice_line_item": { @@ -3550,9 +4057,75 @@ "title": "InvoiceLineItem", "type": [ "object" + ], + "x-expandableFields": [ + ], "x-resourceId": "invoice_line_item" }, + "issued_card": { + "properties": { + "available_balance": { + "description": "", + "type": [ + "integer" + ] + }, + "card": { + "description": "", + "type": [ + "string" + ], + "x-expansionResources": { + "oneOf": [ + { + "$ref": "#/definitions/card" + } + ] + } + }, + "currency": { + "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://support.stripe.com/questions/which-currencies-does-stripe-support).", + "type": [ + "string" + ] + }, + "id": { + "description": "Unique identifier for the object.", + "type": [ + "string" + ] + }, + "object": { + "description": "String representing the object's type. Objects of the same type share the same value.", + "type": [ + "string" + ] + }, + "status": { + "description": "", + "type": [ + "string" + ] + } + }, + "required": [ + "available_balance", + "card", + "currency", + "id", + "object", + "status" + ], + "title": "IssuedCard", + "type": [ + "object" + ], + "x-expandableFields": [ + "card" + ], + "x-resourceId": "issued_card" + }, "legacy_transfer": { "properties": { "amount": { @@ -3571,13 +4144,27 @@ "description": "", "type": [ "string" - ] + ], + "x-expansionResources": { + "oneOf": [ + { + "$ref": "#/definitions/backwards_compatible_platform_earning" + } + ] + } }, "balance_transaction": { "description": "Balance transaction that describes the impact of this transfer on your account balance.", "type": [ "string" - ] + ], + "x-expansionResources": { + "oneOf": [ + { + "$ref": "#/definitions/balance_transaction" + } + ] + } }, "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", @@ -3607,13 +4194,33 @@ "description": "ID of the bank account, card, or Stripe account the transfer was sent to.", "type": [ "string" - ] + ], + "x-expansionResources": { + "oneOf": [ + { + "$ref": "#/definitions/account" + }, + { + "$ref": "#/definitions/bank_account" + }, + { + "$ref": "#/definitions/card" + } + ] + } }, "destination_payment": { "description": "If the destination is a Stripe account, this will be the ID of the payment that the destination account received for the transfer.", "type": [ "string" - ] + ], + "x-expansionResources": { + "oneOf": [ + { + "$ref": "#/definitions/charge" + } + ] + } }, "failure_code": { "description": "Error code explaining reason for transfer failure if available. See [Types of transfer failures](/docs/api#transfer_failures) for a list of failure codes.", @@ -3633,12 +4240,6 @@ "string" ] }, - "legacy_date": { - "description": "", - "type": [ - "integer" - ] - }, "livemode": { "description": "Flag indicating whether the object exists in live mode or test mode.", "type": [ @@ -3710,6 +4311,9 @@ "title": "TransferReversalList", "type": [ "object" + ], + "x-expandableFields": [ + ] }, "reversed": { @@ -3722,7 +4326,20 @@ "description": "ID of the charge (or other transaction) that was used to fund the transfer. If null, the transfer was funded from the available balance.", "type": [ "string" - ] + ], + "x-expansionResources": { + "oneOf": [ + { + "$ref": "#/definitions/charge" + }, + { + "$ref": "#/definitions/platform_fee" + }, + { + "$ref": "#/definitions/transfer_reversal" + } + ] + } }, "source_type": { "description": "The source balance this transfer came from. One of `card`, `bank_account`, `bitcoin_receiver`, or `alipay_account`.", @@ -3774,12 +4391,24 @@ "type": [ "object" ], + "x-expandableFields": [ + "application_fee", + "balance_transaction", + "destination", + "destination_payment", + "source_transaction" + ], "x-resourceId": "legacy_transfer" }, "legal_entity": { "properties": { "additional_owners": { - "$ref": "#/definitions/legal_entity_additional_owner" + "items": { + "$ref": "#/definitions/legal_entity_additional_owner" + }, + "type": [ + "array" + ] }, "address": { "$ref": "#/definitions/legal_entity_address" @@ -3921,6 +4550,9 @@ "title": "LegalEntity", "type": [ "object" + ], + "x-expandableFields": [ + ], "x-resourceId": "legal_entity" }, @@ -3956,6 +4588,9 @@ "title": "LegalEntityAdditionalOwner", "type": [ "object" + ], + "x-expandableFields": [ + ], "x-resourceId": "legal_entity_additional_owner" }, @@ -4001,6 +4636,9 @@ "title": "LegalEntityAddress", "type": [ "object" + ], + "x-expandableFields": [ + ], "x-resourceId": "legal_entity_address" }, @@ -4028,6 +4666,9 @@ "title": "LegalEntityDOB", "type": [ "object" + ], + "x-expandableFields": [ + ], "x-resourceId": "legal_entity_dob" }, @@ -4079,6 +4720,9 @@ "title": "LegalEntityJapanAddress", "type": [ "object" + ], + "x-expandableFields": [ + ], "x-resourceId": "legal_entity_japan_address" }, @@ -4100,7 +4744,14 @@ "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) A photo (jpg or png) of an identifying document, either a passport or local ID card.", "type": [ "string" - ] + ], + "x-expansionResources": { + "oneOf": [ + { + "$ref": "#/definitions/file" + } + ] + } }, "status": { "description": "The state of verification for this legal entity. Possible values are unverified, pending, or verified.", @@ -4116,8 +4767,91 @@ "type": [ "object" ], + "x-expandableFields": [ + "document" + ], "x-resourceId": "legal_entity_verification" }, + "login_link": { + "properties": { + "created": { + "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", + "type": [ + "integer" + ] + }, + "object": { + "description": "String representing the object's type. Objects of the same type share the same value.", + "type": [ + "string" + ] + }, + "url": { + "description": "The URL for the login link.", + "type": [ + "string" + ] + } + }, + "required": [ + "created", + "object", + "url" + ], + "title": "LoginLink", + "type": [ + "object" + ], + "x-expandableFields": [ + + ], + "x-resourceId": "login_link" + }, + "merchant_data": { + "properties": { + "category": { + "description": "", + "type": [ + "string" + ] + }, + "city": { + "description": "", + "type": [ + "string" + ] + }, + "country": { + "description": "", + "type": [ + "string" + ] + }, + "name": { + "description": "", + "type": [ + "string" + ] + }, + "postal_code": { + "description": "", + "type": [ + "string" + ] + } + }, + "required": [ + "category" + ], + "title": "MerchantData", + "type": [ + "object" + ], + "x-expandableFields": [ + + ], + "x-resourceId": "merchant_data" + }, "order": { "properties": { "amount": { @@ -4148,7 +4882,14 @@ "description": "The ID of the payment used to pay for the order. Present if the order status is `paid`, `fulfilled`, or `refunded`.", "type": [ "string" - ] + ], + "x-expansionResources": { + "oneOf": [ + { + "$ref": "#/definitions/charge" + } + ] + } }, "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", @@ -4166,7 +4907,14 @@ "description": "The customer used for the order.", "type": [ "string" - ] + ], + "x-expansionResources": { + "oneOf": [ + { + "$ref": "#/definitions/customer" + } + ] + } }, "email": { "description": "The email address of the customer placing the order.", @@ -4254,6 +5002,9 @@ "title": "OrderReturnList", "type": [ "object" + ], + "x-expandableFields": [ + ] }, "selected_shipping_method": { @@ -4305,6 +5056,10 @@ "type": [ "object" ], + "x-expandableFields": [ + "charge", + "customer" + ], "x-resourceId": "order" }, "order_item": { @@ -4337,7 +5092,17 @@ "description": "The ID of the associated object for this line item. Expandable if not null (e.g., expandable to a SKU).", "type": [ "string" - ] + ], + "x-expansionResources": { + "oneOf": [ + { + "$ref": "#/definitions/discount" + }, + { + "$ref": "#/definitions/sku" + } + ] + } }, "quantity": { "description": "A positive integer representing the number of instances of `parent` that are included in this order item. Applicable/present only if `type` is `sku`.", @@ -4363,32 +5128,11 @@ "type": [ "object" ], + "x-expandableFields": [ + "parent" + ], "x-resourceId": "order_item" }, - "order_management_settings": { - "properties": { - "provider": { - "description": "", - "type": [ - "string" - ] - }, - "type": { - "description": "", - "type": [ - "string" - ] - } - }, - "required": [ - "type" - ], - "title": "OrderManagementSettings", - "type": [ - "object" - ], - "x-resourceId": "order_management_settings" - }, "order_return": { "properties": { "amount": { @@ -4434,13 +5178,27 @@ "description": "The order that this return includes items from.", "type": [ "string" - ] + ], + "x-expansionResources": { + "oneOf": [ + { + "$ref": "#/definitions/order" + } + ] + } }, "refund": { "description": "The ID of the refund issued for this return.", "type": [ "string" - ] + ], + "x-expansionResources": { + "oneOf": [ + { + "$ref": "#/definitions/refund" + } + ] + } } }, "required": [ @@ -4456,6 +5214,10 @@ "type": [ "object" ], + "x-expandableFields": [ + "order", + "refund" + ], "x-resourceId": "order_return" }, "package_dimensions": { @@ -4494,6 +5256,9 @@ "title": "PackageDimensions", "type": [ "object" + ], + "x-expandableFields": [ + ], "x-resourceId": "package_dimensions" }, @@ -4515,7 +5280,14 @@ "description": "ID of the balance transaction that describes the impact of this payout on your account balance.", "type": [ "string" - ] + ], + "x-expansionResources": { + "oneOf": [ + { + "$ref": "#/definitions/balance_transaction" + } + ] + } }, "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", @@ -4533,13 +5305,30 @@ "description": "ID of the bank account or card the payout was sent to.", "type": [ "string" - ] + ], + "x-expansionResources": { + "oneOf": [ + { + "$ref": "#/definitions/bank_account" + }, + { + "$ref": "#/definitions/card" + } + ] + } }, "failure_balance_transaction": { "description": "If the payout failed or was canceled, this will be the ID of the balance transaction that reversed the initial balance transaction, and puts the funds from the failed payout back in your balance.", "type": [ "string" - ] + ], + "x-expansionResources": { + "oneOf": [ + { + "$ref": "#/definitions/balance_transaction" + } + ] + } }, "failure_code": { "description": "Error code explaining reason for payout failure if available. See [Types of payout failures](/docs/api#payout_failures) for a list of failure codes.", @@ -4627,6 +5416,11 @@ "type": [ "object" ], + "x-expandableFields": [ + "balance_transaction", + "destination", + "failure_balance_transaction" + ], "x-resourceId": "payout" }, "plan": { @@ -4719,6 +5513,9 @@ "title": "Plan", "type": [ "object" + ], + "x-expandableFields": [ + ], "x-resourceId": "plan" }, @@ -4728,7 +5525,14 @@ "description": "ID of the Stripe account this fee was taken from.", "type": [ "string" - ] + ], + "x-expansionResources": { + "oneOf": [ + { + "$ref": "#/definitions/account" + } + ] + } }, "amount": { "description": "Amount earned, in %s.", @@ -4746,19 +5550,40 @@ "description": "ID of the Connect application that earned the fee.", "type": [ "string" - ] + ], + "x-expansionResources": { + "oneOf": [ + { + "$ref": "#/definitions/application" + } + ] + } }, "balance_transaction": { "description": "Balance transaction that describes the impact of this collected application fee on your account balance (not including refunds).", "type": [ "string" - ] + ], + "x-expansionResources": { + "oneOf": [ + { + "$ref": "#/definitions/balance_transaction" + } + ] + } }, "charge": { "description": "ID of the charge that the application fee was taken from.", "type": [ "string" - ] + ], + "x-expansionResources": { + "oneOf": [ + { + "$ref": "#/definitions/charge" + } + ] + } }, "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", @@ -4794,7 +5619,17 @@ "description": "ID of the corresponding charge on the platform account, if this fee was the result of a charge using the `destination` parameter.", "type": [ "string" - ] + ], + "x-expansionResources": { + "oneOf": [ + { + "$ref": "#/definitions/charge" + }, + { + "$ref": "#/definitions/transfer" + } + ] + } }, "refunded": { "description": "Whether or not the fee has been fully refunded. If the fee is only partially refunded, this attribute will still be false.", @@ -4849,6 +5684,9 @@ "title": "FeeRefundList", "type": [ "object" + ], + "x-expandableFields": [ + ] } }, @@ -4871,8 +5709,214 @@ "type": [ "object" ], + "x-expandableFields": [ + "account", + "application", + "balance_transaction", + "charge", + "originating_transaction" + ], "x-resourceId": "platform_earning" }, + "platform_fee": { + "properties": { + "account": { + "description": "ID of the Stripe account this fee was taken from.", + "type": [ + "string" + ], + "x-expansionResources": { + "oneOf": [ + { + "$ref": "#/definitions/account" + } + ] + } + }, + "amount": { + "description": "Amount earned, in %s.", + "type": [ + "integer" + ] + }, + "amount_refunded": { + "description": "", + "type": [ + "integer" + ] + }, + "application": { + "description": "ID of the Connect Application that earned the fee.", + "type": [ + "string" + ], + "x-expansionResources": { + "oneOf": [ + { + "$ref": "#/definitions/application" + } + ] + } + }, + "balance_transaction": { + "description": "Balance transaction that describes the impact of this collected application fee on your account balance (not including refunds).", + "type": [ + "string" + ], + "x-expansionResources": { + "oneOf": [ + { + "$ref": "#/definitions/balance_transaction" + } + ] + } + }, + "charge": { + "description": "ID of the charge that the application fee was taken from.", + "type": [ + "string" + ], + "x-expansionResources": { + "oneOf": [ + { + "$ref": "#/definitions/charge" + } + ] + } + }, + "created": { + "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", + "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://support.stripe.com/questions/which-currencies-does-stripe-support).", + "type": [ + "string" + ] + }, + "id": { + "description": "Unique identifier for the object.", + "type": [ + "string" + ] + }, + "livemode": { + "description": "Flag indicating whether the object exists in live mode or test mode.", + "type": [ + "boolean" + ] + }, + "object": { + "description": "String representing the object's type. Objects of the same type share the same value.", + "type": [ + "string" + ] + }, + "originating_transaction": { + "description": "ID of the corresponding charge on the platform account, if this fee was the result of a charge using the `destination` parameter.", + "type": [ + "string" + ], + "x-expansionResources": { + "oneOf": [ + { + "$ref": "#/definitions/charge" + }, + { + "$ref": "#/definitions/transfer" + } + ] + } + }, + "refunded": { + "description": "Whether or not the fee has been fully refunded. If the fee is only partially refunded, this attribute will still be false.", + "type": [ + "boolean" + ] + }, + "refunds": { + "properties": { + "data": { + "items": { + "$ref": "#/definitions/fee_refund" + }, + "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" + ] + }, + "total_count": { + "description": "The total number of items available. This value is not included by default, but you can request it by specifying ?include[]=total_count.", + "type": [ + "integer" + ] + }, + "url": { + "description": "The URL where this list can be accessed.", + "type": [ + "string" + ] + } + }, + "required": [ + "data", + "has_more", + "object", + "url" + ], + "title": "FeeRefundList", + "type": [ + "object" + ], + "x-expandableFields": [ + + ] + } + }, + "required": [ + "account", + "amount", + "amount_refunded", + "application", + "balance_transaction", + "charge", + "created", + "currency", + "id", + "livemode", + "object", + "refunded", + "refunds" + ], + "title": "PlatformFee", + "type": [ + "object" + ], + "x-expandableFields": [ + "account", + "application", + "balance_transaction", + "charge", + "originating_transaction" + ], + "x-resourceId": "platform_fee" + }, "product": { "properties": { "active": { @@ -5003,6 +6047,9 @@ "title": "SKUList", "type": [ "object" + ], + "x-expandableFields": [ + ] }, "updated": { @@ -5034,6 +6081,9 @@ "title": "Product", "type": [ "object" + ], + "x-expandableFields": [ + ], "x-resourceId": "product" }, @@ -5049,13 +6099,27 @@ "description": "Balance transaction that describes the impact on your account balance.", "type": [ "string" - ] + ], + "x-expansionResources": { + "oneOf": [ + { + "$ref": "#/definitions/balance_transaction" + } + ] + } }, "charge": { "description": "ID of the charge that was refunded.", "type": [ "string" - ] + ], + "x-expansionResources": { + "oneOf": [ + { + "$ref": "#/definitions/charge" + } + ] + } }, "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", @@ -5124,50 +6188,164 @@ "type": [ "object" ], + "x-expandableFields": [ + "balance_transaction", + "charge" + ], "x-resourceId": "refund" }, - "settings": { + "reserve_transaction": { "properties": { - "authorization": { - "$ref": "#/definitions/authorization_settings" + "amount": { + "description": "", + "type": [ + "integer" + ] }, - "channels": { - "$ref": "#/definitions/channel_settings" - }, - "create_order_hook_url": { - "description": "URL that Stripe will call to prepare an order at creation time. Present when shipping type, taxes, or order_management type is `dynamic`.", + "currency": { + "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://support.stripe.com/questions/which-currencies-does-stripe-support).", "type": [ "string" ] }, - "order_management": { - "$ref": "#/definitions/order_management_settings" - }, - "pay_order_hook_url": { - "description": "URL that Stripe will call to place an order at payment time. Present when order_management type is `dynamic`, or authorization type is `combined`.", + "description": { + "description": "An arbitrary string attached to the object. Often useful for displaying to users.", "type": [ "string" ] }, - "shipping": { - "$ref": "#/definitions/shipping_settings" + "id": { + "description": "Unique identifier for the object.", + "type": [ + "string" + ] }, - "taxes": { - "$ref": "#/definitions/tax_settings" + "object": { + "description": "String representing the object's type. Objects of the same type share the same value.", + "type": [ + "string" + ] } }, "required": [ - "authorization", - "channels", - "order_management", - "shipping", - "taxes" + "amount", + "currency", + "id", + "object" ], - "title": "Settings", + "title": "ReserveTransaction", "type": [ "object" ], - "x-resourceId": "settings" + "x-expandableFields": [ + + ], + "x-resourceId": "reserve_transaction" + }, + "review": { + "properties": { + "charge": { + "description": "The charge associated with this review.", + "type": [ + "string" + ], + "x-expansionResources": { + "oneOf": [ + { + "$ref": "#/definitions/charge" + } + ] + } + }, + "created": { + "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", + "type": [ + "integer" + ] + }, + "id": { + "description": "Unique identifier for the object.", + "type": [ + "string" + ] + }, + "livemode": { + "description": "Flag indicating whether the object exists in live mode or test mode.", + "type": [ + "boolean" + ] + }, + "object": { + "description": "String representing the object's type. Objects of the same type share the same value.", + "type": [ + "string" + ] + }, + "open": { + "description": "If `true`, the review needs action.", + "type": [ + "boolean" + ] + }, + "reason": { + "description": "The reason the review is currently open or closed. One of `rule`, `manual`, `approved`, `refunded`, `refunded_as_fraud`, or `disputed`.", + "type": [ + "string" + ] + } + }, + "required": [ + "charge", + "created", + "id", + "livemode", + "object", + "open", + "reason" + ], + "title": "Review", + "type": [ + "object" + ], + "x-expandableFields": [ + "charge" + ], + "x-resourceId": "review" + }, + "rule": { + "properties": { + "action": { + "description": "The action (`allow`, `block`, or `manual_review`) taken on the payment.", + "type": [ + "string" + ] + }, + "id": { + "description": "Unique identifier for the object.", + "type": [ + "string" + ] + }, + "predicate": { + "description": "The predicate to evaluate the payment against.", + "type": [ + "string" + ] + } + }, + "required": [ + "action", + "id", + "predicate" + ], + "title": "Rule", + "type": [ + "object" + ], + "x-expandableFields": [ + + ], + "x-resourceId": "rule" }, "shipping": { "properties": { @@ -5206,6 +6384,9 @@ "title": "Shipping", "type": [ "object" + ], + "x-expandableFields": [ + ], "x-resourceId": "shipping" }, @@ -5248,107 +6429,12 @@ "title": "ShippingMethod", "type": [ "object" + ], + "x-expandableFields": [ + ], "x-resourceId": "shipping_method" }, - "shipping_settings": { - "properties": { - "amount": { - "description": "", - "type": [ - "integer" - ] - }, - "currency": { - "description": "Three-letter [ISO code for the currency](https://support.stripe.com/questions/which-currencies-does-stripe-support) in which shipping cost will be assessed. Present when `type` is `flat_rate`.", - "type": [ - "string" - ] - }, - "description": { - "description": "An arbitrary string attached to the object. Often useful for displaying to users.", - "type": [ - "string" - ] - }, - "free_above": { - "description": "The order amount (before taxes are calculated) above which shipping is free.", - "type": [ - "integer" - ] - }, - "from_address": { - "$ref": "#/definitions/address" - }, - "from_name": { - "description": "Sender name to use when shipping through a provider. Present when `type` is `provider`.", - "type": [ - "string" - ] - }, - "provider": { - "description": "Shipping provider to use (eg, \"USPS\"). Present when `type` is `provider`.", - "type": [ - "string" - ] - }, - "provider_url": { - "description": "The provider's URL used to calculate shipping rates. If present, `type` must be `provider`.", - "type": [ - "string" - ] - }, - "rates": { - "$ref": "#/definitions/shipping_settings_rate" - }, - "type": { - "description": "Shipping plan type. One of `free`, `flat_rate`, `provider`, `dynamic`.", - "type": [ - "string" - ] - } - }, - "required": [ - "type" - ], - "title": "ShippingSettings", - "type": [ - "object" - ], - "x-resourceId": "shipping_settings" - }, - "shipping_settings_rate": { - "properties": { - "amount": { - "description": "A positive integer in the smallest currency unit (that is, 100 cents for $1.00, or 1 for ¥1, Japanese Yen being a 0-decimal currency) representing the total amount for the line item.", - "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://support.stripe.com/questions/which-currencies-does-stripe-support).", - "type": [ - "string" - ] - }, - "description": { - "description": "An arbitrary string attached to the object. Often useful for displaying to users.", - "type": [ - "string" - ] - } - }, - "required": [ - "amount", - "currency", - "description" - ], - "title": "ShippingSettingsRate", - "type": [ - "object" - ], - "x-resourceId": "shipping_settings_rate" - }, "sku": { "properties": { "active": { @@ -5421,7 +6507,14 @@ "description": "The ID of the product this SKU is associated with. The product must be currently active.", "type": [ "string" - ] + ], + "x-expansionResources": { + "oneOf": [ + { + "$ref": "#/definitions/product" + } + ] + } }, "updated": { "description": "", @@ -5448,12 +6541,15 @@ "type": [ "object" ], + "x-expandableFields": [ + "product" + ], "x-resourceId": "sku" }, "source": { "properties": { "amount": { - "description": "Amount associated with the source. This is the amount for which the source will be chargeable once ready. Required for `single-use` sources.", + "description": "Amount associated with the source. This is the amount for which the source will be chargeable once ready. Required for `single_use` sources.", "type": [ "integer" ] @@ -5474,7 +6570,7 @@ ] }, "currency": { - "description": "Three-letter [ISO code for the currency](https://support.stripe.com/questions/which-currencies-does-stripe-support) associated with the source. This is the currency for which the source will be chargeable once ready. Required for `single-use` sources.", + "description": "Three-letter [ISO code for the currency](https://support.stripe.com/questions/which-currencies-does-stripe-support) associated with the source. This is the currency for which the source will be chargeable once ready. Required for `single_use` sources.", "type": [ "string" ] @@ -5531,7 +6627,7 @@ ] }, "usage": { - "description": "One of `reusable`, `single-use`. Whether this source should be reusable or not. Some source types may or may not be reusable by construction, while other may leave the option at creation. If an incompatible value is passed, an error will be returned.", + "description": "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 other may leave the option at creation. If an incompatible value is passed, an error will be returned.", "type": [ "string" ] @@ -5550,6 +6646,9 @@ "title": "Source", "type": [ "object" + ], + "x-expandableFields": [ + ], "x-resourceId": "source" }, @@ -5575,6 +6674,9 @@ "title": "SourceCodeVerificationFlow", "type": [ "object" + ], + "x-expandableFields": [ + ], "x-resourceId": "source_code_verification_flow" }, @@ -5626,6 +6728,9 @@ "title": "SourceOwner", "type": [ "object" + ], + "x-expandableFields": [ + ], "x-resourceId": "source_owner" }, @@ -5664,6 +6769,9 @@ "title": "SourceReceiverFlow", "type": [ "object" + ], + "x-expandableFields": [ + ], "x-resourceId": "source_receiver_flow" }, @@ -5696,6 +6804,9 @@ "title": "SourceRedirectFlow", "type": [ "object" + ], + "x-expandableFields": [ + ], "x-resourceId": "source_redirect_flow" }, @@ -5729,29 +6840,20 @@ "title": "StatusTransitions", "type": [ "object" + ], + "x-expandableFields": [ + ], "x-resourceId": "status_transitions" }, "subscription": { "properties": { - "account_balance": { - "description": "", - "type": [ - "integer" - ] - }, "application_fee_percent": { "description": "A non-negative decimal (with at most two decimal places) between 0 and 100. This represents the percentage of the subscription invoice subtotal that will be transferred to the application owner's Stripe account.", "type": [ "number" ] }, - "billing": { - "description": "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.", - "type": [ - "string" - ] - }, "cancel_at_period_end": { "description": "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.", "type": [ @@ -5786,13 +6888,14 @@ "description": "ID of the customer who owns the subscription.", "type": [ "string" - ] - }, - "days_until_due": { - "description": "Number of days a customer has to pay invoices generated by this subscription.", - "type": [ - "integer" - ] + ], + "x-expansionResources": { + "oneOf": [ + { + "$ref": "#/definitions/customer" + } + ] + } }, "discount": { "$ref": "#/definitions/discount" @@ -5856,6 +6959,9 @@ "title": "SubscriptionItemList", "type": [ "object" + ], + "x-expandableFields": [ + ] }, "livemode": { @@ -5864,12 +6970,6 @@ "boolean" ] }, - "max_occurrences": { - "description": "", - "type": [ - "integer" - ] - }, "metadata": { "description": "Set of key/value pairs that you can attach to an object. It can be useful for storing additional information about the object in a structured format.", "type": [ @@ -5882,12 +6982,6 @@ "string" ] }, - "on_behalf_of": { - "description": "The account (if any) the charge was made on behalf of for charges associated with this subscription. See the Connect documentation for details.", - "type": [ - "string" - ] - }, "plan": { "$ref": "#/definitions/plan" }, @@ -5897,12 +6991,6 @@ "integer" ] }, - "retains_own_balance": { - "description": "", - "type": [ - "boolean" - ] - }, "start": { "description": "Date the most recent update to this subscription started.", "type": [ @@ -5949,6 +7037,9 @@ "type": [ "object" ], + "x-expandableFields": [ + "customer" + ], "x-resourceId": "subscription" }, "subscription_item": { @@ -5991,51 +7082,12 @@ "title": "SubscriptionItem", "type": [ "object" + ], + "x-expandableFields": [ + ], "x-resourceId": "subscription_item" }, - "tax_settings": { - "properties": { - "description": { - "description": "An arbitrary string attached to the object. Often useful for displaying to users.", - "type": [ - "string" - ] - }, - "provider": { - "description": "Tax provider to use. Present when `type` is `provider`.", - "type": [ - "string" - ] - }, - "provider_url": { - "description": "The provider's URL used to calculate taxes. If present, `type` must be `provider`.", - "type": [ - "string" - ] - }, - "rate": { - "description": "Tax rate, expressed as a percentage. Present when `type` is `percentage`.", - "type": [ - "number" - ] - }, - "type": { - "description": "Tax plan type. One of `included`, `flat_rate`, `provider`, `dynamic`.", - "type": [ - "string" - ] - } - }, - "required": [ - "type" - ], - "title": "TaxSettings", - "type": [ - "object" - ], - "x-resourceId": "tax_settings" - }, "three_d_secure": { "properties": { "amount": { @@ -6110,6 +7162,9 @@ "title": "ThreeDSecure", "type": [ "object" + ], + "x-expandableFields": [ + ], "x-resourceId": "three_d_secure" }, @@ -6157,12 +7212,6 @@ "string" ] }, - "usage": { - "description": "", - "type": [ - "string" - ] - }, "used": { "description": "Whether or not this token has already been used (tokens can be used only once).", "type": [ @@ -6181,6 +7230,9 @@ "title": "Token", "type": [ "object" + ], + "x-expandableFields": [ + ], "x-resourceId": "token" }, @@ -6198,42 +7250,6 @@ "string" ] }, - "address_city": { - "description": "", - "type": [ - "string" - ] - }, - "address_line1": { - "description": "", - "type": [ - "string" - ] - }, - "address_line2": { - "description": "", - "type": [ - "string" - ] - }, - "address_state": { - "description": "", - "type": [ - "string" - ] - }, - "address_zip": { - "description": "", - "type": [ - "string" - ] - }, - "allows_debits": { - "description": "", - "type": [ - "boolean" - ] - }, "bank_name": { "description": "Name of the bank associated with the routing number, e.g. `WELLS FARGO`.", "type": [ @@ -6276,12 +7292,6 @@ "string" ] }, - "reusable": { - "description": "", - "type": [ - "boolean" - ] - }, "routing_number": { "description": "The routing transit number for the bank account.", "type": [ @@ -6293,12 +7303,6 @@ "type": [ "string" ] - }, - "used": { - "description": "", - "type": [ - "boolean" - ] } }, "required": [ @@ -6312,6 +7316,9 @@ "title": "TokenBankAccount", "type": [ "object" + ], + "x-expandableFields": [ + ], "x-resourceId": "token_bank_account" }, @@ -6419,12 +7426,6 @@ "string" ] }, - "google_reference": { - "description": "", - "type": [ - "string" - ] - }, "id": { "description": "Unique identifier for the object.", "type": [ @@ -6455,12 +7456,6 @@ "string" ] }, - "three_d_secure": { - "description": "", - "type": [ - "object" - ] - }, "tokenization_method": { "description": "If the card number is tokenized, this is the method that was used. Can be `apple_pay` or `android_pay`.", "type": [ @@ -6481,9 +7476,108 @@ "title": "TokenCard", "type": [ "object" + ], + "x-expandableFields": [ + ], "x-resourceId": "token_card" }, + "transaction": { + "properties": { + "amount": { + "description": "", + "type": [ + "integer" + ] + }, + "authorization": { + "description": "", + "type": [ + "string" + ], + "x-expansionResources": { + "oneOf": [ + { + "$ref": "#/definitions/authorization" + } + ] + } + }, + "balance_transaction": { + "description": "", + "type": [ + "string" + ], + "x-expansionResources": { + "oneOf": [ + { + "$ref": "#/definitions/balance_transaction" + } + ] + } + }, + "card": { + "description": "", + "type": [ + "string" + ], + "x-expansionResources": { + "oneOf": [ + { + "$ref": "#/definitions/issued_card" + } + ] + } + }, + "currency": { + "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://support.stripe.com/questions/which-currencies-does-stripe-support).", + "type": [ + "string" + ] + }, + "id": { + "description": "Unique identifier for the object.", + "type": [ + "string" + ] + }, + "merchant_data": { + "$ref": "#/definitions/merchant_data" + }, + "object": { + "description": "String representing the object's type. Objects of the same type share the same value.", + "type": [ + "string" + ] + }, + "type": { + "description": "", + "type": [ + "string" + ] + } + }, + "required": [ + "amount", + "balance_transaction", + "card", + "currency", + "id", + "merchant_data", + "object", + "type" + ], + "title": "Transaction", + "type": [ + "object" + ], + "x-expandableFields": [ + "authorization", + "balance_transaction", + "card" + ], + "x-resourceId": "transaction" + }, "transfer": { "properties": { "amount": { @@ -6502,7 +7596,14 @@ "description": "Balance transaction that describes the impact of this transfer on your account balance.", "type": [ "string" - ] + ], + "x-expansionResources": { + "oneOf": [ + { + "$ref": "#/definitions/balance_transaction" + } + ] + } }, "created": { "description": "Time that this record of the transfer was first created.", @@ -6520,13 +7621,27 @@ "description": "ID of the Stripe account the transfer was sent to.", "type": [ "string" - ] + ], + "x-expansionResources": { + "oneOf": [ + { + "$ref": "#/definitions/account" + } + ] + } }, "destination_payment": { "description": "If the destination is a Stripe account, this will be the ID of the payment that the destination account received for the transfer.", "type": [ "string" - ] + ], + "x-expansionResources": { + "oneOf": [ + { + "$ref": "#/definitions/charge" + } + ] + } }, "id": { "description": "Unique identifier for the object.", @@ -6599,6 +7714,9 @@ "title": "TransferReversalList", "type": [ "object" + ], + "x-expandableFields": [ + ] }, "reversed": { @@ -6607,6 +7725,19 @@ "boolean" ] }, + "source_transaction": { + "description": "ID of the charge or payment that was used to fund the transfer. If null, the transfer was funded from the available balance.", + "type": [ + "string" + ], + "x-expansionResources": { + "oneOf": [ + { + "$ref": "#/definitions/charge" + } + ] + } + }, "source_type": { "description": "", "type": [ @@ -6636,6 +7767,12 @@ "type": [ "object" ], + "x-expandableFields": [ + "balance_transaction", + "destination", + "destination_payment", + "source_transaction" + ], "x-resourceId": "transfer" }, "transfer_recipient": { @@ -6690,6 +7827,9 @@ "title": "CardList", "type": [ "object" + ], + "x-expandableFields": [ + ] }, "created": { @@ -6702,7 +7842,14 @@ "description": "The default card to use for creating transfers to this recipient.", "type": [ "string" - ] + ], + "x-expansionResources": { + "oneOf": [ + { + "$ref": "#/definitions/card" + } + ] + } }, "description": { "description": "An arbitrary string attached to the object. Often useful for displaying to users.", @@ -6738,7 +7885,14 @@ "description": "The ID of the [managed account](/docs/connect/managed-accounts) this recipient was migrated to. If set, the recipient can no longer be updated, nor can transfers be made to it: use the managed account instead.", "type": [ "string" - ] + ], + "x-expansionResources": { + "oneOf": [ + { + "$ref": "#/definitions/account" + } + ] + } }, "name": { "description": "Full, legal name of the recipient.", @@ -6752,18 +7906,6 @@ "string" ] }, - "tin": { - "description": "", - "type": [ - "string" - ] - }, - "tin_verification_pending": { - "description": "", - "type": [ - "boolean" - ] - }, "type": { "description": "Type of the recipient, one of `individual` or `corporation`.", "type": [ @@ -6777,15 +7919,292 @@ "livemode", "metadata", "object", - "tin_verification_pending", "type" ], "title": "TransferRecipient", "type": [ "object" ], + "x-expandableFields": [ + "default_card", + "migrated_to" + ], "x-resourceId": "transfer_recipient" }, + "transfer_recipient_transfer": { + "properties": { + "amount": { + "description": "Amount (in %s) to be transferred to your bank account.", + "type": [ + "integer" + ] + }, + "amount_reversed": { + "description": "Amount in %s reversed (can be less than the amount attribute on the transfer if a partial reversal was issued).", + "type": [ + "integer" + ] + }, + "application_fee": { + "description": "", + "type": [ + "string" + ], + "x-expansionResources": { + "oneOf": [ + { + "$ref": "#/definitions/backwards_compatible_platform_earning" + } + ] + } + }, + "balance_transaction": { + "description": "Balance transaction that describes the impact of this transfer on your account balance.", + "type": [ + "string" + ], + "x-expansionResources": { + "oneOf": [ + { + "$ref": "#/definitions/balance_transaction" + } + ] + } + }, + "created": { + "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", + "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://support.stripe.com/questions/which-currencies-does-stripe-support).", + "type": [ + "string" + ] + }, + "date": { + "description": "Date the transfer is scheduled to arrive in the bank. This factors in delays like weekends or bank holidays.", + "type": [ + "integer" + ] + }, + "description": { + "description": "Internal-only description of the transfer.", + "type": [ + "string" + ] + }, + "destination": { + "description": "ID of the bank account, card, or Stripe account the transfer was sent to.", + "type": [ + "string" + ], + "x-expansionResources": { + "oneOf": [ + { + "$ref": "#/definitions/account" + }, + { + "$ref": "#/definitions/bank_account" + }, + { + "$ref": "#/definitions/card" + } + ] + } + }, + "destination_payment": { + "description": "If the destination is a Stripe account, this will be the ID of the payment that the destination account received for the transfer.", + "type": [ + "string" + ], + "x-expansionResources": { + "oneOf": [ + { + "$ref": "#/definitions/charge" + } + ] + } + }, + "failure_code": { + "description": "Error code explaining reason for transfer failure if available. See [Types of transfer failures](/docs/api#transfer_failures) for a list of failure codes.", + "type": [ + "string" + ] + }, + "failure_message": { + "description": "Message to user further explaining reason for transfer failure if available.", + "type": [ + "string" + ] + }, + "id": { + "description": "Unique identifier for the object.", + "type": [ + "string" + ] + }, + "livemode": { + "description": "Flag indicating whether the object exists in live mode or test mode.", + "type": [ + "boolean" + ] + }, + "metadata": { + "description": "Set of key/value pairs that you can attach to an object. It can be useful for storing additional information about the object in a structured format.", + "type": [ + "object" + ] + }, + "method": { + "description": "The method used to send this transfer, which can be `standard` or `instant`. `instant` is only supported for transfers to debit cards. (See [Instant payouts for marketplaces](/blog/instant-payouts-for-marketplaces) for more information.)", + "type": [ + "string" + ] + }, + "object": { + "description": "String representing the object's type. Objects of the same type share the same value.", + "type": [ + "string" + ] + }, + "reversals": { + "properties": { + "data": { + "items": { + "$ref": "#/definitions/transfer_reversal" + }, + "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" + ] + }, + "total_count": { + "description": "The total number of items available. This value is not included by default, but you can request it by specifying ?include[]=total_count.", + "type": [ + "integer" + ] + }, + "url": { + "description": "The URL where this list can be accessed.", + "type": [ + "string" + ] + } + }, + "required": [ + "data", + "has_more", + "object", + "url" + ], + "title": "TransferReversalList", + "type": [ + "object" + ], + "x-expandableFields": [ + + ] + }, + "reversed": { + "description": "Whether or not the transfer has been fully reversed. If the transfer is only partially reversed, this attribute will still be false.", + "type": [ + "boolean" + ] + }, + "source_transaction": { + "description": "ID of the charge (or other transaction) that was used to fund the transfer. If null, the transfer was funded from the available balance.", + "type": [ + "string" + ], + "x-expansionResources": { + "oneOf": [ + { + "$ref": "#/definitions/charge" + }, + { + "$ref": "#/definitions/platform_fee" + }, + { + "$ref": "#/definitions/transfer_reversal" + } + ] + } + }, + "source_type": { + "description": "The source balance this transfer came from. One of `card`, `bank_account`, `bitcoin_receiver`, or `alipay_account`.", + "type": [ + "string" + ] + }, + "statement_descriptor": { + "description": "Extra information about a transfer to be displayed on the user's bank statement.", + "type": [ + "string" + ] + }, + "status": { + "description": "Current status of the transfer (`paid`, `pending`, `in_transit`, `canceled` or `failed`). A transfer will be `pending` until it is submitted to the bank, at which point it becomes `in_transit`. It will then change to `paid` if the transaction goes through. If it does not go through successfully, its status will change to `failed` or `canceled`.", + "type": [ + "string" + ] + }, + "transfer_group": { + "description": "A string that identifies this transaction as part of a group. See the [Connect documentation](/docs/connect/charges-transfers#grouping-transactions) for details.", + "type": [ + "string" + ] + }, + "type": { + "description": "Can be `card`, `bank_account`, or `stripe_account`.", + "type": [ + "string" + ] + } + }, + "required": [ + "amount", + "amount_reversed", + "created", + "currency", + "date", + "id", + "livemode", + "metadata", + "object", + "reversals", + "reversed", + "status", + "type" + ], + "title": "TransferRecipientTransfer", + "type": [ + "object" + ], + "x-expandableFields": [ + "application_fee", + "balance_transaction", + "destination", + "destination_payment", + "source_transaction" + ], + "x-resourceId": "transfer_recipient_transfer" + }, "transfer_reversal": { "properties": { "amount": { @@ -6798,7 +8217,14 @@ "description": "Balance transaction that describes the impact on your account balance.", "type": [ "string" - ] + ], + "x-expansionResources": { + "oneOf": [ + { + "$ref": "#/definitions/balance_transaction" + } + ] + } }, "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", @@ -6834,7 +8260,17 @@ "description": "ID of the transfer that was reversed.", "type": [ "string" - ] + ], + "x-expansionResources": { + "oneOf": [ + { + "$ref": "#/definitions/legacy_transfer" + }, + { + "$ref": "#/definitions/transfer" + } + ] + } } }, "required": [ @@ -6850,6 +8286,10 @@ "type": [ "object" ], + "x-expandableFields": [ + "balance_transaction", + "transfer" + ], "x-resourceId": "transfer_reversal" }, "transfer_schedule": { @@ -6886,84 +8326,12 @@ "title": "TransferSchedule", "type": [ "object" + ], + "x-expandableFields": [ + ], "x-resourceId": "transfer_schedule" }, - "twitter_buy_now_settings": { - "properties": { - "enabled": { - "description": "", - "type": [ - "boolean" - ] - }, - "marketplace_id": { - "description": "", - "type": [ - "string" - ] - }, - "merchant_id": { - "description": "", - "type": [ - "string" - ] - }, - "oauth_token_provided": { - "description": "", - "type": [ - "boolean" - ] - }, - "oauth_token_secret_provided": { - "description": "", - "type": [ - "boolean" - ] - }, - "privacy_url": { - "description": "", - "type": [ - "string" - ] - }, - "sales_terms": { - "description": "", - "type": [ - "string" - ] - }, - "shipping_policy": { - "description": "", - "type": [ - "string" - ] - }, - "terms_url": { - "description": "", - "type": [ - "string" - ] - }, - "username": { - "description": "", - "type": [ - "string" - ] - } - }, - "required": [ - "enabled", - "oauth_token_provided", - "oauth_token_secret_provided", - "username" - ], - "title": "TwitterBuyNowSettings", - "type": [ - "object" - ], - "x-resourceId": "twitter_buy_now_settings" - }, "upcoming_invoice": { "properties": { "amount_due": { @@ -6990,17 +8358,18 @@ "boolean" ] }, - "billing": { - "description": "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.", - "type": [ - "string" - ] - }, "charge": { "description": "ID of the latest charge generated for this invoice, if any.", "type": [ "string" - ] + ], + "x-expansionResources": { + "oneOf": [ + { + "$ref": "#/definitions/charge" + } + ] + } }, "closed": { "description": "Whether or not the invoice is still trying to collect payment. An invoice is closed if it's either paid or it has been marked closed. A closed invoice will no longer attempt to collect payment.", @@ -7018,7 +8387,14 @@ "description": "", "type": [ "string" - ] + ], + "x-expansionResources": { + "oneOf": [ + { + "$ref": "#/definitions/customer" + } + ] + } }, "date": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", @@ -7035,12 +8411,6 @@ "discount": { "$ref": "#/definitions/discount" }, - "due_date": { - "description": "The date on which payment for this invoice is due.", - "type": [ - "integer" - ] - }, "ending_balance": { "description": "Ending customer balance after attempting to pay invoice. If the invoice has not been attempted yet, this will be null.", "type": [ @@ -7100,6 +8470,9 @@ "title": "InvoiceLinesList", "type": [ "object" + ], + "x-expandableFields": [ + ] }, "livemode": { @@ -7120,12 +8493,6 @@ "integer" ] }, - "number": { - "description": "A unique, identifying string that appears on emails sent to the customer for this invoice.", - "type": [ - "string" - ] - }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "type": [ @@ -7172,7 +8539,14 @@ "description": "The subscription that this invoice was prepared for, if any.", "type": [ "string" - ] + ], + "x-expansionResources": { + "oneOf": [ + { + "$ref": "#/definitions/subscription" + } + ] + } }, "subscription_proration_date": { "description": "Only set for upcoming invoices that preview prorations. The time used to calculate prorations.", @@ -7234,6 +8608,11 @@ "type": [ "object" ], + "x-expandableFields": [ + "charge", + "customer", + "subscription" + ], "x-resourceId": "upcoming_invoice" } }, @@ -7290,6 +8669,19 @@ "string" ] }, + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "type": [ + "string" + ] + }, + "title": "expand", + "type": [ + "array", + "string" + ] + }, "return_url": { "description": "The URL that the cardholder's browser will be returned to when authentication completes.", "title": "return_url", @@ -7327,6 +8719,13 @@ "description": "

Retrieves a 3D Secure object.

", "operationId": "Retrieve3DSecure", "parameters": [ + { + "description": "Specifies which fields in the response should be expanded.", + "in": "query", + "name": "expand", + "required": false, + "type": "string" + }, { "description": "The identifier of the 3D Secure object to be retrieved.", "in": "path", @@ -7369,6 +8768,19 @@ "type": [ "string" ] + }, + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "type": [ + "string" + ] + }, + "title": "expand", + "type": [ + "array", + "string" + ] } } } @@ -7393,6 +8805,13 @@ "description": "

Retrieves the details of the account.

", "operationId": "AccountRetrieve", "parameters": [ + { + "description": "Specifies which fields in the response should be expanded.", + "in": "query", + "name": "expand", + "required": false, + "type": "string" + }, { "description": "The identifier of the account to be retrieved. If none is provided, will default to the account of the API key.", "in": "query", @@ -7483,6 +8902,19 @@ "string" ] }, + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "type": [ + "string" + ] + }, + "title": "expand", + "type": [ + "array", + "string" + ] + }, "external_account": { "description": "A card or bank account to attach to the account. You can provide either a token, like the ones returned by [Stripe.js](/docs/stripe.js), or a dictionary as documented in the external_account parameter for either [card](/docs/api#account_create_card) or [bank account](/docs/api#account_create_bank_account) creation.

This will create a new external account object, make it the new default external account for its currency, and delete the old default if one exists. If you want to add additional external accounts instead of replacing the existing default for this currency, use the bank account or card creation API.", "title": "external_account", @@ -7498,13 +8930,6 @@ "object" ] }, - "mcc": { - "description": "", - "title": "mcc", - "type": [ - "integer" - ] - }, "metadata": { "description": "A set of key/value pairs that you can attach to an account object. It can be useful for storing additional information about the account in a structured format.", "title": "metadata", @@ -7512,13 +8937,6 @@ "object" ] }, - "orders": { - "description": "", - "title": "orders", - "type": [ - "object" - ] - }, "payout_schedule": { "description": "Details on when this account will make funds from charges available, and when they will be paid out to the account holder's bank account. See our [managed account bank transfer guide](/docs/connect/bank-transfers#payout-information) for more information.", "title": "payout_schedule", @@ -7604,7 +9022,7 @@ "description": "Body parameters for the request.", "in": "body", "name": "payload", - "required": false, + "required": true, "schema": { "properties": { "default_for_currency": { @@ -7614,6 +9032,19 @@ "boolean" ] }, + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "type": [ + "string" + ] + }, + "title": "expand", + "type": [ + "array", + "string" + ] + }, "external_account": { "description": "This string to be replaced by DocSpecGenerator.", "title": "external_account", @@ -7663,6 +9094,63 @@ "name": "id", "required": true, "type": "string" + }, + { + "description": "Body parameters for the request.", + "in": "body", + "name": "payload", + "required": false, + "schema": { + "properties": { + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "type": [ + "string" + ] + }, + "title": "expand", + "type": [ + "array", + "string" + ] + } + } + } + } + ], + "responses": { + "200": { + "description": "Successful response.", + "schema": { + "$ref": "#/definitions/external_account_source" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/error" + } + } + } + }, + "get": { + "description": "", + "operationId": "RetrieveAccountExternalAccount", + "parameters": [ + { + "description": "Specifies which fields in the response should be expanded.", + "in": "query", + "name": "expand", + "required": false, + "type": "string" + }, + { + "description": "", + "in": "path", + "name": "id", + "required": true, + "type": "string" } ], "responses": { @@ -7705,6 +9193,19 @@ "boolean" ] }, + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "type": [ + "string" + ] + }, + "title": "expand", + "type": [ + "array", + "string" + ] + }, "metadata": { "description": "", "title": "metadata", @@ -7737,6 +9238,13 @@ "description": "", "operationId": "AllAccountExternalAccounts", "parameters": [ + { + "description": "Specifies which fields in the response should be expanded.", + "in": "query", + "name": "expand", + "required": false, + "type": "string" + }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100 items.", "in": "query", @@ -7766,9 +9274,7 @@ "properties": { "data": { "items": { - "type": [ - "object" - ] + "$ref": "#/definitions/bank_account" }, "type": [ "array" @@ -7811,6 +9317,9 @@ "title": "ExternalAccountList", "type": [ "object" + ], + "x-expandableFields": [ + "data" ] } }, @@ -7830,7 +9339,7 @@ "description": "Body parameters for the request.", "in": "body", "name": "payload", - "required": false, + "required": true, "schema": { "properties": { "default_for_currency": { @@ -7840,6 +9349,19 @@ "boolean" ] }, + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "type": [ + "string" + ] + }, + "title": "expand", + "type": [ + "array", + "string" + ] + }, "external_account": { "description": "This string to be replaced by DocSpecGenerator.", "title": "external_account", @@ -7889,6 +9411,63 @@ "name": "id", "required": true, "type": "string" + }, + { + "description": "Body parameters for the request.", + "in": "body", + "name": "payload", + "required": false, + "schema": { + "properties": { + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "type": [ + "string" + ] + }, + "title": "expand", + "type": [ + "array", + "string" + ] + } + } + } + } + ], + "responses": { + "200": { + "description": "Successful response.", + "schema": { + "$ref": "#/definitions/external_account_source" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/error" + } + } + } + }, + "get": { + "description": "", + "operationId": "RetrieveAccountExternalAccount", + "parameters": [ + { + "description": "Specifies which fields in the response should be expanded.", + "in": "query", + "name": "expand", + "required": false, + "type": "string" + }, + { + "description": "", + "in": "path", + "name": "id", + "required": true, + "type": "string" } ], "responses": { @@ -7931,6 +9510,19 @@ "boolean" ] }, + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "type": [ + "string" + ] + }, + "title": "expand", + "type": [ + "array", + "string" + ] + }, "metadata": { "description": "", "title": "metadata", @@ -7958,11 +9550,87 @@ } } }, + "/v1/account/login_links": { + "post": { + "description": "", + "operationId": "LoginLinkCreate", + "parameters": [ + { + "description": "Body parameters for the request.", + "in": "body", + "name": "payload", + "required": true, + "schema": { + "properties": { + "account": { + "description": "The identifier of the account to create a login link for.", + "title": "account", + "type": [ + "string" + ] + }, + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "type": [ + "string" + ] + }, + "title": "expand", + "type": [ + "array", + "string" + ] + }, + "id": { + "description": "", + "title": "id", + "type": [ + "string" + ] + }, + "percent_off": { + "description": "", + "title": "percent_off", + "type": [ + "integer" + ] + } + }, + "required": [ + "account" + ] + } + } + ], + "responses": { + "200": { + "description": "Successful response.", + "schema": { + "$ref": "#/definitions/login_link" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/error" + } + } + } + } + }, "/v1/accounts": { "get": { "description": "

Returns a list of accounts connected to your platform via Connect. If you’re not a platform, the list will be empty.

", "operationId": "AllAccount", "parameters": [ + { + "description": "Specifies which fields in the response should be expanded.", + "in": "query", + "name": "expand", + "required": false, + "type": "string" + }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100 items.", "in": "query", @@ -8037,6 +9705,9 @@ ], "type": [ "object" + ], + "x-expandableFields": [ + ] } }, @@ -8122,6 +9793,19 @@ "string" ] }, + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "type": [ + "string" + ] + }, + "title": "expand", + "type": [ + "array", + "string" + ] + }, "external_account": { "description": "A card or bank account to attach to the account. You can provide either a token, like the ones returned by [Stripe.js](/docs/stripe.js), or a dictionary as documented in the external_account parameter for either [card](/docs/api#account_create_card) or [bank account](/docs/api#account_create_bank_account) creation.

This will create a new external account object, make it the new default external account for its currency, and delete the old default if one exists. If you want to add additional external accounts instead of replacing the existing default for this currency, use the bank account or card creation API.", "title": "external_account", @@ -8144,13 +9828,6 @@ "boolean" ] }, - "mcc": { - "description": "", - "title": "mcc", - "type": [ - "integer" - ] - }, "metadata": { "description": "A set of key/value pairs that you can attach to an account object. It can be useful for storing additional information about the account in a structured format.", "title": "metadata", @@ -8158,13 +9835,6 @@ "object" ] }, - "orders": { - "description": "", - "title": "orders", - "type": [ - "object" - ] - }, "payout_schedule": { "description": "Details on when this account will make funds from charges available, and when they will be paid out to the account holder's bank account. See our [managed account bank transfer guide](/docs/connect/bank-transfers#payout-information) for more information.", "title": "payout_schedule", @@ -8179,13 +9849,6 @@ "string" ] }, - "platform_account": { - "description": "", - "title": "platform_account", - "type": [ - "boolean" - ] - }, "product_description": { "description": "Internal-only description of the product being sold or service being provided by this account. It's used by Stripe for risk and underwriting purposes.", "title": "product_description", @@ -8259,6 +9922,29 @@ "name": "account", "required": true, "type": "string" + }, + { + "description": "Body parameters for the request.", + "in": "body", + "name": "payload", + "required": false, + "schema": { + "properties": { + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "type": [ + "string" + ] + }, + "title": "expand", + "type": [ + "array", + "string" + ] + } + } + } } ], "responses": { @@ -8280,6 +9966,13 @@ "description": "

Retrieves the details of the account.

", "operationId": "AccountRetrieve", "parameters": [ + { + "description": "Specifies which fields in the response should be expanded.", + "in": "query", + "name": "expand", + "required": false, + "type": "string" + }, { "description": "The identifier of the account to be retrieved. If none is provided, will default to the account of the API key.", "in": "path", @@ -8370,6 +10063,19 @@ "string" ] }, + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "type": [ + "string" + ] + }, + "title": "expand", + "type": [ + "array", + "string" + ] + }, "external_account": { "description": "A card or bank account to attach to the account. You can provide either a token, like the ones returned by [Stripe.js](/docs/stripe.js), or a dictionary as documented in the external_account parameter for either [card](/docs/api#account_create_card) or [bank account](/docs/api#account_create_bank_account) creation.

This will create a new external account object, make it the new default external account for its currency, and delete the old default if one exists. If you want to add additional external accounts instead of replacing the existing default for this currency, use the bank account or card creation API.", "title": "external_account", @@ -8385,13 +10091,6 @@ "object" ] }, - "mcc": { - "description": "", - "title": "mcc", - "type": [ - "integer" - ] - }, "metadata": { "description": "A set of key/value pairs that you can attach to an account object. It can be useful for storing additional information about the account in a structured format.", "title": "metadata", @@ -8399,13 +10098,6 @@ "object" ] }, - "orders": { - "description": "", - "title": "orders", - "type": [ - "object" - ] - }, "payout_schedule": { "description": "Details on when this account will make funds from charges available, and when they will be paid out to the account holder's bank account. See our [managed account bank transfer guide](/docs/connect/bank-transfers#payout-information) for more information.", "title": "payout_schedule", @@ -8491,7 +10183,7 @@ "description": "Body parameters for the request.", "in": "body", "name": "payload", - "required": false, + "required": true, "schema": { "properties": { "default_for_currency": { @@ -8501,6 +10193,19 @@ "boolean" ] }, + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "type": [ + "string" + ] + }, + "title": "expand", + "type": [ + "array", + "string" + ] + }, "external_account": { "description": "This string to be replaced by DocSpecGenerator.", "title": "external_account", @@ -8550,6 +10255,63 @@ "name": "id", "required": true, "type": "string" + }, + { + "description": "Body parameters for the request.", + "in": "body", + "name": "payload", + "required": false, + "schema": { + "properties": { + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "type": [ + "string" + ] + }, + "title": "expand", + "type": [ + "array", + "string" + ] + } + } + } + } + ], + "responses": { + "200": { + "description": "Successful response.", + "schema": { + "$ref": "#/definitions/external_account_source" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/error" + } + } + } + }, + "get": { + "description": "", + "operationId": "RetrieveAccountExternalAccount", + "parameters": [ + { + "description": "Specifies which fields in the response should be expanded.", + "in": "query", + "name": "expand", + "required": false, + "type": "string" + }, + { + "description": "", + "in": "path", + "name": "id", + "required": true, + "type": "string" } ], "responses": { @@ -8592,6 +10354,19 @@ "boolean" ] }, + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "type": [ + "string" + ] + }, + "title": "expand", + "type": [ + "array", + "string" + ] + }, "metadata": { "description": "", "title": "metadata", @@ -8624,6 +10399,13 @@ "description": "", "operationId": "AllAccountExternalAccounts", "parameters": [ + { + "description": "Specifies which fields in the response should be expanded.", + "in": "query", + "name": "expand", + "required": false, + "type": "string" + }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100 items.", "in": "query", @@ -8653,9 +10435,7 @@ "properties": { "data": { "items": { - "type": [ - "object" - ] + "$ref": "#/definitions/bank_account" }, "type": [ "array" @@ -8698,6 +10478,9 @@ "title": "ExternalAccountList", "type": [ "object" + ], + "x-expandableFields": [ + "data" ] } }, @@ -8717,7 +10500,7 @@ "description": "Body parameters for the request.", "in": "body", "name": "payload", - "required": false, + "required": true, "schema": { "properties": { "default_for_currency": { @@ -8727,6 +10510,19 @@ "boolean" ] }, + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "type": [ + "string" + ] + }, + "title": "expand", + "type": [ + "array", + "string" + ] + }, "external_account": { "description": "This string to be replaced by DocSpecGenerator.", "title": "external_account", @@ -8776,6 +10572,63 @@ "name": "id", "required": true, "type": "string" + }, + { + "description": "Body parameters for the request.", + "in": "body", + "name": "payload", + "required": false, + "schema": { + "properties": { + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "type": [ + "string" + ] + }, + "title": "expand", + "type": [ + "array", + "string" + ] + } + } + } + } + ], + "responses": { + "200": { + "description": "Successful response.", + "schema": { + "$ref": "#/definitions/external_account_source" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/error" + } + } + } + }, + "get": { + "description": "", + "operationId": "RetrieveAccountExternalAccount", + "parameters": [ + { + "description": "Specifies which fields in the response should be expanded.", + "in": "query", + "name": "expand", + "required": false, + "type": "string" + }, + { + "description": "", + "in": "path", + "name": "id", + "required": true, + "type": "string" } ], "responses": { @@ -8818,6 +10671,19 @@ "boolean" ] }, + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "type": [ + "string" + ] + }, + "title": "expand", + "type": [ + "array", + "string" + ] + }, "metadata": { "description": "", "title": "metadata", @@ -8845,6 +10711,72 @@ } } }, + "/v1/accounts/{account}/login_links": { + "post": { + "description": "", + "operationId": "LoginLinkCreate", + "parameters": [ + { + "description": "The identifier of the account to create a login link for.", + "in": "path", + "name": "account", + "required": true, + "type": "string" + }, + { + "description": "Body parameters for the request.", + "in": "body", + "name": "payload", + "required": false, + "schema": { + "properties": { + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "type": [ + "string" + ] + }, + "title": "expand", + "type": [ + "array", + "string" + ] + }, + "id": { + "description": "", + "title": "id", + "type": [ + "string" + ] + }, + "percent_off": { + "description": "", + "title": "percent_off", + "type": [ + "integer" + ] + } + } + } + } + ], + "responses": { + "200": { + "description": "Successful response.", + "schema": { + "$ref": "#/definitions/login_link" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/error" + } + } + } + } + }, "/v1/accounts/{account}/reject": { "post": { "description": "

With Connect, you may flag managed accounts as suspicious.

Managed accounts created using test-mode keys can be rejected at any time. Managed accounts created using live-mode keys may only be rejected once all balances are zero.

", @@ -8861,9 +10793,22 @@ "description": "Body parameters for the request.", "in": "body", "name": "payload", - "required": false, + "required": true, "schema": { "properties": { + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "type": [ + "string" + ] + }, + "title": "expand", + "type": [ + "array", + "string" + ] + }, "reason": { "description": "The reason for rejecting the account. May be one of `fraud`, `terms_of_service`, or `other`.", "title": "reason", @@ -8899,6 +10844,13 @@ "description": "", "operationId": "AllApplePayDomains", "parameters": [ + { + "description": "Specifies which fields in the response should be expanded.", + "in": "query", + "name": "expand", + "required": false, + "type": "string" + }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100 items.", "in": "query", @@ -8981,6 +10933,9 @@ "title": "ApplePayDomainList", "type": [ "object" + ], + "x-expandableFields": [ + ] } }, @@ -9000,7 +10955,7 @@ "description": "Body parameters for the request.", "in": "body", "name": "payload", - "required": false, + "required": true, "schema": { "properties": { "domain_name": { @@ -9009,6 +10964,19 @@ "type": [ "string" ] + }, + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "type": [ + "string" + ] + }, + "title": "expand", + "type": [ + "array", + "string" + ] } }, "required": [ @@ -9044,6 +11012,29 @@ "name": "domain", "required": true, "type": "string" + }, + { + "description": "Body parameters for the request.", + "in": "body", + "name": "payload", + "required": false, + "schema": { + "properties": { + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "type": [ + "string" + ] + }, + "title": "expand", + "type": [ + "array", + "string" + ] + } + } + } } ], "responses": { @@ -9065,6 +11056,13 @@ "description": "", "operationId": "RetrieveApplePayDomain", "parameters": [ + { + "description": "Specifies which fields in the response should be expanded.", + "in": "query", + "name": "expand", + "required": false, + "type": "string" + }, { "description": "", "in": "path", @@ -9094,6 +11092,13 @@ "description": "

Returns a list of application fees you’ve previously collected. The application fees are returned in sorted order, with the most recent fees appearing first.

", "operationId": "AllPlatformEarnings", "parameters": [ + { + "description": "Specifies which fields in the response should be expanded.", + "in": "query", + "name": "expand", + "required": false, + "type": "string" + }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100 items.", "in": "query", @@ -9182,6 +11187,9 @@ ], "type": [ "object" + ], + "x-expandableFields": [ + ] } }, @@ -9199,6 +11207,13 @@ "description": "

By default, you can see the 10 most recent refunds stored directly on the application fee object, but you can also retrieve details about a specific refund stored on the application fee.

", "operationId": "RetrievePlatformEarningRefund", "parameters": [ + { + "description": "Specifies which fields in the response should be expanded.", + "in": "query", + "name": "expand", + "required": false, + "type": "string" + }, { "description": "ID of the application fee refunded.", "in": "path", @@ -9240,6 +11255,19 @@ "required": false, "schema": { "properties": { + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "type": [ + "string" + ] + }, + "title": "expand", + "type": [ + "array", + "string" + ] + }, "metadata": { "description": "A set of key/value pairs that you can attach to an application fee refund object. It can be useful for storing additional information about the refund in a structured format.", "title": "metadata", @@ -9272,6 +11300,13 @@ "description": "

Retrieves the details of an application fee that your account has collected. The same information is returned when refunding the application fee.

", "operationId": "RetrievePlatformEarning", "parameters": [ + { + "description": "Specifies which fields in the response should be expanded.", + "in": "query", + "name": "expand", + "required": false, + "type": "string" + }, { "description": "The identifier of the fee to be retrieved.", "in": "path", @@ -9328,6 +11363,19 @@ "type": [ "string" ] + }, + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "type": [ + "string" + ] + }, + "title": "expand", + "type": [ + "array", + "string" + ] } } } @@ -9354,6 +11402,13 @@ "description": "

You can see a list of the refunds belonging to a specific application fee. Note that the 10 most recent refunds are always available by default on the application fee object. If you need more than those 10, you can use this API method and the limit and starting_after parameters to page through additional refunds.

", "operationId": "AllPlatformEarningsRefunds", "parameters": [ + { + "description": "Specifies which fields in the response should be expanded.", + "in": "query", + "name": "expand", + "required": false, + "type": "string" + }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100 items.", "in": "query", @@ -9433,6 +11488,9 @@ "title": "FeeRefundList", "type": [ "object" + ], + "x-expandableFields": [ + ] } }, @@ -9476,6 +11534,19 @@ "string" ] }, + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "type": [ + "string" + ] + }, + "title": "expand", + "type": [ + "array", + "string" + ] + }, "metadata": { "description": "", "title": "metadata", @@ -9508,7 +11579,13 @@ "description": "

Retrieves the current account balance, based on the authentication that was used to make the request.

", "operationId": "BalanceRetrieve", "parameters": [ - + { + "description": "Specifies which fields in the response should be expanded.", + "in": "query", + "name": "expand", + "required": false, + "type": "string" + } ], "responses": { "200": { @@ -9531,6 +11608,13 @@ "description": "

Returns a list of transactions that have contributed to the Stripe account balance (e.g., charges, transfers, and so forth). The transactions are returned in sorted order, with the most recent transactions appearing first.

", "operationId": "AllBalanceTransactions", "parameters": [ + { + "description": "Specifies which fields in the response should be expanded.", + "in": "query", + "name": "expand", + "required": false, + "type": "string" + }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100 items.", "in": "query", @@ -9648,6 +11732,9 @@ "title": "BalanceTransactionsList", "type": [ "object" + ], + "x-expandableFields": [ + ] } }, @@ -9665,6 +11752,13 @@ "description": "

Retrieves the balance transaction with the given ID.

", "operationId": "RetrieveBalanceTransaction", "parameters": [ + { + "description": "Specifies which fields in the response should be expanded.", + "in": "query", + "name": "expand", + "required": false, + "type": "string" + }, { "description": "The ID of the desired balance transaction (as found on any API object that affects the balance, e.g. a charge or transfer).", "in": "path", @@ -9689,6 +11783,378 @@ } } }, + "/v1/bitcoin/payments": { + "get": { + "description": "", + "operationId": "AllPayments", + "parameters": [ + { + "description": "Specifies which fields in the response should be expanded.", + "in": "query", + "name": "expand", + "required": false, + "type": "string" + }, + { + "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100 items.", + "in": "query", + "name": "limit", + "required": false, + "type": "integer" + }, + { + "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, + "type": "string" + }, + { + "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, + "type": "string" + }, + { + "description": "Only return payments for the customer specified by this customer ID.", + "in": "query", + "name": "customer", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Successful response.", + "schema": { + "properties": { + "data": { + "items": { + "$ref": "#/definitions/charge" + }, + "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" + ] + }, + "total_count": { + "description": "The total number of items available. This value is not included by default, but you can request it by specifying ?include[]=total_count.", + "type": [ + "integer" + ] + }, + "url": { + "description": "The URL where this list can be accessed.", + "enum": [ + "/v1/bitcoin/payments" + ], + "type": [ + "string" + ] + } + }, + "required": [ + "data", + "has_more", + "object", + "url" + ], + "type": [ + "object" + ], + "x-expandableFields": [ + + ] + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/error" + } + } + } + }, + "post": { + "description": "", + "operationId": "CreatePayment", + "parameters": [ + { + "description": "Body parameters for the request.", + "in": "body", + "name": "payload", + "required": true, + "schema": { + "properties": { + "alternate_statement_descriptors": { + "description": "", + "title": "alternate_statement_descriptors", + "type": [ + "object" + ] + }, + "amount": { + "description": "", + "title": "amount", + "type": [ + "integer" + ] + }, + "application": { + "description": "", + "title": "application", + "type": [ + "string" + ] + }, + "application_fee": { + "description": "", + "title": "application_fee", + "type": [ + "integer" + ] + }, + "capture": { + "description": "", + "title": "capture", + "type": [ + "boolean" + ] + }, + "currency": { + "description": "", + "title": "currency", + "type": [ + "string" + ] + }, + "customer": { + "description": "", + "title": "customer", + "type": [ + "string" + ] + }, + "description": { + "description": "", + "title": "description", + "type": [ + "string" + ] + }, + "destination": { + "description": "", + "title": "destination", + "type": [ + "object" + ] + }, + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "type": [ + "string" + ] + }, + "title": "expand", + "type": [ + "array", + "string" + ] + }, + "external_id": { + "description": "", + "title": "external_id", + "type": [ + "string" + ] + }, + "idempotency_key": { + "description": "", + "title": "idempotency_key", + "type": [ + "string" + ] + }, + "invoice": { + "description": "", + "title": "invoice", + "type": [ + "string" + ] + }, + "invoice_source": { + "description": "", + "title": "invoice_source", + "type": [ + "string" + ] + }, + "ip": { + "description": "", + "title": "ip", + "type": [ + "string" + ] + }, + "level3": { + "description": "", + "title": "level3", + "type": [ + "object" + ] + }, + "metadata": { + "description": "", + "title": "metadata", + "type": [ + "object" + ] + }, + "on_behalf_of": { + "description": "", + "title": "on_behalf_of", + "type": [ + "string" + ] + }, + "order": { + "description": "", + "title": "order", + "type": [ + "string" + ] + }, + "payment_method": { + "description": "", + "title": "payment_method", + "type": [ + "string" + ] + }, + "payment_user_agent": { + "description": "", + "title": "payment_user_agent", + "type": [ + "string" + ] + }, + "receipt_email": { + "description": "", + "title": "receipt_email", + "type": [ + "string" + ] + }, + "recurring": { + "description": "", + "title": "recurring", + "type": [ + "boolean" + ] + }, + "referrer": { + "description": "", + "title": "referrer", + "type": [ + "string" + ] + }, + "shipping": { + "description": "", + "title": "shipping", + "type": [ + "object" + ] + }, + "source": { + "description": "", + "title": "source", + "type": [ + "string" + ] + }, + "statement_descriptor": { + "description": "", + "title": "statement_descriptor", + "type": [ + "string" + ] + }, + "three_d_secure": { + "description": "", + "title": "three_d_secure", + "type": [ + "object" + ] + }, + "transfer_group": { + "description": "", + "title": "transfer_group", + "type": [ + "string" + ] + }, + "trust": { + "description": "", + "title": "trust", + "type": [ + "object" + ] + }, + "uncaptured": { + "description": "", + "title": "uncaptured", + "type": [ + "boolean" + ] + }, + "user_agent": { + "description": "", + "title": "user_agent", + "type": [ + "string" + ] + } + }, + "required": [ + "amount", + "currency" + ] + } + } + ], + "responses": { + "200": { + "description": "Successful response.", + "schema": { + "$ref": "#/definitions/charge" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/error" + } + } + } + } + }, "/v1/bitcoin/payments/{charge}/refund": { "post": { "description": "", @@ -9729,6 +12195,19 @@ "string" ] }, + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "type": [ + "string" + ] + }, + "title": "expand", + "type": [ + "array", + "string" + ] + }, "metadata": { "description": "", "title": "metadata", @@ -9784,11 +12263,54 @@ } } }, + "/v1/bitcoin/payments/{id}": { + "get": { + "description": "", + "operationId": "RetrievePayment", + "parameters": [ + { + "description": "Specifies which fields in the response should be expanded.", + "in": "query", + "name": "expand", + "required": false, + "type": "string" + }, + { + "description": "", + "in": "path", + "name": "id", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Successful response.", + "schema": { + "$ref": "#/definitions/charge" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/error" + } + } + } + } + }, "/v1/bitcoin/receivers": { "get": { "description": "

Returns a list of your receivers. Receivers are returned sorted by creation date, with the most recently created receivers appearing first.

", "operationId": "AllReceivers", "parameters": [ + { + "description": "Specifies which fields in the response should be expanded.", + "in": "query", + "name": "expand", + "required": false, + "type": "string" + }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100 items.", "in": "query", @@ -9884,6 +12406,9 @@ ], "type": [ "object" + ], + "x-expandableFields": [ + ] } }, @@ -9934,6 +12459,19 @@ "string" ] }, + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "type": [ + "string" + ] + }, + "title": "expand", + "type": [ + "array", + "string" + ] + }, "metadata": { "description": "A set of key/value pairs that you can attach to a customer object. It can be useful for storing additional information about the customer in a structured format.", "title": "metadata", @@ -9983,6 +12521,29 @@ "name": "id", "required": true, "type": "string" + }, + { + "description": "Body parameters for the request.", + "in": "body", + "name": "payload", + "required": false, + "schema": { + "properties": { + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "type": [ + "string" + ] + }, + "title": "expand", + "type": [ + "array", + "string" + ] + } + } + } } ], "responses": { @@ -10004,6 +12565,13 @@ "description": "

Retrieves the Bitcoin receiver with the given ID.

", "operationId": "RetrieveReceiver", "parameters": [ + { + "description": "Specifies which fields in the response should be expanded.", + "in": "query", + "name": "expand", + "required": false, + "type": "string" + }, { "description": "", "in": "path", @@ -10059,6 +12627,19 @@ "string" ] }, + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "type": [ + "string" + ] + }, + "title": "expand", + "type": [ + "array", + "string" + ] + }, "metadata": { "description": "", "title": "metadata", @@ -10112,6 +12693,19 @@ "required": false, "schema": { "properties": { + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "type": [ + "string" + ] + }, + "title": "expand", + "type": [ + "array", + "string" + ] + }, "refund_address": { "description": "If the receiver does not already have a refund address, then you need to provide one to perform a refund.", "title": "refund_address", @@ -10144,6 +12738,13 @@ "description": "", "operationId": "AllTransactions", "parameters": [ + { + "description": "Specifies which fields in the response should be expanded.", + "in": "query", + "name": "expand", + "required": false, + "type": "string" + }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100 items.", "in": "query", @@ -10230,6 +12831,9 @@ "title": "BitcoinTransactionList", "type": [ "object" + ], + "x-expandableFields": [ + ] } }, @@ -10247,6 +12851,13 @@ "description": "", "operationId": "AllTransactions", "parameters": [ + { + "description": "Specifies which fields in the response should be expanded.", + "in": "query", + "name": "expand", + "required": false, + "type": "string" + }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100 items.", "in": "query", @@ -10333,6 +12944,9 @@ "title": "BitcoinTransactionList", "type": [ "object" + ], + "x-expandableFields": [ + ] } }, @@ -10350,6 +12964,13 @@ "description": "", "operationId": "RetrieveTransaction", "parameters": [ + { + "description": "Specifies which fields in the response should be expanded.", + "in": "query", + "name": "expand", + "required": false, + "type": "string" + }, { "description": "", "in": "path", @@ -10379,6 +13000,13 @@ "description": "

Returns a list of charges you’ve previously created. The charges are returned in sorted order, with the most recent charges appearing first.

", "operationId": "AllCharges", "parameters": [ + { + "description": "Specifies which fields in the response should be expanded.", + "in": "query", + "name": "expand", + "required": false, + "type": "string" + }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100 items.", "in": "query", @@ -10481,6 +13109,9 @@ ], "type": [ "object" + ], + "x-expandableFields": [ + ] } }, @@ -10563,7 +13194,19 @@ "description": "", "title": "destination", "type": [ - "object", + "object" + ] + }, + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "type": [ + "string" + ] + }, + "title": "expand", + "type": [ + "array", "string" ] }, @@ -10666,20 +13309,6 @@ "string" ] }, - "three_d_secure": { - "description": "", - "title": "three_d_secure", - "type": [ - "object" - ] - }, - "transfer": { - "description": "", - "title": "transfer", - "type": [ - "object" - ] - }, "transfer_group": { "description": "", "title": "transfer_group", @@ -10737,6 +13366,13 @@ "description": "

Retrieves the details of a charge that has previously been created. Supply the unique charge ID that was returned from your previous request, and Stripe will return the corresponding charge information. The same information is returned when creating or refunding the charge.

", "operationId": "RetrieveCharge", "parameters": [ + { + "description": "Specifies which fields in the response should be expanded.", + "in": "query", + "name": "expand", + "required": false, + "type": "string" + }, { "description": "The identifier of the charge to be retrieved.", "in": "path", @@ -10778,6 +13414,19 @@ "string" ] }, + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "type": [ + "string" + ] + }, + "title": "expand", + "type": [ + "array", + "string" + ] + }, "fraud_details": { "description": "A set of key/value pairs you can attach to a charge giving information about its riskiness. If you believe a charge is fraudulent, include a `user_report` key with a value of `fraudulent`. If you believe a charge is safe, include a `user_report` key with a value of `safe`. Note that you must refund a charge before setting the `user_report` to `fraudulent`. Stripe will use the information you send to improve our fraud detection algorithms.", "title": "fraud_details", @@ -10866,6 +13515,26 @@ "integer" ] }, + "destination": { + "description": "An optional dictionary containing a new destination amount to use. Can only be used with destination charges created with Stripe Connect.", + "title": "destination", + "type": [ + "object" + ] + }, + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "type": [ + "string" + ] + }, + "title": "expand", + "type": [ + "array", + "string" + ] + }, "receipt_email": { "description": "The email address to send this charge's receipt to. This will override the previously-specified email address for this charge, if one was set. Receipts will not be sent in test mode.", "title": "receipt_email", @@ -10905,6 +13574,13 @@ "description": "", "operationId": "RetrieveChargeDispute", "parameters": [ + { + "description": "Specifies which fields in the response should be expanded.", + "in": "query", + "name": "expand", + "required": false, + "type": "string" + }, { "description": "", "in": "path", @@ -10953,6 +13629,19 @@ "object" ] }, + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "type": [ + "string" + ] + }, + "title": "expand", + "type": [ + "array", + "string" + ] + }, "metadata": { "description": "A set of key/value pairs that you can attach to a dispute object. It can be useful for storing additional information about the dispute in a structured format.", "title": "metadata", @@ -10991,6 +13680,29 @@ "name": "charge", "required": true, "type": "string" + }, + { + "description": "Body parameters for the request.", + "in": "body", + "name": "payload", + "required": false, + "schema": { + "properties": { + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "type": [ + "string" + ] + }, + "title": "expand", + "type": [ + "array", + "string" + ] + } + } + } } ], "responses": { @@ -11049,6 +13761,19 @@ "string" ] }, + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "type": [ + "string" + ] + }, + "title": "expand", + "type": [ + "array", + "string" + ] + }, "metadata": { "description": "", "title": "metadata", @@ -11109,6 +13834,13 @@ "description": "

You can see a list of the refunds belonging to a specific charge. Note that the 10 most recent refunds are always available by default on the charge object. If you need more than those 10, you can use this API method and the limit and starting_after parameters to page through additional refunds.

", "operationId": "AllChargeRefunds", "parameters": [ + { + "description": "Specifies which fields in the response should be expanded.", + "in": "query", + "name": "expand", + "required": false, + "type": "string" + }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100 items.", "in": "query", @@ -11188,6 +13920,9 @@ "title": "RefundList", "type": [ "object" + ], + "x-expandableFields": [ + ] } }, @@ -11231,6 +13966,19 @@ "string" ] }, + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "type": [ + "string" + ] + }, + "title": "expand", + "type": [ + "array", + "string" + ] + }, "metadata": { "description": "", "title": "metadata", @@ -11284,6 +14032,13 @@ "description": "", "operationId": "RetrieveChargeRefund", "parameters": [ + { + "description": "Specifies which fields in the response should be expanded.", + "in": "query", + "name": "expand", + "required": false, + "type": "string" + }, { "description": "ID of refund to retrieve.", "in": "path", @@ -11332,6 +14087,19 @@ "required": false, "schema": { "properties": { + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "type": [ + "string" + ] + }, + "title": "expand", + "type": [ + "array", + "string" + ] + }, "metadata": { "description": "A set of key/value pairs that you can attach to a refund object. It can be useful for storing additional information about the refund in a structured format.", "title": "metadata", @@ -11364,6 +14132,13 @@ "description": "

Lists all Country Spec objects available in the API.

", "operationId": "AllCountrySpecs", "parameters": [ + { + "description": "Specifies which fields in the response should be expanded.", + "in": "query", + "name": "expand", + "required": false, + "type": "string" + }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100 items.", "in": "query", @@ -11438,6 +14213,9 @@ ], "type": [ "object" + ], + "x-expandableFields": [ + ] } }, @@ -11455,6 +14233,13 @@ "description": "

Returns a Country Spec for a given Country code.

", "operationId": "RetrieveCountrySpec", "parameters": [ + { + "description": "Specifies which fields in the response should be expanded.", + "in": "query", + "name": "expand", + "required": false, + "type": "string" + }, { "description": "An ISO 3166-1 alpha-2 country code. Available country codes can be listed with the [List Country Specs](/docs/api#list_country_specs) endpoint.", "in": "path", @@ -11484,6 +14269,13 @@ "description": "

Returns a list of your coupons.

", "operationId": "AllCoupons", "parameters": [ + { + "description": "Specifies which fields in the response should be expanded.", + "in": "query", + "name": "expand", + "required": false, + "type": "string" + }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100 items.", "in": "query", @@ -11565,6 +14357,9 @@ ], "type": [ "object" + ], + "x-expandableFields": [ + ] } }, @@ -11615,6 +14410,19 @@ "integer" ] }, + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "type": [ + "string" + ] + }, + "title": "expand", + "type": [ + "array", + "string" + ] + }, "id": { "description": "Unique string of your choice that will be used to identify this coupon when applying it to a customer. This is often a specific code you'll give to your customer to use when signing up (e.g. *FALL25OFF*). If you don't want to specify a particular code, you can leave the ID blank and we'll generate a random code for you.", "title": "id", @@ -11684,6 +14492,29 @@ "name": "coupon", "required": true, "type": "string" + }, + { + "description": "Body parameters for the request.", + "in": "body", + "name": "payload", + "required": false, + "schema": { + "properties": { + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "type": [ + "string" + ] + }, + "title": "expand", + "type": [ + "array", + "string" + ] + } + } + } } ], "responses": { @@ -11705,6 +14536,13 @@ "description": "

Retrieves the coupon with the given ID.

", "operationId": "RetrieveCoupon", "parameters": [ + { + "description": "Specifies which fields in the response should be expanded.", + "in": "query", + "name": "expand", + "required": false, + "type": "string" + }, { "description": "The ID of the desired coupon.", "in": "path", @@ -11746,6 +14584,19 @@ "required": false, "schema": { "properties": { + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "type": [ + "string" + ] + }, + "title": "expand", + "type": [ + "array", + "string" + ] + }, "metadata": { "description": "A set of key/value pairs that you can attach to a coupon object. It can be useful for storing additional information about the coupon in a structured format.", "title": "metadata", @@ -11778,6 +14629,13 @@ "description": "

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

", "operationId": "AllCustomers", "parameters": [ + { + "description": "Specifies which fields in the response should be expanded.", + "in": "query", + "name": "expand", + "required": false, + "type": "string" + }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100 items.", "in": "query", @@ -11805,13 +14663,6 @@ "name": "created", "required": false, "type": "integer" - }, - { - "description": "", - "in": "query", - "name": "deleted", - "required": false, - "type": "boolean" } ], "responses": { @@ -11866,6 +14717,9 @@ ], "type": [ "object" + ], + "x-expandableFields": [ + ] } }, @@ -11923,11 +14777,17 @@ "string" ] }, - "max_occurrences": { - "description": "", - "title": "max_occurrences", + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "type": [ + "string" + ] + }, + "title": "expand", "type": [ - "integer" + "array", + "string" ] }, "metadata": { @@ -11937,27 +14797,6 @@ "object" ] }, - "on_behalf_of": { - "description": "", - "title": "on_behalf_of", - "type": [ - "string" - ] - }, - "pay_immediately": { - "description": "", - "title": "pay_immediately", - "type": [ - "boolean" - ] - }, - "retains_own_balance": { - "description": "", - "title": "retains_own_balance", - "type": [ - "boolean" - ] - }, "shipping": { "description": "", "title": "shipping", @@ -12004,6 +14843,29 @@ "name": "customer", "required": true, "type": "string" + }, + { + "description": "Body parameters for the request.", + "in": "body", + "name": "payload", + "required": false, + "schema": { + "properties": { + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "type": [ + "string" + ] + }, + "title": "expand", + "type": [ + "array", + "string" + ] + } + } + } } ], "responses": { @@ -12025,6 +14887,13 @@ "description": "

Retrieves the details of an existing customer. You need only supply the unique customer identifier that was returned upon customer creation.

", "operationId": "RetrieveCustomer", "parameters": [ + { + "description": "Specifies which fields in the response should be expanded.", + "in": "query", + "name": "expand", + "required": false, + "type": "string" + }, { "description": "The identifier of the customer to be retrieved.", "in": "path", @@ -12101,11 +14970,17 @@ "string" ] }, - "max_occurrences": { - "description": "", - "title": "max_occurrences", + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "type": [ + "string" + ] + }, + "title": "expand", "type": [ - "integer" + "array", + "string" ] }, "metadata": { @@ -12115,27 +14990,6 @@ "object" ] }, - "on_behalf_of": { - "description": "", - "title": "on_behalf_of", - "type": [ - "string" - ] - }, - "pay_immediately": { - "description": "", - "title": "pay_immediately", - "type": [ - "boolean" - ] - }, - "retains_own_balance": { - "description": "", - "title": "retains_own_balance", - "type": [ - "boolean" - ] - }, "shipping": { "description": "", "title": "shipping", @@ -12176,6 +15030,13 @@ "description": "", "operationId": "AllCustomerAlipayAccounts", "parameters": [ + { + "description": "Specifies which fields in the response should be expanded.", + "in": "query", + "name": "expand", + "required": false, + "type": "string" + }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100 items.", "in": "query", @@ -12255,6 +15116,9 @@ "title": "AlipayAccountList", "type": [ "object" + ], + "x-expandableFields": [ + ] } }, @@ -12274,9 +15138,22 @@ "description": "Body parameters for the request.", "in": "body", "name": "payload", - "required": false, + "required": true, "schema": { "properties": { + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "type": [ + "string" + ] + }, + "title": "expand", + "type": [ + "array", + "string" + ] + }, "metadata": { "description": "A set of key/value pairs that you can attach to a card object. It can be useful for storing additional information about the card in a structured format.", "title": "metadata", @@ -12326,6 +15203,29 @@ "name": "id", "required": true, "type": "string" + }, + { + "description": "Body parameters for the request.", + "in": "body", + "name": "payload", + "required": false, + "schema": { + "properties": { + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "type": [ + "string" + ] + }, + "title": "expand", + "type": [ + "array", + "string" + ] + } + } + } } ], "responses": { @@ -12347,6 +15247,13 @@ "description": "", "operationId": "RetrieveCustomerAlipayAccount", "parameters": [ + { + "description": "Specifies which fields in the response should be expanded.", + "in": "query", + "name": "expand", + "required": false, + "type": "string" + }, { "description": "The ID of the Alipay account to be retrieved.", "in": "path", @@ -12376,6 +15283,13 @@ "description": "

You can see a list of the bank accounts belonging to a Customer. Note that the 10 most recent sources are always available by default on the Customer. If you need more than those 10, you can use this API method and the limit and starting_after parameters to page through additional bank accounts.

", "operationId": "AllCustomerBankAccounts", "parameters": [ + { + "description": "Specifies which fields in the response should be expanded.", + "in": "query", + "name": "expand", + "required": false, + "type": "string" + }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100 items.", "in": "query", @@ -12455,6 +15369,9 @@ "title": "BankAccountList", "type": [ "object" + ], + "x-expandableFields": [ + ] } }, @@ -12474,9 +15391,22 @@ "description": "Body parameters for the request.", "in": "body", "name": "payload", - "required": false, + "required": true, "schema": { "properties": { + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "type": [ + "string" + ] + }, + "title": "expand", + "type": [ + "array", + "string" + ] + }, "metadata": { "description": "A set of key/value pairs that you can attach to a card object. It can be useful for storing additional information about the card in a structured format.", "title": "metadata", @@ -12526,6 +15456,29 @@ "name": "id", "required": true, "type": "string" + }, + { + "description": "Body parameters for the request.", + "in": "body", + "name": "payload", + "required": false, + "schema": { + "properties": { + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "type": [ + "string" + ] + }, + "title": "expand", + "type": [ + "array", + "string" + ] + } + } + } } ], "responses": { @@ -12547,6 +15500,13 @@ "description": "

By default, you can see the 10 most recent sources stored on a Customer directly on the object, but you can also retrieve details about a specific bank account stored on the Stripe account.

", "operationId": "RetrieveCustomerBankAccount", "parameters": [ + { + "description": "Specifies which fields in the response should be expanded.", + "in": "query", + "name": "expand", + "required": false, + "type": "string" + }, { "description": "ID of bank account to retrieve.", "in": "path", @@ -12637,13 +15597,6 @@ "string" ] }, - "cvc": { - "description": "", - "title": "cvc", - "type": [ - "string" - ] - }, "exp_month": { "description": "", "title": "exp_month", @@ -12658,6 +15611,19 @@ "string" ] }, + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "type": [ + "string" + ] + }, + "title": "expand", + "type": [ + "array", + "string" + ] + }, "metadata": { "description": "", "title": "metadata", @@ -12671,13 +15637,6 @@ "type": [ "string" ] - }, - "validate": { - "description": "", - "title": "validate", - "type": [ - "boolean" - ] } } } @@ -12732,6 +15691,19 @@ "array" ] }, + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "type": [ + "string" + ] + }, + "title": "expand", + "type": [ + "array", + "string" + ] + }, "verification_method": { "description": "", "title": "verification_method", @@ -12764,6 +15736,13 @@ "description": "", "operationId": "AllCustomerCards", "parameters": [ + { + "description": "Specifies which fields in the response should be expanded.", + "in": "query", + "name": "expand", + "required": false, + "type": "string" + }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100 items.", "in": "query", @@ -12843,6 +15822,9 @@ "title": "CardList", "type": [ "object" + ], + "x-expandableFields": [ + ] } }, @@ -12862,9 +15844,22 @@ "description": "Body parameters for the request.", "in": "body", "name": "payload", - "required": false, + "required": true, "schema": { "properties": { + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "type": [ + "string" + ] + }, + "title": "expand", + "type": [ + "array", + "string" + ] + }, "metadata": { "description": "A set of key/value pairs that you can attach to a card object. It can be useful for storing additional information about the card in a structured format.", "title": "metadata", @@ -12914,6 +15909,29 @@ "name": "id", "required": true, "type": "string" + }, + { + "description": "Body parameters for the request.", + "in": "body", + "name": "payload", + "required": false, + "schema": { + "properties": { + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "type": [ + "string" + ] + }, + "title": "expand", + "type": [ + "array", + "string" + ] + } + } + } } ], "responses": { @@ -12935,6 +15953,13 @@ "description": "", "operationId": "RetrieveCustomerCard", "parameters": [ + { + "description": "Specifies which fields in the response should be expanded.", + "in": "query", + "name": "expand", + "required": false, + "type": "string" + }, { "description": "The ID of the card to be retrieved.", "in": "path", @@ -13018,13 +16043,6 @@ "string" ] }, - "cvc": { - "description": "", - "title": "cvc", - "type": [ - "string" - ] - }, "exp_month": { "description": "", "title": "exp_month", @@ -13039,6 +16057,19 @@ "string" ] }, + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "type": [ + "string" + ] + }, + "title": "expand", + "type": [ + "array", + "string" + ] + }, "metadata": { "description": "", "title": "metadata", @@ -13052,13 +16083,6 @@ "type": [ "string" ] - }, - "validate": { - "description": "", - "title": "validate", - "type": [ - "boolean" - ] } } } @@ -13085,7 +16109,29 @@ "description": "

Removes the currently applied discount on a customer.

", "operationId": "DeleteCustomerDiscount", "parameters": [ - + { + "description": "Body parameters for the request.", + "in": "body", + "name": "payload", + "required": false, + "schema": { + "properties": { + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "type": [ + "string" + ] + }, + "title": "expand", + "type": [ + "array", + "string" + ] + } + } + } + } ], "responses": { "200": { @@ -13106,6 +16152,13 @@ "description": "", "operationId": "RetrieveCustomerDiscount", "parameters": [ + { + "description": "Specifies which fields in the response should be expanded.", + "in": "query", + "name": "expand", + "required": false, + "type": "string" + }, { "description": "", "in": "path", @@ -13135,6 +16188,13 @@ "description": "", "operationId": "AllCustomerSources", "parameters": [ + { + "description": "Specifies which fields in the response should be expanded.", + "in": "query", + "name": "expand", + "required": false, + "type": "string" + }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100 items.", "in": "query", @@ -13162,6 +16222,13 @@ "name": "customer", "required": true, "type": "string" + }, + { + "description": "", + "in": "query", + "name": "type", + "required": false, + "type": "string" } ], "responses": { @@ -13171,9 +16238,7 @@ "properties": { "data": { "items": { - "type": [ - "object" - ] + "$ref": "#/definitions/account_debit_account" }, "type": [ "array" @@ -13216,6 +16281,9 @@ "title": "SourceList", "type": [ "object" + ], + "x-expandableFields": [ + "data" ] } }, @@ -13235,9 +16303,22 @@ "description": "Body parameters for the request.", "in": "body", "name": "payload", - "required": false, + "required": true, "schema": { "properties": { + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "type": [ + "string" + ] + }, + "title": "expand", + "type": [ + "array", + "string" + ] + }, "metadata": { "description": "A set of key/value pairs that you can attach to a card object. It can be useful for storing additional information about the card in a structured format.", "title": "metadata", @@ -13287,6 +16368,29 @@ "name": "id", "required": true, "type": "string" + }, + { + "description": "Body parameters for the request.", + "in": "body", + "name": "payload", + "required": false, + "schema": { + "properties": { + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "type": [ + "string" + ] + }, + "title": "expand", + "type": [ + "array", + "string" + ] + } + } + } } ], "responses": { @@ -13308,6 +16412,13 @@ "description": "", "operationId": "RetrieveCustomerSource", "parameters": [ + { + "description": "Specifies which fields in the response should be expanded.", + "in": "query", + "name": "expand", + "required": false, + "type": "string" + }, { "description": "The ID of the source to be retrieved.", "in": "path", @@ -13391,13 +16502,6 @@ "string" ] }, - "cvc": { - "description": "", - "title": "cvc", - "type": [ - "string" - ] - }, "exp_month": { "description": "", "title": "exp_month", @@ -13412,6 +16516,19 @@ "string" ] }, + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "type": [ + "string" + ] + }, + "title": "expand", + "type": [ + "array", + "string" + ] + }, "metadata": { "description": "", "title": "metadata", @@ -13425,13 +16542,6 @@ "type": [ "string" ] - }, - "validate": { - "description": "", - "title": "validate", - "type": [ - "boolean" - ] } } } @@ -13486,6 +16596,19 @@ "array" ] }, + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "type": [ + "string" + ] + }, + "title": "expand", + "type": [ + "array", + "string" + ] + }, "verification_method": { "description": "", "title": "verification_method", @@ -13518,6 +16641,13 @@ "description": "

You can see a list of the customer’s active subscriptions. Note that the 10 most recent active subscriptions are always available by default on the customer object. If you need more than those 10, you can use the limit and starting_after parameters to page through additional subscriptions.

", "operationId": "AllCustomerSubscriptions", "parameters": [ + { + "description": "Specifies which fields in the response should be expanded.", + "in": "query", + "name": "expand", + "required": false, + "type": "string" + }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100 items.", "in": "query", @@ -13597,6 +16727,9 @@ "title": "SubscriptionList", "type": [ "object" + ], + "x-expandableFields": [ + ] } }, @@ -13626,27 +16759,13 @@ "required": false, "schema": { "properties": { - "account_balance": { - "description": "", - "title": "account_balance", - "type": [ - "integer" - ] - }, "application_fee_percent": { - "description": "A non-negative decimal (with at most two decimal places) between 0 and 100. 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 with an OAuth key 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).", + "description": "A non-negative decimal (with at most two decimal places) between 0 and 100. 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 with an OAuth key 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).", "title": "application_fee_percent", "type": [ "number" ] }, - "billing": { - "description": "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.", - "title": "billing", - "type": [ - "string" - ] - }, "coupon": { "description": "The code of the coupon to apply to this subscription. A coupon applied to a subscription will only affect invoices created for that particular subscription.", "title": "coupon", @@ -13654,11 +16773,17 @@ "string" ] }, - "days_until_due": { - "description": "Number of days a customer has to pay invoices generated by this subscription.", - "title": "days_until_due", + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "type": [ + "string" + ] + }, + "title": "expand", "type": [ - "integer" + "array", + "string" ] }, "items": { @@ -13675,13 +16800,6 @@ "object" ] }, - "on_behalf_of": { - "description": "", - "title": "on_behalf_of", - "type": [ - "string" - ] - }, "plan": { "description": "The identifier of the plan to subscribe the customer to.", "title": "plan", @@ -13689,13 +16807,6 @@ "string" ] }, - "prorate": { - "description": "", - "title": "prorate", - "type": [ - "boolean" - ] - }, "quantity": { "description": "The quantity you'd like to apply to the subscription you're creating. For example, if your plan is 10/user/month, and your customer has 5 users, you could pass 5 as the quantity to have the customer charged 50 (5 x 10) monthly. If you update a subscription but don't change the plan ID (e.g. changing only the trial_end), the subscription will inherit the old subscription's quantity attribute unless you pass a new quantity parameter. If you update a subscription and change the plan ID, the new subscription will not inherit the quantity attribute and will default to 1 unless you pass a quantity parameter.", "title": "quantity", @@ -13703,13 +16814,6 @@ "integer" ] }, - "retains_own_balance": { - "description": "", - "title": "retains_own_balance", - "type": [ - "boolean" - ] - }, "source": { "description": "The source can either be a token, like the ones returned by [Elements](https://stripe.com/docs/elements), or a dictionary containing a user's credit card details (with the options shown below). You must provide a source if the customer does not already have a valid source attached, and you are subscribing the customer for a plan that is not free. Passing `source` will create a new source object, make it the customer default source, and delete the old customer default if one exists. If you want to add an additional source to use with subscriptions, instead use the [card creation API](https://stripe.com/docs/api#create_card) to add the card and then the [customer update API](https://stripe.com/docs/api#update customer) to set it as the default. Whenever you attach a card to a customer, Stripe will automatically validate the card.", "title": "source", @@ -13778,6 +16882,19 @@ "type": [ "boolean" ] + }, + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "type": [ + "string" + ] + }, + "title": "expand", + "type": [ + "array", + "string" + ] } } } @@ -13802,7 +16919,13 @@ "description": "

Retrieves the subscription with the given ID.

", "operationId": "RetrieveCustomerSubscription", "parameters": [ - + { + "description": "Specifies which fields in the response should be expanded.", + "in": "query", + "name": "expand", + "required": false, + "type": "string" + } ], "responses": { "200": { @@ -13830,13 +16953,6 @@ "required": false, "schema": { "properties": { - "account_balance": { - "description": "", - "title": "account_balance", - "type": [ - "integer" - ] - }, "application_fee_percent": { "description": "A non-negative decimal (with at most two decimal places) between 0 and 100. 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 with an OAuth key 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')}).", "title": "application_fee_percent", @@ -13844,13 +16960,6 @@ "number" ] }, - "billing": { - "description": "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.", - "title": "billing", - "type": [ - "string" - ] - }, "coupon": { "description": "The code of the coupon to apply to this subscription. A coupon applied to a subscription will only affect invoices created for that particular subscription.", "title": "coupon", @@ -13858,11 +16967,17 @@ "string" ] }, - "days_until_due": { - "description": "Number of days a customer has to pay invoices generated by this subscription.", - "title": "days_until_due", + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "type": [ + "string" + ] + }, + "title": "expand", "type": [ - "integer" + "array", + "string" ] }, "items": { @@ -13872,13 +16987,6 @@ "array" ] }, - "max_occurrences": { - "description": "", - "title": "max_occurrences", - "type": [ - "integer" - ] - }, "metadata": { "description": "A set of key/value pairs that you can attach to a subscription object. It can be useful for storing additional information about the subscription in a structured format.", "title": "metadata", @@ -13886,13 +16994,6 @@ "object" ] }, - "pay_immediately": { - "description": "", - "title": "pay_immediately", - "type": [ - "boolean" - ] - }, "plan": { "description": "The identifier of the plan to update the subscription to. If omitted, the subscription will not change plans.", "title": "plan", @@ -13921,13 +17022,6 @@ "integer" ] }, - "retains_own_balance": { - "description": "", - "title": "retains_own_balance", - "type": [ - "boolean" - ] - }, "source": { "description": "The source can either be a token, like the ones returned by [Elements](https://stripe.com/docs/elements), or a dictionary containing a user's credit card details (with the options shown below). You must provide a source if the customer does not already have a valid source attached, and you are subscribing the customer for a plan that is not free. Passing `source` will create a new source object, make it the customer default source, and delete the old customer default if one exists. If you want to add an additional source to use with subscriptions, instead use the [card creation API](https://stripe.com/docs/api#create_card) to add the card and then the [customer update API](https://stripe.com/docs/api#update customer) to set it as the default. Whenever you attach a card to a customer, Stripe will automatically validate the card.", "title": "source", @@ -13976,7 +17070,29 @@ "description": "

Removes the currently applied discount on a customer.

", "operationId": "DeleteCustomerDiscount", "parameters": [ - + { + "description": "Body parameters for the request.", + "in": "body", + "name": "payload", + "required": false, + "schema": { + "properties": { + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "type": [ + "string" + ] + }, + "title": "expand", + "type": [ + "array", + "string" + ] + } + } + } + } ], "responses": { "200": { @@ -13997,6 +17113,13 @@ "description": "", "operationId": "RetrieveCustomerDiscount", "parameters": [ + { + "description": "Specifies which fields in the response should be expanded.", + "in": "query", + "name": "expand", + "required": false, + "type": "string" + }, { "description": "", "in": "path", @@ -14026,6 +17149,13 @@ "description": "

Returns a list of your disputes.

", "operationId": "AllDisputes", "parameters": [ + { + "description": "Specifies which fields in the response should be expanded.", + "in": "query", + "name": "expand", + "required": false, + "type": "string" + }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100 items.", "in": "query", @@ -14107,6 +17237,9 @@ ], "type": [ "object" + ], + "x-expandableFields": [ + ] } }, @@ -14124,6 +17257,13 @@ "description": "

Retrieves the dispute with the given ID.

", "operationId": "RetrieveDispute", "parameters": [ + { + "description": "Specifies which fields in the response should be expanded.", + "in": "query", + "name": "expand", + "required": false, + "type": "string" + }, { "description": "ID of dispute to retrieve.", "in": "path", @@ -14172,6 +17312,19 @@ "object" ] }, + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "type": [ + "string" + ] + }, + "title": "expand", + "type": [ + "array", + "string" + ] + }, "metadata": { "description": "A set of key/value pairs that you can attach to a dispute object. It can be useful for storing additional information about the dispute in a structured format.", "title": "metadata", @@ -14210,6 +17363,29 @@ "name": "dispute", "required": true, "type": "string" + }, + { + "description": "Body parameters for the request.", + "in": "body", + "name": "payload", + "required": false, + "schema": { + "properties": { + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "type": [ + "string" + ] + }, + "title": "expand", + "type": [ + "array", + "string" + ] + } + } + } } ], "responses": { @@ -14233,6 +17409,13 @@ "description": "

List events, going back up to 30 days.

", "operationId": "AllEvents", "parameters": [ + { + "description": "Specifies which fields in the response should be expanded.", + "in": "query", + "name": "expand", + "required": false, + "type": "string" + }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100 items.", "in": "query", @@ -14328,6 +17511,9 @@ ], "type": [ "object" + ], + "x-expandableFields": [ + ] } }, @@ -14345,6 +17531,13 @@ "description": "

Retrieves the details of an event. Supply the unique identifier of the event, which you might have received in a webhook.

", "operationId": "RetrieveEvent", "parameters": [ + { + "description": "Specifies which fields in the response should be expanded.", + "in": "query", + "name": "expand", + "required": false, + "type": "string" + }, { "description": "The identifier of the event to be retrieved.", "in": "path", @@ -14380,6 +17573,29 @@ "name": "id", "required": true, "type": "string" + }, + { + "description": "Body parameters for the request.", + "in": "body", + "name": "payload", + "required": false, + "schema": { + "properties": { + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "type": [ + "string" + ] + }, + "title": "expand", + "type": [ + "array", + "string" + ] + } + } + } } ], "responses": { @@ -14403,6 +17619,13 @@ "description": "

Returns a list of your invoice items. Invoice items are returned sorted by creation date, with the most recently created invoice items appearing first.

", "operationId": "AllInvoiceItems", "parameters": [ + { + "description": "Specifies which fields in the response should be expanded.", + "in": "query", + "name": "expand", + "required": false, + "type": "string" + }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100 items.", "in": "query", @@ -14491,6 +17714,9 @@ ], "type": [ "object" + ], + "x-expandableFields": [ + ] } }, @@ -14548,6 +17774,19 @@ "boolean" ] }, + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "type": [ + "string" + ] + }, + "title": "expand", + "type": [ + "array", + "string" + ] + }, "invoice": { "description": "The ID of an existing invoice to add this invoice item to. When left blank, the invoice item will be added to the next upcoming scheduled invoice. Use this when adding invoice items in response to an invoice.created webhook. You cannot add an invoice item to an invoice that has already been paid, attempted or closed.", "title": "invoice", @@ -14605,6 +17844,29 @@ "name": "invoiceitem", "required": true, "type": "string" + }, + { + "description": "Body parameters for the request.", + "in": "body", + "name": "payload", + "required": false, + "schema": { + "properties": { + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "type": [ + "string" + ] + }, + "title": "expand", + "type": [ + "array", + "string" + ] + } + } + } } ], "responses": { @@ -14626,6 +17888,13 @@ "description": "

Retrieves the invoice item with the given ID.

", "operationId": "RetrieveInvoiceItem", "parameters": [ + { + "description": "Specifies which fields in the response should be expanded.", + "in": "query", + "name": "expand", + "required": false, + "type": "string" + }, { "description": "The ID of the desired invoice item.", "in": "path", @@ -14681,6 +17950,19 @@ "boolean" ] }, + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "type": [ + "string" + ] + }, + "title": "expand", + "type": [ + "array", + "string" + ] + }, "metadata": { "description": "A set of key/value pairs that you can attach to an invoice item object. It can be useful for storing additional information about the invoice item in a structured format.", "title": "metadata", @@ -14713,6 +17995,13 @@ "description": "

You can list all invoices, or list the invoices for a specific customer. The invoices are returned sorted by creation date, with the most recently created invoices appearing first.

", "operationId": "AllInvoices", "parameters": [ + { + "description": "Specifies which fields in the response should be expanded.", + "in": "query", + "name": "expand", + "required": false, + "type": "string" + }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100 items.", "in": "query", @@ -14735,14 +18024,14 @@ "type": "string" }, { - "description": "The identifier of the customer whose invoices to return.", + "description": "Only return invoices for the customer specified by this customer ID.", "in": "query", "name": "customer", "required": false, "type": "string" }, { - "description": "The identifier of the subscription whose invoices to return.", + "description": "Only return invoices for the subscription specified by this subscription ID.", "in": "query", "name": "subscription", "required": false, @@ -14808,6 +18097,9 @@ ], "type": [ "object" + ], + "x-expandableFields": [ + ] } }, @@ -14827,7 +18119,7 @@ "description": "Body parameters for the request.", "in": "body", "name": "payload", - "required": false, + "required": true, "schema": { "properties": { "application_fee": { @@ -14837,13 +18129,6 @@ "integer" ] }, - "billing": { - "description": "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.", - "title": "billing", - "type": [ - "string" - ] - }, "customer": { "description": "", "title": "customer", @@ -14851,13 +18136,6 @@ "string" ] }, - "days_until_due": { - "description": "The number of days from which the invoice is created until it is due.", - "title": "days_until_due", - "type": [ - "integer" - ] - }, "description": { "description": "", "title": "description", @@ -14865,11 +18143,17 @@ "string" ] }, - "due_date": { - "description": "The date on which payment for this invoice is due.", - "title": "due_date", + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "type": [ + "string" + ] + }, + "title": "expand", "type": [ - "integer" + "array", + "string" ] }, "metadata": { @@ -14928,6 +18212,13 @@ "description": "

At any time, you can preview the upcoming invoice for a customer. This will show you all the charges that are pending, including subscription renewal charges, invoice item charges, etc. It will also show you any discount that is applicable to the customer.

Note that when you are viewing an upcoming invoice, you are simply viewing a preview – the invoice has not yet been created. As such, the upcoming invoice will not show up in invoice listing calls, and you cannot use the API to pay or edit the invoice. If you want to change the amount that your customer will be billed, you can add, remove, or update pending invoice items, or update the customer’s discount.

You can preview the effects of updating a subscription, including a preview of what proration will take place. To ensure that the actual proration is calculated exactly the same as the previewed proration, you should pass a proration_date parameter when doing the actual subscription update. The value passed in should be the same as the subscription_proration_date returned on the upcoming invoice resource. The recommended way to get only the prorations being previewed is to consider only proration line items where period[start] is equal to the subscription_proration_date on the upcoming invoice resource.

", "operationId": "RetrieveCustomerUpcomingInvoice", "parameters": [ + { + "description": "Specifies which fields in the response should be expanded.", + "in": "query", + "name": "expand", + "required": false, + "type": "string" + }, { "description": "The identifier of the customer whose upcoming invoice you'd like to retrieve.", "in": "query", @@ -15020,6 +18311,13 @@ "description": "

Retrieves the invoice with the given ID.

", "operationId": "RetrieveInvoice", "parameters": [ + { + "description": "Specifies which fields in the response should be expanded.", + "in": "query", + "name": "expand", + "required": false, + "type": "string" + }, { "description": "The identifier of the desired invoice.", "in": "path", @@ -15075,6 +18373,19 @@ "string" ] }, + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "type": [ + "string" + ] + }, + "title": "expand", + "type": [ + "array", + "string" + ] + }, "forgiven": { "description": "Boolean representing whether an invoice is forgiven or not. To forgive an invoice, pass true. Forgiving an invoice instructs us to update the subscription status as if the invoice were successfully paid. Once an invoice has been forgiven, it cannot be unforgiven or reopened.", "title": "forgiven", @@ -15089,13 +18400,6 @@ "object" ] }, - "paid": { - "description": "Boolean representing whether an invoice is paid or not. To mark invoice as paid, pass true.", - "title": "paid", - "type": [ - "boolean" - ] - }, "statement_descriptor": { "description": "Extra information about a charge for the customer's credit card statement.", "title": "statement_descriptor", @@ -15135,6 +18439,13 @@ "description": "

When retrieving an invoice, you’ll get a lines property containing the total count of line items and the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.

", "operationId": "AllInvoiceLines", "parameters": [ + { + "description": "Specifies which fields in the response should be expanded.", + "in": "query", + "name": "expand", + "required": false, + "type": "string" + }, { "description": "The maximum number of line items to return.", "in": "query", @@ -15284,6 +18595,9 @@ "title": "InvoiceLinesList", "type": [ "object" + ], + "x-expandableFields": [ + ] } }, @@ -15307,6 +18621,29 @@ "name": "invoice", "required": true, "type": "string" + }, + { + "description": "Body parameters for the request.", + "in": "body", + "name": "payload", + "required": false, + "schema": { + "properties": { + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "type": [ + "string" + ] + }, + "title": "expand", + "type": [ + "array", + "string" + ] + } + } + } } ], "responses": { @@ -15330,6 +18667,13 @@ "description": "

Returns a list of your order returns. The returns are returned sorted by creation date, with the most recently created return appearing first.

", "operationId": "AllOrderReturns", "parameters": [ + { + "description": "Specifies which fields in the response should be expanded.", + "in": "query", + "name": "expand", + "required": false, + "type": "string" + }, { "description": "The order to retrieve returns for.", "in": "query", @@ -15418,6 +18762,9 @@ ], "type": [ "object" + ], + "x-expandableFields": [ + ] } }, @@ -15435,6 +18782,13 @@ "description": "

Retrieves the details of an existing order return. Supply the unique order ID from either an order return creation request or the order return list, and Stripe will return the corresponding order information.

", "operationId": "RetrieveOrderReturn", "parameters": [ + { + "description": "Specifies which fields in the response should be expanded.", + "in": "query", + "name": "expand", + "required": false, + "type": "string" + }, { "description": "The identifier of the order return to be retrieved.", "in": "path", @@ -15464,6 +18818,13 @@ "description": "

Returns a list of your orders. The orders are returned sorted by creation date, with the most recently created orders appearing first.

", "operationId": "AllOrders", "parameters": [ + { + "description": "Specifies which fields in the response should be expanded.", + "in": "query", + "name": "expand", + "required": false, + "type": "string" + }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100 items.", "in": "query", @@ -15580,6 +18941,9 @@ ], "type": [ "object" + ], + "x-expandableFields": [ + ] } }, @@ -15630,6 +18994,19 @@ "string" ] }, + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "type": [ + "string" + ] + }, + "title": "expand", + "type": [ + "array", + "string" + ] + }, "items": { "description": "List of items constituting the order.", "title": "items", @@ -15679,6 +19056,13 @@ "description": "

Retrieves the details of an existing order. Supply the unique order ID from either an order creation request or the order list, and Stripe will return the corresponding order information.

", "operationId": "RetrieveOrder", "parameters": [ + { + "description": "Specifies which fields in the response should be expanded.", + "in": "query", + "name": "expand", + "required": false, + "type": "string" + }, { "description": "The identifier of the order to be retrieved.", "in": "path", @@ -15727,6 +19111,19 @@ "string" ] }, + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "type": [ + "string" + ] + }, + "title": "expand", + "type": [ + "array", + "string" + ] + }, "metadata": { "description": "A set of key/value pairs that you can attach to a product object. It can be useful for storing additional information about the order in a structured format.", "title": "metadata", @@ -15815,6 +19212,19 @@ "string" ] }, + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "type": [ + "string" + ] + }, + "title": "expand", + "type": [ + "array", + "string" + ] + }, "metadata": { "description": "A set of key/value pairs that you can attach to an order object. It can be useful for storing additional information about the order in a structured format.", "title": "metadata", @@ -15876,6 +19286,19 @@ "required": false, "schema": { "properties": { + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "type": [ + "string" + ] + }, + "title": "expand", + "type": [ + "array", + "string" + ] + }, "items": { "description": "List of items to return.", "title": "items", @@ -15908,6 +19331,13 @@ "description": "", "operationId": "AllPayments", "parameters": [ + { + "description": "Specifies which fields in the response should be expanded.", + "in": "query", + "name": "expand", + "required": false, + "type": "string" + }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100 items.", "in": "query", @@ -15996,6 +19426,9 @@ ], "type": [ "object" + ], + "x-expandableFields": [ + ] } }, @@ -16006,6 +19439,270 @@ } } } + }, + "post": { + "description": "", + "operationId": "CreatePayment", + "parameters": [ + { + "description": "Body parameters for the request.", + "in": "body", + "name": "payload", + "required": true, + "schema": { + "properties": { + "alternate_statement_descriptors": { + "description": "", + "title": "alternate_statement_descriptors", + "type": [ + "object" + ] + }, + "amount": { + "description": "", + "title": "amount", + "type": [ + "integer" + ] + }, + "application": { + "description": "", + "title": "application", + "type": [ + "string" + ] + }, + "application_fee": { + "description": "", + "title": "application_fee", + "type": [ + "integer" + ] + }, + "capture": { + "description": "", + "title": "capture", + "type": [ + "boolean" + ] + }, + "currency": { + "description": "", + "title": "currency", + "type": [ + "string" + ] + }, + "customer": { + "description": "", + "title": "customer", + "type": [ + "string" + ] + }, + "description": { + "description": "", + "title": "description", + "type": [ + "string" + ] + }, + "destination": { + "description": "", + "title": "destination", + "type": [ + "object" + ] + }, + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "type": [ + "string" + ] + }, + "title": "expand", + "type": [ + "array", + "string" + ] + }, + "external_id": { + "description": "", + "title": "external_id", + "type": [ + "string" + ] + }, + "idempotency_key": { + "description": "", + "title": "idempotency_key", + "type": [ + "string" + ] + }, + "invoice": { + "description": "", + "title": "invoice", + "type": [ + "string" + ] + }, + "invoice_source": { + "description": "", + "title": "invoice_source", + "type": [ + "string" + ] + }, + "ip": { + "description": "", + "title": "ip", + "type": [ + "string" + ] + }, + "level3": { + "description": "", + "title": "level3", + "type": [ + "object" + ] + }, + "metadata": { + "description": "", + "title": "metadata", + "type": [ + "object" + ] + }, + "on_behalf_of": { + "description": "", + "title": "on_behalf_of", + "type": [ + "string" + ] + }, + "order": { + "description": "", + "title": "order", + "type": [ + "string" + ] + }, + "payment_method": { + "description": "", + "title": "payment_method", + "type": [ + "string" + ] + }, + "payment_user_agent": { + "description": "", + "title": "payment_user_agent", + "type": [ + "string" + ] + }, + "receipt_email": { + "description": "", + "title": "receipt_email", + "type": [ + "string" + ] + }, + "recurring": { + "description": "", + "title": "recurring", + "type": [ + "boolean" + ] + }, + "referrer": { + "description": "", + "title": "referrer", + "type": [ + "string" + ] + }, + "shipping": { + "description": "", + "title": "shipping", + "type": [ + "object" + ] + }, + "source": { + "description": "", + "title": "source", + "type": [ + "string" + ] + }, + "statement_descriptor": { + "description": "", + "title": "statement_descriptor", + "type": [ + "string" + ] + }, + "three_d_secure": { + "description": "", + "title": "three_d_secure", + "type": [ + "object" + ] + }, + "transfer_group": { + "description": "", + "title": "transfer_group", + "type": [ + "string" + ] + }, + "trust": { + "description": "", + "title": "trust", + "type": [ + "object" + ] + }, + "uncaptured": { + "description": "", + "title": "uncaptured", + "type": [ + "boolean" + ] + }, + "user_agent": { + "description": "", + "title": "user_agent", + "type": [ + "string" + ] + } + }, + "required": [ + "amount", + "currency" + ] + } + } + ], + "responses": { + "200": { + "description": "Successful response.", + "schema": { + "$ref": "#/definitions/charge" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/error" + } + } + } } }, "/v1/payments/{payment}": { @@ -16013,6 +19710,13 @@ "description": "", "operationId": "RetrievePayment", "parameters": [ + { + "description": "Specifies which fields in the response should be expanded.", + "in": "query", + "name": "expand", + "required": false, + "type": "string" + }, { "description": "", "in": "path", @@ -16042,6 +19746,13 @@ "description": "

Returns a list of existing payouts sent to third-party bank accounts or that Stripe has sent you. The payouts are returned in sorted order, with the most recently created payouts appearing first.

", "operationId": "PayoutAll", "parameters": [ + { + "description": "Specifies which fields in the response should be expanded.", + "in": "query", + "name": "expand", + "required": false, + "type": "string" + }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100 items.", "in": "query", @@ -16145,6 +19856,9 @@ "title": "PayoutList", "type": [ "object" + ], + "x-expandableFields": [ + ] } }, @@ -16182,12 +19896,25 @@ ] }, "destination": { - "description": "The id of a bank account or a card to send the payout to. If no destination is supplied, the default external account for the specified currency will be used.", + "description": "The ID of a bank account or a card to send the payout to. If no destination is supplied, the default external account for the specified currency will be used.", "title": "destination", "type": [ "string" ] }, + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "type": [ + "string" + ] + }, + "title": "expand", + "type": [ + "array", + "string" + ] + }, "metadata": { "description": "A set of key/value pairs that you can attach to a payout object. It can be useful for storing additional information about the payout in a structured format.", "title": "metadata", @@ -16240,15 +19967,22 @@ } } }, - "/v1/payouts/{id}": { + "/v1/payouts/{payout}": { "get": { "description": "

Retrieves the details of an existing payout. Supply the unique payout ID from either a payout creation request or the payout list, and Stripe will return the corresponding payout information.

", "operationId": "PayoutRetrieve", "parameters": [ + { + "description": "Specifies which fields in the response should be expanded.", + "in": "query", + "name": "expand", + "required": false, + "type": "string" + }, { "description": "The identifier of the payout to be retrieved.", "in": "path", - "name": "id", + "name": "payout", "required": true, "type": "string" } @@ -16275,7 +20009,7 @@ { "description": "The identifier of the payout to be updated.", "in": "path", - "name": "id", + "name": "payout", "required": true, "type": "string" }, @@ -16286,6 +20020,19 @@ "required": false, "schema": { "properties": { + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "type": [ + "string" + ] + }, + "title": "expand", + "type": [ + "array", + "string" + ] + }, "metadata": { "description": "A set of key/value pairs that you can attach to a payout object. It can be useful for storing additional information about the payout in a structured format.", "title": "metadata", @@ -16313,7 +20060,7 @@ } } }, - "/v1/payouts/{id}/cancel": { + "/v1/payouts/{payout}/cancel": { "post": { "description": "

A previously created payout can be canceled if it has not yet been paid out. Funds will be refunded to your available balance, and the fees you were originally charged on the payout will be refunded. You may not cancel automatic Stripe payouts.

", "operationId": "PayoutCancel", @@ -16321,9 +20068,32 @@ { "description": "The identifier of the payout to be canceled.", "in": "path", - "name": "id", + "name": "payout", "required": true, "type": "string" + }, + { + "description": "Body parameters for the request.", + "in": "body", + "name": "payload", + "required": false, + "schema": { + "properties": { + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "type": [ + "string" + ] + }, + "title": "expand", + "type": [ + "array", + "string" + ] + } + } + } } ], "responses": { @@ -16347,6 +20117,13 @@ "description": "

Returns a list of your plans.

", "operationId": "AllPlans", "parameters": [ + { + "description": "Specifies which fields in the response should be expanded.", + "in": "query", + "name": "expand", + "required": false, + "type": "string" + }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100 items.", "in": "query", @@ -16428,6 +20205,9 @@ ], "type": [ "object" + ], + "x-expandableFields": [ + ] } }, @@ -16464,6 +20244,19 @@ "string" ] }, + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "type": [ + "string" + ] + }, + "title": "expand", + "type": [ + "array", + "string" + ] + }, "id": { "description": "Unique string of your choice that will be used to identify this plan when subscribing a customer. This could be an identifier like \"gold\" or a primary key from your own database.", "title": "id", @@ -16551,6 +20344,29 @@ "name": "plan", "required": true, "type": "string" + }, + { + "description": "Body parameters for the request.", + "in": "body", + "name": "payload", + "required": false, + "schema": { + "properties": { + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "type": [ + "string" + ] + }, + "title": "expand", + "type": [ + "array", + "string" + ] + } + } + } } ], "responses": { @@ -16572,6 +20388,13 @@ "description": "

Retrieves the plan with the given ID.

", "operationId": "RetrievePlan", "parameters": [ + { + "description": "Specifies which fields in the response should be expanded.", + "in": "query", + "name": "expand", + "required": false, + "type": "string" + }, { "description": "The ID of the desired plan.", "in": "path", @@ -16613,6 +20436,19 @@ "required": false, "schema": { "properties": { + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "type": [ + "string" + ] + }, + "title": "expand", + "type": [ + "array", + "string" + ] + }, "metadata": { "description": "A set of key/value pairs that you can attach to a plan object. It can be useful for storing additional information about the plan in a structured format.", "title": "metadata", @@ -16666,6 +20502,13 @@ "description": "

Returns a list of your products. The products are returned sorted by creation date, with the most recently created products appearing first.

", "operationId": "AllProducts", "parameters": [ + { + "description": "Specifies which fields in the response should be expanded.", + "in": "query", + "name": "expand", + "required": false, + "type": "string" + }, { "description": "Only return products that are active or inactive (e.g. pass `false` to list all inactive products).", "in": "query", @@ -16768,6 +20611,9 @@ ], "type": [ "object" + ], + "x-expandableFields": [ + ] } }, @@ -16825,6 +20671,19 @@ "string" ] }, + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "type": [ + "string" + ] + }, + "title": "expand", + "type": [ + "array", + "string" + ] + }, "id": { "description": "The identifier for the product. Must be unique. If not provided, an identifier will be randomly generated.", "title": "id", @@ -16908,6 +20767,29 @@ "name": "id", "required": true, "type": "string" + }, + { + "description": "Body parameters for the request.", + "in": "body", + "name": "payload", + "required": false, + "schema": { + "properties": { + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "type": [ + "string" + ] + }, + "title": "expand", + "type": [ + "array", + "string" + ] + } + } + } } ], "responses": { @@ -16929,6 +20811,13 @@ "description": "

Retrieves the details of an existing product. Supply the unique product ID from either a product creation request or the product list, and Stripe will return the corresponding product information.

", "operationId": "RetrieveProduct", "parameters": [ + { + "description": "Specifies which fields in the response should be expanded.", + "in": "query", + "name": "expand", + "required": false, + "type": "string" + }, { "description": "The identifier of the product to be retrieved.", "in": "path", @@ -17000,6 +20889,19 @@ "string" ] }, + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "type": [ + "string" + ] + }, + "title": "expand", + "type": [ + "array", + "string" + ] + }, "images": { "description": "A list of up to 8 URLs of images for this product, meant to be displayable to the customer.", "title": "images", @@ -17068,6 +20970,13 @@ "description": "

Returns a list of your recipients. The recipients are returned sorted by creation date, with the most recently created recipients appearing first.

", "operationId": "AllTransferRecipients", "parameters": [ + { + "description": "Specifies which fields in the response should be expanded.", + "in": "query", + "name": "expand", + "required": false, + "type": "string" + }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100 items.", "in": "query", @@ -17163,6 +21072,9 @@ ], "type": [ "object" + ], + "x-expandableFields": [ + ] } }, @@ -17185,48 +21097,6 @@ "required": true, "schema": { "properties": { - "address_city": { - "description": "", - "title": "address_city", - "type": [ - "string" - ] - }, - "address_country": { - "description": "", - "title": "address_country", - "type": [ - "string" - ] - }, - "address_line1": { - "description": "", - "title": "address_line1", - "type": [ - "string" - ] - }, - "address_line2": { - "description": "", - "title": "address_line2", - "type": [ - "string" - ] - }, - "address_state": { - "description": "", - "title": "address_state", - "type": [ - "string" - ] - }, - "address_zip": { - "description": "", - "title": "address_zip", - "type": [ - "string" - ] - }, "bank_account": { "description": "", "title": "bank_account", @@ -17250,27 +21120,6 @@ "string" ] }, - "dob_day": { - "description": "", - "title": "dob_day", - "type": [ - "integer" - ] - }, - "dob_month": { - "description": "", - "title": "dob_month", - "type": [ - "integer" - ] - }, - "dob_year": { - "description": "", - "title": "dob_year", - "type": [ - "integer" - ] - }, "email": { "description": "", "title": "email", @@ -17278,6 +21127,19 @@ "string" ] }, + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "type": [ + "string" + ] + }, + "title": "expand", + "type": [ + "array", + "string" + ] + }, "metadata": { "description": "", "title": "metadata", @@ -17341,6 +21203,29 @@ "name": "id", "required": true, "type": "string" + }, + { + "description": "Body parameters for the request.", + "in": "body", + "name": "payload", + "required": false, + "schema": { + "properties": { + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "type": [ + "string" + ] + }, + "title": "expand", + "type": [ + "array", + "string" + ] + } + } + } } ], "responses": { @@ -17362,6 +21247,13 @@ "description": "

Retrieves the details of an existing recipient. You need only supply the unique recipient identifier that was returned upon recipient creation.

", "operationId": "RetrieveTransferRecipient", "parameters": [ + { + "description": "Specifies which fields in the response should be expanded.", + "in": "query", + "name": "expand", + "required": false, + "type": "string" + }, { "description": "The identifier of the recipient to be retrieved.", "in": "path", @@ -17403,48 +21295,6 @@ "required": false, "schema": { "properties": { - "address_city": { - "description": "", - "title": "address_city", - "type": [ - "string" - ] - }, - "address_country": { - "description": "", - "title": "address_country", - "type": [ - "string" - ] - }, - "address_line1": { - "description": "", - "title": "address_line1", - "type": [ - "string" - ] - }, - "address_line2": { - "description": "", - "title": "address_line2", - "type": [ - "string" - ] - }, - "address_state": { - "description": "", - "title": "address_state", - "type": [ - "string" - ] - }, - "address_zip": { - "description": "", - "title": "address_zip", - "type": [ - "string" - ] - }, "bank_account": { "description": "", "title": "bank_account", @@ -17475,27 +21325,6 @@ "string" ] }, - "dob_day": { - "description": "", - "title": "dob_day", - "type": [ - "integer" - ] - }, - "dob_month": { - "description": "", - "title": "dob_month", - "type": [ - "integer" - ] - }, - "dob_year": { - "description": "", - "title": "dob_year", - "type": [ - "integer" - ] - }, "email": { "description": "", "title": "email", @@ -17503,6 +21332,19 @@ "string" ] }, + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "type": [ + "string" + ] + }, + "title": "expand", + "type": [ + "array", + "string" + ] + }, "metadata": { "description": "", "title": "metadata", @@ -17556,6 +21398,13 @@ "description": "", "operationId": "AllTransferRecipientCards", "parameters": [ + { + "description": "Specifies which fields in the response should be expanded.", + "in": "query", + "name": "expand", + "required": false, + "type": "string" + }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100 items.", "in": "query", @@ -17635,6 +21484,9 @@ "title": "CardList", "type": [ "object" + ], + "x-expandableFields": [ + ] } }, @@ -17654,7 +21506,7 @@ "description": "Body parameters for the request.", "in": "body", "name": "payload", - "required": false, + "required": true, "schema": { "properties": { "card": { @@ -17664,6 +21516,19 @@ "object", "string" ] + }, + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "type": [ + "string" + ] + }, + "title": "expand", + "type": [ + "array", + "string" + ] } }, "required": [ @@ -17706,6 +21571,29 @@ "name": "recipient", "required": true, "type": "string" + }, + { + "description": "Body parameters for the request.", + "in": "body", + "name": "payload", + "required": false, + "schema": { + "properties": { + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "type": [ + "string" + ] + }, + "title": "expand", + "type": [ + "array", + "string" + ] + } + } + } } ], "responses": { @@ -17727,6 +21615,13 @@ "description": "", "operationId": "RetrieveTransferRecipientCard", "parameters": [ + { + "description": "Specifies which fields in the response should be expanded.", + "in": "query", + "name": "expand", + "required": false, + "type": "string" + }, { "description": "ID of card to retrieve.", "in": "path", @@ -17824,6 +21719,19 @@ "string" ] }, + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "type": [ + "string" + ] + }, + "title": "expand", + "type": [ + "array", + "string" + ] + }, "name": { "description": "", "title": "name", @@ -17856,6 +21764,13 @@ "description": "

Returns a list of all refunds you’ve previously created. The refunds are returned in sorted order, with the most recent refunds appearing first. For convenience, the 10 most recent refunds are always available by default on the charge object.

", "operationId": "AllRefunds", "parameters": [ + { + "description": "Specifies which fields in the response should be expanded.", + "in": "query", + "name": "expand", + "required": false, + "type": "string" + }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100 items.", "in": "query", @@ -17937,6 +21852,9 @@ ], "type": [ "object" + ], + "x-expandableFields": [ + ] } }, @@ -17956,7 +21874,7 @@ "description": "Body parameters for the request.", "in": "body", "name": "payload", - "required": false, + "required": true, "schema": { "properties": { "amount": { @@ -17980,6 +21898,19 @@ "string" ] }, + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "type": [ + "string" + ] + }, + "title": "expand", + "type": [ + "array", + "string" + ] + }, "metadata": { "description": "", "title": "metadata", @@ -18036,6 +21967,13 @@ "description": "

Retrieves the details of an existing refund.

", "operationId": "RetrieveRefund", "parameters": [ + { + "description": "Specifies which fields in the response should be expanded.", + "in": "query", + "name": "expand", + "required": false, + "type": "string" + }, { "description": "ID of refund to retrieve.", "in": "path", @@ -18070,6 +22008,19 @@ "required": false, "schema": { "properties": { + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "type": [ + "string" + ] + }, + "title": "expand", + "type": [ + "array", + "string" + ] + }, "metadata": { "description": "A set of key/value pairs that you can attach to a refund object. It can be useful for storing additional information about the refund in a structured format.", "title": "metadata", @@ -18102,6 +22053,13 @@ "description": "

Returns a list of your SKUs. The SKUs are returned sorted by creation date, with the most recently created SKUs appearing first.

", "operationId": "AllSKUs", "parameters": [ + { + "description": "Specifies which fields in the response should be expanded.", + "in": "query", + "name": "expand", + "required": false, + "type": "string" + }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100 items.", "in": "query", @@ -18211,6 +22169,9 @@ ], "type": [ "object" + ], + "x-expandableFields": [ + ] } }, @@ -18254,6 +22215,19 @@ "string" ] }, + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "type": [ + "string" + ] + }, + "title": "expand", + "type": [ + "array", + "string" + ] + }, "id": { "description": "The identifier for the SKU. Must be unique. If not provided, an identifier will be randomly generated.", "title": "id", @@ -18275,13 +22249,6 @@ "object" ] }, - "inventory_last_updated": { - "description": "", - "title": "inventory_last_updated", - "type": [ - "integer" - ] - }, "metadata": { "description": "A set of key/value pairs that you can attach to a SKU object. It can be useful for storing additional information about the SKU in a structured format.", "title": "metadata", @@ -18347,6 +22314,29 @@ "name": "id", "required": true, "type": "string" + }, + { + "description": "Body parameters for the request.", + "in": "body", + "name": "payload", + "required": false, + "schema": { + "properties": { + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "type": [ + "string" + ] + }, + "title": "expand", + "type": [ + "array", + "string" + ] + } + } + } } ], "responses": { @@ -18368,6 +22358,13 @@ "description": "

Retrieves the details of an existing SKU. Supply the unique SKU identifier from either a SKU creation request or from the product, and Stripe will return the corresponding SKU information.

", "operationId": "RetrieveSKU", "parameters": [ + { + "description": "Specifies which fields in the response should be expanded.", + "in": "query", + "name": "expand", + "required": false, + "type": "string" + }, { "description": "The identifier of the SKU to be retrieved.", "in": "path", @@ -18423,6 +22420,19 @@ "string" ] }, + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "type": [ + "string" + ] + }, + "title": "expand", + "type": [ + "array", + "string" + ] + }, "image": { "description": "The URL of an image for this SKU, meant to be displayable to the customer.", "title": "image", @@ -18437,13 +22447,6 @@ "object" ] }, - "inventory_last_updated": { - "description": "", - "title": "inventory_last_updated", - "type": [ - "integer" - ] - }, "metadata": { "description": "A set of key/value pairs that you can attach to a SKU object. It can be useful for storing additional information about the SKU in a structured format.", "title": "metadata", @@ -18501,11 +22504,11 @@ "description": "Body parameters for the request.", "in": "body", "name": "payload", - "required": false, + "required": true, "schema": { "properties": { "amount": { - "description": "Amount associated with the source. This is the amount for which the source will be chargeable once ready. Required for `single-use` sources.", + "description": "Amount associated with the source. This is the amount for which the source will be chargeable once ready. Required for `single_use` sources.", "title": "amount", "type": [ "integer" @@ -18518,6 +22521,19 @@ "string" ] }, + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "type": [ + "string" + ] + }, + "title": "expand", + "type": [ + "array", + "string" + ] + }, "flow": { "description": "The authentication `flow` of the source to create. `flow` is one of `redirect`, `receiver`, `code_verification`, `none`. It is generally inferred unless a type supports multiple flows.", "title": "flow", @@ -18561,7 +22577,7 @@ ] }, "usage": { - "description": "One of `reusable`, `single-use`. Whether this source should be reusable or not. Some source types may or may not be reusable by construction, while other may leave the option at creation. If an incompatible value is passed, an error will be returned.", + "description": "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 other may leave the option at creation. If an incompatible value is passed, an error will be returned.", "title": "usage", "type": [ "string" @@ -18595,6 +22611,13 @@ "description": "

Retrieves an existing source object. Supply the unique source ID from a source creation request and Stripe will return the corresponding up-to-date source object information.

", "operationId": "RetrieveSource", "parameters": [ + { + "description": "Specifies which fields in the response should be expanded.", + "in": "query", + "name": "expand", + "required": false, + "type": "string" + }, { "description": "The identifier of the source to be retrieved.", "in": "path", @@ -18636,6 +22659,19 @@ "required": false, "schema": { "properties": { + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "type": [ + "string" + ] + }, + "title": "expand", + "type": [ + "array", + "string" + ] + }, "metadata": { "description": "A set of key/value pairs that you can attach to a source object. It can be useful for storing additional information about the source in a structured format.", "title": "metadata", @@ -18686,9 +22722,22 @@ "description": "Body parameters for the request.", "in": "body", "name": "payload", - "required": false, + "required": true, "schema": { "properties": { + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "type": [ + "string" + ] + }, + "title": "expand", + "type": [ + "array", + "string" + ] + }, "values": { "description": "The values needed to verify the source.", "title": "values", @@ -18724,6 +22773,13 @@ "description": "

Returns a list of your subscription items for a given subscription.

", "operationId": "AllSubscriptionItems", "parameters": [ + { + "description": "Specifies which fields in the response should be expanded.", + "in": "query", + "name": "expand", + "required": false, + "type": "string" + }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100 items.", "in": "query", @@ -18805,6 +22861,9 @@ ], "type": [ "object" + ], + "x-expandableFields": [ + ] } }, @@ -18827,6 +22886,19 @@ "required": true, "schema": { "properties": { + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "type": [ + "string" + ] + }, + "title": "expand", + "type": [ + "array", + "string" + ] + }, "plan": { "description": "The identifier of the plan to add to the subscription.", "title": "plan", @@ -18905,6 +22977,19 @@ "required": false, "schema": { "properties": { + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "type": [ + "string" + ] + }, + "title": "expand", + "type": [ + "array", + "string" + ] + }, "prorate": { "description": "Flag indicating whether to [prorate](/docs/subscriptions/upgrading-downgrading#understanding-proration) switching plans during a billing cycle.", "title": "prorate", @@ -18942,6 +23027,13 @@ "description": "

Retrieves the invoice item with the given ID.

", "operationId": "RetrieveSubscriptionItem", "parameters": [ + { + "description": "Specifies which fields in the response should be expanded.", + "in": "query", + "name": "expand", + "required": false, + "type": "string" + }, { "description": "The identifier of the subscription item to retrieve.", "in": "path", @@ -18983,6 +23075,19 @@ "required": false, "schema": { "properties": { + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "type": [ + "string" + ] + }, + "title": "expand", + "type": [ + "array", + "string" + ] + }, "plan": { "description": "The identifier of the new plan for this subscription item.", "title": "plan", @@ -19036,6 +23141,13 @@ "description": "

By default, returns a list of subscriptions that have not been canceled. In order to list canceled subscriptions, specify status=canceled.

", "operationId": "AllSubscriptions", "parameters": [ + { + "description": "Specifies which fields in the response should be expanded.", + "in": "query", + "name": "expand", + "required": false, + "type": "string" + }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100 items.", "in": "query", @@ -19138,6 +23250,9 @@ ], "type": [ "object" + ], + "x-expandableFields": [ + ] } }, @@ -19157,30 +23272,16 @@ "description": "Body parameters for the request.", "in": "body", "name": "payload", - "required": false, + "required": true, "schema": { "properties": { - "account_balance": { - "description": "", - "title": "account_balance", - "type": [ - "integer" - ] - }, "application_fee_percent": { - "description": "A non-negative decimal (with at most two decimal places) between 0 and 100. 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 with an OAuth key 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).", + "description": "A non-negative decimal (with at most two decimal places) between 0 and 100. 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 with an OAuth key 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).", "title": "application_fee_percent", "type": [ "number" ] }, - "billing": { - "description": "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.", - "title": "billing", - "type": [ - "string" - ] - }, "coupon": { "description": "The code of the coupon to apply to this subscription. A coupon applied to a subscription will only affect invoices created for that particular subscription.", "title": "coupon", @@ -19195,11 +23296,17 @@ "string" ] }, - "days_until_due": { - "description": "Number of days a customer has to pay invoices generated by this subscription.", - "title": "days_until_due", + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "type": [ + "string" + ] + }, + "title": "expand", "type": [ - "integer" + "array", + "string" ] }, "items": { @@ -19216,13 +23323,6 @@ "object" ] }, - "on_behalf_of": { - "description": "", - "title": "on_behalf_of", - "type": [ - "string" - ] - }, "plan": { "description": "The identifier of the plan to subscribe the customer to.", "title": "plan", @@ -19230,13 +23330,6 @@ "string" ] }, - "prorate": { - "description": "", - "title": "prorate", - "type": [ - "boolean" - ] - }, "quantity": { "description": "The quantity you'd like to apply to the subscription you're creating. For example, if your plan is 10/user/month, and your customer has 5 users, you could pass 5 as the quantity to have the customer charged 50 (5 x 10) monthly. If you update a subscription but don't change the plan ID (e.g. changing only the trial_end), the subscription will inherit the old subscription's quantity attribute unless you pass a new quantity parameter. If you update a subscription and change the plan ID, the new subscription will not inherit the quantity attribute and will default to 1 unless you pass a quantity parameter.", "title": "quantity", @@ -19244,13 +23337,6 @@ "integer" ] }, - "retains_own_balance": { - "description": "", - "title": "retains_own_balance", - "type": [ - "boolean" - ] - }, "source": { "description": "The source can either be a token, like the ones returned by [Elements](https://stripe.com/docs/elements), or a dictionary containing a user's credit card details (with the options shown below). You must provide a source if the customer does not already have a valid source attached, and you are subscribing the customer for a plan that is not free. Passing `source` will create a new source object, make it the customer default source, and delete the old customer default if one exists. If you want to add an additional source to use with subscriptions, instead use the [card creation API](https://stripe.com/docs/api#create_card) to add the card and then the [customer update API](https://stripe.com/docs/api#update customer) to set it as the default. Whenever you attach a card to a customer, Stripe will automatically validate the card.", "title": "source", @@ -19322,6 +23408,19 @@ "type": [ "boolean" ] + }, + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "type": [ + "string" + ] + }, + "title": "expand", + "type": [ + "array", + "string" + ] } } } @@ -19346,7 +23445,13 @@ "description": "

Retrieves the subscription with the given ID.

", "operationId": "RetrieveCustomerSubscription", "parameters": [ - + { + "description": "Specifies which fields in the response should be expanded.", + "in": "query", + "name": "expand", + "required": false, + "type": "string" + } ], "responses": { "200": { @@ -19374,13 +23479,6 @@ "required": false, "schema": { "properties": { - "account_balance": { - "description": "", - "title": "account_balance", - "type": [ - "integer" - ] - }, "application_fee_percent": { "description": "A non-negative decimal (with at most two decimal places) between 0 and 100. 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 with an OAuth key 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')}).", "title": "application_fee_percent", @@ -19388,13 +23486,6 @@ "number" ] }, - "billing": { - "description": "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.", - "title": "billing", - "type": [ - "string" - ] - }, "coupon": { "description": "The code of the coupon to apply to this subscription. A coupon applied to a subscription will only affect invoices created for that particular subscription.", "title": "coupon", @@ -19402,11 +23493,17 @@ "string" ] }, - "days_until_due": { - "description": "Number of days a customer has to pay invoices generated by this subscription.", - "title": "days_until_due", + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "type": [ + "string" + ] + }, + "title": "expand", "type": [ - "integer" + "array", + "string" ] }, "items": { @@ -19416,13 +23513,6 @@ "array" ] }, - "max_occurrences": { - "description": "", - "title": "max_occurrences", - "type": [ - "integer" - ] - }, "metadata": { "description": "A set of key/value pairs that you can attach to a subscription object. It can be useful for storing additional information about the subscription in a structured format.", "title": "metadata", @@ -19430,13 +23520,6 @@ "object" ] }, - "pay_immediately": { - "description": "", - "title": "pay_immediately", - "type": [ - "boolean" - ] - }, "plan": { "description": "The identifier of the plan to update the subscription to. If omitted, the subscription will not change plans.", "title": "plan", @@ -19465,13 +23548,6 @@ "integer" ] }, - "retains_own_balance": { - "description": "", - "title": "retains_own_balance", - "type": [ - "boolean" - ] - }, "source": { "description": "The source can either be a token, like the ones returned by [Elements](https://stripe.com/docs/elements), or a dictionary containing a user's credit card details (with the options shown below). You must provide a source if the customer does not already have a valid source attached, and you are subscribing the customer for a plan that is not free. Passing `source` will create a new source object, make it the customer default source, and delete the old customer default if one exists. If you want to add an additional source to use with subscriptions, instead use the [card creation API](https://stripe.com/docs/api#create_card) to add the card and then the [customer update API](https://stripe.com/docs/api#update customer) to set it as the default. Whenever you attach a card to a customer, Stripe will automatically validate the card.", "title": "source", @@ -19520,7 +23596,29 @@ "description": "

Removes the currently applied discount on a customer.

", "operationId": "DeleteCustomerDiscount", "parameters": [ - + { + "description": "Body parameters for the request.", + "in": "body", + "name": "payload", + "required": false, + "schema": { + "properties": { + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "type": [ + "string" + ] + }, + "title": "expand", + "type": [ + "array", + "string" + ] + } + } + } + } ], "responses": { "200": { @@ -19558,6 +23656,19 @@ "string" ] }, + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "type": [ + "string" + ] + }, + "title": "expand", + "type": [ + "array", + "string" + ] + }, "payment_user_agent": { "description": "", "title": "payment_user_agent", @@ -19597,6 +23708,13 @@ "description": "

Retrieves the token with the given ID.

", "operationId": "RetrieveToken", "parameters": [ + { + "description": "Specifies which fields in the response should be expanded.", + "in": "query", + "name": "expand", + "required": false, + "type": "string" + }, { "description": "The ID of the desired token.", "in": "path", @@ -19626,6 +23744,13 @@ "description": "

Returns a list of existing transfers sent to connected accounts. The transfers are returned in sorted order, with the most recently created transfers appearing first.

", "operationId": "AllTransfers", "parameters": [ + { + "description": "Specifies which fields in the response should be expanded.", + "in": "query", + "name": "expand", + "required": false, + "type": "string" + }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100 items.", "in": "query", @@ -19722,6 +23847,9 @@ "title": "TransferList", "type": [ "object" + ], + "x-expandableFields": [ + ] } }, @@ -19765,6 +23893,19 @@ "string" ] }, + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "type": [ + "string" + ] + }, + "title": "expand", + "type": [ + "array", + "string" + ] + }, "metadata": { "description": "", "title": "metadata", @@ -19796,7 +23937,8 @@ }, "required": [ "amount", - "currency" + "currency", + "destination" ] } } @@ -19822,6 +23964,13 @@ "description": "

Retrieves the details of an existing transfer. Supply the unique transfer ID from either a transfer creation request or the transfer list, and Stripe will return the corresponding transfer information.

", "operationId": "RetrieveTransfer", "parameters": [ + { + "description": "Specifies which fields in the response should be expanded.", + "in": "query", + "name": "expand", + "required": false, + "type": "string" + }, { "description": "The identifier of the transfer to be retrieved.", "in": "path", @@ -19863,6 +24012,19 @@ "required": false, "schema": { "properties": { + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "type": [ + "string" + ] + }, + "title": "expand", + "type": [ + "array", + "string" + ] + }, "metadata": { "description": "", "title": "metadata", @@ -19901,6 +24063,29 @@ "name": "id", "required": true, "type": "string" + }, + { + "description": "Body parameters for the request.", + "in": "body", + "name": "payload", + "required": false, + "schema": { + "properties": { + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "type": [ + "string" + ] + }, + "title": "expand", + "type": [ + "array", + "string" + ] + } + } + } } ], "responses": { @@ -19924,6 +24109,13 @@ "description": "

You can see a list of the reversals belonging to a specific transfer. Note that the 10 most recent reversals are always available by default on the transfer object. If you need more than those 10, you can use this API method and the limit and starting_after parameters to page through additional reversals.

", "operationId": "AllTransferReversals", "parameters": [ + { + "description": "Specifies which fields in the response should be expanded.", + "in": "query", + "name": "expand", + "required": false, + "type": "string" + }, { "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100 items.", "in": "query", @@ -20003,6 +24195,9 @@ "title": "TransferReversalList", "type": [ "object" + ], + "x-expandableFields": [ + ] } }, @@ -20046,6 +24241,19 @@ "string" ] }, + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "type": [ + "string" + ] + }, + "title": "expand", + "type": [ + "array", + "string" + ] + }, "metadata": { "description": "", "title": "metadata", @@ -20085,6 +24293,13 @@ "description": "

By default, you can see the 10 most recent reversals stored directly on the transfer object, but you can also retrieve details about a specific reversal stored on the transfer.

", "operationId": "RetrieveTransferReversal", "parameters": [ + { + "description": "Specifies which fields in the response should be expanded.", + "in": "query", + "name": "expand", + "required": false, + "type": "string" + }, { "description": "ID of the transfer reversed.", "in": "path", @@ -20140,6 +24355,19 @@ "required": false, "schema": { "properties": { + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "type": [ + "string" + ] + }, + "title": "expand", + "type": [ + "array", + "string" + ] + }, "metadata": { "description": "A set of key/value pairs that you can attach to a reversal object. It can be useful for storing additional information about the reversal in a structured format.", "title": "metadata", diff --git a/openapi/spec2.yaml b/openapi/spec2.yaml index 7d4db152..0bb8f279 100644 --- a/openapi/spec2.yaml +++ b/openapi/spec2.yaml @@ -4,10 +4,6 @@ consumes: definitions: account: properties: - active_payment_methods: - description: '' - type: - - array business_name: description: The publicly visible name of the business. type: @@ -53,8 +49,7 @@ definitions: properties: data: items: - type: - - object + "$ref": "#/definitions/bank_account" type: - array has_more: @@ -86,6 +81,8 @@ definitions: title: ExternalAccountList type: - object + x-expandableFields: + - data id: description: Unique identifier for the object. type: @@ -97,10 +94,6 @@ definitions: by your platform. Returns null if the account was not created by a platform. type: - boolean - mcc: - description: '' - type: - - string metadata: description: Set of key/value pairs that you can attach to an object. It can be useful for storing additional information about the object in a structured @@ -112,8 +105,6 @@ definitions: share the same value. type: - string - orders: - "$ref": "#/definitions/settings" payout_schedule: "$ref": "#/definitions/transfer_schedule" payout_statement_descriptor: @@ -158,7 +149,6 @@ definitions: verification: "$ref": "#/definitions/account_verification" required: - - active_payment_methods - charges_enabled - country - debit_negative_balances @@ -177,7 +167,27 @@ definitions: title: Account type: - object + x-expandableFields: [] x-resourceId: account + account_debit_account: + properties: + id: + description: Unique identifier for the object. + type: + - string + object: + description: String representing the object's type. Objects of the same type + share the same value. + type: + - string + required: + - id + - object + title: AccountDebitAccount + type: + - object + x-expandableFields: [] + x-resourceId: account_debit_account account_decline_charge_on: properties: avs_failure: @@ -198,6 +208,7 @@ definitions: title: AccountDeclineChargeOn type: - object + x-expandableFields: [] x-resourceId: account_decline_charge_on account_tos_acceptance: properties: @@ -218,6 +229,7 @@ definitions: title: AccountTOSAcceptance type: - object + x-expandableFields: [] x-resourceId: account_tos_acceptance account_verification: properties: @@ -246,13 +258,10 @@ definitions: title: AccountVerification type: - object + x-expandableFields: [] x-resourceId: account_verification account_with_keys: properties: - active_payment_methods: - description: '' - type: - - array business_name: description: The publicly visible name of the business. type: @@ -298,8 +307,7 @@ definitions: properties: data: items: - type: - - object + "$ref": "#/definitions/bank_account" type: - array has_more: @@ -331,6 +339,8 @@ definitions: title: ExternalAccountList type: - object + x-expandableFields: + - data id: description: Unique identifier for the object. type: @@ -346,10 +356,6 @@ definitions: by your platform. Returns null if the account was not created by a platform. type: - boolean - mcc: - description: '' - type: - - string metadata: description: Set of key/value pairs that you can attach to an object. It can be useful for storing additional information about the object in a structured @@ -361,8 +367,6 @@ definitions: share the same value. type: - string - orders: - "$ref": "#/definitions/settings" payout_schedule: "$ref": "#/definitions/transfer_schedule" payout_statement_descriptor: @@ -407,7 +411,6 @@ definitions: verification: "$ref": "#/definitions/account_verification" required: - - active_payment_methods - charges_enabled - country - debit_negative_balances @@ -427,6 +430,7 @@ definitions: title: AccountWithKeys type: - object + x-expandableFields: [] x-resourceId: account_with_keys address: properties: @@ -457,6 +461,7 @@ definitions: title: Address type: - object + x-expandableFields: [] x-resourceId: address alipay_account: properties: @@ -469,6 +474,9 @@ definitions: description: '' type: - string + x-expansionResources: + oneOf: + - "$ref": "#/definitions/customer" fingerprint: description: Uniquely identifies the account and will be the same across all Alipay account objects that are linked to the same Alipay account. @@ -531,6 +539,8 @@ definitions: title: AlipayAccount type: - object + x-expandableFields: + - customer x-resourceId: alipay_account apple_pay_domain: properties: @@ -566,27 +576,235 @@ definitions: title: ApplePayDomain type: - object + x-expandableFields: [] x-resourceId: apple_pay_domain - authorization_settings: + application: properties: - issuer: - description: '' + id: + description: Unique identifier for the object. type: - string - provider: - description: '' + name: + description: The name of the application. type: - string - type: - description: '' + object: + description: String representing the object's type. Objects of the same type + share the same value. type: - string required: - - type - title: AuthorizationSettings + - id + - object + title: Application type: - object - x-resourceId: authorization_settings + x-expandableFields: [] + x-resourceId: application + authorization: + properties: + amount: + description: '' + type: + - integer + balance_transactions: + items: + "$ref": "#/definitions/balance_transaction" + type: + - array + card: + description: '' + type: + - string + x-expansionResources: + oneOf: + - "$ref": "#/definitions/issued_card" + currency: + description: Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), + in lowercase. Must be a [supported currency](https://support.stripe.com/questions/which-currencies-does-stripe-support). + type: + - string + held_amount: + description: '' + type: + - integer + held_currency: + description: '' + type: + - string + id: + description: Unique identifier for the object. + type: + - string + merchant_data: + "$ref": "#/definitions/merchant_data" + metadata: + description: Set of key/value pairs that you can attach to an object. It can + be useful for storing additional information about the object in a structured + format. + type: + - object + object: + description: String representing the object's type. Objects of the same type + share the same value. + type: + - string + required: + - amount + - balance_transactions + - card + - currency + - held_amount + - held_currency + - id + - merchant_data + - metadata + - object + title: Authorization + type: + - object + x-expandableFields: + - card + x-resourceId: authorization + backwards_compatible_platform_earning: + properties: + account: + description: ID of the Stripe account this fee was taken from. + type: + - string + x-expansionResources: + oneOf: + - "$ref": "#/definitions/account" + amount: + description: Amount earned, in %s. + type: + - integer + amount_refunded: + description: Amount in %s refunded (can be less than the amount attribute + on the fee if a partial refund was issued) + type: + - integer + application: + description: ID of the Connect application that earned the fee. + type: + - string + x-expansionResources: + oneOf: + - "$ref": "#/definitions/application" + balance_transaction: + description: Balance transaction that describes the impact of this collected + application fee on your account balance (not including refunds). + type: + - string + x-expansionResources: + oneOf: + - "$ref": "#/definitions/balance_transaction" + charge: + description: ID of the charge that the application fee was taken from. + type: + - string + x-expansionResources: + oneOf: + - "$ref": "#/definitions/charge" + created: + description: Time at which the object was created. Measured in seconds since + the Unix epoch. + 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://support.stripe.com/questions/which-currencies-does-stripe-support). + type: + - string + id: + description: Unique identifier for the object. + type: + - string + livemode: + description: Flag indicating whether the object exists in live mode or test + mode. + type: + - boolean + object: + description: String representing the object's type. Objects of the same type + share the same value. + type: + - string + originating_transaction: + description: ID of the corresponding charge on the platform account, if this + fee was the result of a charge using the `destination` parameter. + type: + - string + x-expansionResources: + oneOf: + - "$ref": "#/definitions/charge" + - "$ref": "#/definitions/transfer" + refunded: + description: Whether or not the fee has been fully refunded. If the fee is + only partially refunded, this attribute will still be false. + type: + - boolean + refunds: + properties: + data: + items: + "$ref": "#/definitions/fee_refund" + 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 + total_count: + description: The total number of items available. This value is not included + by default, but you can request it by specifying ?include[]=total_count. + type: + - integer + url: + description: The URL where this list can be accessed. + type: + - string + required: + - data + - has_more + - object + - url + title: FeeRefundList + type: + - object + x-expandableFields: [] + required: + - account + - amount + - amount_refunded + - application + - balance_transaction + - charge + - created + - currency + - id + - livemode + - object + - refunded + - refunds + title: BackwardsCompatiblePlatformEarning + type: + - object + x-expandableFields: + - account + - application + - balance_transaction + - charge + - originating_transaction + x-resourceId: backwards_compatible_platform_earning balance: properties: available: @@ -625,6 +843,7 @@ definitions: title: Balance type: - object + x-expandableFields: [] x-resourceId: balance balance_transaction: properties: @@ -657,7 +876,10 @@ definitions: type: - integer fee_details: - "$ref": "#/definitions/fee" + items: + "$ref": "#/definitions/fee" + type: + - array id: description: Unique identifier for the object. type: @@ -675,6 +897,22 @@ definitions: description: The Stripe object this transaction is related to. type: - string + x-expansionResources: + oneOf: + - "$ref": "#/definitions/bitcoin_transaction" + - "$ref": "#/definitions/charge" + - "$ref": "#/definitions/dispute" + - "$ref": "#/definitions/fee_refund" + - "$ref": "#/definitions/authorization" + - "$ref": "#/definitions/transaction" + - "$ref": "#/definitions/legacy_transfer" + - "$ref": "#/definitions/payout" + - "$ref": "#/definitions/platform_fee" + - "$ref": "#/definitions/refund" + - "$ref": "#/definitions/reserve_transaction" + - "$ref": "#/definitions/transfer" + - "$ref": "#/definitions/transfer_recipient_transfer" + - "$ref": "#/definitions/transfer_reversal" status: description: If the transaction's net funds are available in the Stripe balance yet. Either `available` or `pending`. @@ -683,8 +921,8 @@ definitions: type: description: 'Transaction type: `adjustment`, `application_fee`, `application_fee_refund`, `charge`, `payment`, `payment_failure_refund`, `payment_refund`, `refund`, - `transfer`, `transfer_cancel`, `transfer_failure`, `transfer_refund`, or - `validation`.' + `transfer`, `transfer_refund`, `payout`, `payout_cancel`, `payout_failure`, + or `validation`.' type: - string required: @@ -702,6 +940,8 @@ definitions: title: BalanceTransaction type: - object + x-expandableFields: + - source x-resourceId: balance_transaction bank_account: properties: @@ -709,6 +949,9 @@ definitions: description: '' type: - string + x-expansionResources: + oneOf: + - "$ref": "#/definitions/account" account_holder_name: description: The name of the person or business that owns the bank account. type: @@ -718,30 +961,6 @@ definitions: `individual` or `company`. type: - string - address_city: - description: '' - type: - - string - address_line1: - description: '' - type: - - string - address_line2: - description: '' - type: - - string - address_state: - description: '' - type: - - string - address_zip: - description: '' - type: - - string - allows_debits: - description: '' - type: - - boolean bank_name: description: Name of the bank associated with the routing number, e.g. `WELLS FARGO`. @@ -761,10 +980,9 @@ definitions: description: '' type: - string - customer_reference: - description: '' - type: - - string + x-expansionResources: + oneOf: + - "$ref": "#/definitions/customer" default_for_currency: description: Whether this external account is the default account for its currency. @@ -794,10 +1012,6 @@ definitions: share the same value. type: - string - reusable: - description: '' - type: - - boolean routing_number: description: The routing transit number for the bank account. type: @@ -815,10 +1029,6 @@ definitions: and will not continue to send transfers until the bank details are updated. type: - string - used: - description: '' - type: - - boolean required: - country - currency @@ -829,6 +1039,9 @@ definitions: title: BankAccount type: - object + x-expandableFields: + - account + - customer x-resourceId: bank_account bitcoin_receiver: properties: @@ -961,6 +1174,7 @@ definitions: title: BitcoinTransactionList type: - object + x-expandableFields: [] uncaptured_funds: description: This receiver contains uncaptured funds that can be used for a payment or refunded. @@ -990,6 +1204,7 @@ definitions: title: BitcoinReceiver type: - object + x-expandableFields: [] x-resourceId: bitcoin_receiver bitcoin_transaction: properties: @@ -1036,6 +1251,7 @@ definitions: title: BitcoinTransaction type: - object + x-expandableFields: [] x-resourceId: bitcoin_transaction card: properties: @@ -1044,6 +1260,9 @@ definitions: in the card object if the card belongs to a customer or recipient instead. type: - string + x-expansionResources: + oneOf: + - "$ref": "#/definitions/account" address_city: description: City/District/Suburb/Town/Village. type: @@ -1106,6 +1325,9 @@ definitions: be in the card object if the card belongs to an account or recipient instead. type: - string + x-expansionResources: + oneOf: + - "$ref": "#/definitions/customer" cvc_check: description: 'If a CVC was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`.' @@ -1122,10 +1344,6 @@ definitions: account number." type: - string - estimated_availability: - description: '' - type: - - string exp_month: description: Two digit number representing the card's expiration month. type: @@ -1144,10 +1362,6 @@ definitions: description: Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`. type: - string - google_reference: - description: '' - type: - - string id: description: Unique identifier for the object. type: @@ -1176,10 +1390,9 @@ definitions: not be in the card object if the card belongs to a customer or account instead. type: - string - three_d_secure: - description: '' - type: - - object + x-expansionResources: + oneOf: + - "$ref": "#/definitions/transfer_recipient" tokenization_method: description: If the card number is tokenized, this is the method that was used. Can be `apple_pay` or `android_pay`. @@ -1197,15 +1410,11 @@ definitions: title: Card type: - object + x-expandableFields: + - account + - customer + - recipient x-resourceId: card - channel_settings: - properties: - twitter: - "$ref": "#/definitions/twitter_buy_now_settings" - title: ChannelSettings - type: - - object - x-resourceId: channel_settings charge: properties: amount: @@ -1215,14 +1424,6 @@ definitions: in charge currency](https://support.stripe.com/questions/what-is-the-minimum-amount-i-can-charge-with-stripe). type: - integer - amount_authorized: - description: '' - type: - - integer - amount_captured: - description: '' - type: - - integer amount_refunded: description: Amount in %s refunded (can be less than the amount attribute on the charge if a partial refund was issued). @@ -1232,23 +1433,31 @@ definitions: description: ID of the Connect application that created the charge. type: - string + x-expansionResources: + oneOf: + - "$ref": "#/definitions/application" application_fee: description: The application fee (if any) for the charge. [See the Connect documentation](/docs/connect/direct-charges#collecting-fees) for details. type: - string + x-expansionResources: + oneOf: + - "$ref": "#/definitions/backwards_compatible_platform_earning" + - "$ref": "#/definitions/platform_fee" balance_transaction: description: ID of the balance transaction that describes the impact of this charge on your account balance (not including refunds or disputes). type: - string + x-expansionResources: + oneOf: + - "$ref": "#/definitions/balance_transaction" captured: description: If the charge was created without capturing, this boolean represents whether or not it is still uncaptured or has since been captured. type: - boolean - card: - "$ref": "#/definitions/card" created: description: Time at which the object was created. Measured in seconds since the Unix epoch. @@ -1263,6 +1472,9 @@ definitions: description: ID of the customer this charge is for if one exists. type: - string + x-expansionResources: + oneOf: + - "$ref": "#/definitions/customer" description: description: An arbitrary string attached to the object. Often useful for displaying to users. @@ -1274,10 +1486,16 @@ definitions: for details. type: - string + x-expansionResources: + oneOf: + - "$ref": "#/definitions/account" dispute: description: Details about the dispute if the charge has been disputed. type: - string + x-expansionResources: + oneOf: + - "$ref": "#/definitions/dispute" failure_code: description: Error code explaining reason for charge failure if available (see [the errors section](/docs/api#errors) for a list of codes). @@ -1303,6 +1521,9 @@ definitions: description: ID of the invoice this charge is for if one exists. type: - string + x-expansionResources: + oneOf: + - "$ref": "#/definitions/invoice" livemode: description: Flag indicating whether the object exists in live mode or test mode. @@ -1325,10 +1546,16 @@ definitions: for details. type: - string + x-expansionResources: + oneOf: + - "$ref": "#/definitions/account" order: description: ID of the order this charge is for if one exists. type: - string + x-expansionResources: + oneOf: + - "$ref": "#/definitions/order" outcome: "$ref": "#/definitions/charge_outcome" paid: @@ -1387,10 +1614,14 @@ definitions: title: RefundList type: - object + x-expandableFields: [] review: description: ID of the review associated with this charge if one exists. type: - string + x-expansionResources: + oneOf: + - "$ref": "#/definitions/review" shipping: "$ref": "#/definitions/shipping" source_transfer: @@ -1399,6 +1630,9 @@ definitions: for details. type: - string + x-expansionResources: + oneOf: + - "$ref": "#/definitions/transfer" statement_descriptor: description: Extra information about a charge. This will appear on your customer's credit card statement. @@ -1414,6 +1648,9 @@ definitions: if the charge was created using the `destination` parameter). type: - string + x-expansionResources: + oneOf: + - "$ref": "#/definitions/transfer" transfer_group: description: A string that identifies this transaction as part of a group. See the [Connect documentation](/docs/connect/charges-transfers#grouping-transactions) @@ -1422,7 +1659,6 @@ definitions: - string required: - amount - - amount_captured - amount_refunded - captured - created @@ -1438,6 +1674,19 @@ definitions: title: Charge type: - object + x-expandableFields: + - application + - application_fee + - balance_transaction + - customer + - destination + - dispute + - invoice + - on_behalf_of + - order + - review + - source_transfer + - transfer x-resourceId: charge charge_outcome: properties: @@ -1466,6 +1715,9 @@ definitions: description: The ID of the Radar rule that matched the payment. type: - string + x-expansionResources: + oneOf: + - "$ref": "#/definitions/rule" seller_message: description: A human-readable description of the outcome type and reason, designed for you (the recipient of the payment), not your customer. @@ -1482,6 +1734,8 @@ definitions: title: ChargeOutcome type: - object + x-expandableFields: + - rule x-resourceId: charge_outcome country_spec: properties: @@ -1535,6 +1789,7 @@ definitions: title: CountrySpec type: - object + x-expandableFields: [] x-resourceId: country_spec coupon: properties: @@ -1620,6 +1875,7 @@ definitions: title: Coupon type: - object + x-expandableFields: [] x-resourceId: coupon customer: properties: @@ -1633,118 +1889,10 @@ definitions: subscriptions, invoices, invoice items). type: - integer - alipay_accounts: - properties: - data: - items: - "$ref": "#/definitions/alipay_account" - 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 - total_count: - description: The total number of items available. This value is not included - by default, but you can request it by specifying ?include[]=total_count. - type: - - integer - url: - description: The URL where this list can be accessed. - type: - - string - required: - - data - - has_more - - object - - url - title: AlipayAccountList - type: - - object - bank_accounts: - properties: - data: - items: - "$ref": "#/definitions/bank_account" - 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 - total_count: - description: The total number of items available. This value is not included - by default, but you can request it by specifying ?include[]=total_count. - type: - - integer - url: - description: The URL where this list can be accessed. - type: - - string - required: - - data - - has_more - - object - - url - title: BankAccountList - type: - - object business_vat_id: description: The customer's VAT identification number. type: - string - cards: - properties: - data: - items: - "$ref": "#/definitions/card" - 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 - total_count: - description: The total number of items available. This value is not included - by default, but you can request it by specifying ?include[]=total_count. - type: - - integer - url: - description: The URL where this list can be accessed. - type: - - string - required: - - data - - has_more - - object - - url - title: CardList - type: - - object created: description: Time at which the object was created. Measured in seconds since the Unix epoch. @@ -1755,18 +1903,18 @@ definitions: the customer can be charged in for recurring billing purposes. type: - string - default_bank_account: - description: '' - type: - - string - default_card: - description: '' - type: - - string default_source: description: ID of the default source attached to this customer. type: - string + x-expansionResources: + oneOf: + - "$ref": "#/definitions/account_debit_account" + - "$ref": "#/definitions/alipay_account" + - "$ref": "#/definitions/bank_account" + - "$ref": "#/definitions/bitcoin_receiver" + - "$ref": "#/definitions/card" + - "$ref": "#/definitions/source" delinquent: description: Whether or not the latest charge for the customer's latest invoice has failed. @@ -1809,8 +1957,7 @@ definitions: properties: data: items: - type: - - object + "$ref": "#/definitions/account_debit_account" type: - array has_more: @@ -1842,6 +1989,8 @@ definitions: title: SourceList type: - object + x-expandableFields: + - data subscriptions: properties: data: @@ -1878,9 +2027,9 @@ definitions: title: SubscriptionList type: - object + x-expandableFields: [] required: - account_balance - - cards - created - id - livemode @@ -1891,6 +2040,8 @@ definitions: title: Customer type: - object + x-expandableFields: + - default_source x-resourceId: customer customer_shipping: properties: @@ -1910,6 +2061,7 @@ definitions: title: CustomerShipping type: - object + x-expandableFields: [] x-resourceId: customer_shipping customer_source: properties: @@ -1917,6 +2069,9 @@ definitions: description: '' type: - string + x-expansionResources: + oneOf: + - "$ref": "#/definitions/customer" id: description: Unique identifier for the object. type: @@ -1938,6 +2093,15 @@ definitions: title: Polymorphic type: - object + x-expandableFields: + - customer + x-polymorphicResources: + oneOf: + - "$ref": "#/definitions/alipay_account" + - "$ref": "#/definitions/bank_account" + - "$ref": "#/definitions/bitcoin_receiver" + - "$ref": "#/definitions/card" + - "$ref": "#/definitions/source" x-resourceId: customer_source delivery_estimate: properties: @@ -1965,6 +2129,7 @@ definitions: title: DeliveryEstimate type: - object + x-expandableFields: [] x-resourceId: delivery_estimate discount: properties: @@ -1974,6 +2139,9 @@ definitions: description: '' type: - string + x-expansionResources: + oneOf: + - "$ref": "#/definitions/customer" end: description: If the coupon has a duration of `once` or `repeating`, the date that this discount will end. If the coupon used has a `forever` duration, @@ -2001,6 +2169,8 @@ definitions: title: Discount type: - object + x-expandableFields: + - customer x-resourceId: discount dispute: properties: @@ -2011,11 +2181,17 @@ definitions: type: - integer balance_transactions: - "$ref": "#/definitions/balance_transaction" + items: + "$ref": "#/definitions/balance_transaction" + type: + - array charge: description: ID of the charge that was disputed. type: - string + x-expansionResources: + oneOf: + - "$ref": "#/definitions/charge" created: description: Time at which the object was created. Measured in seconds since the Unix epoch. @@ -2093,6 +2269,8 @@ definitions: title: Dispute type: - object + x-expandableFields: + - charge x-resourceId: dispute error: description: An error response from the Stripe API. @@ -2140,7 +2318,7 @@ definitions: properties: api_version: description: 'The Stripe API version used to render `data`. *Note: this property - is populated for events on or after October 31, 2014.*.' + is populated for events on or after October 31, 2014*.' type: - string created: @@ -2174,7 +2352,7 @@ definitions: 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. *Note: this property is populated for events - on or after April 23, 2013.*.' + on or after April 23, 2013*.' type: - string type: @@ -2193,6 +2371,7 @@ definitions: title: Event type: - object + x-expandableFields: [] x-resourceId: event event_data: properties: @@ -2212,6 +2391,7 @@ definitions: title: EventData type: - object + x-expandableFields: [] x-resourceId: event_data external_account_source: properties: @@ -2219,26 +2399,9 @@ definitions: description: '' type: - string - address_city: - description: '' - type: - - string - address_line1: - description: '' - type: - - string - address_line2: - description: '' - type: - - string - address_state: - description: '' - type: - - string - address_zip: - description: '' - type: - - string + x-expansionResources: + oneOf: + - "$ref": "#/definitions/account" country: description: Two-letter ISO code representing the country the bank account is located in. @@ -2253,6 +2416,9 @@ definitions: description: '' type: - string + x-expansionResources: + oneOf: + - "$ref": "#/definitions/customer" default_for_currency: description: Whether this external account is the default account for its currency. @@ -2291,6 +2457,13 @@ definitions: title: Polymorphic type: - object + x-expandableFields: + - account + - customer + x-polymorphicResources: + oneOf: + - "$ref": "#/definitions/bank_account" + - "$ref": "#/definitions/card" x-resourceId: external_account_source fee: properties: @@ -2324,6 +2497,7 @@ definitions: title: Fee type: - object + x-expandableFields: [] x-resourceId: fee fee_refund: properties: @@ -2336,6 +2510,9 @@ definitions: balance. type: - string + x-expansionResources: + oneOf: + - "$ref": "#/definitions/balance_transaction" created: description: Time at which the object was created. Measured in seconds since the Unix epoch. @@ -2350,6 +2527,9 @@ definitions: description: ID of the application fee that was refunded. type: - string + x-expansionResources: + oneOf: + - "$ref": "#/definitions/platform_fee" id: description: Unique identifier for the object. type: @@ -2376,7 +2556,59 @@ definitions: title: FeeRefund type: - object + x-expandableFields: + - balance_transaction + - fee x-resourceId: fee_refund + file: + properties: + created: + description: Time at which the object was created. Measured in seconds since + the Unix epoch. + type: + - integer + id: + description: Unique identifier for the object. + type: + - string + object: + description: String representing the object's type. Objects of the same type + share the same value. + type: + - string + purpose: + description: The purpose of the uploaded file. Possible values are `business_logo`, + `dispute_evidence`, `identity_document`, `incorporation_article`, `incorporation_document`, + `invoice_statement`, `payment_provider_transfer`, or `product_feed`. + type: + - string + size: + description: The size in bytes of the file upload object. + type: + - integer + type: + description: 'The type of the file returned. Returns one of the following: + `pdf`, `xml`, `jpg`, `png`, `csv`, or `tsv`.' + type: + - string + url: + description: 'A read-only URL where the uploaded file can be accessed. Will + be nil unless the uploaded file has one of the following purposes: `business_logo`, + `dispute_evidence`, `incorporation_document`, `invoice_statement`, `payment_provider_transfer`, + or `product_feed`. Also nil if retrieved with the publishable API key.' + type: + - string + required: + - created + - id + - object + - purpose + - size + title: File + type: + - object + x-expandableFields: [] + x-resourceId: file inventory: properties: quantity: @@ -2400,6 +2632,7 @@ definitions: title: Inventory type: - object + x-expandableFields: [] x-resourceId: inventory invoice: properties: @@ -2433,17 +2666,13 @@ definitions: your users. type: - boolean - billing: - description: 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. - type: - - string charge: description: ID of the latest charge generated for this invoice, if any. type: - string + x-expansionResources: + oneOf: + - "$ref": "#/definitions/charge" closed: description: Whether or not the invoice is still trying to collect payment. An invoice is closed if it's either paid or it has been marked closed. A @@ -2459,6 +2688,9 @@ definitions: description: '' type: - string + x-expansionResources: + oneOf: + - "$ref": "#/definitions/customer" date: description: Time at which the object was created. Measured in seconds since the Unix epoch. @@ -2471,10 +2703,6 @@ definitions: - string discount: "$ref": "#/definitions/discount" - due_date: - description: The date on which payment for this invoice is due. - type: - - integer ending_balance: description: Ending customer balance after attempting to pay invoice. If the invoice has not been attempted yet, this will be null. @@ -2526,6 +2754,7 @@ definitions: title: InvoiceLinesList type: - object + x-expandableFields: [] livemode: description: Flag indicating whether the object exists in live mode or test mode. @@ -2541,11 +2770,6 @@ definitions: description: The time at which payment will next be attempted. type: - integer - number: - description: A unique, identifying string that appears on emails sent to the - customer for this invoice. - type: - - string object: description: String representing the object's type. Objects of the same type share the same value. @@ -2587,6 +2811,9 @@ definitions: description: The subscription that this invoice was prepared for, if any. type: - string + x-expansionResources: + oneOf: + - "$ref": "#/definitions/subscription" subscription_proration_date: description: Only set for upcoming invoices that preview prorations. The time used to calculate prorations. @@ -2642,6 +2869,10 @@ definitions: title: Invoice type: - object + x-expandableFields: + - charge + - customer + - subscription x-resourceId: invoice invoice_item: properties: @@ -2659,6 +2890,9 @@ definitions: is billed. type: - string + x-expansionResources: + oneOf: + - "$ref": "#/definitions/customer" date: description: '' type: @@ -2681,6 +2915,9 @@ definitions: description: The ID of the invoice this invoice item belongs to. type: - string + x-expansionResources: + oneOf: + - "$ref": "#/definitions/invoice" livemode: description: Flag indicating whether the object exists in live mode or test mode. @@ -2718,6 +2955,9 @@ definitions: if any. type: - string + x-expansionResources: + oneOf: + - "$ref": "#/definitions/subscription" subscription_item: description: '' type: @@ -2736,6 +2976,10 @@ definitions: title: InvoiceItem type: - object + x-expandableFields: + - customer + - invoice + - subscription x-resourceId: invoice_item invoice_line_item: properties: @@ -2825,7 +3069,52 @@ definitions: title: InvoiceLineItem type: - object + x-expandableFields: [] x-resourceId: invoice_line_item + issued_card: + properties: + available_balance: + description: '' + type: + - integer + card: + description: '' + type: + - string + x-expansionResources: + oneOf: + - "$ref": "#/definitions/card" + currency: + description: Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), + in lowercase. Must be a [supported currency](https://support.stripe.com/questions/which-currencies-does-stripe-support). + type: + - string + id: + description: Unique identifier for the object. + type: + - string + object: + description: String representing the object's type. Objects of the same type + share the same value. + type: + - string + status: + description: '' + type: + - string + required: + - available_balance + - card + - currency + - id + - object + - status + title: IssuedCard + type: + - object + x-expandableFields: + - card + x-resourceId: issued_card legacy_transfer: properties: amount: @@ -2841,11 +3130,17 @@ definitions: description: '' type: - string + x-expansionResources: + oneOf: + - "$ref": "#/definitions/backwards_compatible_platform_earning" balance_transaction: description: Balance transaction that describes the impact of this transfer on your account balance. type: - string + x-expansionResources: + oneOf: + - "$ref": "#/definitions/balance_transaction" created: description: Time at which the object was created. Measured in seconds since the Unix epoch. @@ -2870,11 +3165,19 @@ definitions: was sent to. type: - string + x-expansionResources: + oneOf: + - "$ref": "#/definitions/account" + - "$ref": "#/definitions/bank_account" + - "$ref": "#/definitions/card" destination_payment: description: If the destination is a Stripe account, this will be the ID of the payment that the destination account received for the transfer. type: - string + x-expansionResources: + oneOf: + - "$ref": "#/definitions/charge" failure_code: description: Error code explaining reason for transfer failure if available. See [Types of transfer failures](/docs/api#transfer_failures) for a list @@ -2890,10 +3193,6 @@ definitions: description: Unique identifier for the object. type: - string - legacy_date: - description: '' - type: - - integer livemode: description: Flag indicating whether the object exists in live mode or test mode. @@ -2953,6 +3252,7 @@ definitions: title: TransferReversalList type: - object + x-expandableFields: [] reversed: description: Whether or not the transfer has been fully reversed. If the transfer is only partially reversed, this attribute will still be false. @@ -2963,6 +3263,11 @@ definitions: the transfer. If null, the transfer was funded from the available balance. type: - string + x-expansionResources: + oneOf: + - "$ref": "#/definitions/charge" + - "$ref": "#/definitions/platform_fee" + - "$ref": "#/definitions/transfer_reversal" source_type: description: The source balance this transfer came from. One of `card`, `bank_account`, `bitcoin_receiver`, or `alipay_account`. @@ -3008,11 +3313,20 @@ definitions: title: LegacyTransfer type: - object + x-expandableFields: + - application_fee + - balance_transaction + - destination + - destination_payment + - source_transaction x-resourceId: legacy_transfer legal_entity: properties: additional_owners: - "$ref": "#/definitions/legal_entity_additional_owner" + items: + "$ref": "#/definitions/legal_entity_additional_owner" + type: + - array address: "$ref": "#/definitions/legal_entity_address" address_kana: @@ -3118,6 +3432,7 @@ definitions: title: LegalEntity type: - object + x-expandableFields: [] x-resourceId: legal_entity legal_entity_additional_owner: properties: @@ -3142,6 +3457,7 @@ definitions: title: LegalEntityAdditionalOwner type: - object + x-expandableFields: [] x-resourceId: legal_entity_additional_owner legal_entity_address: properties: @@ -3172,6 +3488,7 @@ definitions: title: LegalEntityAddress type: - object + x-expandableFields: [] x-resourceId: legal_entity_address legal_entity_dob: properties: @@ -3190,6 +3507,7 @@ definitions: title: LegalEntityDOB type: - object + x-expandableFields: [] x-resourceId: legal_entity_dob legal_entity_japan_address: properties: @@ -3224,6 +3542,7 @@ definitions: title: LegalEntityJapanAddress type: - object + x-expandableFields: [] x-resourceId: legal_entity_japan_address legal_entity_verification: properties: @@ -3247,6 +3566,9 @@ definitions: ID card." type: - string + x-expansionResources: + oneOf: + - "$ref": "#/definitions/file" status: description: The state of verification for this legal entity. Possible values are unverified, pending, or verified. @@ -3257,7 +3579,63 @@ definitions: title: LegalEntityVerification type: - object + x-expandableFields: + - document x-resourceId: legal_entity_verification + login_link: + properties: + created: + description: Time at which the object was created. Measured in seconds since + the Unix epoch. + type: + - integer + object: + description: String representing the object's type. Objects of the same type + share the same value. + type: + - string + url: + description: The URL for the login link. + type: + - string + required: + - created + - object + - url + title: LoginLink + type: + - object + x-expandableFields: [] + x-resourceId: login_link + merchant_data: + properties: + category: + description: '' + type: + - string + city: + description: '' + type: + - string + country: + description: '' + type: + - string + name: + description: '' + type: + - string + postal_code: + description: '' + type: + - string + required: + - category + title: MerchantData + type: + - object + x-expandableFields: [] + x-resourceId: merchant_data order: properties: amount: @@ -3283,6 +3661,9 @@ definitions: order status is `paid`, `fulfilled`, or `refunded`. type: - string + x-expansionResources: + oneOf: + - "$ref": "#/definitions/charge" created: description: Time at which the object was created. Measured in seconds since the Unix epoch. @@ -3297,6 +3678,9 @@ definitions: description: The customer used for the order. type: - string + x-expansionResources: + oneOf: + - "$ref": "#/definitions/customer" email: description: The email address of the customer placing the order. type: @@ -3363,6 +3747,7 @@ definitions: title: OrderReturnList type: - object + x-expandableFields: [] selected_shipping_method: description: 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 @@ -3403,6 +3788,9 @@ definitions: title: Order type: - object + x-expandableFields: + - charge + - customer x-resourceId: order order_item: properties: @@ -3432,6 +3820,10 @@ definitions: if not null (e.g., expandable to a SKU). type: - string + x-expansionResources: + oneOf: + - "$ref": "#/definitions/discount" + - "$ref": "#/definitions/sku" quantity: description: A positive integer representing the number of instances of `parent` that are included in this order item. Applicable/present only if `type` @@ -3451,23 +3843,9 @@ definitions: title: OrderItem type: - object + x-expandableFields: + - parent x-resourceId: order_item - order_management_settings: - properties: - provider: - description: '' - type: - - string - type: - description: '' - type: - - string - required: - - type - title: OrderManagementSettings - type: - - object - x-resourceId: order_management_settings order_return: properties: amount: @@ -3506,10 +3884,16 @@ definitions: description: The order that this return includes items from. type: - string + x-expansionResources: + oneOf: + - "$ref": "#/definitions/order" refund: description: The ID of the refund issued for this return. type: - string + x-expansionResources: + oneOf: + - "$ref": "#/definitions/refund" required: - amount - created @@ -3521,6 +3905,9 @@ definitions: title: OrderReturn type: - object + x-expandableFields: + - order + - refund x-resourceId: order_return package_dimensions: properties: @@ -3548,6 +3935,7 @@ definitions: title: PackageDimensions type: - object + x-expandableFields: [] x-resourceId: package_dimensions payout: properties: @@ -3566,6 +3954,9 @@ definitions: payout on your account balance. type: - string + x-expansionResources: + oneOf: + - "$ref": "#/definitions/balance_transaction" created: description: Time at which the object was created. Measured in seconds since the Unix epoch. @@ -3580,12 +3971,19 @@ definitions: description: ID of the bank account or card the payout was sent to. type: - string + x-expansionResources: + oneOf: + - "$ref": "#/definitions/bank_account" + - "$ref": "#/definitions/card" failure_balance_transaction: description: If the payout failed or was canceled, this will be the ID of the balance transaction that reversed the initial balance transaction, and puts the funds from the failed payout back in your balance. type: - string + x-expansionResources: + oneOf: + - "$ref": "#/definitions/balance_transaction" failure_code: description: Error code explaining reason for payout failure if available. See [Types of payout failures](/docs/api#payout_failures) for a list of @@ -3663,6 +4061,10 @@ definitions: title: Payout type: - object + x-expandableFields: + - balance_transaction + - destination + - failure_balance_transaction x-resourceId: payout plan: properties: @@ -3739,6 +4141,7 @@ definitions: title: Plan type: - object + x-expandableFields: [] x-resourceId: plan platform_earning: properties: @@ -3746,6 +4149,9 @@ definitions: description: ID of the Stripe account this fee was taken from. type: - string + x-expansionResources: + oneOf: + - "$ref": "#/definitions/account" amount: description: Amount earned, in %s. type: @@ -3759,15 +4165,24 @@ definitions: description: ID of the Connect application that earned the fee. type: - string + x-expansionResources: + oneOf: + - "$ref": "#/definitions/application" balance_transaction: description: Balance transaction that describes the impact of this collected application fee on your account balance (not including refunds). type: - string + x-expansionResources: + oneOf: + - "$ref": "#/definitions/balance_transaction" charge: description: ID of the charge that the application fee was taken from. type: - string + x-expansionResources: + oneOf: + - "$ref": "#/definitions/charge" created: description: Time at which the object was created. Measured in seconds since the Unix epoch. @@ -3797,6 +4212,10 @@ definitions: fee was the result of a charge using the `destination` parameter. type: - string + x-expansionResources: + oneOf: + - "$ref": "#/definitions/charge" + - "$ref": "#/definitions/transfer" refunded: description: Whether or not the fee has been fully refunded. If the fee is only partially refunded, this attribute will still be false. @@ -3838,6 +4257,7 @@ definitions: title: FeeRefundList type: - object + x-expandableFields: [] required: - account - amount @@ -3855,7 +4275,151 @@ definitions: title: PlatformEarning type: - object + x-expandableFields: + - account + - application + - balance_transaction + - charge + - originating_transaction x-resourceId: platform_earning + platform_fee: + properties: + account: + description: ID of the Stripe account this fee was taken from. + type: + - string + x-expansionResources: + oneOf: + - "$ref": "#/definitions/account" + amount: + description: Amount earned, in %s. + type: + - integer + amount_refunded: + description: '' + type: + - integer + application: + description: ID of the Connect Application that earned the fee. + type: + - string + x-expansionResources: + oneOf: + - "$ref": "#/definitions/application" + balance_transaction: + description: Balance transaction that describes the impact of this collected + application fee on your account balance (not including refunds). + type: + - string + x-expansionResources: + oneOf: + - "$ref": "#/definitions/balance_transaction" + charge: + description: ID of the charge that the application fee was taken from. + type: + - string + x-expansionResources: + oneOf: + - "$ref": "#/definitions/charge" + created: + description: Time at which the object was created. Measured in seconds since + the Unix epoch. + 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://support.stripe.com/questions/which-currencies-does-stripe-support). + type: + - string + id: + description: Unique identifier for the object. + type: + - string + livemode: + description: Flag indicating whether the object exists in live mode or test + mode. + type: + - boolean + object: + description: String representing the object's type. Objects of the same type + share the same value. + type: + - string + originating_transaction: + description: ID of the corresponding charge on the platform account, if this + fee was the result of a charge using the `destination` parameter. + type: + - string + x-expansionResources: + oneOf: + - "$ref": "#/definitions/charge" + - "$ref": "#/definitions/transfer" + refunded: + description: Whether or not the fee has been fully refunded. If the fee is + only partially refunded, this attribute will still be false. + type: + - boolean + refunds: + properties: + data: + items: + "$ref": "#/definitions/fee_refund" + 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 + total_count: + description: The total number of items available. This value is not included + by default, but you can request it by specifying ?include[]=total_count. + type: + - integer + url: + description: The URL where this list can be accessed. + type: + - string + required: + - data + - has_more + - object + - url + title: FeeRefundList + type: + - object + x-expandableFields: [] + required: + - account + - amount + - amount_refunded + - application + - balance_transaction + - charge + - created + - currency + - id + - livemode + - object + - refunded + - refunds + title: PlatformFee + type: + - object + x-expandableFields: + - account + - application + - balance_transaction + - charge + - originating_transaction + x-resourceId: platform_fee product: properties: active: @@ -3957,6 +4521,7 @@ definitions: title: SKUList type: - object + x-expandableFields: [] updated: description: '' type: @@ -3980,6 +4545,7 @@ definitions: title: Product type: - object + x-expandableFields: [] x-resourceId: product refund: properties: @@ -3992,10 +4558,16 @@ definitions: balance. type: - string + x-expansionResources: + oneOf: + - "$ref": "#/definitions/balance_transaction" charge: description: ID of the charge that was refunded. type: - string + x-expansionResources: + oneOf: + - "$ref": "#/definitions/charge" created: description: Time at which the object was created. Measured in seconds since the Unix epoch. @@ -4052,40 +4624,120 @@ definitions: title: Refund type: - object + x-expandableFields: + - balance_transaction + - charge x-resourceId: refund - settings: + reserve_transaction: properties: - authorization: - "$ref": "#/definitions/authorization_settings" - channels: - "$ref": "#/definitions/channel_settings" - create_order_hook_url: - description: URL that Stripe will call to prepare an order at creation time. - Present when shipping type, taxes, or order_management type is `dynamic`. + amount: + description: '' + 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://support.stripe.com/questions/which-currencies-does-stripe-support). type: - string - order_management: - "$ref": "#/definitions/order_management_settings" - pay_order_hook_url: - description: URL that Stripe will call to place an order at payment time. - Present when order_management type is `dynamic`, or authorization type is - `combined`. + description: + description: An arbitrary string attached to the object. Often useful for + displaying to users. + type: + - string + id: + description: Unique identifier for the object. + type: + - string + object: + description: String representing the object's type. Objects of the same type + share the same value. type: - string - shipping: - "$ref": "#/definitions/shipping_settings" - taxes: - "$ref": "#/definitions/tax_settings" required: - - authorization - - channels - - order_management - - shipping - - taxes - title: Settings + - amount + - currency + - id + - object + title: ReserveTransaction type: - object - x-resourceId: settings + x-expandableFields: [] + x-resourceId: reserve_transaction + review: + properties: + charge: + description: The charge associated with this review. + type: + - string + x-expansionResources: + oneOf: + - "$ref": "#/definitions/charge" + created: + description: Time at which the object was created. Measured in seconds since + the Unix epoch. + type: + - integer + id: + description: Unique identifier for the object. + type: + - string + livemode: + description: Flag indicating whether the object exists in live mode or test + mode. + type: + - boolean + object: + description: String representing the object's type. Objects of the same type + share the same value. + type: + - string + open: + description: If `true`, the review needs action. + type: + - boolean + reason: + description: The reason the review is currently open or closed. One of `rule`, + `manual`, `approved`, `refunded`, `refunded_as_fraud`, or `disputed`. + type: + - string + required: + - charge + - created + - id + - livemode + - object + - open + - reason + title: Review + type: + - object + x-expandableFields: + - charge + x-resourceId: review + rule: + properties: + action: + description: The action (`allow`, `block`, or `manual_review`) taken on the + payment. + type: + - string + id: + description: Unique identifier for the object. + type: + - string + predicate: + description: The predicate to evaluate the payment against. + type: + - string + required: + - action + - id + - predicate + title: Rule + type: + - object + x-expandableFields: [] + x-resourceId: rule shipping: properties: address: @@ -4115,6 +4767,7 @@ definitions: title: Shipping type: - object + x-expandableFields: [] x-resourceId: shipping shipping_method: properties: @@ -4148,83 +4801,8 @@ definitions: title: ShippingMethod type: - object + x-expandableFields: [] x-resourceId: shipping_method - shipping_settings: - properties: - amount: - description: '' - type: - - integer - currency: - description: Three-letter [ISO code for the currency](https://support.stripe.com/questions/which-currencies-does-stripe-support) - in which shipping cost will be assessed. Present when `type` is `flat_rate`. - type: - - string - description: - description: An arbitrary string attached to the object. Often useful for - displaying to users. - type: - - string - free_above: - description: The order amount (before taxes are calculated) above which shipping - is free. - type: - - integer - from_address: - "$ref": "#/definitions/address" - from_name: - description: Sender name to use when shipping through a provider. Present - when `type` is `provider`. - type: - - string - provider: - description: Shipping provider to use (eg, "USPS"). Present when `type` is - `provider`. - type: - - string - provider_url: - description: The provider's URL used to calculate shipping rates. If present, - `type` must be `provider`. - type: - - string - rates: - "$ref": "#/definitions/shipping_settings_rate" - type: - description: Shipping plan type. One of `free`, `flat_rate`, `provider`, `dynamic`. - type: - - string - required: - - type - title: ShippingSettings - type: - - object - x-resourceId: shipping_settings - shipping_settings_rate: - properties: - amount: - description: A positive integer in the smallest currency unit (that is, 100 - cents for $1.00, or 1 for ¥1, Japanese Yen being a 0-decimal currency) representing - the total amount for the line item. - 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://support.stripe.com/questions/which-currencies-does-stripe-support). - type: - - string - description: - description: An arbitrary string attached to the object. Often useful for - displaying to users. - type: - - string - required: - - amount - - currency - - description - title: ShippingSettingsRate - type: - - object - x-resourceId: shipping_settings_rate sku: properties: active: @@ -4288,6 +4866,9 @@ definitions: must be currently active. type: - string + x-expansionResources: + oneOf: + - "$ref": "#/definitions/product" updated: description: '' type: @@ -4308,12 +4889,14 @@ definitions: title: SKU type: - object + x-expandableFields: + - product x-resourceId: sku source: properties: amount: description: Amount associated with the source. This is the amount for which - the source will be chargeable once ready. Required for `single-use` sources. + the source will be chargeable once ready. Required for `single_use` sources. type: - integer client_secret: @@ -4331,7 +4914,7 @@ definitions: currency: description: Three-letter [ISO code for the currency](https://support.stripe.com/questions/which-currencies-does-stripe-support) associated with the source. This is the currency for which the source will - be chargeable once ready. Required for `single-use` sources. + be chargeable once ready. Required for `single_use` sources. type: - string flow: @@ -4378,8 +4961,8 @@ definitions: type: - string usage: - description: One of `reusable`, `single-use`. Whether this source should be - reusable or not. Some source types may or may not be reusable by construction, + description: 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 other may leave the option at creation. If an incompatible value is passed, an error will be returned. type: @@ -4396,6 +4979,7 @@ definitions: title: Source type: - object + x-expandableFields: [] x-resourceId: source source_code_verification_flow: properties: @@ -4415,6 +4999,7 @@ definitions: title: SourceCodeVerificationFlow type: - object + x-expandableFields: [] x-resourceId: source_code_verification_flow source_owner: properties: @@ -4449,6 +5034,7 @@ definitions: title: SourceOwner type: - object + x-expandableFields: [] x-resourceId: source_owner source_receiver_flow: properties: @@ -4480,6 +5066,7 @@ definitions: title: SourceReceiverFlow type: - object + x-expandableFields: [] x-resourceId: source_receiver_flow source_redirect_flow: properties: @@ -4505,6 +5092,7 @@ definitions: title: SourceRedirectFlow type: - object + x-expandableFields: [] x-resourceId: source_redirect_flow status_transitions: properties: @@ -4527,26 +5115,16 @@ definitions: title: StatusTransitions type: - object + x-expandableFields: [] x-resourceId: status_transitions subscription: properties: - account_balance: - description: '' - type: - - integer application_fee_percent: description: A non-negative decimal (with at most two decimal places) between 0 and 100. This represents the percentage of the subscription invoice subtotal that will be transferred to the application owner's Stripe account. type: - number - billing: - description: 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. - type: - - string cancel_at_period_end: description: 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. @@ -4582,11 +5160,9 @@ definitions: description: ID of the customer who owns the subscription. type: - string - days_until_due: - description: Number of days a customer has to pay invoices generated by this - subscription. - type: - - integer + x-expansionResources: + oneOf: + - "$ref": "#/definitions/customer" discount: "$ref": "#/definitions/discount" ended_at: @@ -4635,15 +5211,12 @@ definitions: title: SubscriptionItemList type: - object + x-expandableFields: [] livemode: description: Flag indicating whether the object exists in live mode or test mode. type: - boolean - max_occurrences: - description: '' - type: - - integer metadata: description: Set of key/value pairs that you can attach to an object. It can be useful for storing additional information about the object in a structured @@ -4655,11 +5228,6 @@ definitions: share the same value. type: - string - on_behalf_of: - description: The account (if any) the charge was made on behalf of for charges - associated with this subscription. See the Connect documentation for details. - type: - - string plan: "$ref": "#/definitions/plan" quantity: @@ -4669,10 +5237,6 @@ definitions: monthly. type: - integer - retains_own_balance: - description: '' - type: - - boolean start: description: Date the most recent update to this subscription started. type: @@ -4717,6 +5281,8 @@ definitions: title: Subscription type: - object + x-expandableFields: + - customer x-resourceId: subscription subscription_item: properties: @@ -4750,37 +5316,8 @@ definitions: title: SubscriptionItem type: - object + x-expandableFields: [] x-resourceId: subscription_item - tax_settings: - properties: - description: - description: An arbitrary string attached to the object. Often useful for - displaying to users. - type: - - string - provider: - description: Tax provider to use. Present when `type` is `provider`. - type: - - string - provider_url: - description: The provider's URL used to calculate taxes. If present, `type` - must be `provider`. - type: - - string - rate: - description: Tax rate, expressed as a percentage. Present when `type` is `percentage`. - type: - - number - type: - description: Tax plan type. One of `included`, `flat_rate`, `provider`, `dynamic`. - type: - - string - required: - - type - title: TaxSettings - type: - - object - x-resourceId: tax_settings three_d_secure: properties: amount: @@ -4846,6 +5383,7 @@ definitions: title: ThreeDSecure type: - object + x-expandableFields: [] x-resourceId: three_d_secure token: properties: @@ -4880,10 +5418,6 @@ definitions: description: 'Type of the token: `card` or `bank_account`.' type: - string - usage: - description: '' - type: - - string used: description: Whether or not this token has already been used (tokens can be used only once). @@ -4899,6 +5433,7 @@ definitions: title: Token type: - object + x-expandableFields: [] x-resourceId: token token_bank_account: properties: @@ -4911,30 +5446,6 @@ definitions: `individual` or `company`. type: - string - address_city: - description: '' - type: - - string - address_line1: - description: '' - type: - - string - address_line2: - description: '' - type: - - string - address_state: - description: '' - type: - - string - address_zip: - description: '' - type: - - string - allows_debits: - description: '' - type: - - boolean bank_name: description: Name of the bank associated with the routing number, e.g. `WELLS FARGO`. @@ -4968,10 +5479,6 @@ definitions: share the same value. type: - string - reusable: - description: '' - type: - - boolean routing_number: description: The routing transit number for the bank account. type: @@ -4989,10 +5496,6 @@ definitions: and will not continue to send transfers until the bank details are updated. type: - string - used: - description: '' - type: - - boolean required: - country - currency @@ -5003,6 +5506,7 @@ definitions: title: TokenBankAccount type: - object + x-expandableFields: [] x-resourceId: token_bank_account token_card: properties: @@ -5084,10 +5588,6 @@ definitions: description: Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`. type: - string - google_reference: - description: '' - type: - - string id: description: Unique identifier for the object. type: @@ -5111,10 +5611,6 @@ definitions: share the same value. type: - string - three_d_secure: - description: '' - type: - - object tokenization_method: description: If the card number is tokenized, this is the method that was used. Can be `apple_pay` or `android_pay`. @@ -5132,7 +5628,72 @@ definitions: title: TokenCard type: - object + x-expandableFields: [] x-resourceId: token_card + transaction: + properties: + amount: + description: '' + type: + - integer + authorization: + description: '' + type: + - string + x-expansionResources: + oneOf: + - "$ref": "#/definitions/authorization" + balance_transaction: + description: '' + type: + - string + x-expansionResources: + oneOf: + - "$ref": "#/definitions/balance_transaction" + card: + description: '' + type: + - string + x-expansionResources: + oneOf: + - "$ref": "#/definitions/issued_card" + currency: + description: Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), + in lowercase. Must be a [supported currency](https://support.stripe.com/questions/which-currencies-does-stripe-support). + type: + - string + id: + description: Unique identifier for the object. + type: + - string + merchant_data: + "$ref": "#/definitions/merchant_data" + object: + description: String representing the object's type. Objects of the same type + share the same value. + type: + - string + type: + description: '' + type: + - string + required: + - amount + - balance_transaction + - card + - currency + - id + - merchant_data + - object + - type + title: Transaction + type: + - object + x-expandableFields: + - authorization + - balance_transaction + - card + x-resourceId: transaction transfer: properties: amount: @@ -5149,6 +5710,9 @@ definitions: on your account balance. type: - string + x-expansionResources: + oneOf: + - "$ref": "#/definitions/balance_transaction" created: description: Time that this record of the transfer was first created. type: @@ -5162,11 +5726,17 @@ definitions: description: ID of the Stripe account the transfer was sent to. type: - string + x-expansionResources: + oneOf: + - "$ref": "#/definitions/account" destination_payment: description: If the destination is a Stripe account, this will be the ID of the payment that the destination account received for the transfer. type: - string + x-expansionResources: + oneOf: + - "$ref": "#/definitions/charge" id: description: Unique identifier for the object. type: @@ -5223,11 +5793,20 @@ definitions: title: TransferReversalList type: - object + x-expandableFields: [] reversed: description: Whether or not the transfer has been fully reversed. If the transfer is only partially reversed, this attribute will still be false. type: - boolean + source_transaction: + description: ID of the charge or payment that was used to fund the transfer. + If null, the transfer was funded from the available balance. + type: + - string + x-expansionResources: + oneOf: + - "$ref": "#/definitions/charge" source_type: description: '' type: @@ -5252,6 +5831,11 @@ definitions: title: Transfer type: - object + x-expandableFields: + - balance_transaction + - destination + - destination_payment + - source_transaction x-resourceId: transfer transfer_recipient: properties: @@ -5293,6 +5877,7 @@ definitions: title: CardList type: - object + x-expandableFields: [] created: description: Time at which the object was created. Measured in seconds since the Unix epoch. @@ -5302,6 +5887,9 @@ definitions: description: The default card to use for creating transfers to this recipient. type: - string + x-expansionResources: + oneOf: + - "$ref": "#/definitions/card" description: description: An arbitrary string attached to the object. Often useful for displaying to users. @@ -5332,6 +5920,9 @@ definitions: nor can transfers be made to it: use the managed account instead.' type: - string + x-expansionResources: + oneOf: + - "$ref": "#/definitions/account" name: description: Full, legal name of the recipient. type: @@ -5341,14 +5932,6 @@ definitions: share the same value. type: - string - tin: - description: '' - type: - - string - tin_verification_pending: - description: '' - type: - - boolean type: description: Type of the recipient, one of `individual` or `corporation`. type: @@ -5359,12 +5942,219 @@ definitions: - livemode - metadata - object - - tin_verification_pending - type title: TransferRecipient type: - object + x-expandableFields: + - default_card + - migrated_to x-resourceId: transfer_recipient + transfer_recipient_transfer: + properties: + amount: + description: Amount (in %s) to be transferred to your bank account. + type: + - integer + amount_reversed: + description: Amount in %s reversed (can be less than the amount attribute + on the transfer if a partial reversal was issued). + type: + - integer + application_fee: + description: '' + type: + - string + x-expansionResources: + oneOf: + - "$ref": "#/definitions/backwards_compatible_platform_earning" + balance_transaction: + description: Balance transaction that describes the impact of this transfer + on your account balance. + type: + - string + x-expansionResources: + oneOf: + - "$ref": "#/definitions/balance_transaction" + created: + description: Time at which the object was created. Measured in seconds since + the Unix epoch. + 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://support.stripe.com/questions/which-currencies-does-stripe-support). + type: + - string + date: + description: Date the transfer is scheduled to arrive in the bank. This factors + in delays like weekends or bank holidays. + type: + - integer + description: + description: Internal-only description of the transfer. + type: + - string + destination: + description: ID of the bank account, card, or Stripe account the transfer + was sent to. + type: + - string + x-expansionResources: + oneOf: + - "$ref": "#/definitions/account" + - "$ref": "#/definitions/bank_account" + - "$ref": "#/definitions/card" + destination_payment: + description: If the destination is a Stripe account, this will be the ID of + the payment that the destination account received for the transfer. + type: + - string + x-expansionResources: + oneOf: + - "$ref": "#/definitions/charge" + failure_code: + description: Error code explaining reason for transfer failure if available. + See [Types of transfer failures](/docs/api#transfer_failures) for a list + of failure codes. + type: + - string + failure_message: + description: Message to user further explaining reason for transfer failure + if available. + type: + - string + id: + description: Unique identifier for the object. + type: + - string + livemode: + description: Flag indicating whether the object exists in live mode or test + mode. + type: + - boolean + metadata: + description: Set of key/value pairs that you can attach to an object. It can + be useful for storing additional information about the object in a structured + format. + type: + - object + method: + description: The method used to send this transfer, which can be `standard` + or `instant`. `instant` is only supported for transfers to debit cards. + (See [Instant payouts for marketplaces](/blog/instant-payouts-for-marketplaces) + for more information.) + type: + - string + object: + description: String representing the object's type. Objects of the same type + share the same value. + type: + - string + reversals: + properties: + data: + items: + "$ref": "#/definitions/transfer_reversal" + 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 + total_count: + description: The total number of items available. This value is not included + by default, but you can request it by specifying ?include[]=total_count. + type: + - integer + url: + description: The URL where this list can be accessed. + type: + - string + required: + - data + - has_more + - object + - url + title: TransferReversalList + type: + - object + x-expandableFields: [] + reversed: + description: Whether or not the transfer has been fully reversed. If the transfer + is only partially reversed, this attribute will still be false. + type: + - boolean + source_transaction: + description: ID of the charge (or other transaction) that was used to fund + the transfer. If null, the transfer was funded from the available balance. + type: + - string + x-expansionResources: + oneOf: + - "$ref": "#/definitions/charge" + - "$ref": "#/definitions/platform_fee" + - "$ref": "#/definitions/transfer_reversal" + source_type: + description: The source balance this transfer came from. One of `card`, `bank_account`, + `bitcoin_receiver`, or `alipay_account`. + type: + - string + statement_descriptor: + description: Extra information about a transfer to be displayed on the user's + bank statement. + type: + - string + status: + description: Current status of the transfer (`paid`, `pending`, `in_transit`, + `canceled` or `failed`). A transfer will be `pending` until it is submitted + to the bank, at which point it becomes `in_transit`. It will then change + to `paid` if the transaction goes through. If it does not go through successfully, + its status will change to `failed` or `canceled`. + type: + - string + transfer_group: + description: A string that identifies this transaction as part of a group. + See the [Connect documentation](/docs/connect/charges-transfers#grouping-transactions) + for details. + type: + - string + type: + description: Can be `card`, `bank_account`, or `stripe_account`. + type: + - string + required: + - amount + - amount_reversed + - created + - currency + - date + - id + - livemode + - metadata + - object + - reversals + - reversed + - status + - type + title: TransferRecipientTransfer + type: + - object + x-expandableFields: + - application_fee + - balance_transaction + - destination + - destination_payment + - source_transaction + x-resourceId: transfer_recipient_transfer transfer_reversal: properties: amount: @@ -5376,6 +6166,9 @@ definitions: balance. type: - string + x-expansionResources: + oneOf: + - "$ref": "#/definitions/balance_transaction" created: description: Time at which the object was created. Measured in seconds since the Unix epoch. @@ -5405,6 +6198,10 @@ definitions: description: ID of the transfer that was reversed. type: - string + x-expansionResources: + oneOf: + - "$ref": "#/definitions/legacy_transfer" + - "$ref": "#/definitions/transfer" required: - amount - created @@ -5416,6 +6213,9 @@ definitions: title: TransferReversal type: - object + x-expandableFields: + - balance_transaction + - transfer x-resourceId: transfer_reversal transfer_schedule: properties: @@ -5445,58 +6245,8 @@ definitions: title: TransferSchedule type: - object + x-expandableFields: [] x-resourceId: transfer_schedule - twitter_buy_now_settings: - properties: - enabled: - description: '' - type: - - boolean - marketplace_id: - description: '' - type: - - string - merchant_id: - description: '' - type: - - string - oauth_token_provided: - description: '' - type: - - boolean - oauth_token_secret_provided: - description: '' - type: - - boolean - privacy_url: - description: '' - type: - - string - sales_terms: - description: '' - type: - - string - shipping_policy: - description: '' - type: - - string - terms_url: - description: '' - type: - - string - username: - description: '' - type: - - string - required: - - enabled - - oauth_token_provided - - oauth_token_secret_provided - - username - title: TwitterBuyNowSettings - type: - - object - x-resourceId: twitter_buy_now_settings upcoming_invoice: properties: amount_due: @@ -5529,17 +6279,13 @@ definitions: your users. type: - boolean - billing: - description: 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. - type: - - string charge: description: ID of the latest charge generated for this invoice, if any. type: - string + x-expansionResources: + oneOf: + - "$ref": "#/definitions/charge" closed: description: Whether or not the invoice is still trying to collect payment. An invoice is closed if it's either paid or it has been marked closed. A @@ -5555,6 +6301,9 @@ definitions: description: '' type: - string + x-expansionResources: + oneOf: + - "$ref": "#/definitions/customer" date: description: Time at which the object was created. Measured in seconds since the Unix epoch. @@ -5567,10 +6316,6 @@ definitions: - string discount: "$ref": "#/definitions/discount" - due_date: - description: The date on which payment for this invoice is due. - type: - - integer ending_balance: description: Ending customer balance after attempting to pay invoice. If the invoice has not been attempted yet, this will be null. @@ -5618,6 +6363,7 @@ definitions: title: InvoiceLinesList type: - object + x-expandableFields: [] livemode: description: Flag indicating whether the object exists in live mode or test mode. @@ -5633,11 +6379,6 @@ definitions: description: The time at which payment will next be attempted. type: - integer - number: - description: A unique, identifying string that appears on emails sent to the - customer for this invoice. - type: - - string object: description: String representing the object's type. Objects of the same type share the same value. @@ -5679,6 +6420,9 @@ definitions: description: The subscription that this invoice was prepared for, if any. type: - string + x-expansionResources: + oneOf: + - "$ref": "#/definitions/subscription" subscription_proration_date: description: Only set for upcoming invoices that preview prorations. The time used to calculate prorations. @@ -5733,6 +6477,10 @@ definitions: title: UpcomingInvoice type: - object + x-expandableFields: + - charge + - customer + - subscription x-resourceId: upcoming_invoice host: api.stripe.com info: @@ -5780,6 +6528,15 @@ paths: title: customer type: - string + expand: + description: Specifies which fields in the response should be expanded. + items: + type: + - string + title: expand + type: + - array + - string return_url: description: The URL that the cardholder's browser will be returned to when authentication completes. @@ -5804,6 +6561,11 @@ paths: description: "

Retrieves a 3D Secure object.

" operationId: Retrieve3DSecure parameters: + - description: Specifies which fields in the response should be expanded. + in: query + name: expand + required: false + type: string - description: The identifier of the 3D Secure object to be retrieved. in: path name: three_d_secure @@ -5840,6 +6602,15 @@ paths: title: account type: - string + expand: + description: Specifies which fields in the response should be expanded. + items: + type: + - string + title: expand + type: + - array + - string responses: '200': description: Successful response. @@ -5853,6 +6624,11 @@ paths: description: "

Retrieves the details of the account.

" operationId: AccountRetrieve parameters: + - description: Specifies which fields in the response should be expanded. + in: query + name: expand + required: false + type: string - description: The identifier of the account to be retrieved. If none is provided, will default to the account of the API key. in: query @@ -5934,6 +6710,15 @@ paths: title: email type: - string + expand: + description: Specifies which fields in the response should be expanded. + items: + type: + - string + title: expand + type: + - array + - string external_account: description: A card or bank account to attach to the account. You can provide either a token, like the ones returned by [Stripe.js](/docs/stripe.js), @@ -5954,11 +6739,6 @@ paths: title: legal_entity type: - object - mcc: - description: '' - title: mcc - type: - - integer metadata: description: A set of key/value pairs that you can attach to an account object. It can be useful for storing additional information about @@ -5966,11 +6746,6 @@ paths: title: metadata type: - object - orders: - description: '' - title: orders - type: - - object payout_schedule: description: Details on when this account will make funds from charges available, and when they will be paid out to the account holder's @@ -6041,7 +6816,7 @@ paths: - description: Body parameters for the request. in: body name: payload - required: false + required: true schema: properties: default_for_currency: @@ -6051,6 +6826,15 @@ paths: title: default_for_currency type: - boolean + expand: + description: Specifies which fields in the response should be expanded. + items: + type: + - string + title: expand + type: + - array + - string external_account: description: This string to be replaced by DocSpecGenerator. title: external_account @@ -6085,6 +6869,44 @@ paths: name: id required: true type: string + - description: Body parameters for the request. + in: body + name: payload + required: false + schema: + properties: + expand: + description: Specifies which fields in the response should be expanded. + items: + type: + - string + title: expand + type: + - array + - string + responses: + '200': + description: Successful response. + schema: + "$ref": "#/definitions/external_account_source" + default: + description: Error response. + schema: + "$ref": "#/definitions/error" + get: + description: '' + operationId: RetrieveAccountExternalAccount + parameters: + - description: Specifies which fields in the response should be expanded. + in: query + name: expand + required: false + type: string + - description: '' + in: path + name: id + required: true + type: string responses: '200': description: Successful response. @@ -6117,6 +6939,15 @@ paths: title: default_for_currency type: - boolean + expand: + description: Specifies which fields in the response should be expanded. + items: + type: + - string + title: expand + type: + - array + - string metadata: description: '' title: metadata @@ -6136,6 +6967,11 @@ paths: description: '' operationId: AllAccountExternalAccounts parameters: + - description: Specifies which fields in the response should be expanded. + in: query + name: expand + required: false + type: string - description: A limit on the number of objects to be returned. Limit can range between 1 and 100 items. in: query @@ -6167,8 +7003,7 @@ paths: properties: data: items: - type: - - object + "$ref": "#/definitions/bank_account" type: - array has_more: @@ -6200,6 +7035,8 @@ paths: title: ExternalAccountList type: - object + x-expandableFields: + - data default: description: Error response. schema: @@ -6211,7 +7048,7 @@ paths: - description: Body parameters for the request. in: body name: payload - required: false + required: true schema: properties: default_for_currency: @@ -6221,6 +7058,15 @@ paths: title: default_for_currency type: - boolean + expand: + description: Specifies which fields in the response should be expanded. + items: + type: + - string + title: expand + type: + - array + - string external_account: description: This string to be replaced by DocSpecGenerator. title: external_account @@ -6255,6 +7101,44 @@ paths: name: id required: true type: string + - description: Body parameters for the request. + in: body + name: payload + required: false + schema: + properties: + expand: + description: Specifies which fields in the response should be expanded. + items: + type: + - string + title: expand + type: + - array + - string + responses: + '200': + description: Successful response. + schema: + "$ref": "#/definitions/external_account_source" + default: + description: Error response. + schema: + "$ref": "#/definitions/error" + get: + description: '' + operationId: RetrieveAccountExternalAccount + parameters: + - description: Specifies which fields in the response should be expanded. + in: query + name: expand + required: false + type: string + - description: '' + in: path + name: id + required: true + type: string responses: '200': description: Successful response. @@ -6287,6 +7171,15 @@ paths: title: default_for_currency type: - boolean + expand: + description: Specifies which fields in the response should be expanded. + items: + type: + - string + title: expand + type: + - array + - string metadata: description: '' title: metadata @@ -6301,6 +7194,52 @@ paths: description: Error response. schema: "$ref": "#/definitions/error" + "/v1/account/login_links": + post: + description: '' + operationId: LoginLinkCreate + parameters: + - description: Body parameters for the request. + in: body + name: payload + required: true + schema: + properties: + account: + description: The identifier of the account to create a login link for. + title: account + type: + - string + expand: + description: Specifies which fields in the response should be expanded. + items: + type: + - string + title: expand + type: + - array + - string + id: + description: '' + title: id + type: + - string + percent_off: + description: '' + title: percent_off + type: + - integer + required: + - account + responses: + '200': + description: Successful response. + schema: + "$ref": "#/definitions/login_link" + default: + description: Error response. + schema: + "$ref": "#/definitions/error" "/v1/accounts": get: description:

Returns a list of accounts connected to your platform via operationId: AllAccount parameters: + - description: Specifies which fields in the response should be expanded. + in: query + name: expand + required: false + type: string - description: A limit on the number of objects to be returned. Limit can range between 1 and 100 items. in: query @@ -6372,6 +7316,7 @@ paths: - url type: - object + x-expandableFields: [] default: description: Error response. schema: @@ -6442,6 +7387,15 @@ paths: title: email type: - string + expand: + description: Specifies which fields in the response should be expanded. + items: + type: + - string + title: expand + type: + - array + - string external_account: description: A card or bank account to attach to the account. You can provide either a token, like the ones returned by [Stripe.js](/docs/stripe.js), @@ -6467,11 +7421,6 @@ paths: title: managed type: - boolean - mcc: - description: '' - title: mcc - type: - - integer metadata: description: A set of key/value pairs that you can attach to an account object. It can be useful for storing additional information about @@ -6479,11 +7428,6 @@ paths: title: metadata type: - object - orders: - description: '' - title: orders - type: - - object payout_schedule: description: Details on when this account will make funds from charges available, and when they will be paid out to the account holder's @@ -6499,11 +7443,6 @@ paths: title: payout_statement_descriptor type: - string - platform_account: - description: '' - title: platform_account - type: - - boolean product_description: description: Internal-only description of the product being sold or service being provided by this account. It's used by Stripe for risk @@ -6567,6 +7506,21 @@ paths: name: account required: true type: string + - description: Body parameters for the request. + in: body + name: payload + required: false + schema: + properties: + expand: + description: Specifies which fields in the response should be expanded. + items: + type: + - string + title: expand + type: + - array + - string responses: '200': description: Successful response. @@ -6580,6 +7534,11 @@ paths: description: "

Retrieves the details of the account.

" operationId: AccountRetrieve parameters: + - description: Specifies which fields in the response should be expanded. + in: query + name: expand + required: false + type: string - description: The identifier of the account to be retrieved. If none is provided, will default to the account of the API key. in: path @@ -6661,6 +7620,15 @@ paths: title: email type: - string + expand: + description: Specifies which fields in the response should be expanded. + items: + type: + - string + title: expand + type: + - array + - string external_account: description: A card or bank account to attach to the account. You can provide either a token, like the ones returned by [Stripe.js](/docs/stripe.js), @@ -6681,11 +7649,6 @@ paths: title: legal_entity type: - object - mcc: - description: '' - title: mcc - type: - - integer metadata: description: A set of key/value pairs that you can attach to an account object. It can be useful for storing additional information about @@ -6693,11 +7656,6 @@ paths: title: metadata type: - object - orders: - description: '' - title: orders - type: - - object payout_schedule: description: Details on when this account will make funds from charges available, and when they will be paid out to the account holder's @@ -6768,7 +7726,7 @@ paths: - description: Body parameters for the request. in: body name: payload - required: false + required: true schema: properties: default_for_currency: @@ -6778,6 +7736,15 @@ paths: title: default_for_currency type: - boolean + expand: + description: Specifies which fields in the response should be expanded. + items: + type: + - string + title: expand + type: + - array + - string external_account: description: This string to be replaced by DocSpecGenerator. title: external_account @@ -6812,6 +7779,44 @@ paths: name: id required: true type: string + - description: Body parameters for the request. + in: body + name: payload + required: false + schema: + properties: + expand: + description: Specifies which fields in the response should be expanded. + items: + type: + - string + title: expand + type: + - array + - string + responses: + '200': + description: Successful response. + schema: + "$ref": "#/definitions/external_account_source" + default: + description: Error response. + schema: + "$ref": "#/definitions/error" + get: + description: '' + operationId: RetrieveAccountExternalAccount + parameters: + - description: Specifies which fields in the response should be expanded. + in: query + name: expand + required: false + type: string + - description: '' + in: path + name: id + required: true + type: string responses: '200': description: Successful response. @@ -6844,6 +7849,15 @@ paths: title: default_for_currency type: - boolean + expand: + description: Specifies which fields in the response should be expanded. + items: + type: + - string + title: expand + type: + - array + - string metadata: description: '' title: metadata @@ -6863,6 +7877,11 @@ paths: description: '' operationId: AllAccountExternalAccounts parameters: + - description: Specifies which fields in the response should be expanded. + in: query + name: expand + required: false + type: string - description: A limit on the number of objects to be returned. Limit can range between 1 and 100 items. in: query @@ -6894,8 +7913,7 @@ paths: properties: data: items: - type: - - object + "$ref": "#/definitions/bank_account" type: - array has_more: @@ -6927,6 +7945,8 @@ paths: title: ExternalAccountList type: - object + x-expandableFields: + - data default: description: Error response. schema: @@ -6938,7 +7958,7 @@ paths: - description: Body parameters for the request. in: body name: payload - required: false + required: true schema: properties: default_for_currency: @@ -6948,6 +7968,15 @@ paths: title: default_for_currency type: - boolean + expand: + description: Specifies which fields in the response should be expanded. + items: + type: + - string + title: expand + type: + - array + - string external_account: description: This string to be replaced by DocSpecGenerator. title: external_account @@ -6982,6 +8011,44 @@ paths: name: id required: true type: string + - description: Body parameters for the request. + in: body + name: payload + required: false + schema: + properties: + expand: + description: Specifies which fields in the response should be expanded. + items: + type: + - string + title: expand + type: + - array + - string + responses: + '200': + description: Successful response. + schema: + "$ref": "#/definitions/external_account_source" + default: + description: Error response. + schema: + "$ref": "#/definitions/error" + get: + description: '' + operationId: RetrieveAccountExternalAccount + parameters: + - description: Specifies which fields in the response should be expanded. + in: query + name: expand + required: false + type: string + - description: '' + in: path + name: id + required: true + type: string responses: '200': description: Successful response. @@ -7014,6 +8081,15 @@ paths: title: default_for_currency type: - boolean + expand: + description: Specifies which fields in the response should be expanded. + items: + type: + - string + title: expand + type: + - array + - string metadata: description: '' title: metadata @@ -7028,6 +8104,50 @@ paths: description: Error response. schema: "$ref": "#/definitions/error" + "/v1/accounts/{account}/login_links": + post: + description: '' + operationId: LoginLinkCreate + parameters: + - description: The identifier of the account to create a login link for. + in: path + name: account + required: true + type: string + - description: Body parameters for the request. + in: body + name: payload + required: false + schema: + properties: + expand: + description: Specifies which fields in the response should be expanded. + items: + type: + - string + title: expand + type: + - array + - string + id: + description: '' + title: id + type: + - string + percent_off: + description: '' + title: percent_off + type: + - integer + responses: + '200': + description: Successful response. + schema: + "$ref": "#/definitions/login_link" + default: + description: Error response. + schema: + "$ref": "#/definitions/error" "/v1/accounts/{account}/reject": post: description:

With Connect, you may flag managed @@ -7044,9 +8164,18 @@ paths: - description: Body parameters for the request. in: body name: payload - required: false + required: true schema: properties: + expand: + description: Specifies which fields in the response should be expanded. + items: + type: + - string + title: expand + type: + - array + - string reason: description: The reason for rejecting the account. May be one of `fraud`, `terms_of_service`, or `other`. @@ -7069,6 +8198,11 @@ paths: description: '' operationId: AllApplePayDomains parameters: + - description: Specifies which fields in the response should be expanded. + in: query + name: expand + required: false + type: string - description: A limit on the number of objects to be returned. Limit can range between 1 and 100 items. in: query @@ -7139,6 +8273,7 @@ paths: title: ApplePayDomainList type: - object + x-expandableFields: [] default: description: Error response. schema: @@ -7150,7 +8285,7 @@ paths: - description: Body parameters for the request. in: body name: payload - required: false + required: true schema: properties: domain_name: @@ -7158,6 +8293,15 @@ paths: title: domain_name type: - string + expand: + description: Specifies which fields in the response should be expanded. + items: + type: + - string + title: expand + type: + - array + - string required: - domain_name responses: @@ -7179,6 +8323,21 @@ paths: name: domain required: true type: string + - description: Body parameters for the request. + in: body + name: payload + required: false + schema: + properties: + expand: + description: Specifies which fields in the response should be expanded. + items: + type: + - string + title: expand + type: + - array + - string responses: '200': description: Successful response. @@ -7192,6 +8351,11 @@ paths: description: '' operationId: RetrieveApplePayDomain parameters: + - description: Specifies which fields in the response should be expanded. + in: query + name: expand + required: false + type: string - description: '' in: path name: domain @@ -7213,6 +8377,11 @@ paths: appearing first.

" operationId: AllPlatformEarnings parameters: + - description: Specifies which fields in the response should be expanded. + in: query + name: expand + required: false + type: string - description: A limit on the number of objects to be returned. Limit can range between 1 and 100 items. in: query @@ -7288,6 +8457,7 @@ paths: - url type: - object + x-expandableFields: [] default: description: Error response. schema: @@ -7299,6 +8469,11 @@ paths: refund stored on the application fee.

" operationId: RetrievePlatformEarningRefund parameters: + - description: Specifies which fields in the response should be expanded. + in: query + name: expand + required: false + type: string - description: ID of the application fee refunded. in: path name: fee @@ -7330,6 +8505,15 @@ paths: required: false schema: properties: + expand: + description: Specifies which fields in the response should be expanded. + items: + type: + - string + title: expand + type: + - array + - string metadata: description: A set of key/value pairs that you can attach to an application fee refund object. It can be useful for storing additional information @@ -7353,6 +8537,11 @@ paths: fee.

" operationId: RetrievePlatformEarning parameters: + - description: Specifies which fields in the response should be expanded. + in: query + name: expand + required: false + type: string - description: The identifier of the fee to be retrieved. in: path name: id @@ -7393,6 +8582,15 @@ paths: title: directive type: - string + expand: + description: Specifies which fields in the response should be expanded. + items: + type: + - string + title: expand + type: + - array + - string responses: '200': description: Successful response. @@ -7411,6 +8609,11 @@ paths: parameters to page through additional refunds.

" operationId: AllPlatformEarningsRefunds parameters: + - description: Specifies which fields in the response should be expanded. + in: query + name: expand + required: false + type: string - description: A limit on the number of objects to be returned. Limit can range between 1 and 100 items. in: query @@ -7479,6 +8682,7 @@ paths: title: FeeRefundList type: - object + x-expandableFields: [] default: description: Error response. schema: @@ -7508,6 +8712,15 @@ paths: title: directive type: - string + expand: + description: Specifies which fields in the response should be expanded. + items: + type: + - string + title: expand + type: + - array + - string metadata: description: '' title: metadata @@ -7527,7 +8740,12 @@ paths: description: "

Retrieves the current account balance, based on the authentication that was used to make the request.

" operationId: BalanceRetrieve - parameters: [] + parameters: + - description: Specifies which fields in the response should be expanded. + in: query + name: expand + required: false + type: string responses: '200': description: Successful response. @@ -7545,6 +8763,11 @@ paths: first.

" operationId: AllBalanceTransactions parameters: + - description: Specifies which fields in the response should be expanded. + in: query + name: expand + required: false + type: string - description: A limit on the number of objects to be returned. Limit can range between 1 and 100 items. in: query @@ -7643,6 +8866,7 @@ paths: title: BalanceTransactionsList type: - object + x-expandableFields: [] default: description: Error response. schema: @@ -7652,6 +8876,11 @@ paths: description: "

Retrieves the balance transaction with the given ID.

" operationId: RetrieveBalanceTransaction parameters: + - description: Specifies which fields in the response should be expanded. + in: query + name: expand + required: false + type: string - description: The ID of the desired balance transaction (as found on any API object that affects the balance, e.g. a charge or transfer). in: path @@ -7667,6 +8896,277 @@ paths: description: Error response. schema: "$ref": "#/definitions/error" + "/v1/bitcoin/payments": + get: + description: '' + operationId: AllPayments + parameters: + - description: Specifies which fields in the response should be expanded. + in: query + name: expand + required: false + type: string + - description: A limit on the number of objects to be returned. Limit can range + between 1 and 100 items. + in: query + name: limit + required: false + type: integer + - 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 + type: string + - 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 + type: string + - description: Only return payments for the customer specified by this customer + ID. + in: query + name: customer + required: false + type: string + responses: + '200': + description: Successful response. + schema: + properties: + data: + items: + "$ref": "#/definitions/charge" + 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 + total_count: + description: The total number of items available. This value is not + included by default, but you can request it by specifying ?include[]=total_count. + type: + - integer + url: + description: The URL where this list can be accessed. + enum: + - "/v1/bitcoin/payments" + type: + - string + required: + - data + - has_more + - object + - url + type: + - object + x-expandableFields: [] + default: + description: Error response. + schema: + "$ref": "#/definitions/error" + post: + description: '' + operationId: CreatePayment + parameters: + - description: Body parameters for the request. + in: body + name: payload + required: true + schema: + properties: + alternate_statement_descriptors: + description: '' + title: alternate_statement_descriptors + type: + - object + amount: + description: '' + title: amount + type: + - integer + application: + description: '' + title: application + type: + - string + application_fee: + description: '' + title: application_fee + type: + - integer + capture: + description: '' + title: capture + type: + - boolean + currency: + description: '' + title: currency + type: + - string + customer: + description: '' + title: customer + type: + - string + description: + description: '' + title: description + type: + - string + destination: + description: '' + title: destination + type: + - object + expand: + description: Specifies which fields in the response should be expanded. + items: + type: + - string + title: expand + type: + - array + - string + external_id: + description: '' + title: external_id + type: + - string + idempotency_key: + description: '' + title: idempotency_key + type: + - string + invoice: + description: '' + title: invoice + type: + - string + invoice_source: + description: '' + title: invoice_source + type: + - string + ip: + description: '' + title: ip + type: + - string + level3: + description: '' + title: level3 + type: + - object + metadata: + description: '' + title: metadata + type: + - object + on_behalf_of: + description: '' + title: on_behalf_of + type: + - string + order: + description: '' + title: order + type: + - string + payment_method: + description: '' + title: payment_method + type: + - string + payment_user_agent: + description: '' + title: payment_user_agent + type: + - string + receipt_email: + description: '' + title: receipt_email + type: + - string + recurring: + description: '' + title: recurring + type: + - boolean + referrer: + description: '' + title: referrer + type: + - string + shipping: + description: '' + title: shipping + type: + - object + source: + description: '' + title: source + type: + - string + statement_descriptor: + description: '' + title: statement_descriptor + type: + - string + three_d_secure: + description: '' + title: three_d_secure + type: + - object + transfer_group: + description: '' + title: transfer_group + type: + - string + trust: + description: '' + title: trust + type: + - object + uncaptured: + description: '' + title: uncaptured + type: + - boolean + user_agent: + description: '' + title: user_agent + type: + - string + required: + - amount + - currency + responses: + '200': + description: Successful response. + schema: + "$ref": "#/definitions/charge" + default: + description: Error response. + schema: + "$ref": "#/definitions/error" "/v1/bitcoin/payments/{charge}/refund": post: description: '' @@ -7698,6 +9198,15 @@ paths: title: directive type: - string + expand: + description: Specifies which fields in the response should be expanded. + items: + type: + - string + title: expand + type: + - array + - string metadata: description: '' title: metadata @@ -7732,12 +9241,41 @@ paths: description: Error response. schema: "$ref": "#/definitions/error" + "/v1/bitcoin/payments/{id}": + get: + description: '' + operationId: RetrievePayment + parameters: + - description: Specifies which fields in the response should be expanded. + in: query + name: expand + required: false + type: string + - description: '' + in: path + name: id + required: true + type: string + responses: + '200': + description: Successful response. + schema: + "$ref": "#/definitions/charge" + default: + description: Error response. + schema: + "$ref": "#/definitions/error" "/v1/bitcoin/receivers": get: description: "

Returns a list of your receivers. Receivers are returned sorted by creation date, with the most recently created receivers appearing first.

" operationId: AllReceivers parameters: + - description: Specifies which fields in the response should be expanded. + in: query + name: expand + required: false + type: string - description: A limit on the number of objects to be returned. Limit can range between 1 and 100 items. in: query @@ -7817,6 +9355,7 @@ paths: - url type: - object + x-expandableFields: [] default: description: Error response. schema: @@ -7855,6 +9394,15 @@ paths: title: email type: - string + expand: + description: Specifies which fields in the response should be expanded. + items: + type: + - string + title: expand + type: + - array + - string metadata: description: A set of key/value pairs that you can attach to a customer object. It can be useful for storing additional information about @@ -7891,6 +9439,21 @@ paths: name: id required: true type: string + - description: Body parameters for the request. + in: body + name: payload + required: false + schema: + properties: + expand: + description: Specifies which fields in the response should be expanded. + items: + type: + - string + title: expand + type: + - array + - string responses: '200': description: Successful response. @@ -7904,6 +9467,11 @@ paths: description: "

Retrieves the Bitcoin receiver with the given ID.

" operationId: RetrieveReceiver parameters: + - description: Specifies which fields in the response should be expanded. + in: query + name: expand + required: false + type: string - description: '' in: path name: id @@ -7943,6 +9511,15 @@ paths: title: email type: - string + expand: + description: Specifies which fields in the response should be expanded. + items: + type: + - string + title: expand + type: + - array + - string metadata: description: '' title: metadata @@ -7978,6 +9555,15 @@ paths: required: false schema: properties: + expand: + description: Specifies which fields in the response should be expanded. + items: + type: + - string + title: expand + type: + - array + - string refund_address: description: If the receiver does not already have a refund address, then you need to provide one to perform a refund. @@ -7998,6 +9584,11 @@ paths: description: '' operationId: AllTransactions parameters: + - description: Specifies which fields in the response should be expanded. + in: query + name: expand + required: false + type: string - description: A limit on the number of objects to be returned. Limit can range between 1 and 100 items. in: query @@ -8073,6 +9664,7 @@ paths: title: BitcoinTransactionList type: - object + x-expandableFields: [] default: description: Error response. schema: @@ -8082,6 +9674,11 @@ paths: description: '' operationId: AllTransactions parameters: + - description: Specifies which fields in the response should be expanded. + in: query + name: expand + required: false + type: string - description: A limit on the number of objects to be returned. Limit can range between 1 and 100 items. in: query @@ -8157,6 +9754,7 @@ paths: title: BitcoinTransactionList type: - object + x-expandableFields: [] default: description: Error response. schema: @@ -8166,6 +9764,11 @@ paths: description: '' operationId: RetrieveTransaction parameters: + - description: Specifies which fields in the response should be expanded. + in: query + name: expand + required: false + type: string - description: '' in: path name: id @@ -8186,6 +9789,11 @@ paths: are returned in sorted order, with the most recent charges appearing first.

" operationId: AllCharges parameters: + - description: Specifies which fields in the response should be expanded. + in: query + name: expand + required: false + type: string - description: A limit on the number of objects to be returned. Limit can range between 1 and 100 items. in: query @@ -8271,6 +9879,7 @@ paths: - url type: - object + x-expandableFields: [] default: description: Error response. schema: @@ -8330,6 +9939,14 @@ paths: title: destination type: - object + expand: + description: Specifies which fields in the response should be expanded. + items: + type: + - string + title: expand + type: + - array - string external_id: description: '' @@ -8402,16 +10019,6 @@ paths: title: statement_descriptor type: - string - three_d_secure: - description: '' - title: three_d_secure - type: - - object - transfer: - description: '' - title: transfer - type: - - object transfer_group: description: '' title: transfer_group @@ -8452,6 +10059,11 @@ paths: same information is returned when creating or refunding the charge.

" operationId: RetrieveCharge parameters: + - description: Specifies which fields in the response should be expanded. + in: query + name: expand + required: false + type: string - description: The identifier of the charge to be retrieved. in: path name: charge @@ -8488,6 +10100,15 @@ paths: title: description type: - string + expand: + description: Specifies which fields in the response should be expanded. + items: + type: + - string + title: expand + type: + - array + - string fraud_details: description: A set of key/value pairs you can attach to a charge giving information about its riskiness. If you believe a charge is fraudulent, @@ -8572,6 +10193,22 @@ paths: title: application_fee type: - integer + destination: + description: An optional dictionary containing a new destination amount + to use. Can only be used with destination charges created with Stripe + Connect. + title: destination + type: + - object + expand: + description: Specifies which fields in the response should be expanded. + items: + type: + - string + title: expand + type: + - array + - string receipt_email: description: The email address to send this charge's receipt to. This will override the previously-specified email address for this charge, @@ -8607,6 +10244,11 @@ paths: description: '' operationId: RetrieveChargeDispute parameters: + - description: Specifies which fields in the response should be expanded. + in: query + name: expand + required: false + type: string - description: '' in: path name: charge @@ -8642,6 +10284,15 @@ paths: title: evidence type: - object + expand: + description: Specifies which fields in the response should be expanded. + items: + type: + - string + title: expand + type: + - array + - string metadata: description: A set of key/value pairs that you can attach to a dispute object. It can be useful for storing additional information about @@ -8668,6 +10319,21 @@ paths: name: charge required: true type: string + - description: Body parameters for the request. + in: body + name: payload + required: false + schema: + properties: + expand: + description: Specifies which fields in the response should be expanded. + items: + type: + - string + title: expand + type: + - array + - string responses: '200': description: Successful response. @@ -8708,6 +10374,15 @@ paths: title: directive type: - string + expand: + description: Specifies which fields in the response should be expanded. + items: + type: + - string + title: expand + type: + - array + - string metadata: description: '' title: metadata @@ -8751,6 +10426,11 @@ paths: through additional refunds.

" operationId: AllChargeRefunds parameters: + - description: Specifies which fields in the response should be expanded. + in: query + name: expand + required: false + type: string - description: A limit on the number of objects to be returned. Limit can range between 1 and 100 items. in: query @@ -8819,6 +10499,7 @@ paths: title: RefundList type: - object + x-expandableFields: [] default: description: Error response. schema: @@ -8848,6 +10529,15 @@ paths: title: directive type: - string + expand: + description: Specifies which fields in the response should be expanded. + items: + type: + - string + title: expand + type: + - array + - string metadata: description: '' title: metadata @@ -8882,6 +10572,11 @@ paths: description: '' operationId: RetrieveChargeRefund parameters: + - description: Specifies which fields in the response should be expanded. + in: query + name: expand + required: false + type: string - description: ID of refund to retrieve. in: path name: refund @@ -8916,6 +10611,15 @@ paths: required: false schema: properties: + expand: + description: Specifies which fields in the response should be expanded. + items: + type: + - string + title: expand + type: + - array + - string metadata: description: A set of key/value pairs that you can attach to a refund object. It can be useful for storing additional information about @@ -8937,6 +10641,11 @@ paths: description: "

Lists all Country Spec objects available in the API.

" operationId: AllCountrySpecs parameters: + - description: Specifies which fields in the response should be expanded. + in: query + name: expand + required: false + type: string - description: A limit on the number of objects to be returned. Limit can range between 1 and 100 items. in: query @@ -9001,6 +10710,7 @@ paths: - url type: - object + x-expandableFields: [] default: description: Error response. schema: @@ -9010,6 +10720,11 @@ paths: description: "

Returns a Country Spec for a given Country code.

" operationId: RetrieveCountrySpec parameters: + - description: Specifies which fields in the response should be expanded. + in: query + name: expand + required: false + type: string - description: An ISO 3166-1 alpha-2 country code. Available country codes can be listed with the [List Country Specs](/docs/api#list_country_specs) endpoint. in: path @@ -9030,6 +10745,11 @@ paths: description: "

Returns a list of your coupons.

" operationId: AllCoupons parameters: + - description: Specifies which fields in the response should be expanded. + in: query + name: expand + required: false + type: string - description: A limit on the number of objects to be returned. Limit can range between 1 and 100 items. in: query @@ -9101,6 +10821,7 @@ paths: - url type: - object + x-expandableFields: [] default: description: Error response. schema: @@ -9150,6 +10871,15 @@ paths: title: duration_in_months type: - integer + expand: + description: Specifies which fields in the response should be expanded. + items: + type: + - string + title: expand + type: + - array + - string id: description: Unique string of your choice that will be used to identify this coupon when applying it to a customer. This is often a specific @@ -9211,6 +10941,21 @@ paths: name: coupon required: true type: string + - description: Body parameters for the request. + in: body + name: payload + required: false + schema: + properties: + expand: + description: Specifies which fields in the response should be expanded. + items: + type: + - string + title: expand + type: + - array + - string responses: '200': description: Successful response. @@ -9224,6 +10969,11 @@ paths: description: "

Retrieves the coupon with the given ID.

" operationId: RetrieveCoupon parameters: + - description: Specifies which fields in the response should be expanded. + in: query + name: expand + required: false + type: string - description: The ID of the desired coupon. in: path name: coupon @@ -9254,6 +11004,15 @@ paths: required: false schema: properties: + expand: + description: Specifies which fields in the response should be expanded. + items: + type: + - string + title: expand + type: + - array + - string metadata: description: A set of key/value pairs that you can attach to a coupon object. It can be useful for storing additional information about @@ -9276,6 +11035,11 @@ paths: sorted by creation date, with the most recent customers appearing first.

" operationId: AllCustomers parameters: + - description: Specifies which fields in the response should be expanded. + in: query + name: expand + required: false + type: string - description: A limit on the number of objects to be returned. Limit can range between 1 and 100 items. in: query @@ -9305,11 +11069,6 @@ paths: name: created required: false type: integer - - description: '' - in: query - name: deleted - required: false - type: boolean responses: '200': description: Successful response. @@ -9350,6 +11109,7 @@ paths: - url type: - object + x-expandableFields: [] default: description: Error response. schema: @@ -9398,11 +11158,15 @@ paths: title: email type: - string - max_occurrences: - description: '' - title: max_occurrences + expand: + description: Specifies which fields in the response should be expanded. + items: + type: + - string + title: expand type: - - integer + - array + - string metadata: description: A set of key/value pairs that you can attach to a customer object. It can be useful for storing additional information about @@ -9410,21 +11174,6 @@ paths: title: metadata type: - object - on_behalf_of: - description: '' - title: on_behalf_of - type: - - string - pay_immediately: - description: '' - title: pay_immediately - type: - - boolean - retains_own_balance: - description: '' - title: retains_own_balance - type: - - boolean shipping: description: '' title: shipping @@ -9458,6 +11207,21 @@ paths: name: customer required: true type: string + - description: Body parameters for the request. + in: body + name: payload + required: false + schema: + properties: + expand: + description: Specifies which fields in the response should be expanded. + items: + type: + - string + title: expand + type: + - array + - string responses: '200': description: Successful response. @@ -9472,6 +11236,11 @@ paths: supply the unique customer identifier that was returned upon customer creation.

" operationId: RetrieveCustomer parameters: + - description: Specifies which fields in the response should be expanded. + in: query + name: expand + required: false + type: string - description: The identifier of the customer to be retrieved. in: path name: customer @@ -9535,11 +11304,15 @@ paths: title: email type: - string - max_occurrences: - description: '' - title: max_occurrences + expand: + description: Specifies which fields in the response should be expanded. + items: + type: + - string + title: expand type: - - integer + - array + - string metadata: description: A set of key/value pairs that you can attach to a customer object. It can be useful for storing additional information about @@ -9547,21 +11320,6 @@ paths: title: metadata type: - object - on_behalf_of: - description: '' - title: on_behalf_of - type: - - string - pay_immediately: - description: '' - title: pay_immediately - type: - - boolean - retains_own_balance: - description: '' - title: retains_own_balance - type: - - boolean shipping: description: '' title: shipping @@ -9589,6 +11347,11 @@ paths: description: '' operationId: AllCustomerAlipayAccounts parameters: + - description: Specifies which fields in the response should be expanded. + in: query + name: expand + required: false + type: string - description: A limit on the number of objects to be returned. Limit can range between 1 and 100 items. in: query @@ -9657,6 +11420,7 @@ paths: title: AlipayAccountList type: - object + x-expandableFields: [] default: description: Error response. schema: @@ -9668,9 +11432,18 @@ paths: - description: Body parameters for the request. in: body name: payload - required: false + required: true schema: properties: + expand: + description: Specifies which fields in the response should be expanded. + items: + type: + - string + title: expand + type: + - array + - string metadata: description: A set of key/value pairs that you can attach to a card object. It can be useful for storing additional information about @@ -9705,6 +11478,21 @@ paths: name: id required: true type: string + - description: Body parameters for the request. + in: body + name: payload + required: false + schema: + properties: + expand: + description: Specifies which fields in the response should be expanded. + items: + type: + - string + title: expand + type: + - array + - string responses: '200': description: Successful response. @@ -9718,6 +11506,11 @@ paths: description: '' operationId: RetrieveCustomerAlipayAccount parameters: + - description: Specifies which fields in the response should be expanded. + in: query + name: expand + required: false + type: string - description: The ID of the Alipay account to be retrieved. in: path name: id @@ -9741,6 +11534,11 @@ paths: through additional bank accounts.

" operationId: AllCustomerBankAccounts parameters: + - description: Specifies which fields in the response should be expanded. + in: query + name: expand + required: false + type: string - description: A limit on the number of objects to be returned. Limit can range between 1 and 100 items. in: query @@ -9809,6 +11607,7 @@ paths: title: BankAccountList type: - object + x-expandableFields: [] default: description: Error response. schema: @@ -9820,9 +11619,18 @@ paths: - description: Body parameters for the request. in: body name: payload - required: false + required: true schema: properties: + expand: + description: Specifies which fields in the response should be expanded. + items: + type: + - string + title: expand + type: + - array + - string metadata: description: A set of key/value pairs that you can attach to a card object. It can be useful for storing additional information about @@ -9857,6 +11665,21 @@ paths: name: id required: true type: string + - description: Body parameters for the request. + in: body + name: payload + required: false + schema: + properties: + expand: + description: Specifies which fields in the response should be expanded. + items: + type: + - string + title: expand + type: + - array + - string responses: '200': description: Successful response. @@ -9872,6 +11695,11 @@ paths: a specific bank account stored on the Stripe account.

" operationId: RetrieveCustomerBankAccount parameters: + - description: Specifies which fields in the response should be expanded. + in: query + name: expand + required: false + type: string - description: ID of bank account to retrieve. in: path name: id @@ -9936,11 +11764,6 @@ paths: title: address_zip type: - string - cvc: - description: '' - title: cvc - type: - - string exp_month: description: '' title: exp_month @@ -9951,6 +11774,15 @@ paths: title: exp_year type: - string + expand: + description: Specifies which fields in the response should be expanded. + items: + type: + - string + title: expand + type: + - array + - string metadata: description: '' title: metadata @@ -9961,11 +11793,6 @@ paths: title: name type: - string - validate: - description: '' - title: validate - type: - - boolean responses: '200': description: Successful response. @@ -10002,6 +11829,15 @@ paths: title: amounts type: - array + expand: + description: Specifies which fields in the response should be expanded. + items: + type: + - string + title: expand + type: + - array + - string verification_method: description: '' title: verification_method @@ -10021,6 +11857,11 @@ paths: description: '' operationId: AllCustomerCards parameters: + - description: Specifies which fields in the response should be expanded. + in: query + name: expand + required: false + type: string - description: A limit on the number of objects to be returned. Limit can range between 1 and 100 items. in: query @@ -10089,6 +11930,7 @@ paths: title: CardList type: - object + x-expandableFields: [] default: description: Error response. schema: @@ -10100,9 +11942,18 @@ paths: - description: Body parameters for the request. in: body name: payload - required: false + required: true schema: properties: + expand: + description: Specifies which fields in the response should be expanded. + items: + type: + - string + title: expand + type: + - array + - string metadata: description: A set of key/value pairs that you can attach to a card object. It can be useful for storing additional information about @@ -10137,6 +11988,21 @@ paths: name: id required: true type: string + - description: Body parameters for the request. + in: body + name: payload + required: false + schema: + properties: + expand: + description: Specifies which fields in the response should be expanded. + items: + type: + - string + title: expand + type: + - array + - string responses: '200': description: Successful response. @@ -10150,6 +12016,11 @@ paths: description: '' operationId: RetrieveCustomerCard parameters: + - description: Specifies which fields in the response should be expanded. + in: query + name: expand + required: false + type: string - description: The ID of the card to be retrieved. in: path name: id @@ -10209,11 +12080,6 @@ paths: title: address_zip type: - string - cvc: - description: '' - title: cvc - type: - - string exp_month: description: '' title: exp_month @@ -10224,6 +12090,15 @@ paths: title: exp_year type: - string + expand: + description: Specifies which fields in the response should be expanded. + items: + type: + - string + title: expand + type: + - array + - string metadata: description: '' title: metadata @@ -10234,11 +12109,6 @@ paths: title: name type: - string - validate: - description: '' - title: validate - type: - - boolean responses: '200': description: Successful response. @@ -10252,7 +12122,22 @@ paths: delete: description: "

Removes the currently applied discount on a customer.

" operationId: DeleteCustomerDiscount - parameters: [] + parameters: + - description: Body parameters for the request. + in: body + name: payload + required: false + schema: + properties: + expand: + description: Specifies which fields in the response should be expanded. + items: + type: + - string + title: expand + type: + - array + - string responses: '200': description: Successful response. @@ -10266,6 +12151,11 @@ paths: description: '' operationId: RetrieveCustomerDiscount parameters: + - description: Specifies which fields in the response should be expanded. + in: query + name: expand + required: false + type: string - description: '' in: path name: customer @@ -10285,6 +12175,11 @@ paths: description: '' operationId: AllCustomerSources parameters: + - description: Specifies which fields in the response should be expanded. + in: query + name: expand + required: false + type: string - description: A limit on the number of objects to be returned. Limit can range between 1 and 100 items. in: query @@ -10314,6 +12209,11 @@ paths: name: customer required: true type: string + - description: '' + in: query + name: type + required: false + type: string responses: '200': description: Successful response. @@ -10321,8 +12221,7 @@ paths: properties: data: items: - type: - - object + "$ref": "#/definitions/account_debit_account" type: - array has_more: @@ -10354,6 +12253,8 @@ paths: title: SourceList type: - object + x-expandableFields: + - data default: description: Error response. schema: @@ -10365,9 +12266,18 @@ paths: - description: Body parameters for the request. in: body name: payload - required: false + required: true schema: properties: + expand: + description: Specifies which fields in the response should be expanded. + items: + type: + - string + title: expand + type: + - array + - string metadata: description: A set of key/value pairs that you can attach to a card object. It can be useful for storing additional information about @@ -10402,6 +12312,21 @@ paths: name: id required: true type: string + - description: Body parameters for the request. + in: body + name: payload + required: false + schema: + properties: + expand: + description: Specifies which fields in the response should be expanded. + items: + type: + - string + title: expand + type: + - array + - string responses: '200': description: Successful response. @@ -10415,6 +12340,11 @@ paths: description: '' operationId: RetrieveCustomerSource parameters: + - description: Specifies which fields in the response should be expanded. + in: query + name: expand + required: false + type: string - description: The ID of the source to be retrieved. in: path name: id @@ -10474,11 +12404,6 @@ paths: title: address_zip type: - string - cvc: - description: '' - title: cvc - type: - - string exp_month: description: '' title: exp_month @@ -10489,6 +12414,15 @@ paths: title: exp_year type: - string + expand: + description: Specifies which fields in the response should be expanded. + items: + type: + - string + title: expand + type: + - array + - string metadata: description: '' title: metadata @@ -10499,11 +12433,6 @@ paths: title: name type: - string - validate: - description: '' - title: validate - type: - - boolean responses: '200': description: Successful response. @@ -10540,6 +12469,15 @@ paths: title: amounts type: - array + expand: + description: Specifies which fields in the response should be expanded. + items: + type: + - string + title: expand + type: + - array + - string verification_method: description: '' title: verification_method @@ -10562,6 +12500,11 @@ paths: the limit and starting_after parameters to page through additional subscriptions.

" operationId: AllCustomerSubscriptions parameters: + - description: Specifies which fields in the response should be expanded. + in: query + name: expand + required: false + type: string - description: A limit on the number of objects to be returned. Limit can range between 1 and 100 items. in: query @@ -10630,6 +12573,7 @@ paths: title: SubscriptionList type: - object + x-expandableFields: [] default: description: Error response. schema: @@ -10649,30 +12593,16 @@ paths: required: false schema: properties: - account_balance: - description: '' - title: account_balance - type: - - integer application_fee_percent: description: A non-negative decimal (with at most two decimal places) between 0 and 100. 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 with an OAuth key 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). + application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions). title: application_fee_percent type: - number - billing: - description: 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. - title: billing - type: - - string coupon: description: The code of the coupon to apply to this subscription. A coupon applied to a subscription will only affect invoices created @@ -10680,12 +12610,15 @@ paths: title: coupon type: - string - days_until_due: - description: Number of days a customer has to pay invoices generated - by this subscription. - title: days_until_due + expand: + description: Specifies which fields in the response should be expanded. + items: + type: + - string + title: expand type: - - integer + - array + - string items: description: List of subscription items, each with an attached plan. title: items @@ -10698,21 +12631,11 @@ paths: title: metadata type: - object - on_behalf_of: - description: '' - title: on_behalf_of - type: - - string plan: description: The identifier of the plan to subscribe the customer to. title: plan type: - string - prorate: - description: '' - title: prorate - type: - - boolean quantity: description: The quantity you'd like to apply to the subscription you're creating. For example, if your plan is 10/user/month, @@ -10727,11 +12650,6 @@ paths: title: quantity type: - integer - retains_own_balance: - description: '' - title: retains_own_balance - type: - - boolean source: description: The source can either be a token, like the ones returned by [Elements](https://stripe.com/docs/elements), or a dictionary containing @@ -10817,6 +12735,15 @@ paths: title: at_period_end type: - boolean + expand: + description: Specifies which fields in the response should be expanded. + items: + type: + - string + title: expand + type: + - array + - string responses: '200': description: Successful response. @@ -10829,7 +12756,12 @@ paths: get: description: "

Retrieves the subscription with the given ID.

" operationId: RetrieveCustomerSubscription - parameters: [] + parameters: + - description: Specifies which fields in the response should be expanded. + in: query + name: expand + required: false + type: string responses: '200': description: Successful response. @@ -10853,11 +12785,6 @@ paths: required: false schema: properties: - account_balance: - description: '' - title: account_balance - type: - - integer application_fee_percent: description: A non-negative decimal (with at most two decimal places) between 0 and 100. This represents the percentage of the subscription @@ -10868,15 +12795,6 @@ paths: title: application_fee_percent type: - number - billing: - description: 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. - title: billing - type: - - string coupon: description: The code of the coupon to apply to this subscription. A coupon applied to a subscription will only affect invoices created @@ -10884,22 +12802,20 @@ paths: title: coupon type: - string - days_until_due: - description: Number of days a customer has to pay invoices generated - by this subscription. - title: days_until_due + expand: + description: Specifies which fields in the response should be expanded. + items: + type: + - string + title: expand type: - - integer + - array + - string items: description: List of subscription items, each with an attached plan. title: items type: - array - max_occurrences: - description: '' - title: max_occurrences - type: - - integer metadata: description: A set of key/value pairs that you can attach to a subscription object. It can be useful for storing additional information about @@ -10907,11 +12823,6 @@ paths: title: metadata type: - object - pay_immediately: - description: '' - title: pay_immediately - type: - - boolean plan: description: The identifier of the plan to update the subscription to. If omitted, the subscription will not change plans. @@ -10948,11 +12859,6 @@ paths: title: quantity type: - integer - retains_own_balance: - description: '' - title: retains_own_balance - type: - - boolean source: description: The source can either be a token, like the ones returned by [Elements](https://stripe.com/docs/elements), or a dictionary containing @@ -11002,7 +12908,22 @@ paths: delete: description: "

Removes the currently applied discount on a customer.

" operationId: DeleteCustomerDiscount - parameters: [] + parameters: + - description: Body parameters for the request. + in: body + name: payload + required: false + schema: + properties: + expand: + description: Specifies which fields in the response should be expanded. + items: + type: + - string + title: expand + type: + - array + - string responses: '200': description: Successful response. @@ -11016,6 +12937,11 @@ paths: description: '' operationId: RetrieveCustomerDiscount parameters: + - description: Specifies which fields in the response should be expanded. + in: query + name: expand + required: false + type: string - description: '' in: path name: customer @@ -11035,6 +12961,11 @@ paths: description: "

Returns a list of your disputes.

" operationId: AllDisputes parameters: + - description: Specifies which fields in the response should be expanded. + in: query + name: expand + required: false + type: string - description: A limit on the number of objects to be returned. Limit can range between 1 and 100 items. in: query @@ -11104,6 +13035,7 @@ paths: - url type: - object + x-expandableFields: [] default: description: Error response. schema: @@ -11113,6 +13045,11 @@ paths: description: "

Retrieves the dispute with the given ID.

" operationId: RetrieveDispute parameters: + - description: Specifies which fields in the response should be expanded. + in: query + name: expand + required: false + type: string - description: ID of dispute to retrieve. in: path name: dispute @@ -11154,6 +13091,15 @@ paths: title: evidence type: - object + expand: + description: Specifies which fields in the response should be expanded. + items: + type: + - string + title: expand + type: + - array + - string metadata: description: A set of key/value pairs that you can attach to a dispute object. It can be useful for storing additional information about @@ -11184,6 +13130,21 @@ paths: name: dispute required: true type: string + - description: Body parameters for the request. + in: body + name: payload + required: false + schema: + properties: + expand: + description: Specifies which fields in the response should be expanded. + items: + type: + - string + title: expand + type: + - array + - string responses: '200': description: Successful response. @@ -11198,6 +13159,11 @@ paths: description: "

List events, going back up to 30 days.

" operationId: AllEvents parameters: + - description: Specifies which fields in the response should be expanded. + in: query + name: expand + required: false + type: string - description: A limit on the number of objects to be returned. Limit can range between 1 and 100 items. in: query @@ -11281,6 +13247,7 @@ paths: - url type: - object + x-expandableFields: [] default: description: Error response. schema: @@ -11291,6 +13258,11 @@ paths: of the event, which you might have received in a webhook.

" operationId: RetrieveEvent parameters: + - description: Specifies which fields in the response should be expanded. + in: query + name: expand + required: false + type: string - description: The identifier of the event to be retrieved. in: path name: id @@ -11315,6 +13287,21 @@ paths: name: id required: true type: string + - description: Body parameters for the request. + in: body + name: payload + required: false + schema: + properties: + expand: + description: Specifies which fields in the response should be expanded. + items: + type: + - string + title: expand + type: + - array + - string responses: '200': description: Successful response. @@ -11331,6 +13318,11 @@ paths: first.

" operationId: AllInvoiceItems parameters: + - description: Specifies which fields in the response should be expanded. + in: query + name: expand + required: false + type: string - description: A limit on the number of objects to be returned. Limit can range between 1 and 100 items. in: query @@ -11406,6 +13398,7 @@ paths: - url type: - object + x-expandableFields: [] default: description: Error response. schema: @@ -11453,6 +13446,15 @@ paths: title: discountable type: - boolean + expand: + description: Specifies which fields in the response should be expanded. + items: + type: + - string + title: expand + type: + - array + - string invoice: description: The ID of an existing invoice to add this invoice item to. When left blank, the invoice item will be added to the next upcoming @@ -11503,6 +13505,21 @@ paths: name: invoiceitem required: true type: string + - description: Body parameters for the request. + in: body + name: payload + required: false + schema: + properties: + expand: + description: Specifies which fields in the response should be expanded. + items: + type: + - string + title: expand + type: + - array + - string responses: '200': description: Successful response. @@ -11516,6 +13533,11 @@ paths: description: "

Retrieves the invoice item with the given ID.

" operationId: RetrieveInvoiceItem parameters: + - description: Specifies which fields in the response should be expanded. + in: query + name: expand + required: false + type: string - description: The ID of the desired invoice item. in: path name: invoiceitem @@ -11562,6 +13584,15 @@ paths: title: discountable type: - boolean + expand: + description: Specifies which fields in the response should be expanded. + items: + type: + - string + title: expand + type: + - array + - string metadata: description: A set of key/value pairs that you can attach to an invoice item object. It can be useful for storing additional information about @@ -11585,6 +13616,11 @@ paths: recently created invoices appearing first.

" operationId: AllInvoices parameters: + - description: Specifies which fields in the response should be expanded. + in: query + name: expand + required: false + type: string - description: A limit on the number of objects to be returned. Limit can range between 1 and 100 items. in: query @@ -11609,12 +13645,14 @@ paths: name: ending_before required: false type: string - - description: The identifier of the customer whose invoices to return. + - description: Only return invoices for the customer specified by this customer + ID. in: query name: customer required: false type: string - - description: The identifier of the subscription whose invoices to return. + - description: Only return invoices for the subscription specified by this subscription + ID. in: query name: subscription required: false @@ -11664,6 +13702,7 @@ paths: - url type: - object + x-expandableFields: [] default: description: Error response. schema: @@ -11680,7 +13719,7 @@ paths: - description: Body parameters for the request. in: body name: payload - required: false + required: true schema: properties: application_fee: @@ -11691,35 +13730,25 @@ paths: title: application_fee type: - integer - billing: - description: 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. - title: billing - type: - - string customer: description: '' title: customer type: - string - days_until_due: - description: The number of days from which the invoice is created until - it is due. - title: days_until_due - type: - - integer description: description: '' title: description type: - string - due_date: - description: The date on which payment for this invoice is due. - title: due_date + expand: + description: Specifies which fields in the response should be expanded. + items: + type: + - string + title: expand type: - - integer + - array + - string metadata: description: '' title: metadata @@ -11778,6 +13807,11 @@ paths: resource.

" operationId: RetrieveCustomerUpcomingInvoice parameters: + - description: Specifies which fields in the response should be expanded. + in: query + name: expand + required: false + type: string - description: The identifier of the customer whose upcoming invoice you'd like to retrieve. in: query @@ -11867,6 +13901,11 @@ paths: description: "

Retrieves the invoice with the given ID.

" operationId: RetrieveInvoice parameters: + - description: Specifies which fields in the response should be expanded. + in: query + name: expand + required: false + type: string - description: The identifier of the desired invoice. in: path name: invoice @@ -11913,6 +13952,15 @@ paths: title: description type: - string + expand: + description: Specifies which fields in the response should be expanded. + items: + type: + - string + title: expand + type: + - array + - string forgiven: description: Boolean representing whether an invoice is forgiven or not. To forgive an invoice, pass true. Forgiving an invoice instructs @@ -11927,12 +13975,6 @@ paths: title: metadata type: - object - paid: - description: Boolean representing whether an invoice is paid or not. - To mark invoice as paid, pass true. - title: paid - type: - - boolean statement_descriptor: description: Extra information about a charge for the customer's credit card statement. @@ -11963,6 +14005,11 @@ paths: list of line items.

" operationId: AllInvoiceLines parameters: + - description: Specifies which fields in the response should be expanded. + in: query + name: expand + required: false + type: string - description: The maximum number of line items to return. in: query name: limit @@ -12103,6 +14150,7 @@ paths: title: InvoiceLinesList type: - object + x-expandableFields: [] default: description: Error response. schema: @@ -12121,6 +14169,21 @@ paths: name: invoice required: true type: string + - description: Body parameters for the request. + in: body + name: payload + required: false + schema: + properties: + expand: + description: Specifies which fields in the response should be expanded. + items: + type: + - string + title: expand + type: + - array + - string responses: '200': description: Successful response. @@ -12136,6 +14199,11 @@ paths: sorted by creation date, with the most recently created return appearing first.

" operationId: AllOrderReturns parameters: + - description: Specifies which fields in the response should be expanded. + in: query + name: expand + required: false + type: string - description: The order to retrieve returns for. in: query name: order @@ -12210,6 +14278,7 @@ paths: - url type: - object + x-expandableFields: [] default: description: Error response. schema: @@ -12221,6 +14290,11 @@ paths: return list, and Stripe will return the corresponding order information.

" operationId: RetrieveOrderReturn parameters: + - description: Specifies which fields in the response should be expanded. + in: query + name: expand + required: false + type: string - description: The identifier of the order return to be retrieved. in: path name: id @@ -12241,6 +14315,11 @@ paths: by creation date, with the most recently created orders appearing first.

" operationId: AllOrders parameters: + - description: Specifies which fields in the response should be expanded. + in: query + name: expand + required: false + type: string - description: A limit on the number of objects to be returned. Limit can range between 1 and 100 items. in: query @@ -12337,6 +14416,7 @@ paths: - url type: - object + x-expandableFields: [] default: description: Error response. schema: @@ -12378,6 +14458,15 @@ paths: title: email type: - string + expand: + description: Specifies which fields in the response should be expanded. + items: + type: + - string + title: expand + type: + - array + - string items: description: List of items constituting the order. title: items @@ -12414,6 +14503,11 @@ paths: will return the corresponding order information.

" operationId: RetrieveOrder parameters: + - description: Specifies which fields in the response should be expanded. + in: query + name: expand + required: false + type: string - description: The identifier of the order to be retrieved. in: path name: id @@ -12452,6 +14546,15 @@ paths: title: coupon type: - string + expand: + description: Specifies which fields in the response should be expanded. + items: + type: + - string + title: expand + type: + - array + - string metadata: description: A set of key/value pairs that you can attach to a product object. It can be useful for storing additional information about @@ -12522,6 +14625,15 @@ paths: title: email type: - string + expand: + description: Specifies which fields in the response should be expanded. + items: + type: + - string + title: expand + type: + - array + - string metadata: description: A set of key/value pairs that you can attach to an order object. It can be useful for storing additional information about @@ -12574,6 +14686,15 @@ paths: required: false schema: properties: + expand: + description: Specifies which fields in the response should be expanded. + items: + type: + - string + title: expand + type: + - array + - string items: description: List of items to return. title: items @@ -12593,6 +14714,11 @@ paths: description: '' operationId: AllPayments parameters: + - description: Specifies which fields in the response should be expanded. + in: query + name: expand + required: false + type: string - description: A limit on the number of objects to be returned. Limit can range between 1 and 100 items. in: query @@ -12668,6 +14794,193 @@ paths: - url type: - object + x-expandableFields: [] + default: + description: Error response. + schema: + "$ref": "#/definitions/error" + post: + description: '' + operationId: CreatePayment + parameters: + - description: Body parameters for the request. + in: body + name: payload + required: true + schema: + properties: + alternate_statement_descriptors: + description: '' + title: alternate_statement_descriptors + type: + - object + amount: + description: '' + title: amount + type: + - integer + application: + description: '' + title: application + type: + - string + application_fee: + description: '' + title: application_fee + type: + - integer + capture: + description: '' + title: capture + type: + - boolean + currency: + description: '' + title: currency + type: + - string + customer: + description: '' + title: customer + type: + - string + description: + description: '' + title: description + type: + - string + destination: + description: '' + title: destination + type: + - object + expand: + description: Specifies which fields in the response should be expanded. + items: + type: + - string + title: expand + type: + - array + - string + external_id: + description: '' + title: external_id + type: + - string + idempotency_key: + description: '' + title: idempotency_key + type: + - string + invoice: + description: '' + title: invoice + type: + - string + invoice_source: + description: '' + title: invoice_source + type: + - string + ip: + description: '' + title: ip + type: + - string + level3: + description: '' + title: level3 + type: + - object + metadata: + description: '' + title: metadata + type: + - object + on_behalf_of: + description: '' + title: on_behalf_of + type: + - string + order: + description: '' + title: order + type: + - string + payment_method: + description: '' + title: payment_method + type: + - string + payment_user_agent: + description: '' + title: payment_user_agent + type: + - string + receipt_email: + description: '' + title: receipt_email + type: + - string + recurring: + description: '' + title: recurring + type: + - boolean + referrer: + description: '' + title: referrer + type: + - string + shipping: + description: '' + title: shipping + type: + - object + source: + description: '' + title: source + type: + - string + statement_descriptor: + description: '' + title: statement_descriptor + type: + - string + three_d_secure: + description: '' + title: three_d_secure + type: + - object + transfer_group: + description: '' + title: transfer_group + type: + - string + trust: + description: '' + title: trust + type: + - object + uncaptured: + description: '' + title: uncaptured + type: + - boolean + user_agent: + description: '' + title: user_agent + type: + - string + required: + - amount + - currency + responses: + '200': + description: Successful response. + schema: + "$ref": "#/definitions/charge" default: description: Error response. schema: @@ -12677,6 +14990,11 @@ paths: description: '' operationId: RetrievePayment parameters: + - description: Specifies which fields in the response should be expanded. + in: query + name: expand + required: false + type: string - description: '' in: path name: payment @@ -12698,6 +15016,11 @@ paths: with the most recently created payouts appearing first.

" operationId: PayoutAll parameters: + - description: Specifies which fields in the response should be expanded. + in: query + name: expand + required: false + type: string - description: A limit on the number of objects to be returned. Limit can range between 1 and 100 items. in: query @@ -12785,6 +15108,7 @@ paths: title: PayoutList type: - object + x-expandableFields: [] default: description: Error response. schema: @@ -12818,12 +15142,21 @@ paths: type: - string destination: - description: The id of a bank account or a card to send the payout to. + description: The ID of a bank account or a card to send the payout to. If no destination is supplied, the default external account for the specified currency will be used. title: destination type: - string + expand: + description: Specifies which fields in the response should be expanded. + items: + type: + - string + title: expand + type: + - array + - string metadata: description: A set of key/value pairs that you can attach to a payout object. It can be useful for storing additional information about @@ -12867,16 +15200,21 @@ paths: description: Error response. schema: "$ref": "#/definitions/error" - "/v1/payouts/{id}": + "/v1/payouts/{payout}": get: description: "

Retrieves the details of an existing payout. Supply the unique payout ID from either a payout creation request or the payout list, and Stripe will return the corresponding payout information.

" operationId: PayoutRetrieve parameters: + - description: Specifies which fields in the response should be expanded. + in: query + name: expand + required: false + type: string - description: The identifier of the payout to be retrieved. in: path - name: id + name: payout required: true type: string responses: @@ -12896,7 +15234,7 @@ paths: parameters: - description: The identifier of the payout to be updated. in: path - name: id + name: payout required: true type: string - description: Body parameters for the request. @@ -12905,6 +15243,15 @@ paths: required: false schema: properties: + expand: + description: Specifies which fields in the response should be expanded. + items: + type: + - string + title: expand + type: + - array + - string metadata: description: A set of key/value pairs that you can attach to a payout object. It can be useful for storing additional information about @@ -12921,7 +15268,7 @@ paths: description: Error response. schema: "$ref": "#/definitions/error" - "/v1/payouts/{id}/cancel": + "/v1/payouts/{payout}/cancel": post: description: "

A previously created payout can be canceled if it has not yet been paid out. Funds will be refunded to your available balance, and the fees @@ -12931,9 +15278,24 @@ paths: parameters: - description: The identifier of the payout to be canceled. in: path - name: id + name: payout required: true type: string + - description: Body parameters for the request. + in: body + name: payload + required: false + schema: + properties: + expand: + description: Specifies which fields in the response should be expanded. + items: + type: + - string + title: expand + type: + - array + - string responses: '200': description: Successful response. @@ -12948,6 +15310,11 @@ paths: description: "

Returns a list of your plans.

" operationId: AllPlans parameters: + - description: Specifies which fields in the response should be expanded. + in: query + name: expand + required: false + type: string - description: A limit on the number of objects to be returned. Limit can range between 1 and 100 items. in: query @@ -13019,6 +15386,7 @@ paths: - url type: - object + x-expandableFields: [] default: description: Error response. schema: @@ -13047,6 +15415,15 @@ paths: title: currency type: - string + expand: + description: Specifies which fields in the response should be expanded. + items: + type: + - string + title: expand + type: + - array + - string id: description: Unique string of your choice that will be used to identify this plan when subscribing a customer. This could be an identifier @@ -13130,6 +15507,21 @@ paths: name: plan required: true type: string + - description: Body parameters for the request. + in: body + name: payload + required: false + schema: + properties: + expand: + description: Specifies which fields in the response should be expanded. + items: + type: + - string + title: expand + type: + - array + - string responses: '200': description: Successful response. @@ -13143,6 +15535,11 @@ paths: description: "

Retrieves the plan with the given ID.

" operationId: RetrievePlan parameters: + - description: Specifies which fields in the response should be expanded. + in: query + name: expand + required: false + type: string - description: The ID of the desired plan. in: path name: plan @@ -13173,6 +15570,15 @@ paths: required: false schema: properties: + expand: + description: Specifies which fields in the response should be expanded. + items: + type: + - string + title: expand + type: + - array + - string metadata: description: A set of key/value pairs that you can attach to a plan object. It can be useful for storing additional information about @@ -13223,6 +15629,11 @@ paths: first.

" operationId: AllProducts parameters: + - description: Specifies which fields in the response should be expanded. + in: query + name: expand + required: false + type: string - description: Only return products that are active or inactive (e.g. pass `false` to list all inactive products). in: query @@ -13309,6 +15720,7 @@ paths: - url type: - object + x-expandableFields: [] default: description: Error response. schema: @@ -13353,6 +15765,15 @@ paths: title: description type: - string + expand: + description: Specifies which fields in the response should be expanded. + items: + type: + - string + title: expand + type: + - array + - string id: description: The identifier for the product. Must be unique. If not provided, an identifier will be randomly generated. @@ -13417,6 +15838,21 @@ paths: name: id required: true type: string + - description: Body parameters for the request. + in: body + name: payload + required: false + schema: + properties: + expand: + description: Specifies which fields in the response should be expanded. + items: + type: + - string + title: expand + type: + - array + - string responses: '200': description: Successful response. @@ -13432,6 +15868,11 @@ paths: Stripe will return the corresponding product information.

" operationId: RetrieveProduct parameters: + - description: Specifies which fields in the response should be expanded. + in: query + name: expand + required: false + type: string - description: The identifier of the product to be retrieved. in: path name: id @@ -13494,6 +15935,15 @@ paths: title: description type: - string + expand: + description: Specifies which fields in the response should be expanded. + items: + type: + - string + title: expand + type: + - array + - string images: description: A list of up to 8 URLs of images for this product, meant to be displayable to the customer. @@ -13547,6 +15997,11 @@ paths: first.

" operationId: AllTransferRecipients parameters: + - description: Specifies which fields in the response should be expanded. + in: query + name: expand + required: false + type: string - description: A limit on the number of objects to be returned. Limit can range between 1 and 100 items. in: query @@ -13626,6 +16081,7 @@ paths: - url type: - object + x-expandableFields: [] default: description: Error response. schema: @@ -13640,36 +16096,6 @@ paths: required: true schema: properties: - address_city: - description: '' - title: address_city - type: - - string - address_country: - description: '' - title: address_country - type: - - string - address_line1: - description: '' - title: address_line1 - type: - - string - address_line2: - description: '' - title: address_line2 - type: - - string - address_state: - description: '' - title: address_state - type: - - string - address_zip: - description: '' - title: address_zip - type: - - string bank_account: description: '' title: bank_account @@ -13687,26 +16113,20 @@ paths: title: description type: - string - dob_day: - description: '' - title: dob_day - type: - - integer - dob_month: - description: '' - title: dob_month - type: - - integer - dob_year: - description: '' - title: dob_year - type: - - integer email: description: '' title: email type: - string + expand: + description: Specifies which fields in the response should be expanded. + items: + type: + - string + title: expand + type: + - array + - string metadata: description: '' title: metadata @@ -13749,6 +16169,21 @@ paths: name: id required: true type: string + - description: Body parameters for the request. + in: body + name: payload + required: false + schema: + properties: + expand: + description: Specifies which fields in the response should be expanded. + items: + type: + - string + title: expand + type: + - array + - string responses: '200': description: Successful response. @@ -13763,6 +16198,11 @@ paths: supply the unique recipient identifier that was returned upon recipient creation.

" operationId: RetrieveTransferRecipient parameters: + - description: Specifies which fields in the response should be expanded. + in: query + name: expand + required: false + type: string - description: The identifier of the recipient to be retrieved. in: path name: id @@ -13792,36 +16232,6 @@ paths: required: false schema: properties: - address_city: - description: '' - title: address_city - type: - - string - address_country: - description: '' - title: address_country - type: - - string - address_line1: - description: '' - title: address_line1 - type: - - string - address_line2: - description: '' - title: address_line2 - type: - - string - address_state: - description: '' - title: address_state - type: - - string - address_zip: - description: '' - title: address_zip - type: - - string bank_account: description: '' title: bank_account @@ -13844,26 +16254,20 @@ paths: title: description type: - string - dob_day: - description: '' - title: dob_day - type: - - integer - dob_month: - description: '' - title: dob_month - type: - - integer - dob_year: - description: '' - title: dob_year - type: - - integer email: description: '' title: email type: - string + expand: + description: Specifies which fields in the response should be expanded. + items: + type: + - string + title: expand + type: + - array + - string metadata: description: '' title: metadata @@ -13898,6 +16302,11 @@ paths: description: '' operationId: AllTransferRecipientCards parameters: + - description: Specifies which fields in the response should be expanded. + in: query + name: expand + required: false + type: string - description: A limit on the number of objects to be returned. Limit can range between 1 and 100 items. in: query @@ -13966,6 +16375,7 @@ paths: title: CardList type: - object + x-expandableFields: [] default: description: Error response. schema: @@ -13977,7 +16387,7 @@ paths: - description: Body parameters for the request. in: body name: payload - required: false + required: true schema: properties: card: @@ -13990,6 +16400,15 @@ paths: type: - object - string + expand: + description: Specifies which fields in the response should be expanded. + items: + type: + - string + title: expand + type: + - array + - string required: - card responses: @@ -14016,6 +16435,21 @@ paths: name: recipient required: true type: string + - description: Body parameters for the request. + in: body + name: payload + required: false + schema: + properties: + expand: + description: Specifies which fields in the response should be expanded. + items: + type: + - string + title: expand + type: + - array + - string responses: '200': description: Successful response. @@ -14029,6 +16463,11 @@ paths: description: '' operationId: RetrieveTransferRecipientCard parameters: + - description: Specifies which fields in the response should be expanded. + in: query + name: expand + required: false + type: string - description: ID of card to retrieve. in: path name: id @@ -14098,6 +16537,15 @@ paths: title: exp_year type: - string + expand: + description: Specifies which fields in the response should be expanded. + items: + type: + - string + title: expand + type: + - array + - string name: description: '' title: name @@ -14120,6 +16568,11 @@ paths: default on the charge object.

" operationId: AllRefunds parameters: + - description: Specifies which fields in the response should be expanded. + in: query + name: expand + required: false + type: string - description: A limit on the number of objects to be returned. Limit can range between 1 and 100 items. in: query @@ -14189,6 +16642,7 @@ paths: - url type: - object + x-expandableFields: [] default: description: Error response. schema: @@ -14200,7 +16654,7 @@ paths: - description: Body parameters for the request. in: body name: payload - required: false + required: true schema: properties: amount: @@ -14218,6 +16672,15 @@ paths: title: directive type: - string + expand: + description: Specifies which fields in the response should be expanded. + items: + type: + - string + title: expand + type: + - array + - string metadata: description: '' title: metadata @@ -14254,6 +16717,11 @@ paths: description: "

Retrieves the details of an existing refund.

" operationId: RetrieveRefund parameters: + - description: Specifies which fields in the response should be expanded. + in: query + name: expand + required: false + type: string - description: ID of refund to retrieve. in: path name: refund @@ -14280,6 +16748,15 @@ paths: required: false schema: properties: + expand: + description: Specifies which fields in the response should be expanded. + items: + type: + - string + title: expand + type: + - array + - string metadata: description: A set of key/value pairs that you can attach to a refund object. It can be useful for storing additional information about @@ -14302,6 +16779,11 @@ paths: creation date, with the most recently created SKUs appearing first.

" operationId: AllSKUs parameters: + - description: Specifies which fields in the response should be expanded. + in: query + name: expand + required: false + type: string - description: A limit on the number of objects to be returned. Limit can range between 1 and 100 items. in: query @@ -14398,6 +16880,7 @@ paths: - url type: - object + x-expandableFields: [] default: description: Error response. schema: @@ -14432,6 +16915,15 @@ paths: title: currency type: - string + expand: + description: Specifies which fields in the response should be expanded. + items: + type: + - string + title: expand + type: + - array + - string id: description: The identifier for the SKU. Must be unique. If not provided, an identifier will be randomly generated. @@ -14449,11 +16941,6 @@ paths: title: inventory type: - object - inventory_last_updated: - description: '' - title: inventory_last_updated - type: - - integer metadata: description: A set of key/value pairs that you can attach to a SKU object. It can be useful for storing additional information about the SKU @@ -14503,6 +16990,21 @@ paths: name: id required: true type: string + - description: Body parameters for the request. + in: body + name: payload + required: false + schema: + properties: + expand: + description: Specifies which fields in the response should be expanded. + items: + type: + - string + title: expand + type: + - array + - string responses: '200': description: Successful response. @@ -14518,6 +17020,11 @@ paths: Stripe will return the corresponding SKU information.

" operationId: RetrieveSKU parameters: + - description: Specifies which fields in the response should be expanded. + in: query + name: expand + required: false + type: string - description: The identifier of the SKU to be retrieved. in: path name: id @@ -14567,6 +17074,15 @@ paths: title: currency type: - string + expand: + description: Specifies which fields in the response should be expanded. + items: + type: + - string + title: expand + type: + - array + - string image: description: The URL of an image for this SKU, meant to be displayable to the customer. @@ -14578,11 +17094,6 @@ paths: title: inventory type: - object - inventory_last_updated: - description: '' - title: inventory_last_updated - type: - - integer metadata: description: A set of key/value pairs that you can attach to a SKU object. It can be useful for storing additional information about the SKU @@ -14626,12 +17137,12 @@ paths: - description: Body parameters for the request. in: body name: payload - required: false + required: true schema: properties: amount: description: Amount associated with the source. This is the amount for - which the source will be chargeable once ready. Required for `single-use` + which the source will be chargeable once ready. Required for `single_use` sources. title: amount type: @@ -14643,6 +17154,15 @@ paths: title: currency type: - string + expand: + description: Specifies which fields in the response should be expanded. + items: + type: + - string + title: expand + type: + - array + - string flow: description: The authentication `flow` of the source to create. `flow` is one of `redirect`, `receiver`, `code_verification`, `none`. It @@ -14681,10 +17201,10 @@ paths: type: - string usage: - description: One of `reusable`, `single-use`. Whether this source should - be reusable or not. Some source types may or may not be reusable by - construction, while other may leave the option at creation. If an - incompatible value is passed, an error will be returned. + description: 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 other may leave the option at creation. If + an incompatible value is passed, an error will be returned. title: usage type: - string @@ -14706,6 +17226,11 @@ paths: up-to-date source object information.

" operationId: RetrieveSource parameters: + - description: Specifies which fields in the response should be expanded. + in: query + name: expand + required: false + type: string - description: The identifier of the source to be retrieved. in: path name: source @@ -14738,6 +17263,15 @@ paths: required: false schema: properties: + expand: + description: Specifies which fields in the response should be expanded. + items: + type: + - string + title: expand + type: + - array + - string metadata: description: A set of key/value pairs that you can attach to a source object. It can be useful for storing additional information about @@ -14773,9 +17307,18 @@ paths: - description: Body parameters for the request. in: body name: payload - required: false + required: true schema: properties: + expand: + description: Specifies which fields in the response should be expanded. + items: + type: + - string + title: expand + type: + - array + - string values: description: The values needed to verify the source. title: values @@ -14797,6 +17340,11 @@ paths: description: "

Returns a list of your subscription items for a given subscription.

" operationId: AllSubscriptionItems parameters: + - description: Specifies which fields in the response should be expanded. + in: query + name: expand + required: false + type: string - description: A limit on the number of objects to be returned. Limit can range between 1 and 100 items. in: query @@ -14866,6 +17414,7 @@ paths: - url type: - object + x-expandableFields: [] default: description: Error response. schema: @@ -14881,6 +17430,15 @@ paths: required: true schema: properties: + expand: + description: Specifies which fields in the response should be expanded. + items: + type: + - string + title: expand + type: + - array + - string plan: description: The identifier of the plan to add to the subscription. title: plan @@ -14940,6 +17498,15 @@ paths: required: false schema: properties: + expand: + description: Specifies which fields in the response should be expanded. + items: + type: + - string + title: expand + type: + - array + - string prorate: description: Flag indicating whether to [prorate](/docs/subscriptions/upgrading-downgrading#understanding-proration) switching plans during a billing cycle. @@ -14967,6 +17534,11 @@ paths: description: "

Retrieves the invoice item with the given ID.

" operationId: RetrieveSubscriptionItem parameters: + - description: Specifies which fields in the response should be expanded. + in: query + name: expand + required: false + type: string - description: The identifier of the subscription item to retrieve. in: path name: item @@ -14996,6 +17568,15 @@ paths: required: false schema: properties: + expand: + description: Specifies which fields in the response should be expanded. + items: + type: + - string + title: expand + type: + - array + - string plan: description: The identifier of the new plan for this subscription item. title: plan @@ -15036,6 +17617,11 @@ paths: canceled. In order to list canceled subscriptions, specify status=canceled.

" operationId: AllSubscriptions parameters: + - description: Specifies which fields in the response should be expanded. + in: query + name: expand + required: false + type: string - description: A limit on the number of objects to be returned. Limit can range between 1 and 100 items. in: query @@ -15124,6 +17710,7 @@ paths: - url type: - object + x-expandableFields: [] default: description: Error response. schema: @@ -15135,33 +17722,19 @@ paths: - description: Body parameters for the request. in: body name: payload - required: false + required: true schema: properties: - account_balance: - description: '' - title: account_balance - type: - - integer application_fee_percent: description: A non-negative decimal (with at most two decimal places) between 0 and 100. 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 with an OAuth key 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). + application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions). title: application_fee_percent type: - number - billing: - description: 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. - title: billing - type: - - string coupon: description: The code of the coupon to apply to this subscription. A coupon applied to a subscription will only affect invoices created @@ -15174,12 +17747,15 @@ paths: title: customer type: - string - days_until_due: - description: Number of days a customer has to pay invoices generated - by this subscription. - title: days_until_due + expand: + description: Specifies which fields in the response should be expanded. + items: + type: + - string + title: expand type: - - integer + - array + - string items: description: List of subscription items, each with an attached plan. title: items @@ -15192,21 +17768,11 @@ paths: title: metadata type: - object - on_behalf_of: - description: '' - title: on_behalf_of - type: - - string plan: description: The identifier of the plan to subscribe the customer to. title: plan type: - string - prorate: - description: '' - title: prorate - type: - - boolean quantity: description: The quantity you'd like to apply to the subscription you're creating. For example, if your plan is 10/user/month, @@ -15221,11 +17787,6 @@ paths: title: quantity type: - integer - retains_own_balance: - description: '' - title: retains_own_balance - type: - - boolean source: description: The source can either be a token, like the ones returned by [Elements](https://stripe.com/docs/elements), or a dictionary containing @@ -15313,6 +17874,15 @@ paths: title: at_period_end type: - boolean + expand: + description: Specifies which fields in the response should be expanded. + items: + type: + - string + title: expand + type: + - array + - string responses: '200': description: Successful response. @@ -15325,7 +17895,12 @@ paths: get: description: "

Retrieves the subscription with the given ID.

" operationId: RetrieveCustomerSubscription - parameters: [] + parameters: + - description: Specifies which fields in the response should be expanded. + in: query + name: expand + required: false + type: string responses: '200': description: Successful response. @@ -15349,11 +17924,6 @@ paths: required: false schema: properties: - account_balance: - description: '' - title: account_balance - type: - - integer application_fee_percent: description: A non-negative decimal (with at most two decimal places) between 0 and 100. This represents the percentage of the subscription @@ -15364,15 +17934,6 @@ paths: title: application_fee_percent type: - number - billing: - description: 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. - title: billing - type: - - string coupon: description: The code of the coupon to apply to this subscription. A coupon applied to a subscription will only affect invoices created @@ -15380,22 +17941,20 @@ paths: title: coupon type: - string - days_until_due: - description: Number of days a customer has to pay invoices generated - by this subscription. - title: days_until_due + expand: + description: Specifies which fields in the response should be expanded. + items: + type: + - string + title: expand type: - - integer + - array + - string items: description: List of subscription items, each with an attached plan. title: items type: - array - max_occurrences: - description: '' - title: max_occurrences - type: - - integer metadata: description: A set of key/value pairs that you can attach to a subscription object. It can be useful for storing additional information about @@ -15403,11 +17962,6 @@ paths: title: metadata type: - object - pay_immediately: - description: '' - title: pay_immediately - type: - - boolean plan: description: The identifier of the plan to update the subscription to. If omitted, the subscription will not change plans. @@ -15444,11 +17998,6 @@ paths: title: quantity type: - integer - retains_own_balance: - description: '' - title: retains_own_balance - type: - - boolean source: description: The source can either be a token, like the ones returned by [Elements](https://stripe.com/docs/elements), or a dictionary containing @@ -15498,7 +18047,22 @@ paths: delete: description: "

Removes the currently applied discount on a customer.

" operationId: DeleteCustomerDiscount - parameters: [] + parameters: + - description: Body parameters for the request. + in: body + name: payload + required: false + schema: + properties: + expand: + description: Specifies which fields in the response should be expanded. + items: + type: + - string + title: expand + type: + - array + - string responses: '200': description: Successful response. @@ -15525,6 +18089,15 @@ paths: type: - object - string + expand: + description: Specifies which fields in the response should be expanded. + items: + type: + - string + title: expand + type: + - array + - string payment_user_agent: description: '' title: payment_user_agent @@ -15549,6 +18122,11 @@ paths: description: "

Retrieves the token with the given ID.

" operationId: RetrieveToken parameters: + - description: Specifies which fields in the response should be expanded. + in: query + name: expand + required: false + type: string - description: The ID of the desired token. in: path name: token @@ -15570,6 +18148,11 @@ paths: transfers appearing first.

" operationId: AllTransfers parameters: + - description: Specifies which fields in the response should be expanded. + in: query + name: expand + required: false + type: string - description: A limit on the number of objects to be returned. Limit can range between 1 and 100 items. in: query @@ -15651,6 +18234,7 @@ paths: title: TransferList type: - object + x-expandableFields: [] default: description: Error response. schema: @@ -15680,6 +18264,15 @@ paths: title: destination type: - string + expand: + description: Specifies which fields in the response should be expanded. + items: + type: + - string + title: expand + type: + - array + - string metadata: description: '' title: metadata @@ -15703,6 +18296,7 @@ paths: required: - amount - currency + - destination responses: '200': description: Successful response. @@ -15719,6 +18313,11 @@ paths: and Stripe will return the corresponding transfer information.

" operationId: RetrieveTransfer parameters: + - description: Specifies which fields in the response should be expanded. + in: query + name: expand + required: false + type: string - description: The identifier of the transfer to be retrieved. in: path name: id @@ -15748,6 +18347,15 @@ paths: required: false schema: properties: + expand: + description: Specifies which fields in the response should be expanded. + items: + type: + - string + title: expand + type: + - array + - string metadata: description: '' title: metadata @@ -15772,6 +18380,21 @@ paths: name: id required: true type: string + - description: Body parameters for the request. + in: body + name: payload + required: false + schema: + properties: + expand: + description: Specifies which fields in the response should be expanded. + items: + type: + - string + title: expand + type: + - array + - string responses: '200': description: Successful response. @@ -15790,6 +18413,11 @@ paths: to page through additional reversals.

" operationId: AllTransferReversals parameters: + - description: Specifies which fields in the response should be expanded. + in: query + name: expand + required: false + type: string - description: A limit on the number of objects to be returned. Limit can range between 1 and 100 items. in: query @@ -15858,6 +18486,7 @@ paths: title: TransferReversalList type: - object + x-expandableFields: [] default: description: Error response. schema: @@ -15887,6 +18516,15 @@ paths: title: description type: - string + expand: + description: Specifies which fields in the response should be expanded. + items: + type: + - string + title: expand + type: + - array + - string metadata: description: '' title: metadata @@ -15913,6 +18551,11 @@ paths: specific reversal stored on the transfer.

" operationId: RetrieveTransferReversal parameters: + - description: Specifies which fields in the response should be expanded. + in: query + name: expand + required: false + type: string - description: ID of the transfer reversed. in: path name: transfer @@ -15954,6 +18597,15 @@ paths: required: false schema: properties: + expand: + description: Specifies which fields in the response should be expanded. + items: + type: + - string + title: expand + type: + - array + - string metadata: description: A set of key/value pairs that you can attach to a reversal object. It can be useful for storing additional information about