openapi/spec2.yaml in stripe-2.9.0 vs openapi/spec2.yaml in stripe-2.10.0

- old
+ new

@@ -2,14 +2,10 @@ consumes: - application/x-www-form-urlencoded definitions: account: properties: - active_payment_methods: - description: '' - type: - - array business_name: description: The publicly visible name of the business. type: - string business_url: @@ -51,12 +47,11 @@ - string external_accounts: properties: data: items: - type: - - object + "$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. @@ -84,10 +79,12 @@ - object - url title: ExternalAccountList type: - object + x-expandableFields: + - data id: description: Unique identifier for the object. type: - string legal_entity: @@ -95,14 +92,10 @@ managed: description: Whether or not the account is [managed](/docs/connect/managed-accounts) 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 format. type: @@ -110,12 +103,10 @@ object: description: String representing the object's type. Objects of the same type share the same value. type: - string - orders: - "$ref": "#/definitions/settings" payout_schedule: "$ref": "#/definitions/transfer_schedule" payout_statement_descriptor: description: The text that will appear on the account's bank account statement for payouts. If not set, this will default to your platform's bank descriptor @@ -156,11 +147,10 @@ tos_acceptance: "$ref": "#/definitions/account_tos_acceptance" verification: "$ref": "#/definitions/account_verification" required: - - active_payment_methods - charges_enabled - country - debit_negative_balances - decline_charge_on - default_currency @@ -175,11 +165,31 @@ - tos_acceptance - verification 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: description: Whether or not Stripe should automatically decline charges with an incorrect zip/postal code. This setting only applies if a card includes @@ -196,10 +206,11 @@ - avs_failure - cvc_failure title: AccountDeclineChargeOn type: - object + x-expandableFields: [] x-resourceId: account_decline_charge_on account_tos_acceptance: properties: date: description: The timestamp when the account owner accepted Stripe's terms. @@ -216,10 +227,11 @@ type: - string title: AccountTOSAcceptance type: - object + x-expandableFields: [] x-resourceId: account_tos_acceptance account_verification: properties: disabled_reason: description: A string describing the reason for this account being unable @@ -244,17 +256,14 @@ required: - fields_needed 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: - string business_url: @@ -296,12 +305,11 @@ - string external_accounts: properties: data: items: - type: - - object + "$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. @@ -329,10 +337,12 @@ - object - url title: ExternalAccountList type: - object + x-expandableFields: + - data id: description: Unique identifier for the object. type: - string keys: @@ -344,14 +354,10 @@ managed: description: Whether or not the account is [managed](/docs/connect/managed-accounts) 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 format. type: @@ -359,12 +365,10 @@ object: description: String representing the object's type. Objects of the same type share the same value. type: - string - orders: - "$ref": "#/definitions/settings" payout_schedule: "$ref": "#/definitions/transfer_schedule" payout_statement_descriptor: description: The text that will appear on the account's bank account statement for payouts. If not set, this will default to your platform's bank descriptor @@ -405,11 +409,10 @@ tos_acceptance: "$ref": "#/definitions/account_tos_acceptance" verification: "$ref": "#/definitions/account_verification" required: - - active_payment_methods - charges_enabled - country - debit_negative_balances - decline_charge_on - default_currency @@ -425,10 +428,11 @@ - tos_acceptance - verification title: AccountWithKeys type: - object + x-expandableFields: [] x-resourceId: account_with_keys address: properties: city: description: City/District/Suburb/Town/Village. @@ -455,10 +459,11 @@ type: - string title: Address type: - object + x-expandableFields: [] x-resourceId: address alipay_account: properties: created: description: Time at which the object was created. Measured in seconds since @@ -467,10 +472,13 @@ - integer customer: 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. type: - string @@ -529,10 +537,12 @@ - used - username title: AlipayAccount type: - object + x-expandableFields: + - customer x-resourceId: alipay_account apple_pay_domain: properties: created: description: Time at which the object was created. Measured in seconds since @@ -564,31 +574,239 @@ - livemode - object 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: + name: + description: The name of the application. + 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: Application + type: + - object + x-expandableFields: [] + x-resourceId: application + authorization: + properties: + amount: description: '' type: + - integer + balance_transactions: + items: + "$ref": "#/definitions/balance_transaction" + type: + - array + card: + description: '' + type: - string - type: + 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: - - type - title: AuthorizationSettings + - amount + - balance_transactions + - card + - currency + - held_amount + - held_currency + - id + - merchant_data + - metadata + - object + title: Authorization type: - object - x-resourceId: authorization_settings + 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: description: Funds that are available to be paid out automatically by Stripe or explicitly via the [transfers API](#transfers). The available balance @@ -623,10 +841,11 @@ - object - pending title: Balance type: - object + x-expandableFields: [] x-resourceId: balance balance_transaction: properties: amount: description: Gross amount of the transaction, in %s. @@ -655,11 +874,14 @@ fee: description: Fees (in %s) paid for this transaction. type: - integer fee_details: - "$ref": "#/definitions/fee" + items: + "$ref": "#/definitions/fee" + type: + - array id: description: Unique identifier for the object. type: - string net: @@ -673,20 +895,36 @@ - string source: 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`. type: - string 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: - amount - available_on @@ -700,50 +938,31 @@ - status - type title: BalanceTransaction type: - object + x-expandableFields: + - source x-resourceId: balance_transaction bank_account: properties: account: 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: - string account_holder_type: description: The type of entity that holds the account. This can be either `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`. type: - string @@ -759,14 +978,13 @@ - string customer: 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. type: - boolean @@ -792,14 +1010,10 @@ object: description: String representing the object's type. Objects of the same type share the same value. type: - string - reusable: - description: '' - type: - - boolean routing_number: description: The routing transit number for the bank account. type: - string status: @@ -813,24 +1027,23 @@ as microdeposit failure, the status will be `verification_failed`. If a transfer sent to this bank account fails, we'll set the status to `errored` and will not continue to send transfers until the bank details are updated. type: - string - used: - description: '' - type: - - boolean required: - country - currency - id - last4 - object - status title: BankAccount type: - object + x-expandableFields: + - account + - customer x-resourceId: bank_account bitcoin_receiver: properties: active: description: True when this bitcoin receiver has received a non-zero amount @@ -959,10 +1172,11 @@ - object - url title: BitcoinTransactionList type: - object + x-expandableFields: [] uncaptured_funds: description: This receiver contains uncaptured funds that can be used for a payment or refunded. type: - boolean @@ -988,10 +1202,11 @@ - transactions - uncaptured_funds title: BitcoinReceiver type: - object + x-expandableFields: [] x-resourceId: bitcoin_receiver bitcoin_transaction: properties: amount: description: The amount of `currency` that the transaction was converted to @@ -1034,18 +1249,22 @@ - object - receiver title: BitcoinTransaction type: - object + x-expandableFields: [] x-resourceId: bitcoin_transaction card: properties: account: 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. type: - string address_country: @@ -1104,10 +1323,13 @@ customer: 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`.' type: - string @@ -1120,14 +1342,10 @@ dynamic_last4: description: "(For tokenized numbers only.) The last four digits of the device account number." type: - string - estimated_availability: - description: '' - type: - - string exp_month: description: Two digit number representing the card's expiration month. type: - integer exp_year: @@ -1142,14 +1360,10 @@ - string funding: 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: - string last4: @@ -1174,14 +1388,13 @@ recipient: 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`. type: - string @@ -1195,62 +1408,58 @@ - metadata - object 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: description: A positive integer in the [smallest currency unit](https://support.stripe.com/questions/which-zero-decimal-currencies-does-stripe-support) (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a 0-decimal currency) representing how much to charge. The minimum amount is $0.50 US or [equivalent 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). type: - integer application: 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. type: - integer @@ -1261,10 +1470,13 @@ - string customer: 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. type: - string @@ -1272,14 +1484,20 @@ 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). type: - string @@ -1301,10 +1519,13 @@ - string invoice: 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. type: - boolean @@ -1323,14 +1544,20 @@ 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" paid: description: "`true` if the charge succeeded, or was successfully authorized for later capture." @@ -1385,22 +1612,29 @@ - object - url 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: 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. type: - string @@ -1412,19 +1646,21 @@ transfer: 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. type: - string required: - amount - - amount_captured - amount_refunded - captured - created - currency - id @@ -1436,10 +1672,23 @@ - refunds - status 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: network_status: description: Possible values are `approved_by_network`, `declined_by_network`, @@ -1464,10 +1713,13 @@ - string rule: 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. type: - string @@ -1480,10 +1732,12 @@ required: - type title: ChargeOutcome type: - object + x-expandableFields: + - rule x-resourceId: charge_outcome country_spec: properties: default_currency: description: The default currency for this country. This applies to both payment @@ -1533,10 +1787,11 @@ - supported_payment_methods - verification_fields title: CountrySpec type: - object + x-expandableFields: [] x-resourceId: country_spec coupon: properties: amount_off: description: Amount (in the `currency` specified) that will be taken off the @@ -1618,10 +1873,11 @@ - times_redeemed - valid title: Coupon type: - object + x-expandableFields: [] x-resourceId: coupon customer: properties: account_balance: description: Current balance, if any, being stored on the customer's account. @@ -1631,144 +1887,36 @@ account amounts that have yet to be successfully applied to any invoice. This balance is only taken into account for recurring billing purposes (i.e., 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. type: - integer currency: description: Three-letter [ISO code for the currency](https://support.stripe.com/questions/which-currencies-does-stripe-support) 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. type: - boolean @@ -1807,12 +1955,11 @@ "$ref": "#/definitions/customer_shipping" sources: properties: data: items: - type: - - object + "$ref": "#/definitions/account_debit_account" type: - array has_more: description: True if this list has another page of items after this one that can be fetched. @@ -1840,10 +1987,12 @@ - object - url title: SourceList type: - object + x-expandableFields: + - data subscriptions: properties: data: items: "$ref": "#/definitions/subscription" @@ -1876,23 +2025,25 @@ - object - url title: SubscriptionList type: - object + x-expandableFields: [] required: - account_balance - - cards - created - id - livemode - metadata - object - sources - subscriptions title: Customer type: - object + x-expandableFields: + - default_source x-resourceId: customer customer_shipping: properties: address: "$ref": "#/definitions/address" @@ -1908,17 +2059,21 @@ - address - name title: CustomerShipping type: - object + x-expandableFields: [] x-resourceId: customer_shipping customer_source: properties: customer: description: '' type: - string + x-expansionResources: + oneOf: + - "$ref": "#/definitions/customer" id: description: Unique identifier for the object. type: - string metadata: @@ -1936,10 +2091,19 @@ - id - object 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: date: description: If `type` is `"exact"`, `date` will be the expected delivery @@ -1963,19 +2127,23 @@ required: - type title: DeliveryEstimate type: - object + x-expandableFields: [] x-resourceId: delivery_estimate discount: properties: coupon: "$ref": "#/definitions/coupon" customer: 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. type: @@ -1999,25 +2167,33 @@ - object - start title: Discount type: - object + x-expandableFields: + - customer x-resourceId: discount dispute: properties: amount: description: Disputed amount. Usually the amount of the charge, but can differ (usually because of currency fluctuation or because only part of the order is disputed). 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. type: - integer @@ -2091,10 +2267,12 @@ - reason - status title: Dispute type: - object + x-expandableFields: + - charge x-resourceId: dispute error: description: An error response from the Stripe API. properties: charge: @@ -2138,11 +2316,11 @@ - object 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.*.' + is populated for events on or after October 31, 2014*.' type: - string created: description: Time at which the object was created. Measured in seconds since the Unix epoch. @@ -2172,11 +2350,11 @@ 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.*.' + on or after April 23, 2013*.' type: - string type: description: 'Description of the event: e.g. `invoice.created`, `charge.refunded`, etc.' @@ -2191,10 +2369,11 @@ - pending_webhooks - type title: Event type: - object + x-expandableFields: [] x-resourceId: event event_data: properties: object: description: Static string describing the type of the object described by @@ -2210,37 +2389,21 @@ required: - object title: EventData type: - object + x-expandableFields: [] x-resourceId: event_data external_account_source: properties: account: 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. type: - string @@ -2251,10 +2414,13 @@ - string customer: description: '' type: - string + x-expansionResources: + oneOf: + - "$ref": "#/definitions/customer" default_for_currency: description: Whether this external account is the default account for its currency. type: - boolean @@ -2289,10 +2455,17 @@ - last4 - object 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: amount: description: Amount of the fee, in cents. @@ -2322,10 +2495,11 @@ - currency - type title: Fee type: - object + x-expandableFields: [] x-resourceId: fee fee_refund: properties: amount: description: Amount, in %s. @@ -2334,10 +2508,13 @@ balance_transaction: 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. type: - integer @@ -2348,10 +2525,13 @@ - string fee: 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: - string metadata: @@ -2374,11 +2554,63 @@ - metadata - object 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: description: The count of inventory available. Will be present if and only if `type` is `finite`. @@ -2398,10 +2630,11 @@ required: - type title: Inventory type: - object + x-expandableFields: [] x-resourceId: inventory invoice: properties: amount_due: description: Final amount due at this time for this invoice. If the invoice's @@ -2431,21 +2664,17 @@ invoice is not attempted until 1 hour after the `invoice.created` webhook, for example, so you might not want to display that invoice as unpaid to your users. 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 closed invoice will no longer attempt to collect payment. type: @@ -2457,10 +2686,13 @@ - string customer: 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. type: - integer @@ -2469,14 +2701,10 @@ displaying to users. type: - 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. type: - integer @@ -2524,10 +2752,11 @@ - object - url title: InvoiceLinesList type: - object + x-expandableFields: [] livemode: description: Flag indicating whether the object exists in live mode or test mode. type: - boolean @@ -2539,15 +2768,10 @@ - object next_payment_attempt: 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. type: - string @@ -2585,10 +2809,13 @@ - string subscription: 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. type: - integer @@ -2640,10 +2867,14 @@ - subtotal - total title: Invoice type: - object + x-expandableFields: + - charge + - customer + - subscription x-resourceId: invoice invoice_item: properties: amount: description: Amount (in the `currency` specified) of the invoice item. @@ -2657,10 +2888,13 @@ customer: 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: '' type: - integer description: @@ -2679,10 +2913,13 @@ - string invoice: 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. type: - boolean @@ -2716,10 +2953,13 @@ subscription: description: The subscription that this invoice item has been created for, if any. type: - string + x-expansionResources: + oneOf: + - "$ref": "#/definitions/subscription" subscription_item: description: '' type: - string required: @@ -2734,10 +2974,14 @@ - object - proration title: InvoiceItem type: - object + x-expandableFields: + - customer + - invoice + - subscription x-resourceId: invoice_item invoice_line_item: properties: amount: description: The amount, in %s. @@ -2823,11 +3067,56 @@ - proration - type 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: description: Amount (in %s) to be transferred to your bank account. type: @@ -2839,15 +3128,21 @@ - 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 @@ -2868,15 +3163,23 @@ 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: @@ -2888,14 +3191,10 @@ - string id: 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. type: - boolean @@ -2951,20 +3250,26 @@ - 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 @@ -3006,15 +3311,24 @@ - status - type 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: "$ref": "#/definitions/legal_entity_japan_address" address_kanji: @@ -3116,10 +3430,11 @@ - ssn_last_4_provided - verification title: LegalEntity type: - object + x-expandableFields: [] x-resourceId: legal_entity legal_entity_additional_owner: properties: address: "$ref": "#/definitions/legal_entity_address" @@ -3140,10 +3455,11 @@ - dob - verification title: LegalEntityAdditionalOwner type: - object + x-expandableFields: [] x-resourceId: legal_entity_additional_owner legal_entity_address: properties: city: description: City/District/Suburb/Town/Village. @@ -3170,10 +3486,11 @@ type: - string title: LegalEntityAddress type: - object + x-expandableFields: [] x-resourceId: legal_entity_address legal_entity_dob: properties: day: description: The day of birth, between 1 and 31. @@ -3188,10 +3505,11 @@ type: - integer title: LegalEntityDOB type: - object + x-expandableFields: [] x-resourceId: legal_entity_dob legal_entity_japan_address: properties: city: description: City/Ward. @@ -3222,10 +3540,11 @@ type: - string title: LegalEntityJapanAddress type: - object + x-expandableFields: [] x-resourceId: legal_entity_japan_address legal_entity_verification: properties: details: description: A user-displayable string describing the verification state for @@ -3245,21 +3564,80 @@ 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. type: - string required: - status 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: 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 @@ -3281,10 +3659,13 @@ charge: 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. type: - integer @@ -3295,10 +3676,13 @@ - string customer: 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: - string external_coupon_code: @@ -3361,10 +3745,11 @@ - object - url 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 in the `shipping_methods` array. At order creation time, if there are multiple shipping methods, Stripe will automatically selected the first method. @@ -3401,10 +3786,13 @@ - object - status title: Order type: - object + x-expandableFields: + - charge + - customer x-resourceId: order order_item: properties: amount: description: A positive integer in the smallest currency unit (that is, 100 @@ -3430,10 +3818,14 @@ parent: 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`. type: @@ -3449,27 +3841,13 @@ - object - type 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: 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 @@ -3504,14 +3882,20 @@ - string order: 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 - currency - id @@ -3519,10 +3903,13 @@ - livemode - object title: OrderReturn type: - object + x-expandableFields: + - order + - refund x-resourceId: order_return package_dimensions: properties: height: description: Height, in inches. @@ -3546,10 +3933,11 @@ - weight - width title: PackageDimensions type: - object + x-expandableFields: [] x-resourceId: package_dimensions payout: properties: amount: description: Amount (in %s) to be transferred to your bank account or debit @@ -3564,10 +3952,13 @@ balance_transaction: 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. type: - integer @@ -3578,16 +3969,23 @@ - string destination: 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. type: @@ -3661,10 +4059,14 @@ - status - type title: Payout type: - object + x-expandableFields: + - balance_transaction + - destination + - failure_balance_transaction x-resourceId: payout plan: properties: amount: description: The amount in %s to be charged on the interval specified. @@ -3737,17 +4139,21 @@ - name - object title: Plan type: - object + x-expandableFields: [] x-resourceId: plan 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: @@ -3757,19 +4163,28 @@ - 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 @@ -3795,10 +4210,14 @@ 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 @@ -3836,10 +4255,11 @@ - object - url title: FeeRefundList type: - object + x-expandableFields: [] required: - account - amount - amount_refunded - application @@ -3853,11 +4273,155 @@ - refunded - refunds 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: description: Whether or not the product is currently available for purchase. type: @@ -3955,10 +4519,11 @@ - object - url title: SKUList type: - object + x-expandableFields: [] updated: description: '' type: - integer url: @@ -3978,10 +4543,11 @@ - skus - updated title: Product type: - object + x-expandableFields: [] x-resourceId: product refund: properties: amount: description: Amount, in %s. @@ -3990,14 +4556,20 @@ balance_transaction: 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. type: - integer @@ -4050,44 +4622,124 @@ - metadata - object 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 - shipping: - "$ref": "#/definitions/shipping_settings" - taxes: - "$ref": "#/definitions/tax_settings" + 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: - - 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: "$ref": "#/definitions/address" carrier: @@ -4113,10 +4765,11 @@ - address - name title: Shipping type: - object + x-expandableFields: [] x-resourceId: shipping shipping_method: properties: amount: description: A positive integer in the smallest currency unit (that is, 100 @@ -4146,87 +4799,12 @@ - description - id 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: description: Whether or not the SKU is available for purchase. type: @@ -4286,10 +4864,13 @@ product: 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: '' type: - integer required: @@ -4306,16 +4887,18 @@ - product - updated 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: description: The client secret of the source. Used for client-side polling using a publishable key. @@ -4329,11 +4912,11 @@ type: - integer 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: description: The authentication `flow` of the source. `flow` is one of `redirect`, `receiver`, `code_verification`, `none`. @@ -4376,12 +4959,12 @@ of `card`, `three_d_secure`, `giropay`, `sepa_debit`, `ideal`, `sofort`, or `bancontact`. 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: - string required: @@ -4394,10 +4977,11 @@ - status - type title: Source type: - object + x-expandableFields: [] x-resourceId: source source_code_verification_flow: properties: attempts_remaining: description: The number of attempts remaining to authenticate the source object @@ -4413,10 +4997,11 @@ - attempts_remaining - status title: SourceCodeVerificationFlow type: - object + x-expandableFields: [] x-resourceId: source_code_verification_flow source_owner: properties: address: "$ref": "#/definitions/address" @@ -4447,10 +5032,11 @@ type: - string title: SourceOwner type: - object + x-expandableFields: [] x-resourceId: source_owner source_receiver_flow: properties: address: description: The address of the receiver source. This is the value that should @@ -4478,10 +5064,11 @@ - amount_received - amount_returned title: SourceReceiverFlow type: - object + x-expandableFields: [] x-resourceId: source_receiver_flow source_redirect_flow: properties: return_url: description: The URL you provide to redirect the customer to after they authenticated @@ -4503,10 +5090,11 @@ - status - url title: SourceRedirectFlow type: - object + x-expandableFields: [] x-resourceId: source_redirect_flow status_transitions: properties: canceled: description: '' @@ -4525,30 +5113,20 @@ type: - integer 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 @@ -4580,15 +5158,13 @@ - integer customer: 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: description: If the subscription has ended (either because it was canceled or because the customer was switched to a subscription to a new plan), the @@ -4633,19 +5209,16 @@ - object - url 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 format. type: @@ -4653,28 +5226,19 @@ object: description: String representing the object's type. Objects of the same type 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: description: The quantity of the plan to which the customer should be subscribed. 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. type: - integer - retains_own_balance: - description: '' - type: - - boolean start: description: Date the most recent update to this subscription started. type: - integer status: @@ -4715,10 +5279,12 @@ - start - status title: Subscription type: - object + x-expandableFields: + - customer x-resourceId: subscription subscription_item: properties: created: description: Time at which the object was created. Measured in seconds since @@ -4748,41 +5314,12 @@ - plan - quantity 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: description: '' type: @@ -4844,10 +5381,11 @@ - object - status title: ThreeDSecure type: - object + x-expandableFields: [] x-resourceId: three_d_secure token: properties: bank_account: "$ref": "#/definitions/token_bank_account" @@ -4878,14 +5416,10 @@ - string type: 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). type: - boolean @@ -4897,10 +5431,11 @@ - type - used title: Token type: - object + x-expandableFields: [] x-resourceId: token token_bank_account: properties: account_holder_name: description: The name of the person or business that owns the bank account. @@ -4909,34 +5444,10 @@ account_holder_type: description: The type of entity that holds the account. This can be either `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`. type: - string @@ -4966,14 +5477,10 @@ object: description: String representing the object's type. Objects of the same type share the same value. type: - string - reusable: - description: '' - type: - - boolean routing_number: description: The routing transit number for the bank account. type: - string status: @@ -4987,24 +5494,21 @@ as microdeposit failure, the status will be `verification_failed`. If a transfer sent to this bank account fails, we'll set the status to `errored` and will not continue to send transfers until the bank details are updated. type: - string - used: - description: '' - type: - - boolean required: - country - currency - id - last4 - object - status title: TokenBankAccount type: - object + x-expandableFields: [] x-resourceId: token_bank_account token_card: properties: address_city: description: City/District/Suburb/Town/Village. @@ -5082,14 +5586,10 @@ - string funding: 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: - string last4: @@ -5109,14 +5609,10 @@ object: description: String representing the object's type. Objects of the same type 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`. type: - string @@ -5130,11 +5626,76 @@ - metadata - object 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: description: Amount in %s to be transferred. type: @@ -5147,10 +5708,13 @@ 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 that this record of the transfer was first created. type: - integer currency: @@ -5160,15 +5724,21 @@ - string destination: 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: - string livemode: @@ -5221,15 +5791,24 @@ - 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 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: - string transfer_group: @@ -5250,10 +5829,15 @@ - reversals - reversed title: Transfer type: - object + x-expandableFields: + - balance_transaction + - destination + - destination_payment + - source_transaction x-resourceId: transfer transfer_recipient: properties: active_account: "$ref": "#/definitions/bank_account" @@ -5291,19 +5875,23 @@ - object - url title: CardList type: - object + x-expandableFields: [] created: description: Time at which the object was created. Measured in seconds since the Unix epoch. type: - integer default_card: 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. type: - string @@ -5330,43 +5918,245 @@ 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. type: - string object: description: String representing the object's type. Objects of the same type share the same value. type: - string - tin: - description: '' + type: + description: Type of the recipient, one of `individual` or `corporation`. type: - string - tin_verification_pending: + required: + - created + - id + - livemode + - metadata + - object + - 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: Type of the recipient, one of `individual` or `corporation`. + description: Can be `card`, `bank_account`, or `stripe_account`. type: - string required: + - amount + - amount_reversed - created + - currency + - date - id - livemode - metadata - object - - tin_verification_pending + - reversals + - reversed + - status - type - title: TransferRecipient + title: TransferRecipientTransfer type: - object - x-resourceId: transfer_recipient + x-expandableFields: + - application_fee + - balance_transaction + - destination + - destination_payment + - source_transaction + x-resourceId: transfer_recipient_transfer transfer_reversal: properties: amount: description: Amount, in %s. type: @@ -5374,10 +6164,13 @@ balance_transaction: 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. type: - integer @@ -5403,10 +6196,14 @@ - string transfer: description: ID of the transfer that was reversed. type: - string + x-expansionResources: + oneOf: + - "$ref": "#/definitions/legacy_transfer" + - "$ref": "#/definitions/transfer" required: - amount - created - currency - id @@ -5414,10 +6211,13 @@ - object - transfer title: TransferReversal type: - object + x-expandableFields: + - balance_transaction + - transfer x-resourceId: transfer_reversal transfer_schedule: properties: delay_days: description: The number of days charges for the account will be held before @@ -5443,62 +6243,12 @@ - delay_days - interval 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: description: Final amount due at this time for this invoice. If the invoice's total is smaller than the minimum charge amount, for example, or if there @@ -5527,21 +6277,17 @@ invoice is not attempted until 1 hour after the `invoice.created` webhook, for example, so you might not want to display that invoice as unpaid to your users. 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 closed invoice will no longer attempt to collect payment. type: @@ -5553,10 +6299,13 @@ - string customer: 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. type: - integer @@ -5565,14 +6314,10 @@ displaying to users. type: - 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. type: - integer @@ -5616,10 +6361,11 @@ - object - url title: InvoiceLinesList type: - object + x-expandableFields: [] livemode: description: Flag indicating whether the object exists in live mode or test mode. type: - boolean @@ -5631,15 +6377,10 @@ - object next_payment_attempt: 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. type: - string @@ -5677,10 +6418,13 @@ - string subscription: 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. type: - integer @@ -5731,10 +6475,14 @@ - subtotal - total title: UpcomingInvoice type: - object + x-expandableFields: + - charge + - customer + - subscription x-resourceId: upcoming_invoice host: api.stripe.com info: contact: email: dev-platform@stripe.com @@ -5778,10 +6526,19 @@ customer: description: '' 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. title: return_url type: @@ -5802,10 +6559,15 @@ "/v1/3d_secure/{three_d_secure}": get: description: "<p>Retrieves a 3D Secure object.</p>" 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 required: true type: string @@ -5838,10 +6600,19 @@ description: The identifier of the account to be deleted. If none is provided, will default to the account of the API key. 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. schema: "$ref": "#/definitions/account" @@ -5851,10 +6622,15 @@ "$ref": "#/definitions/error" get: description: "<p>Retrieves the details of the account.</p>" 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 name: account required: false @@ -5932,10 +6708,19 @@ For managed accounts, this is only to make the account easier to identify to you: Stripe will not email the account holder.' 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), 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) @@ -5952,27 +6737,17 @@ description: Information about the account holder; varies by [account country](#country_spec_object-verification_fields) and [account status](#account_object-verification-fields_needed). 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 the account in a structured format. 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 bank account. See our [managed account bank transfer guide](/docs/connect/bank-transfers#payout-information) for more information. @@ -6039,20 +6814,29 @@ operationId: CreateAccountExternalAccount parameters: - description: Body parameters for the request. in: body name: payload - required: false + required: true schema: properties: default_for_currency: description: If you set this to true (or if this is the first external account being added in this currency) this account will become the default external account for its currency. 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 type: - object @@ -6083,19 +6867,57 @@ - description: The ID of the external account to be deleted. in: path 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. + schema: + "$ref": "#/definitions/external_account_source" + default: + description: Error response. + schema: + "$ref": "#/definitions/error" post: description: <p>Updates the metadata of a bank account belonging to a <a href="/docs/connect/managed-accounts">managed accounts</a>, and optionally sets it as the default for its currency. Other bank account details are not editable by design.</p> operationId: UpdateAccountBankAccount @@ -6115,10 +6937,19 @@ description: If set to `true`, this bank account will become the default external account for its currency. 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 type: - object @@ -6134,10 +6965,15 @@ "/v1/account/external_accounts": get: 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 name: limit required: false @@ -6165,12 +7001,11 @@ description: Successful response. schema: properties: data: items: - type: - - object + "$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. @@ -6198,10 +7033,12 @@ - object - url title: ExternalAccountList type: - object + x-expandableFields: + - data default: description: Error response. schema: "$ref": "#/definitions/error" post: @@ -6209,20 +7046,29 @@ operationId: CreateAccountExternalAccount parameters: - description: Body parameters for the request. in: body name: payload - required: false + required: true schema: properties: default_for_currency: description: If you set this to true (or if this is the first external account being added in this currency) this account will become the default external account for its currency. 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 type: - object @@ -6253,19 +7099,57 @@ - description: The ID of the external account to be deleted. in: path 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. + schema: + "$ref": "#/definitions/external_account_source" + default: + description: Error response. + schema: + "$ref": "#/definitions/error" post: description: <p>Updates the metadata of a bank account belonging to a <a href="/docs/connect/managed-accounts">managed accounts</a>, and optionally sets it as the default for its currency. Other bank account details are not editable by design.</p> operationId: UpdateAccountBankAccount @@ -6285,10 +7169,19 @@ description: If set to `true`, this bank account will become the default external account for its currency. 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 type: - object @@ -6299,17 +7192,68 @@ "$ref": "#/definitions/external_account_source" default: 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: <p>Returns a list of accounts connected to your platform via <a href="/docs/connect">Connect</a>. If you’re not a platform, the list will be empty.</p> 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 name: limit required: false @@ -6370,10 +7314,11 @@ - has_more - object - url type: - object + x-expandableFields: [] default: description: Error response. schema: "$ref": "#/definitions/error" post: @@ -6440,10 +7385,19 @@ For managed accounts, this is only to make the account easier to identify to you: Stripe will not email the account holder.' 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), 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) @@ -6465,27 +7419,17 @@ managed: description: '' 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 the account in a structured format. 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 bank account. See our [managed account bank transfer guide](/docs/connect/bank-transfers#payout-information) for more information. @@ -6497,15 +7441,10 @@ statement for payouts. If not set, this will default to your platform's bank descriptor set on the Dashboard. 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 and underwriting purposes. title: product_description @@ -6565,10 +7504,25 @@ will default to the account of the API key. 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 responses: '200': description: Successful response. schema: "$ref": "#/definitions/account" @@ -6578,10 +7532,15 @@ "$ref": "#/definitions/error" get: description: "<p>Retrieves the details of the account.</p>" 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 name: account required: true @@ -6659,10 +7618,19 @@ For managed accounts, this is only to make the account easier to identify to you: Stripe will not email the account holder.' 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), 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) @@ -6679,27 +7647,17 @@ description: Information about the account holder; varies by [account country](#country_spec_object-verification_fields) and [account status](#account_object-verification-fields_needed). 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 the account in a structured format. 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 bank account. See our [managed account bank transfer guide](/docs/connect/bank-transfers#payout-information) for more information. @@ -6766,20 +7724,29 @@ operationId: CreateAccountExternalAccount parameters: - description: Body parameters for the request. in: body name: payload - required: false + required: true schema: properties: default_for_currency: description: If you set this to true (or if this is the first external account being added in this currency) this account will become the default external account for its currency. 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 type: - object @@ -6810,19 +7777,57 @@ - description: The ID of the external account to be deleted. in: path 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. + schema: + "$ref": "#/definitions/external_account_source" + default: + description: Error response. + schema: + "$ref": "#/definitions/error" post: description: <p>Updates the metadata of a bank account belonging to a <a href="/docs/connect/managed-accounts">managed accounts</a>, and optionally sets it as the default for its currency. Other bank account details are not editable by design.</p> operationId: UpdateAccountBankAccount @@ -6842,10 +7847,19 @@ description: If set to `true`, this bank account will become the default external account for its currency. 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 type: - object @@ -6861,10 +7875,15 @@ "/v1/accounts/{account}/external_accounts": get: 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 name: limit required: false @@ -6892,12 +7911,11 @@ description: Successful response. schema: properties: data: items: - type: - - object + "$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. @@ -6925,10 +7943,12 @@ - object - url title: ExternalAccountList type: - object + x-expandableFields: + - data default: description: Error response. schema: "$ref": "#/definitions/error" post: @@ -6936,20 +7956,29 @@ operationId: CreateAccountExternalAccount parameters: - description: Body parameters for the request. in: body name: payload - required: false + required: true schema: properties: default_for_currency: description: If you set this to true (or if this is the first external account being added in this currency) this account will become the default external account for its currency. 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 type: - object @@ -6980,19 +8009,57 @@ - description: The ID of the external account to be deleted. in: path 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. + schema: + "$ref": "#/definitions/external_account_source" + default: + description: Error response. + schema: + "$ref": "#/definitions/error" post: description: <p>Updates the metadata of a bank account belonging to a <a href="/docs/connect/managed-accounts">managed accounts</a>, and optionally sets it as the default for its currency. Other bank account details are not editable by design.</p> operationId: UpdateAccountBankAccount @@ -7012,10 +8079,19 @@ description: If set to `true`, this bank account will become the default external account for its currency. 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 type: - object @@ -7026,10 +8102,54 @@ "$ref": "#/definitions/external_account_source" default: 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: <p>With <a href="/docs/connect">Connect</a>, you may flag managed accounts as suspicious.</p><p>Managed accounts created using test-mode keys can be rejected at any time. Managed accounts created using live-mode keys @@ -7042,13 +8162,22 @@ required: true type: string - 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 type: @@ -7067,10 +8196,15 @@ "/v1/apple_pay/domains": get: 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 name: limit required: false @@ -7137,10 +8271,11 @@ - object - url title: ApplePayDomainList type: - object + x-expandableFields: [] default: description: Error response. schema: "$ref": "#/definitions/error" post: @@ -7148,18 +8283,27 @@ operationId: CreateApplePayDomain parameters: - description: Body parameters for the request. in: body name: payload - required: false + required: true schema: properties: domain_name: description: '' 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: '200': description: Successful response. @@ -7177,10 +8321,25 @@ - description: '' in: path 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. schema: "$ref": "#/definitions/apple_pay_domain" @@ -7190,10 +8349,15 @@ "$ref": "#/definitions/error" get: 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 required: true type: string @@ -7211,10 +8375,15 @@ description: "<p>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.</p>" 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 name: limit required: false @@ -7286,10 +8455,11 @@ - has_more - object - url type: - object + x-expandableFields: [] default: description: Error response. schema: "$ref": "#/definitions/error" "/v1/application_fees/{fee}/refunds/{id}": @@ -7297,10 +8467,15 @@ description: "<p>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.</p>" 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 required: true type: string @@ -7328,10 +8503,19 @@ 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 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 @@ -7351,10 +8535,15 @@ description: "<p>Retrieves the details of an application fee that your account has collected. The same information is returned when refunding the application fee.</p>" 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 required: true type: string @@ -7391,10 +8580,19 @@ directive: description: '' 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. schema: "$ref": "#/definitions/platform_earning" @@ -7409,10 +8607,15 @@ on the application fee object. If you need more than those 10, you can use this API method and the <code>limit</code> and <code>starting_after</code> parameters to page through additional refunds.</p>" 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 name: limit required: false @@ -7477,10 +8680,11 @@ - object - url title: FeeRefundList type: - object + x-expandableFields: [] default: description: Error response. schema: "$ref": "#/definitions/error" post: @@ -7506,10 +8710,19 @@ directive: description: '' 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 type: - object @@ -7525,11 +8738,16 @@ "/v1/balance": get: description: "<p>Retrieves the current account balance, based on the authentication that was used to make the request.</p>" 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. schema: "$ref": "#/definitions/balance" @@ -7543,10 +8761,15 @@ Stripe account balance (e.g., charges, transfers, and so forth). The transactions are returned in sorted order, with the most recent transactions appearing first.</p>" 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 name: limit required: false @@ -7641,19 +8864,25 @@ - object - url title: BalanceTransactionsList type: - object + x-expandableFields: [] default: description: Error response. schema: "$ref": "#/definitions/error" "/v1/balance/history/{id}": get: description: "<p>Retrieves the balance transaction with the given ID.</p>" 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 name: id required: true @@ -7665,10 +8894,281 @@ "$ref": "#/definitions/balance_transaction" default: 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: '' operationId: CreatePaymentRefundWithPaymentResponse parameters: @@ -7696,10 +9196,19 @@ directive: description: '' 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 type: - object @@ -7730,16 +9239,45 @@ "$ref": "#/definitions/charge" default: 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: "<p>Returns a list of your receivers. Receivers are returned sorted by creation date, with the most recently created receivers appearing first.</p>" 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 name: limit required: false @@ -7815,10 +9353,11 @@ - has_more - object - url type: - object + x-expandableFields: [] default: description: Error response. schema: "$ref": "#/definitions/error" post: @@ -7853,10 +9392,19 @@ email: description: The email address of the customer. 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 the customer in a structured format. title: metadata @@ -7889,10 +9437,25 @@ - description: '' in: path 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/bitcoin_receiver" @@ -7902,10 +9465,15 @@ "$ref": "#/definitions/error" get: description: "<p>Retrieves the Bitcoin receiver with the given ID.</p>" 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 required: true type: string @@ -7941,10 +9509,19 @@ 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 type: - object @@ -7976,10 +9553,19 @@ 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 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 type: @@ -7996,10 +9582,15 @@ "/v1/bitcoin/receivers/{receiver}/transactions": get: 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 name: limit required: false @@ -8071,19 +9662,25 @@ - object - url title: BitcoinTransactionList type: - object + x-expandableFields: [] default: description: Error response. schema: "$ref": "#/definitions/error" "/v1/bitcoin/transactions": get: 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 name: limit required: false @@ -8155,19 +9752,25 @@ - object - url title: BitcoinTransactionList type: - object + x-expandableFields: [] default: description: Error response. schema: "$ref": "#/definitions/error" "/v1/bitcoin/transactions/{id}": get: 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 required: true type: string @@ -8184,10 +9787,15 @@ get: description: "<p>Returns a list of charges you’ve previously created. The charges are returned in sorted order, with the most recent charges appearing first.</p>" 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 name: limit required: false @@ -8269,10 +9877,11 @@ - has_more - object - url type: - object + x-expandableFields: [] default: description: Error response. schema: "$ref": "#/definitions/error" post: @@ -8328,10 +9937,18 @@ 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: @@ -8400,20 +10017,10 @@ statement_descriptor: description: '' 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 type: - string @@ -8450,10 +10057,15 @@ 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.</p>" 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 required: true type: string @@ -8486,10 +10098,19 @@ your receipt emails will include the `description` of the charge(s) that they are describing. 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, 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`. @@ -8570,10 +10191,26 @@ description: An application fee to add on to this charge. Can only be used with Stripe Connect. 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, if one was set. Receipts will not be sent in test mode. title: receipt_email @@ -8605,10 +10242,15 @@ "/v1/charges/{charge}/dispute": get: 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 required: true type: string @@ -8640,10 +10282,19 @@ description: Evidence to upload to respond to a dispute. Updating any field in the hash will submit all fields in the hash for review. 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 the dispute in a structured format. title: metadata @@ -8666,10 +10317,25 @@ - description: '' in: path 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. schema: "$ref": "#/definitions/dispute" @@ -8706,10 +10372,19 @@ directive: description: '' 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 type: - object @@ -8749,10 +10424,15 @@ charge object. If you need more than those 10, you can use this API method and the <code>limit</code> and <code>starting_after</code> parameters to page through additional refunds.</p>" 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 name: limit required: false @@ -8817,10 +10497,11 @@ - object - url title: RefundList type: - object + x-expandableFields: [] default: description: Error response. schema: "$ref": "#/definitions/error" post: @@ -8846,10 +10527,19 @@ directive: description: '' 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 type: - object @@ -8880,10 +10570,15 @@ "/v1/charges/{charge}/refunds/{refund}": get: 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 required: true type: string @@ -8914,10 +10609,19 @@ 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 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 @@ -8935,10 +10639,15 @@ "/v1/country_specs": get: description: "<p>Lists all Country Spec objects available in the API.</p>" 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 name: limit required: false @@ -8999,19 +10708,25 @@ - has_more - object - url type: - object + x-expandableFields: [] default: description: Error response. schema: "$ref": "#/definitions/error" "/v1/country_specs/{country}": get: description: "<p>Returns a Country Spec for a given Country code.</p>" 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 name: country required: true @@ -9028,10 +10743,15 @@ "/v1/coupons": get: description: "<p>Returns a list of your coupons.</p>" 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 name: limit required: false @@ -9099,10 +10819,11 @@ - has_more - object - url type: - object + x-expandableFields: [] default: description: Error response. schema: "$ref": "#/definitions/error" post: @@ -9148,10 +10869,19 @@ it must be a positive integer that specifies the number of months the discount will be in effect. 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 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 @@ -9209,10 +10939,25 @@ - description: The identifier of the coupon to be deleted. in: path 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. schema: "$ref": "#/definitions/coupon" @@ -9222,10 +10967,15 @@ "$ref": "#/definitions/error" get: description: "<p>Retrieves the coupon with the given ID.</p>" 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 required: true type: string @@ -9252,10 +11002,19 @@ 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 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 @@ -9274,10 +11033,15 @@ get: description: "<p>Returns a list of your customers. The customers are returned sorted by creation date, with the most recent customers appearing first.</p>" 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 name: limit required: false @@ -9303,15 +11067,10 @@ - description: '' in: query name: created required: false type: integer - - description: '' - in: query - name: deleted - required: false - type: boolean responses: '200': description: Successful response. schema: properties: @@ -9348,10 +11107,11 @@ - has_more - object - url type: - object + x-expandableFields: [] default: description: Error response. schema: "$ref": "#/definitions/error" post: @@ -9396,37 +11156,26 @@ description: Customer's email address. It's displayed alongside the customer in your dashboard and can be useful for searching and tracking. 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 the customer in a structured format. 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 type: - object @@ -9456,10 +11205,25 @@ - description: The identifier of the customer to be deleted. in: path 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. schema: "$ref": "#/definitions/customer" @@ -9470,10 +11234,15 @@ get: description: "<p>Retrieves the details of an existing customer. You need only supply the unique customer identifier that was returned upon customer creation.</p>" 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 required: true type: string @@ -9533,37 +11302,26 @@ description: Customer's email address. It's displayed alongside the customer in your dashboard and can be useful for searching and tracking. 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 the customer in a structured format. 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 type: - object @@ -9587,10 +11345,15 @@ "/v1/customers/{customer}/alipay_accounts": get: 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 name: limit required: false @@ -9655,10 +11418,11 @@ - object - url title: AlipayAccountList type: - object + x-expandableFields: [] default: description: Error response. schema: "$ref": "#/definitions/error" post: @@ -9666,13 +11430,22 @@ operationId: CreateCustomerSource parameters: - 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 @@ -9703,10 +11476,25 @@ - description: The ID of the source to be deleted. in: path 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/customer_source" @@ -9716,10 +11504,15 @@ "$ref": "#/definitions/error" get: 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 required: true type: string @@ -9739,10 +11532,15 @@ Customer. If you need more than those 10, you can use this API method and the <code>limit</code> and <code>starting_after</code> parameters to page through additional bank accounts.</p>" 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 name: limit required: false @@ -9807,10 +11605,11 @@ - object - url title: BankAccountList type: - object + x-expandableFields: [] default: description: Error response. schema: "$ref": "#/definitions/error" post: @@ -9818,13 +11617,22 @@ operationId: CreateCustomerSource parameters: - 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 @@ -9855,10 +11663,25 @@ - description: The ID of the source to be deleted. in: path 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/customer_source" @@ -9870,10 +11693,15 @@ description: "<p>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.</p>" 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 required: true type: string @@ -9934,40 +11762,39 @@ address_zip: description: '' title: address_zip type: - string - cvc: - description: '' - title: cvc - type: - - string exp_month: description: '' title: exp_month type: - string exp_year: description: '' 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 type: - object name: description: '' title: name type: - string - validate: - description: '' - title: validate - type: - - boolean responses: '200': description: Successful response. schema: "$ref": "#/definitions/card" @@ -10000,10 +11827,19 @@ description: Two positive integers in **cents** equal to the values of the microdeposits sent to the bank account. 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 type: - string @@ -10019,10 +11855,15 @@ "/v1/customers/{customer}/cards": get: 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 name: limit required: false @@ -10087,10 +11928,11 @@ - object - url title: CardList type: - object + x-expandableFields: [] default: description: Error response. schema: "$ref": "#/definitions/error" post: @@ -10098,13 +11940,22 @@ operationId: CreateCustomerSource parameters: - 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 @@ -10135,10 +11986,25 @@ - description: The ID of the source to be deleted. in: path 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/customer_source" @@ -10148,10 +12014,15 @@ "$ref": "#/definitions/error" get: 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 required: true type: string @@ -10207,40 +12078,39 @@ address_zip: description: '' title: address_zip type: - string - cvc: - description: '' - title: cvc - type: - - string exp_month: description: '' title: exp_month type: - string exp_year: description: '' 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 type: - object name: description: '' title: name type: - string - validate: - description: '' - title: validate - type: - - boolean responses: '200': description: Successful response. schema: "$ref": "#/definitions/card" @@ -10250,11 +12120,26 @@ "$ref": "#/definitions/error" "/v1/customers/{customer}/discount": delete: description: "<p>Removes the currently applied discount on a customer.</p>" 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. schema: "$ref": "#/definitions/discount" @@ -10264,10 +12149,15 @@ "$ref": "#/definitions/error" get: 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 required: true type: string @@ -10283,10 +12173,15 @@ "/v1/customers/{customer}/sources": get: 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 name: limit required: false @@ -10312,19 +12207,23 @@ - description: The ID of the customer whose sources will be retrieved. in: path name: customer required: true type: string + - description: '' + in: query + name: type + required: false + type: string responses: '200': description: Successful response. schema: properties: data: items: - type: - - object + "$ref": "#/definitions/account_debit_account" type: - array has_more: description: True if this list has another page of items after this one that can be fetched. @@ -10352,10 +12251,12 @@ - object - url title: SourceList type: - object + x-expandableFields: + - data default: description: Error response. schema: "$ref": "#/definitions/error" post: @@ -10363,13 +12264,22 @@ operationId: CreateCustomerSource parameters: - 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 @@ -10400,10 +12310,25 @@ - description: The ID of the source to be deleted. in: path 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/customer_source" @@ -10413,10 +12338,15 @@ "$ref": "#/definitions/error" get: 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 required: true type: string @@ -10472,40 +12402,39 @@ address_zip: description: '' title: address_zip type: - string - cvc: - description: '' - title: cvc - type: - - string exp_month: description: '' title: exp_month type: - string exp_year: description: '' 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 type: - object name: description: '' title: name type: - string - validate: - description: '' - title: validate - type: - - boolean responses: '200': description: Successful response. schema: "$ref": "#/definitions/card" @@ -10538,10 +12467,19 @@ description: Two positive integers in **cents** equal to the values of the microdeposits sent to the bank account. 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 type: - string @@ -10560,10 +12498,15 @@ 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.</p>" 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 name: limit required: false @@ -10628,10 +12571,11 @@ - object - url title: SubscriptionList type: - object + x-expandableFields: [] default: description: Error response. schema: "$ref": "#/definitions/error" post: @@ -10647,47 +12591,36 @@ in: body name: payload 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 for that particular subscription. 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 @@ -10696,25 +12629,15 @@ object. It can be useful for storing additional information about the subscription in a structured format. 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 <currency>10</currency>/user/month, and your customer has 5 users, you could pass 5 as the quantity to have the customer charged <currency>50</currency> (5 x <currency>10</currency>) @@ -10725,15 +12648,10 @@ new subscription will not inherit the quantity attribute and will default to 1 unless you pass a quantity parameter. 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 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 @@ -10815,10 +12733,19 @@ description: A flag that if set to true will delay the cancellation of the subscription until the end of the current period. 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. schema: "$ref": "#/definitions/subscription" @@ -10827,11 +12754,16 @@ schema: "$ref": "#/definitions/error" get: description: "<p>Retrieves the subscription with the given ID.</p>" 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. schema: "$ref": "#/definitions/subscription" @@ -10851,69 +12783,48 @@ in: body name: payload 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 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 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 the subscription in a structured format. 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. title: plan type: @@ -10946,15 +12857,10 @@ new subscription will not inherit the quantity attribute and will default to 1 unless you pass a quantity parameter. 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 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 @@ -11000,11 +12906,26 @@ "$ref": "#/definitions/error" "/v1/customers/{customer}/subscriptions/{subscription_exposed_id}/discount": delete: description: "<p>Removes the currently applied discount on a customer.</p>" 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. schema: "$ref": "#/definitions/discount" @@ -11014,10 +12935,15 @@ "$ref": "#/definitions/error" get: 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 required: true type: string @@ -11033,10 +12959,15 @@ "/v1/disputes": get: description: "<p>Returns a list of your disputes.</p>" 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 name: limit required: false @@ -11102,19 +13033,25 @@ - has_more - object - url type: - object + x-expandableFields: [] default: description: Error response. schema: "$ref": "#/definitions/error" "/v1/disputes/{dispute}": get: description: "<p>Retrieves the dispute with the given ID.</p>" 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 required: true type: string @@ -11152,10 +13089,19 @@ description: Evidence to upload to respond to a dispute. Updating any field in the hash will submit all fields in the hash for review. 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 the dispute in a structured format. title: metadata @@ -11182,10 +13128,25 @@ - description: ID of dispute to close. in: path 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. schema: "$ref": "#/definitions/dispute" @@ -11196,10 +13157,15 @@ "/v1/events": get: description: "<p>List events, going back up to 30 days.</p>" 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 name: limit required: false @@ -11279,20 +13245,26 @@ - has_more - object - url type: - object + x-expandableFields: [] default: description: Error response. schema: "$ref": "#/definitions/error" "/v1/events/{id}": get: description: "<p>Retrieves the details of an event. Supply the unique identifier of the event, which you might have received in a webhook.</p>" 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 required: true type: string @@ -11313,10 +13285,25 @@ - description: '' in: path 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/event" @@ -11329,10 +13316,15 @@ description: "<p>Returns a list of your invoice items. Invoice items are returned sorted by creation date, with the most recently created invoice items appearing first.</p>" 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 name: limit required: false @@ -11404,10 +13396,11 @@ - has_more - object - url type: - object + x-expandableFields: [] default: description: Error response. schema: "$ref": "#/definitions/error" post: @@ -11451,10 +13444,19 @@ Defaults to false for prorations or negative invoice items, and true for all other invoice items. 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 scheduled invoice. Use this when adding invoice items in response to an invoice.created webhook. You cannot add an invoice item to an @@ -11501,10 +13503,25 @@ - description: The identifier of the invoice item to be deleted. in: path 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. schema: "$ref": "#/definitions/invoice_item" @@ -11514,10 +13531,15 @@ "$ref": "#/definitions/error" get: description: "<p>Retrieves the invoice item with the given ID.</p>" 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 required: true type: string @@ -11560,10 +13582,19 @@ Defaults to false for prorations or negative invoice items, and true for all other invoice items. Cannot be set to true for prorations. 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 the invoice item in a structured format. title: metadata @@ -11583,10 +13614,15 @@ description: "<p>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.</p>" 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 name: limit required: false @@ -11607,16 +13643,18 @@ page of the list. in: query 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 type: string - description: '' @@ -11662,10 +13700,11 @@ - has_more - object - url type: - object + x-expandableFields: [] default: description: Error response. schema: "$ref": "#/definitions/error" post: @@ -11678,50 +13717,40 @@ operationId: CreateInvoice parameters: - description: Body parameters for the request. in: body name: payload - required: false + required: true schema: properties: application_fee: description: A fee in %s that will be applied to the invoice and transferred to the application owner's Stripe account. The request must be made with an OAuth key or the Stripe-Account header in order to take an application fee. For more information, see the application fees [documentation](/docs/connect/subscriptions#working-with-invoices). 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 type: - object @@ -11776,10 +13805,15 @@ being previewed is to consider only proration line items where <code>period[start]</code> is equal to the <code>subscription_proration_date</code> on the upcoming invoice resource.</p>" 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 name: customer required: true @@ -11865,10 +13899,15 @@ "/v1/invoices/{invoice}": get: description: "<p>Retrieves the invoice with the given ID.</p>" 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 required: true type: string @@ -11911,10 +13950,19 @@ description: description: '' 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 us to update the subscription status as if the invoice were successfully paid. Once an invoice has been forgiven, it cannot be unforgiven or @@ -11925,16 +13973,10 @@ metadata: description: '' 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. title: statement_descriptor type: @@ -11961,10 +14003,15 @@ 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.</p>" 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 required: false type: integer @@ -12101,10 +14148,11 @@ - object - url title: InvoiceLinesList type: - object + x-expandableFields: [] default: description: Error response. schema: "$ref": "#/definitions/error" "/v1/invoices/{invoice}/pay": @@ -12119,10 +14167,25 @@ - description: ID of invoice to pay. in: path 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. schema: "$ref": "#/definitions/invoice" @@ -12134,10 +14197,15 @@ get: description: "<p>Returns a list of your order returns. The returns are returned sorted by creation date, with the most recently created return appearing first.</p>" 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 required: false type: string @@ -12208,10 +14276,11 @@ - has_more - object - url type: - object + x-expandableFields: [] default: description: Error response. schema: "$ref": "#/definitions/error" "/v1/order_returns/{id}": @@ -12219,10 +14288,15 @@ description: "<p>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.</p>" 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 required: true type: string @@ -12239,10 +14313,15 @@ get: description: "<p>Returns a list of your orders. The orders are returned sorted by creation date, with the most recently created orders appearing first.</p>" 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 name: limit required: false @@ -12335,10 +14414,11 @@ - has_more - object - url type: - object + x-expandableFields: [] default: description: Error response. schema: "$ref": "#/definitions/error" post: @@ -12376,10 +14456,19 @@ email: description: The email address of the customer placing the order. 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 type: - array @@ -12412,10 +14501,15 @@ description: "<p>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.</p>" 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 required: true type: string @@ -12450,10 +14544,19 @@ to this order. Must be one-time duration and in same currency as the order. 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 the order in a structured format. title: metadata @@ -12520,10 +14623,19 @@ description: The email address of the customer placing the order. Required if not previously specified for the order. 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 the order in a structured format. title: metadata @@ -12572,10 +14684,19 @@ 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 items: description: List of items to return. title: items type: - array @@ -12591,10 +14712,15 @@ "/v1/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 @@ -12666,19 +14792,211 @@ - 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/payments/{payment}": 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: payment required: true type: string @@ -12696,10 +15014,15 @@ description: "<p>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.</p>" 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 name: limit required: false @@ -12783,10 +15106,11 @@ - object - url title: PayoutList type: - object + x-expandableFields: [] default: description: Error response. schema: "$ref": "#/definitions/error" post: @@ -12816,16 +15140,25 @@ in lowercase. Must be a [supported currency](https://support.stripe.com/questions/which-currencies-does-stripe-support). title: currency 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 the payout in a structured format. title: metadata @@ -12865,20 +15198,25 @@ "$ref": "#/definitions/payout" default: description: Error response. schema: "$ref": "#/definitions/error" - "/v1/payouts/{id}": + "/v1/payouts/{payout}": get: description: "<p>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.</p>" 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: '200': description: Successful response. @@ -12894,19 +15232,28 @@ only the metadata as arguments.</p>" operationId: PayoutUpdate 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. 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 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 @@ -12919,23 +15266,38 @@ "$ref": "#/definitions/payout" default: description: Error response. schema: "$ref": "#/definitions/error" - "/v1/payouts/{id}/cancel": + "/v1/payouts/{payout}/cancel": post: description: "<p>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.</p>" operationId: PayoutCancel 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. schema: "$ref": "#/definitions/payout" @@ -12946,10 +15308,15 @@ "/v1/plans": get: description: "<p>Returns a list of your plans.</p>" 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 name: limit required: false @@ -13017,10 +15384,11 @@ - has_more - object - url type: - object + x-expandableFields: [] default: description: Error response. schema: "$ref": "#/definitions/error" post: @@ -13045,10 +15413,19 @@ 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). 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 like "gold" or a primary key from your own database. title: id @@ -13128,10 +15505,25 @@ - description: The identifier of the plan to be deleted. in: path 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. schema: "$ref": "#/definitions/plan" @@ -13141,10 +15533,15 @@ "$ref": "#/definitions/error" get: description: "<p>Retrieves the plan with the given ID.</p>" 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 required: true type: string @@ -13171,10 +15568,19 @@ 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 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 @@ -13221,10 +15627,15 @@ description: "<p>Returns a list of your products. The products are returned sorted by creation date, with the most recently created products appearing first.</p>" 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 name: active required: false @@ -13307,10 +15718,11 @@ - has_more - object - url type: - object + x-expandableFields: [] default: description: Error response. schema: "$ref": "#/definitions/error" post: @@ -13351,10 +15763,19 @@ description: The product's description, meant to be displayable to the customer. 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. title: id type: @@ -13415,10 +15836,25 @@ - description: The ID of the product to delete. in: path 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/product" @@ -13430,10 +15866,15 @@ description: "<p>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.</p>" 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 required: true type: string @@ -13492,10 +15933,19 @@ description: The product's description, meant to be displayable to the customer. 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. title: images type: @@ -13545,10 +15995,15 @@ description: "<p>Returns a list of your recipients. The recipients are returned sorted by creation date, with the most recently created recipients appearing first.</p>" 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 name: limit required: false @@ -13624,10 +16079,11 @@ - has_more - object - url type: - object + x-expandableFields: [] default: description: Error response. schema: "$ref": "#/definitions/error" post: @@ -13638,40 +16094,10 @@ in: body name: payload 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 type: - object @@ -13685,30 +16111,24 @@ description: description: '' 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 type: - object @@ -13747,10 +16167,25 @@ - description: The identifier of the recipient to be deleted. in: path 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/transfer_recipient" @@ -13761,10 +16196,15 @@ get: description: "<p>Retrieves the details of an existing recipient. You need only supply the unique recipient identifier that was returned upon recipient creation.</p>" 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 required: true type: string @@ -13790,40 +16230,10 @@ in: body name: payload 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 type: - object @@ -13842,30 +16252,24 @@ description: description: '' 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 type: - object @@ -13896,10 +16300,15 @@ "/v1/recipients/{id}/cards": get: 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 name: limit required: false @@ -13964,10 +16373,11 @@ - object - url title: CardList type: - object + x-expandableFields: [] default: description: Error response. schema: "$ref": "#/definitions/error" post: @@ -13975,11 +16385,11 @@ operationId: CreateTransferRecipientCard parameters: - description: Body parameters for the request. in: body name: payload - required: false + required: true schema: properties: card: description: The card can either be a token, like the ones returned by [Elements](/docs/elements), or a dictionary containing a user's @@ -13988,10 +16398,19 @@ card. title: card 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: '200': description: Successful response. @@ -14014,10 +16433,25 @@ - description: '' in: path 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. schema: "$ref": "#/definitions/card" @@ -14027,10 +16461,15 @@ "$ref": "#/definitions/error" get: 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 required: true type: string @@ -14096,10 +16535,19 @@ exp_year: description: '' 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 type: - string @@ -14118,10 +16566,15 @@ 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.</p>" 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 name: limit required: false @@ -14187,10 +16640,11 @@ - has_more - object - url type: - object + x-expandableFields: [] default: description: Error response. schema: "$ref": "#/definitions/error" post: @@ -14198,11 +16652,11 @@ operationId: CreateChargeRefund parameters: - description: Body parameters for the request. in: body name: payload - required: false + required: true schema: properties: amount: description: '' title: amount @@ -14216,10 +16670,19 @@ directive: description: '' 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 type: - object @@ -14252,10 +16715,15 @@ "/v1/refunds/{refund}": get: description: "<p>Retrieves the details of an existing refund.</p>" 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 required: true type: string @@ -14278,10 +16746,19 @@ 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 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 @@ -14300,10 +16777,15 @@ get: description: "<p>Returns a list of your SKUs. The SKUs are returned sorted by creation date, with the most recently created SKUs appearing first.</p>" 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 name: limit required: false @@ -14396,10 +16878,11 @@ - has_more - object - url type: - object + x-expandableFields: [] default: description: Error response. schema: "$ref": "#/definitions/error" post: @@ -14430,10 +16913,19 @@ 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). 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. title: id type: @@ -14447,15 +16939,10 @@ inventory: description: Description of the SKU's inventory. 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 in a structured format. title: metadata @@ -14501,10 +16988,25 @@ - description: The identifier of the SKU to be deleted. in: path 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/sku" @@ -14516,10 +17018,15 @@ description: "<p>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.</p>" 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 required: true type: string @@ -14565,10 +17072,19 @@ 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). 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. title: image type: @@ -14576,15 +17092,10 @@ inventory: description: Description of the SKU's inventory. 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 in a structured format. title: metadata @@ -14624,16 +17135,16 @@ operationId: CreateSource parameters: - 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: - integer currency: @@ -14641,10 +17152,19 @@ associated with the source. This is the currency for which the source will be chargeable once ready. 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 is generally inferred unless a type supports multiple flows. title: flow @@ -14679,14 +17199,14 @@ description: The `type` of the source to create. title: type 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 required: - type @@ -14704,10 +17224,15 @@ description: "<p>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.</p>" 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 required: true type: string @@ -14736,10 +17261,19 @@ 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 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 @@ -14771,13 +17305,22 @@ required: true type: string - 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 type: - array @@ -14795,10 +17338,15 @@ "/v1/subscription_items": get: description: "<p>Returns a list of your subscription items for a given subscription.</p>" 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 name: limit required: false @@ -14864,10 +17412,11 @@ - has_more - object - url type: - object + x-expandableFields: [] default: description: Error response. schema: "$ref": "#/definitions/error" post: @@ -14879,10 +17428,19 @@ in: body name: payload 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 type: - string @@ -14938,10 +17496,19 @@ 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 prorate: description: Flag indicating whether to [prorate](/docs/subscriptions/upgrading-downgrading#understanding-proration) switching plans during a billing cycle. title: prorate type: @@ -14965,10 +17532,15 @@ "$ref": "#/definitions/error" get: description: "<p>Retrieves the invoice item with the given ID.</p>" 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 required: true type: string @@ -14994,10 +17566,19 @@ 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 plan: description: The identifier of the new plan for this subscription item. title: plan type: - string @@ -15034,10 +17615,15 @@ get: description: "<p>By default, returns a list of subscriptions that have not been canceled. In order to list canceled subscriptions, specify <code>status=canceled</code>.</p>" 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 name: limit required: false @@ -15122,10 +17708,11 @@ - has_more - object - url type: - object + x-expandableFields: [] default: description: Error response. schema: "$ref": "#/definitions/error" post: @@ -15133,37 +17720,23 @@ operationId: CreateSubscription parameters: - 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 for that particular subscription. title: coupon @@ -15172,16 +17745,19 @@ customer: description: The identifier of the customer to subscribe. 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 type: - array @@ -15190,25 +17766,15 @@ object. It can be useful for storing additional information about the subscription in a structured format. 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 <currency>10</currency>/user/month, and your customer has 5 users, you could pass 5 as the quantity to have the customer charged <currency>50</currency> (5 x <currency>10</currency>) @@ -15219,15 +17785,10 @@ new subscription will not inherit the quantity attribute and will default to 1 unless you pass a quantity parameter. 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 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 @@ -15311,10 +17872,19 @@ description: A flag that if set to true will delay the cancellation of the subscription until the end of the current period. 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. schema: "$ref": "#/definitions/subscription" @@ -15323,11 +17893,16 @@ schema: "$ref": "#/definitions/error" get: description: "<p>Retrieves the subscription with the given ID.</p>" 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. schema: "$ref": "#/definitions/subscription" @@ -15347,69 +17922,48 @@ in: body name: payload 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 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 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 the subscription in a structured format. 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. title: plan type: @@ -15442,15 +17996,10 @@ new subscription will not inherit the quantity attribute and will default to 1 unless you pass a quantity parameter. 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 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 @@ -15496,11 +18045,26 @@ "$ref": "#/definitions/error" "/v1/subscriptions/{subscription_exposed_id}/discount": delete: description: "<p>Removes the currently applied discount on a customer.</p>" 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. schema: "$ref": "#/definitions/discount" @@ -15523,10 +18087,19 @@ description: '' title: bank_account 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 type: - string @@ -15547,10 +18120,15 @@ "/v1/tokens/{token}": get: description: "<p>Retrieves the token with the given ID.</p>" 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 required: true type: string @@ -15568,10 +18146,15 @@ description: "<p>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.</p>" 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 name: limit required: false @@ -15649,10 +18232,11 @@ - object - url title: TransferList type: - object + x-expandableFields: [] default: description: Error response. schema: "$ref": "#/definitions/error" post: @@ -15678,10 +18262,19 @@ destination: description: '' 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 type: - object @@ -15701,10 +18294,11 @@ type: - string required: - amount - currency + - destination responses: '200': description: Successful response. schema: "$ref": "#/definitions/transfer" @@ -15717,10 +18311,15 @@ description: "<p>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.</p>" 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 required: true type: string @@ -15746,10 +18345,19 @@ 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 metadata: description: '' title: metadata type: - object @@ -15770,10 +18378,25 @@ - description: '' in: path 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/legacy_transfer" @@ -15788,10 +18411,15 @@ on the transfer object. If you need more than those 10, you can use this API method and the <code>limit</code> and <code>starting_after</code> parameters to page through additional reversals.</p>" 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 name: limit required: false @@ -15856,10 +18484,11 @@ - object - url title: TransferReversalList type: - object + x-expandableFields: [] default: description: Error response. schema: "$ref": "#/definitions/error" post: @@ -15885,10 +18514,19 @@ description: description: '' 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 type: - object @@ -15911,10 +18549,15 @@ description: "<p>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.</p>" 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 required: true type: string @@ -15952,9 +18595,18 @@ 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 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