Retrieves a 3D Secure object.
" operationId: Retrieve3DSecure parameters: - description: The identifier of the 3D Secure object to be retrieved. in: path name: three_d_secure required: true type: string responses: '200': description: Successful response. schema: "$ref": "#/definitions/three_d_secure" default: description: Error response. schema: "$ref": "#/definitions/error" "/v1/account": delete: description:With Connect, you may delete Stripe accounts you manage.
Managed accounts created using test-mode keys can be deleted at any time. Managed accounts created using live-mode keys may only be deleted once all balances are zero.
If you are looking to close your own account, use the data tab in your account settings instead.
operationId: AccountDelete parameters: - description: Body parameters for the request. in: body name: payload required: false schema: properties: account: 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 responses: '200': description: Successful response. schema: "$ref": "#/definitions/account" default: description: Error response. schema: "$ref": "#/definitions/error" get: description: "Retrieves the details of the account.
" operationId: AccountRetrieve parameters: - 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 type: string responses: '200': description: Successful response. schema: "$ref": "#/definitions/account" default: description: Error response. schema: "$ref": "#/definitions/error" post: description:Updates an account by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
You may only update accounts that you manage. To update your own account, you can currently only do so via the dashboard. For more information on updating Managed Accounts, see our guide.
operationId: AccountUpdate parameters: - description: Body parameters for the request. in: body name: payload required: false schema: properties: business_logo: description: '' title: business_logo type: - string business_name: description: The publicly sharable name for this account. title: business_name type: - string business_primary_color: description: A CSS hex color value representing the primary branding color for this account. title: business_primary_color type: - string business_url: description: The URL that best shows the service or product provided for this account. title: business_url type: - string debit_negative_balances: description: A boolean for whether or not Stripe should try to reclaim negative balances from the account holder's bank account. See our [managed account bank transfer guide](/docs/connect/account-balances) for more information. title: debit_negative_balances type: - boolean decline_charge_on: description: Account-level settings to automatically decline certain types of charges regardless of the bank's decision. title: decline_charge_on type: - object default_currency: description: Three-letter ISO currency code representing the default currency for the account. This must be a currency that [Stripe supports in the account's country](https://support.stripe.com/questions/which-currencies-does-stripe-support). title: default_currency type: - string email: description: 'Email address of the account holder. For standalone accounts, this is used to email them asking them to claim their Stripe account. 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 external_account: description: A card or bank account to attach to the account. You can provide either a token, like the ones returned by [Stripe.js](/docs/stripe.js), or a dictionary as documented in the external_account parameter for either [card](/docs/api#account_create_card) or [bank account](/docs/api#account_create_bank_account) creation.Updates the metadata of a bank account belonging to a managed accounts, and optionally sets it as the default for its currency. Other bank account details are not editable by design.
operationId: UpdateAccountBankAccount parameters: - description: The ID of the bank account to be updated. in: path name: id required: true type: string - description: Body parameters for the request. in: body name: payload required: false schema: properties: default_for_currency: description: If set to `true`, this bank account will become the default external account for its currency. title: default_for_currency type: - boolean metadata: description: '' title: metadata type: - object responses: '200': description: Successful response. schema: "$ref": "#/definitions/external_account_source" default: description: Error response. schema: "$ref": "#/definitions/error" "/v1/account/external_accounts": get: description: '' operationId: AllAccountExternalAccounts parameters: - 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 responses: '200': description: Successful response. schema: properties: data: items: type: - object 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: ExternalAccountList type: - object default: description: Error response. schema: "$ref": "#/definitions/error" post: description: '' operationId: CreateAccountExternalAccount parameters: - description: Body parameters for the request. in: body name: payload required: false 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 external_account: description: This string to be replaced by DocSpecGenerator. title: external_account type: - object - string metadata: description: A set of key/value pairs that you can attach to an external account object. It can be useful for storing additional information about the external account in a structured format. title: metadata type: - object required: - external_account responses: '200': description: Successful response. schema: "$ref": "#/definitions/external_account_source" default: description: Error response. schema: "$ref": "#/definitions/error" "/v1/account/external_accounts/{id}": delete: description: '' operationId: DeleteAccountExternalAccount parameters: - description: The ID of the external account to be deleted. 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:Updates the metadata of a bank account belonging to a managed accounts, and optionally sets it as the default for its currency. Other bank account details are not editable by design.
operationId: UpdateAccountBankAccount parameters: - description: The ID of the bank account to be updated. in: path name: id required: true type: string - description: Body parameters for the request. in: body name: payload required: false schema: properties: default_for_currency: description: If set to `true`, this bank account will become the default external account for its currency. title: default_for_currency type: - boolean metadata: description: '' title: metadata type: - object responses: '200': description: Successful response. schema: "$ref": "#/definitions/external_account_source" default: description: Error response. schema: "$ref": "#/definitions/error" "/v1/accounts": get: description:Returns a list of accounts connected to your platform via Connect. If you’re not a platform, the list will be empty.
operationId: AllAccount parameters: - description: 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 responses: '200': description: Successful response. schema: properties: data: items: "$ref": "#/definitions/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. enum: - "/v1/accounts" type: - string required: - data - has_more - object - url type: - object default: description: Error response. schema: "$ref": "#/definitions/error" post: description: '' operationId: AccountCreate parameters: - description: Body parameters for the request. in: body name: payload required: false schema: properties: business_logo: description: '' title: business_logo type: - string business_name: description: The publicly sharable name for this account. title: business_name type: - string business_primary_color: description: A CSS hex color value representing the primary branding color for this account. title: business_primary_color type: - string business_url: description: The URL that best shows the service or product provided for this account. title: business_url type: - string country: description: '' title: country type: - string debit_negative_balances: description: A boolean for whether or not Stripe should try to reclaim negative balances from the account holder's bank account. See our [managed account bank transfer guide](/docs/connect/account-balances) for more information. title: debit_negative_balances type: - boolean decline_charge_on: description: Account-level settings to automatically decline certain types of charges regardless of the bank's decision. title: decline_charge_on type: - object default_currency: description: Three-letter ISO currency code representing the default currency for the account. This must be a currency that [Stripe supports in the account's country](https://support.stripe.com/questions/which-currencies-does-stripe-support). title: default_currency type: - string email: description: 'Email address of the account holder. For standalone accounts, this is used to email them asking them to claim their Stripe account. 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 external_account: description: A card or bank account to attach to the account. You can provide either a token, like the ones returned by [Stripe.js](/docs/stripe.js), or a dictionary as documented in the external_account parameter for either [card](/docs/api#account_create_card) or [bank account](/docs/api#account_create_bank_account) creation.With Connect, you may delete Stripe accounts you manage.
Managed accounts created using test-mode keys can be deleted at any time. Managed accounts created using live-mode keys may only be deleted once all balances are zero.
If you are looking to close your own account, use the data tab in your account settings instead.
operationId: AccountDelete parameters: - description: The identifier of the account to be deleted. If none is provided, will default to the account of the API key. in: path name: account required: true type: string responses: '200': description: Successful response. schema: "$ref": "#/definitions/account" default: description: Error response. schema: "$ref": "#/definitions/error" get: description: "Retrieves the details of the account.
" operationId: AccountRetrieve parameters: - 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 type: string responses: '200': description: Successful response. schema: "$ref": "#/definitions/account" default: description: Error response. schema: "$ref": "#/definitions/error" post: description:Updates an account by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
You may only update accounts that you manage. To update your own account, you can currently only do so via the dashboard. For more information on updating Managed Accounts, see our guide.
operationId: AccountUpdate parameters: - description: Body parameters for the request. in: body name: payload required: false schema: properties: business_logo: description: '' title: business_logo type: - string business_name: description: The publicly sharable name for this account. title: business_name type: - string business_primary_color: description: A CSS hex color value representing the primary branding color for this account. title: business_primary_color type: - string business_url: description: The URL that best shows the service or product provided for this account. title: business_url type: - string debit_negative_balances: description: A boolean for whether or not Stripe should try to reclaim negative balances from the account holder's bank account. See our [managed account bank transfer guide](/docs/connect/account-balances) for more information. title: debit_negative_balances type: - boolean decline_charge_on: description: Account-level settings to automatically decline certain types of charges regardless of the bank's decision. title: decline_charge_on type: - object default_currency: description: Three-letter ISO currency code representing the default currency for the account. This must be a currency that [Stripe supports in the account's country](https://support.stripe.com/questions/which-currencies-does-stripe-support). title: default_currency type: - string email: description: 'Email address of the account holder. For standalone accounts, this is used to email them asking them to claim their Stripe account. 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 external_account: description: A card or bank account to attach to the account. You can provide either a token, like the ones returned by [Stripe.js](/docs/stripe.js), or a dictionary as documented in the external_account parameter for either [card](/docs/api#account_create_card) or [bank account](/docs/api#account_create_bank_account) creation.Updates the metadata of a bank account belonging to a managed accounts, and optionally sets it as the default for its currency. Other bank account details are not editable by design.
operationId: UpdateAccountBankAccount parameters: - description: The ID of the bank account to be updated. in: path name: id required: true type: string - description: Body parameters for the request. in: body name: payload required: false schema: properties: default_for_currency: description: If set to `true`, this bank account will become the default external account for its currency. title: default_for_currency type: - boolean metadata: description: '' title: metadata type: - object responses: '200': description: Successful response. schema: "$ref": "#/definitions/external_account_source" default: description: Error response. schema: "$ref": "#/definitions/error" "/v1/accounts/{account}/external_accounts": get: description: '' operationId: AllAccountExternalAccounts parameters: - 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 responses: '200': description: Successful response. schema: properties: data: items: type: - object 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: ExternalAccountList type: - object default: description: Error response. schema: "$ref": "#/definitions/error" post: description: '' operationId: CreateAccountExternalAccount parameters: - description: Body parameters for the request. in: body name: payload required: false 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 external_account: description: This string to be replaced by DocSpecGenerator. title: external_account type: - object - string metadata: description: A set of key/value pairs that you can attach to an external account object. It can be useful for storing additional information about the external account in a structured format. title: metadata type: - object required: - external_account responses: '200': description: Successful response. schema: "$ref": "#/definitions/external_account_source" default: description: Error response. schema: "$ref": "#/definitions/error" "/v1/accounts/{account}/external_accounts/{id}": delete: description: '' operationId: DeleteAccountExternalAccount parameters: - description: The ID of the external account to be deleted. 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:Updates the metadata of a bank account belonging to a managed accounts, and optionally sets it as the default for its currency. Other bank account details are not editable by design.
operationId: UpdateAccountBankAccount parameters: - description: The ID of the bank account to be updated. in: path name: id required: true type: string - description: Body parameters for the request. in: body name: payload required: false schema: properties: default_for_currency: description: If set to `true`, this bank account will become the default external account for its currency. title: default_for_currency type: - boolean metadata: description: '' title: metadata type: - object responses: '200': description: Successful response. schema: "$ref": "#/definitions/external_account_source" default: description: Error response. schema: "$ref": "#/definitions/error" "/v1/accounts/{account}/reject": post: description:With Connect, you may flag managed accounts as suspicious.
Managed accounts created using test-mode keys can be rejected at any time. Managed accounts created using live-mode keys may only be rejected once all balances are zero.
operationId: AccountReject parameters: - description: The identifier of the account to be rejected. in: path name: account required: true type: string - description: Body parameters for the request. in: body name: payload required: false schema: properties: reason: description: The reason for rejecting the account. May be one of `fraud`, `terms_of_service`, or `other`. title: reason type: - string required: - reason responses: '200': description: Successful response. schema: "$ref": "#/definitions/account" default: description: Error response. schema: "$ref": "#/definitions/error" "/v1/apple_pay/domains": get: description: '' operationId: AllApplePayDomains parameters: - 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: '' in: query name: domain_name required: false type: string responses: '200': description: Successful response. schema: properties: data: items: "$ref": "#/definitions/apple_pay_domain" 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/apple_pay/domains" type: - string required: - data - has_more - object - url title: ApplePayDomainList type: - object default: description: Error response. schema: "$ref": "#/definitions/error" post: description: '' operationId: CreateApplePayDomain parameters: - description: Body parameters for the request. in: body name: payload required: false schema: properties: domain_name: description: '' title: domain_name type: - string required: - domain_name responses: '200': description: Successful response. schema: "$ref": "#/definitions/apple_pay_domain" default: description: Error response. schema: "$ref": "#/definitions/error" "/v1/apple_pay/domains/{domain}": delete: description: '' operationId: DeleteApplePayDomain parameters: - description: '' in: path name: domain required: true type: string responses: '200': description: Successful response. schema: "$ref": "#/definitions/apple_pay_domain" default: description: Error response. schema: "$ref": "#/definitions/error" get: description: '' operationId: RetrieveApplePayDomain parameters: - description: '' in: path name: domain required: true type: string responses: '200': description: Successful response. schema: "$ref": "#/definitions/apple_pay_domain" default: description: Error response. schema: "$ref": "#/definitions/error" "/v1/application_fees": get: description: "Returns a list of application fees you’ve previously collected. The application fees are returned in sorted order, with the most recent fees appearing first.
" operationId: AllPlatformEarnings parameters: - description: 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: '' in: query name: created required: false type: integer - description: Only return application fees for the charge specified by this charge ID. in: query name: charge required: false type: string responses: '200': description: Successful response. schema: properties: data: items: "$ref": "#/definitions/platform_earning" 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/application_fees" type: - string required: - data - has_more - object - url type: - object default: description: Error response. schema: "$ref": "#/definitions/error" "/v1/application_fees/{fee}/refunds/{id}": get: description: "By default, you can see the 10 most recent refunds stored directly on the application fee object, but you can also retrieve details about a specific refund stored on the application fee.
" operationId: RetrievePlatformEarningRefund parameters: - description: ID of the application fee refunded. in: path name: fee required: true type: string - description: ID of refund to retrieve. in: path name: id required: true type: string responses: '200': description: Successful response. schema: "$ref": "#/definitions/fee_refund" default: description: Error response. schema: "$ref": "#/definitions/error" post: description: "Updates the specified application fee refund by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
This request only accepts metadata as an argument.
" operationId: UpdatePlatformEarningRefund parameters: - description: Body parameters for the request. in: body name: payload required: false schema: properties: 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 type: - object responses: '200': description: Successful response. schema: "$ref": "#/definitions/fee_refund" default: description: Error response. schema: "$ref": "#/definitions/error" "/v1/application_fees/{id}": get: description: "Retrieves the details of an application fee that your account has collected. The same information is returned when refunding the application fee.
" operationId: RetrievePlatformEarning parameters: - description: The identifier of the fee to be retrieved. in: path name: id required: true type: string responses: '200': description: Successful response. schema: "$ref": "#/definitions/platform_earning" default: description: Error response. schema: "$ref": "#/definitions/error" "/v1/application_fees/{id}/refund": post: description: '' operationId: RefundPlatformEarning parameters: - description: '' in: path name: id required: true type: string - description: Body parameters for the request. in: body name: payload required: false schema: properties: amount: description: '' title: amount type: - integer directive: description: '' title: directive type: - string responses: '200': description: Successful response. schema: "$ref": "#/definitions/platform_earning" default: description: Error response. schema: "$ref": "#/definitions/error" "/v1/application_fees/{id}/refunds": get: description: "You can see a list of the refunds belonging to a specific application
fee. Note that the 10 most recent refunds are always available by default
on the application fee object. If you need more than those 10, you can use
this API method and the limit and starting_after
parameters to page through additional refunds.
Retrieves the current account balance, based on the authentication that was used to make the request.
" operationId: BalanceRetrieve parameters: [] responses: '200': description: Successful response. schema: "$ref": "#/definitions/balance" default: description: Error response. schema: "$ref": "#/definitions/error" "/v1/balance/history": get: description: "Returns a list of transactions that have contributed to the Stripe account balance (e.g., charges, transfers, and so forth). The transactions are returned in sorted order, with the most recent transactions appearing first.
" operationId: AllBalanceTransactions parameters: - description: 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: For automatic Stripe payouts only, only returns transactions that were payed out on the specified payout ID. in: query name: payout required: false type: string - description: '' in: query name: available_on required: false type: string - description: '' in: query name: created required: false type: integer - description: 'Only returns transactions of the given type. One of: `charge`, `refund`, `adjustment`, `application_fee`, `application_fee_refund`, `transfer`, `payment`, `payout`, or `payout_failure`.' in: query name: type required: false type: string - description: Only returns the original transaction. in: query name: source required: false type: string - description: '' in: query name: currency required: false type: string responses: '200': description: Successful response. schema: properties: data: items: "$ref": "#/definitions/balance_transaction" 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/balance/history" type: - string required: - data - has_more - object - url title: BalanceTransactionsList type: - object default: description: Error response. schema: "$ref": "#/definitions/error" "/v1/balance/history/{id}": get: description: "Retrieves the balance transaction with the given ID.
" operationId: RetrieveBalanceTransaction parameters: - 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 type: string responses: '200': description: Successful response. schema: "$ref": "#/definitions/balance_transaction" default: description: Error response. schema: "$ref": "#/definitions/error" "/v1/bitcoin/payments/{charge}/refund": post: description: '' operationId: CreatePaymentRefundWithPaymentResponse parameters: - description: '' in: path name: charge required: true type: string - description: Body parameters for the request. in: body name: payload required: false schema: properties: amount: description: '' title: amount type: - integer description: description: '' title: description type: - string directive: description: '' title: directive type: - string metadata: description: '' title: metadata type: - object reason: description: '' title: reason type: - string refund_address: description: '' title: refund_address type: - string refund_application_fee: description: '' title: refund_application_fee type: - boolean reverse_transfer: description: '' title: reverse_transfer type: - boolean responses: '200': description: Successful response. schema: "$ref": "#/definitions/charge" default: description: Error response. schema: "$ref": "#/definitions/error" "/v1/bitcoin/receivers": get: description: "Returns a list of your receivers. Receivers are returned sorted by creation date, with the most recently created receivers appearing first.
" operationId: AllReceivers parameters: - description: 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: Filter for active receivers. in: query name: active required: false type: boolean - description: Filter for filled receivers. in: query name: filled required: false type: boolean - description: Filter for receivers with uncaptured funds. in: query name: uncaptured_funds required: false type: boolean responses: '200': description: Successful response. schema: properties: data: items: "$ref": "#/definitions/bitcoin_receiver" 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/receivers" type: - string required: - data - has_more - object - url type: - object default: description: Error response. schema: "$ref": "#/definitions/error" post: description: "Creates a Bitcoin receiver object that can be used to accept bitcoin payments from your customer. The receiver exposes a Bitcoin address and is created with a bitcoin to USD exchange rate that is valid for 10 minutes.
" operationId: CreateReceiver parameters: - description: Body parameters for the request. in: body name: payload required: true schema: properties: amount: description: The amount of `currency` that you will be paid. title: amount type: - integer currency: description: Three-letter [ISO code for the currency](https://support.stripe.com/questions/which-currencies-does-stripe-support) to which the bitcoin will be converted. You will be paid out in this currency. Only USD is currently supported. title: currency type: - string description: description: '' title: description type: - string email: description: The email address of the customer. title: email type: - 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 refund_mispayments: description: A flag that indicates whether you would like Stripe to automatically handle refunds for any [mispayments](/docs/guides/bitcoin#mispayments) to the receiver. title: refund_mispayments type: - boolean required: - amount - currency responses: '200': description: Successful response. schema: "$ref": "#/definitions/bitcoin_receiver" default: description: Error response. schema: "$ref": "#/definitions/error" "/v1/bitcoin/receivers/{id}": delete: description: '' operationId: DeleteReceiver parameters: - description: '' in: path name: id required: true type: string responses: '200': description: Successful response. schema: "$ref": "#/definitions/bitcoin_receiver" default: description: Error response. schema: "$ref": "#/definitions/error" get: description: "Retrieves the Bitcoin receiver with the given ID.
" operationId: RetrieveReceiver parameters: - description: '' in: path name: id required: true type: string responses: '200': description: Successful response. schema: "$ref": "#/definitions/bitcoin_receiver" default: description: Error response. schema: "$ref": "#/definitions/error" post: description: '' operationId: UpdateReceiver parameters: - description: '' in: path name: id required: true type: string - description: Body parameters for the request. in: body name: payload required: false schema: properties: description: description: '' title: description type: - string email: description: '' title: email type: - string metadata: description: '' title: metadata type: - object refund_address: description: '' title: refund_address type: - string responses: '200': description: Successful response. schema: "$ref": "#/definitions/bitcoin_receiver" default: description: Error response. schema: "$ref": "#/definitions/error" "/v1/bitcoin/receivers/{id}/refund": post: description: '' operationId: RefundReceiver parameters: - description: '' in: path name: id required: true type: string - description: Body parameters for the request. in: body name: payload required: false schema: properties: 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: - string responses: '200': description: Successful response. schema: "$ref": "#/definitions/bitcoin_receiver" default: description: Error response. schema: "$ref": "#/definitions/error" "/v1/bitcoin/receivers/{receiver}/transactions": get: description: '' operationId: AllTransactions parameters: - 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 transactions for the customer specified by this customer ID. in: query name: customer required: false type: string - description: Only return transactions for the receiver specified by this receiver ID. in: path name: receiver required: true type: string responses: '200': description: Successful response. schema: properties: data: items: "$ref": "#/definitions/bitcoin_transaction" 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: BitcoinTransactionList type: - object default: description: Error response. schema: "$ref": "#/definitions/error" "/v1/bitcoin/transactions": get: description: '' operationId: AllTransactions parameters: - 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 transactions for the customer specified by this customer ID. in: query name: customer required: false type: string - description: Only return transactions for the receiver specified by this receiver ID. in: query name: receiver required: false type: string responses: '200': description: Successful response. schema: properties: data: items: "$ref": "#/definitions/bitcoin_transaction" 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: BitcoinTransactionList type: - object default: description: Error response. schema: "$ref": "#/definitions/error" "/v1/bitcoin/transactions/{id}": get: description: '' operationId: RetrieveTransaction parameters: - description: '' in: path name: id required: true type: string responses: '200': description: Successful response. schema: "$ref": "#/definitions/bitcoin_transaction" default: description: Error response. schema: "$ref": "#/definitions/error" "/v1/charges": get: description: "Returns a list of charges you’ve previously created. The charges are returned in sorted order, with the most recent charges appearing first.
" operationId: AllCharges parameters: - description: 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 charges for the customer specified by this customer ID. in: query name: customer required: false type: string - description: '' in: query name: created required: false type: integer - description: '' in: query name: source required: false type: string - description: Only return charges for this transfer group. in: query name: transfer_group 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/charges" type: - string required: - data - has_more - object - url type: - object default: description: Error response. schema: "$ref": "#/definitions/error" post: description: '' operationId: CreateCharge 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 - string external_id: description: '' title: external_id 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 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: - object - string 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 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/charges/{charge}": get: description: "Retrieves the details of a charge that has previously been created. Supply the unique charge ID that was returned from your previous request, and Stripe will return the corresponding charge information. The same information is returned when creating or refunding the charge.
" operationId: RetrieveCharge parameters: - description: The identifier of the charge to be retrieved. in: path name: charge required: true type: string responses: '200': description: Successful response. schema: "$ref": "#/definitions/charge" default: description: Error response. schema: "$ref": "#/definitions/error" post: description: "Updates the specified charge by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
This request
accepts only the description, metadata, receipt_email,
fraud_details, and shipping as arguments.
Capture the payment of an existing, uncaptured, charge. This is the second half of the two-step payment flow, where first you created a charge with the capture option set to false.
Uncaptured payments expire exactly seven days after they are created. If they are not captured by that point in time, they will be marked as refunded and will no longer be capturable.
operationId: ChargeCapture parameters: - description: '' in: path name: charge required: true type: string - description: Body parameters for the request. in: body name: payload required: false schema: properties: amount: description: The amount to capture, which must be less than or equal to the original amount. Any additional amount will be automatically refunded. title: amount type: - integer application_fee: description: An application fee to add on to this charge. Can only be used with Stripe Connect. title: application_fee type: - integer 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 type: - string statement_descriptor: description: An arbitrary string to be displayed on your customer's credit card statement. This may be up to *22 characters*. As an example, if your website is `RunClub` and the item you're charging for is a race ticket, you may want to specify a `statement_descriptor` of `RunClub 5K race ticket`. The statement description may not include `<>"'` characters, and will appear on your customer's statement in capital letters. Non-ASCII characters are automatically stripped. Updating this value will overwrite the previous statement descriptor of this charge. While most banks display this information consistently, some may display it incorrectly or not at all. title: statement_descriptor type: - string responses: '200': description: Successful response. schema: "$ref": "#/definitions/charge" default: description: Error response. schema: "$ref": "#/definitions/error" "/v1/charges/{charge}/dispute": get: description: '' operationId: RetrieveChargeDispute parameters: - description: '' in: path name: charge required: true type: string responses: '200': description: Successful response. schema: "$ref": "#/definitions/dispute" default: description: Error response. schema: "$ref": "#/definitions/error" post: description: '' operationId: UpdateChargeDispute parameters: - description: '' in: path name: charge required: true type: string - description: Body parameters for the request. in: body name: payload required: false schema: properties: evidence: 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 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 type: - object responses: '200': description: Successful response. schema: "$ref": "#/definitions/dispute" default: description: Error response. schema: "$ref": "#/definitions/error" "/v1/charges/{charge}/dispute/close": post: description: '' operationId: CloseChargeDispute parameters: - description: '' in: path name: charge required: true type: string responses: '200': description: Successful response. schema: "$ref": "#/definitions/dispute" default: description: Error response. schema: "$ref": "#/definitions/error" "/v1/charges/{charge}/refund": post: description: '' operationId: CreatePaymentRefundWithPaymentResponse parameters: - description: '' in: path name: charge required: true type: string - description: Body parameters for the request. in: body name: payload required: false schema: properties: amount: description: '' title: amount type: - integer description: description: '' title: description type: - string directive: description: '' title: directive type: - string metadata: description: '' title: metadata type: - object reason: description: '' title: reason type: - string refund_address: description: '' title: refund_address type: - string refund_application_fee: description: '' title: refund_application_fee type: - boolean reverse_transfer: description: '' title: reverse_transfer type: - boolean responses: '200': description: Successful response. schema: "$ref": "#/definitions/charge" default: description: Error response. schema: "$ref": "#/definitions/error" "/v1/charges/{charge}/refunds": get: description: "You can see a list of the refunds belonging to a specific charge.
Note that the 10 most recent refunds are always available by default on the
charge object. If you need more than those 10, you can use this API method
and the limit and starting_after parameters to page
through additional refunds.
Lists all Country Spec objects available in the API.
" operationId: AllCountrySpecs parameters: - 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 responses: '200': description: Successful response. schema: properties: data: items: "$ref": "#/definitions/country_spec" 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/country_specs" type: - string required: - data - has_more - object - url type: - object default: description: Error response. schema: "$ref": "#/definitions/error" "/v1/country_specs/{country}": get: description: "Returns a Country Spec for a given Country code.
" operationId: RetrieveCountrySpec parameters: - 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 type: string responses: '200': description: Successful response. schema: "$ref": "#/definitions/country_spec" default: description: Error response. schema: "$ref": "#/definitions/error" "/v1/coupons": get: description: "Returns a list of your coupons.
" operationId: AllCoupons parameters: - 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: A filter on the list based on the object `created` field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with a number of different query options. in: query name: created required: false type: string responses: '200': description: Successful response. schema: properties: data: items: "$ref": "#/definitions/coupon" 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/coupons" type: - string required: - data - has_more - object - url type: - object default: description: Error response. schema: "$ref": "#/definitions/error" post: description:You can create coupons easily via the coupon management page of the Stripe dashboard. Coupon creation is also accessible via the API if you need to create coupons on the fly.
A coupon has either
a percent_off or an amount_off and currency.
If you set an amount_off, that amount will be subtracted from
any invoice’s subtotal. For example, an invoice with a subtotal of amount_off
of amount_off of
You can delete coupons via the coupon management page of the Stripe dashboard. However, deleting a coupon does not affect any customers who have already applied the coupon; it means that new customers can’t redeem the coupon. You can also delete coupons via the API.
operationId: DeleteCoupon parameters: - description: The identifier of the coupon to be deleted. in: path name: coupon required: true type: string responses: '200': description: Successful response. schema: "$ref": "#/definitions/coupon" default: description: Error response. schema: "$ref": "#/definitions/error" get: description: "Retrieves the coupon with the given ID.
" operationId: RetrieveCoupon parameters: - description: The ID of the desired coupon. in: path name: coupon required: true type: string responses: '200': description: Successful response. schema: "$ref": "#/definitions/coupon" default: description: Error response. schema: "$ref": "#/definitions/error" post: description: "Updates the metadata of a coupon. Other coupon details (currency, duration, amount_off) are, by design, not editable.
" operationId: UpdateCoupon parameters: - description: The identifier of the coupon to be updated. in: path name: coupon required: true type: string - description: Body parameters for the request. in: body name: payload required: false schema: properties: 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 type: - object responses: '200': description: Successful response. schema: "$ref": "#/definitions/coupon" default: description: Error response. schema: "$ref": "#/definitions/error" "/v1/customers": get: description: "Returns a list of your customers. The customers are returned sorted by creation date, with the most recent customers appearing first.
" operationId: AllCustomers parameters: - description: 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: '' in: query name: created required: false type: integer - description: '' in: query name: deleted required: false type: boolean responses: '200': description: Successful response. schema: properties: data: items: "$ref": "#/definitions/customer" 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/customers" type: - string required: - data - has_more - object - url type: - object default: description: Error response. schema: "$ref": "#/definitions/error" post: description: "Creates a new customer object.
" operationId: CustomerCreateWithPlan parameters: - description: Body parameters for the request. in: body name: payload required: false schema: properties: account_balance: description: An integer amount in %s that is the starting account balance for your customer. A negative amount represents a credit that will be used before attempting any charges to the customer's card; a positive amount will be added to the next invoice. title: account_balance type: - integer business_vat_id: description: The customer's VAT identification number. If you are using Relay, this field gets passed to tax provider you are using for your orders. title: business_vat_id type: - string coupon: description: If you provide a coupon code, the customer will have a discount applied on all recurring charges. Charges you create through the API will not have the discount. title: coupon type: - string description: description: An arbitrary string that you can attach to a customer object. It is displayed alongside the customer in the dashboard. title: description type: - string email: 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 type: - integer 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 source: description: The source can either be a token, like the ones returned by [Elements](/docs/elements), or a dictionary containing a user's credit card details (with the options shown below). title: source type: - object - string responses: '200': description: Successful response. schema: "$ref": "#/definitions/customer" default: description: Error response. schema: "$ref": "#/definitions/error" "/v1/customers/{customer}": delete: description: "Permanently deletes a customer. It cannot be undone. Also immediately cancels any active subscriptions on the customer.
" operationId: DeleteCustomer parameters: - description: The identifier of the customer to be deleted. in: path name: customer required: true type: string responses: '200': description: Successful response. schema: "$ref": "#/definitions/customer" default: description: Error response. schema: "$ref": "#/definitions/error" get: description: "Retrieves the details of an existing customer. You need only supply the unique customer identifier that was returned upon customer creation.
" operationId: RetrieveCustomer parameters: - description: The identifier of the customer to be retrieved. in: path name: customer required: true type: string responses: '200': description: Successful response. schema: "$ref": "#/definitions/customer" default: description: Error response. schema: "$ref": "#/definitions/error" post: description: '' operationId: CustomerUpdateWithPlan parameters: - description: '' in: path name: customer required: true type: string - description: Body parameters for the request. in: body name: payload required: false schema: properties: account_balance: description: An integer amount in %s that is the starting account balance for your customer. A negative amount represents a credit that will be used before attempting any charges to the customer's card; a positive amount will be added to the next invoice. title: account_balance type: - integer business_vat_id: description: The customer's VAT identification number. If you are using Relay, this field gets passed to tax provider you are using for your orders. title: business_vat_id type: - string coupon: description: If you provide a coupon code, the customer will have a discount applied on all recurring charges. Charges you create through the API will not have the discount. title: coupon type: - string description: description: An arbitrary string that you can attach to a customer object. It is displayed alongside the customer in the dashboard. title: description type: - string email: 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 type: - integer 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 source: description: The source can either be a token, like the ones returned by [Elements](/docs/elements), or a dictionary containing a user's credit card details (with the options shown below). title: source type: - object - string responses: '200': description: Successful response. schema: "$ref": "#/definitions/customer" default: description: Error response. schema: "$ref": "#/definitions/error" "/v1/customers/{customer}/alipay_accounts": get: description: '' operationId: AllCustomerAlipayAccounts parameters: - 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: The ID of the customer whose Alipay accounts will be retrieved. in: path name: customer required: true type: string responses: '200': description: Successful response. schema: 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 default: description: Error response. schema: "$ref": "#/definitions/error" post: description: '' operationId: CreateCustomerSource parameters: - description: Body parameters for the request. in: body name: payload required: false schema: properties: 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 type: - object source: description: This string to be replaced by DocSpecGenerator. title: source type: - object - string required: - source responses: '200': description: Successful response. schema: "$ref": "#/definitions/customer_source" default: description: Error response. schema: "$ref": "#/definitions/error" "/v1/customers/{customer}/alipay_accounts/{id}": delete: description: '' operationId: DeleteCustomerSource parameters: - description: The ID of the source to be deleted. in: path name: id required: true type: string responses: '200': description: Successful response. schema: "$ref": "#/definitions/customer_source" default: description: Error response. schema: "$ref": "#/definitions/error" get: description: '' operationId: RetrieveCustomerAlipayAccount parameters: - description: The ID of the Alipay account to be retrieved. in: path name: id required: true type: string responses: '200': description: Successful response. schema: "$ref": "#/definitions/alipay_account" default: description: Error response. schema: "$ref": "#/definitions/error" "/v1/customers/{customer}/bank_accounts": get: description: "You can see a list of the bank accounts belonging to a Customer.
Note that the 10 most recent sources are always available by default on the
Customer. If you need more than those 10, you can use this API method and
the limit and starting_after parameters to page
through additional bank accounts.
By default, you can see the 10 most recent sources stored on a Customer directly on the object, but you can also retrieve details about a specific bank account stored on the Stripe account.
" operationId: RetrieveCustomerBankAccount parameters: - description: ID of bank account to retrieve. in: path name: id required: true type: string - description: '' in: path name: customer required: true type: string responses: '200': description: Successful response. schema: "$ref": "#/definitions/bank_account" default: description: Error response. schema: "$ref": "#/definitions/error" post: description: '' operationId: UpdateCustomerCard parameters: - description: The ID of the card to be updated. in: path name: id required: true type: string - description: Body parameters for the request. 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 cvc: description: '' title: cvc type: - string exp_month: description: '' title: exp_month type: - string exp_year: description: '' title: exp_year type: - 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" default: description: Error response. schema: "$ref": "#/definitions/error" "/v1/customers/{customer}/bank_accounts/{id}/verify": post: description: '' operationId: VerifyCustomerSource parameters: - description: The ID of the source to be verified. in: path name: id required: true type: string - description: '' in: path name: customer required: true type: string - description: Body parameters for the request. in: body name: payload required: false schema: properties: amounts: description: Two positive integers in **cents** equal to the values of the microdeposits sent to the bank account. title: amounts type: - array verification_method: description: '' title: verification_method type: - string responses: '200': description: Successful response. schema: "$ref": "#/definitions/bank_account" default: description: Error response. schema: "$ref": "#/definitions/error" "/v1/customers/{customer}/cards": get: description: '' operationId: AllCustomerCards parameters: - 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: The ID of the customer whose cards will be retrieved. in: path name: customer required: true type: string responses: '200': description: Successful response. schema: 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 default: description: Error response. schema: "$ref": "#/definitions/error" post: description: '' operationId: CreateCustomerSource parameters: - description: Body parameters for the request. in: body name: payload required: false schema: properties: 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 type: - object source: description: This string to be replaced by DocSpecGenerator. title: source type: - object - string required: - source responses: '200': description: Successful response. schema: "$ref": "#/definitions/customer_source" default: description: Error response. schema: "$ref": "#/definitions/error" "/v1/customers/{customer}/cards/{id}": delete: description: '' operationId: DeleteCustomerSource parameters: - description: The ID of the source to be deleted. in: path name: id required: true type: string responses: '200': description: Successful response. schema: "$ref": "#/definitions/customer_source" default: description: Error response. schema: "$ref": "#/definitions/error" get: description: '' operationId: RetrieveCustomerCard parameters: - description: The ID of the card to be retrieved. in: path name: id required: true type: string responses: '200': description: Successful response. schema: "$ref": "#/definitions/card" default: description: Error response. schema: "$ref": "#/definitions/error" post: description: '' operationId: UpdateCustomerCard parameters: - description: The ID of the card to be updated. in: path name: id required: true type: string - description: Body parameters for the request. 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 cvc: description: '' title: cvc type: - string exp_month: description: '' title: exp_month type: - string exp_year: description: '' title: exp_year type: - 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" default: description: Error response. schema: "$ref": "#/definitions/error" "/v1/customers/{customer}/discount": delete: description: "Removes the currently applied discount on a customer.
" operationId: DeleteCustomerDiscount parameters: [] responses: '200': description: Successful response. schema: "$ref": "#/definitions/discount" default: description: Error response. schema: "$ref": "#/definitions/error" get: description: '' operationId: RetrieveCustomerDiscount parameters: - description: '' in: path name: customer required: true type: string responses: '200': description: Successful response. schema: "$ref": "#/definitions/discount" default: description: Error response. schema: "$ref": "#/definitions/error" "/v1/customers/{customer}/sources": get: description: '' operationId: AllCustomerSources parameters: - 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: The ID of the customer whose sources will be retrieved. in: path name: customer required: true type: string responses: '200': description: Successful response. schema: properties: data: items: type: - object 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: SourceList type: - object default: description: Error response. schema: "$ref": "#/definitions/error" post: description: '' operationId: CreateCustomerSource parameters: - description: Body parameters for the request. in: body name: payload required: false schema: properties: 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 type: - object source: description: This string to be replaced by DocSpecGenerator. title: source type: - object - string required: - source responses: '200': description: Successful response. schema: "$ref": "#/definitions/customer_source" default: description: Error response. schema: "$ref": "#/definitions/error" "/v1/customers/{customer}/sources/{id}": delete: description: '' operationId: DeleteCustomerSource parameters: - description: The ID of the source to be deleted. in: path name: id required: true type: string responses: '200': description: Successful response. schema: "$ref": "#/definitions/customer_source" default: description: Error response. schema: "$ref": "#/definitions/error" get: description: '' operationId: RetrieveCustomerSource parameters: - description: The ID of the source to be retrieved. in: path name: id required: true type: string responses: '200': description: Successful response. schema: "$ref": "#/definitions/customer_source" default: description: Error response. schema: "$ref": "#/definitions/error" post: description: '' operationId: UpdateCustomerCard parameters: - description: The ID of the card to be updated. in: path name: id required: true type: string - description: Body parameters for the request. 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 cvc: description: '' title: cvc type: - string exp_month: description: '' title: exp_month type: - string exp_year: description: '' title: exp_year type: - 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" default: description: Error response. schema: "$ref": "#/definitions/error" "/v1/customers/{customer}/sources/{id}/verify": post: description: '' operationId: VerifyCustomerSource parameters: - description: The ID of the source to be verified. in: path name: id required: true type: string - description: '' in: path name: customer required: true type: string - description: Body parameters for the request. in: body name: payload required: false schema: properties: amounts: description: Two positive integers in **cents** equal to the values of the microdeposits sent to the bank account. title: amounts type: - array verification_method: description: '' title: verification_method type: - string responses: '200': description: Successful response. schema: "$ref": "#/definitions/bank_account" default: description: Error response. schema: "$ref": "#/definitions/error" "/v1/customers/{customer}/subscriptions": get: description: "You can see a list of the customer’s active subscriptions. Note that the 10 most recent active subscriptions are always available by default on the customer object. If you need more than those 10, you can use the limit and starting_after parameters to page through additional subscriptions.
" operationId: AllCustomerSubscriptions parameters: - description: 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: The ID of the customer whose subscriptions will be retrieved. in: path name: customer required: true type: string responses: '200': description: Successful response. schema: properties: data: items: "$ref": "#/definitions/subscription" 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: SubscriptionList type: - object default: description: Error response. schema: "$ref": "#/definitions/error" post: description: "Creates a new subscription on an existing customer.
" operationId: CreateCustomerSubscription parameters: - description: The identifier of the customer to subscribe. in: path name: customer required: true type: string - description: Body parameters for the request. 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 type: - integer items: description: List of subscription items, each with an attached plan. title: items type: - array 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 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 isCancels a customer’s subscription. If you set the at_period_end
parameter to true, the subscription will remain active until the end of the
period, at which point it will be canceled and not renewed. By default, the
subscription is terminated immediately. In either case, the customer will
not be charged again for the subscription. Note, however, that any pending
invoice items that you’ve created will still be charged for at the end of
the period unless manually deleted. If you’ve
set the subscription to cancel at period end, any pending prorations will
also be left in place and collected at the end of the period, but if the subscription
is set to cancel immediately, pending prorations will be removed.
By default, all unpaid invoices for the customer will be closed upon subscription cancellation. We do this in order to prevent unexpected payment retries once the customer has canceled a subscription. However, you can reopen the invoices manually after subscription cancellation to have us proceed with automatic retries, or you could even re-attempt payment yourself on all unpaid invoices before allowing the customer to cancel the subscription at all.
operationId: DeleteCustomerSubscription parameters: - description: Body parameters for the request. in: body name: payload required: false schema: properties: at_period_end: 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 responses: '200': description: Successful response. schema: "$ref": "#/definitions/subscription" default: description: Error response. schema: "$ref": "#/definitions/error" get: description: "Retrieves the subscription with the given ID.
" operationId: RetrieveCustomerSubscription parameters: [] responses: '200': description: Successful response. schema: "$ref": "#/definitions/subscription" default: description: Error response. schema: "$ref": "#/definitions/error" post: description:Updates an existing subscription on a customer to match the specified parameters. When changing plans or quantities, we will optionally prorate the price we charge next month to make up for any price changes. To preview how the proration will be calculated, use the upcoming invoice endpoint.
operationId: UpdateCustomerSubscription parameters: - description: Body parameters for the request. 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 type: - integer 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: - string prorate: description: Flag telling us whether to prorate switching plans during a billing cycle. title: prorate type: - boolean proration_date: description: If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply exactly the same proration that was previewed with [upcoming invoice](#retrieve_customer_invoice) endpoint. It can also be used to implement custom proration logic, such as prorating by day instead of by second, by providing the time that you wish to use for proration calculations. title: proration_date type: - integer quantity: description: The quantity you'd like to apply to the subscription you're updating. For example, if your plan isRemoves the currently applied discount on a customer.
" operationId: DeleteCustomerDiscount parameters: [] responses: '200': description: Successful response. schema: "$ref": "#/definitions/discount" default: description: Error response. schema: "$ref": "#/definitions/error" get: description: '' operationId: RetrieveCustomerDiscount parameters: - description: '' in: path name: customer required: true type: string responses: '200': description: Successful response. schema: "$ref": "#/definitions/discount" default: description: Error response. schema: "$ref": "#/definitions/error" "/v1/disputes": get: description: "Returns a list of your disputes.
" operationId: AllDisputes parameters: - 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: '' in: query name: created required: false type: integer responses: '200': description: Successful response. schema: properties: data: items: "$ref": "#/definitions/dispute" 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/disputes" type: - string required: - data - has_more - object - url type: - object default: description: Error response. schema: "$ref": "#/definitions/error" "/v1/disputes/{dispute}": get: description: "Retrieves the dispute with the given ID.
" operationId: RetrieveDispute parameters: - description: ID of dispute to retrieve. in: path name: dispute required: true type: string responses: '200': description: Successful response. schema: "$ref": "#/definitions/dispute" default: description: Error response. schema: "$ref": "#/definitions/error" post: description:When you get a dispute, contacting your customer is always the best first step. If that doesn’t work, you can submit evidence in order to help us resolve the dispute in your favor. You can do this in your dashboard, but if you prefer, you can use the API to submit evidence programmatically.
Depending on your dispute type, different evidence fields will give you a better chance of winning your dispute. You may want to consult our guide to dispute types to help you figure out which evidence fields to provide.
operationId: UpdateDispute parameters: - description: ID of the dispute to update. in: path name: dispute required: true type: string - description: Body parameters for the request. in: body name: payload required: false schema: properties: evidence: 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 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 type: - object responses: '200': description: Successful response. schema: "$ref": "#/definitions/dispute" default: description: Error response. schema: "$ref": "#/definitions/error" "/v1/disputes/{dispute}/close": post: description: "Closing the dispute for a charge indicates that you do not have any evidence to submit and are essentially ‘dismissing’ the dispute, acknowledging it as lost
The status of the dispute will change from
needs_response to lost. Closing a dispute
is irreversible.
List events, going back up to 30 days.
" operationId: AllEvents parameters: - 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: A string containing a specific event name, or group of events using * as a wildcard. The list will be filtered to include only events with a matching event property. in: query name: type required: false type: string - description: An array of up to 20 strings containing specific event names. The list will be filtered to include only events with a matching event property. You may pass either `type` or `types`, but not both. in: query name: types required: false type: array - description: '' in: query name: created required: false type: integer responses: '200': description: Successful response. schema: properties: data: items: "$ref": "#/definitions/event" 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/events" type: - string required: - data - has_more - object - url type: - object default: description: Error response. schema: "$ref": "#/definitions/error" "/v1/events/{id}": get: description: "Retrieves the details of an event. Supply the unique identifier of the event, which you might have received in a webhook.
" operationId: RetrieveEvent parameters: - description: The identifier of the event to be retrieved. in: path name: id required: true type: string responses: '200': description: Successful response. schema: "$ref": "#/definitions/event" default: description: Error response. schema: "$ref": "#/definitions/error" "/v1/events/{id}/retry": post: description: "Resend an event. This only works in testmode
" operationId: RetryEvent parameters: - description: '' in: path name: id required: true type: string responses: '200': description: Successful response. schema: "$ref": "#/definitions/event" default: description: Error response. schema: "$ref": "#/definitions/error" "/v1/invoiceitems": get: description: "Returns a list of your invoice items. Invoice items are returned sorted by creation date, with the most recently created invoice items appearing first.
" operationId: AllInvoiceItems parameters: - description: 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: The identifier of the customer whose invoice items to return. If none is provided, all invoice items will be returned. in: query name: customer required: false type: string - description: '' in: query name: created required: false type: integer responses: '200': description: Successful response. schema: properties: data: items: "$ref": "#/definitions/invoice_item" 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/invoiceitems" type: - string required: - data - has_more - object - url type: - object default: description: Error response. schema: "$ref": "#/definitions/error" post: description: "Adds an arbitrary charge or credit to the customer’s upcoming invoice.
" operationId: CreateInvoiceItem parameters: - description: Body parameters for the request. in: body name: payload required: true schema: properties: amount: description: The integer amount in %s of the charge to be applied to the upcoming invoice. To apply a credit to the customer's account, pass a negative amount. title: amount 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). title: currency type: - string customer: description: The ID of the customer who will be billed when this invoice item is billed. title: customer type: - string description: description: An arbitrary string which you can attach to the invoice item. The description is displayed in the invoice for easy tracking. title: description type: - string discountable: description: Controls whether discounts apply to this invoice item. Defaults to false for prorations or negative invoice items, and true for all other invoice items. title: discountable type: - boolean invoice: description: The ID of an existing invoice to add this invoice item to. When left blank, the invoice item will be added to the next upcoming scheduled invoice. Use this when adding invoice items in response to an invoice.created webhook. You cannot add an invoice item to an invoice that has already been paid, attempted or closed. title: invoice type: - 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 type: - object subscription: description: The ID of a subscription to add this invoice item to. When left blank, the invoice item will be be added to the next upcoming scheduled invoice. When set, scheduled invoices for subscriptions other than the specified subscription will ignore the invoice item. Use this when you want to express that an invoice item has been accrued within the context of a particular subscription. title: subscription type: - string required: - amount - currency - customer responses: '200': description: Successful response. schema: "$ref": "#/definitions/invoice_item" default: description: Error response. schema: "$ref": "#/definitions/error" "/v1/invoiceitems/{invoiceitem}": delete: description: "Removes an invoice item from the upcoming invoice. Removing an invoice item is only possible before the invoice it’s attached to is closed.
" operationId: DeleteInvoiceItem parameters: - description: The identifier of the invoice item to be deleted. in: path name: invoiceitem required: true type: string responses: '200': description: Successful response. schema: "$ref": "#/definitions/invoice_item" default: description: Error response. schema: "$ref": "#/definitions/error" get: description: "Retrieves the invoice item with the given ID.
" operationId: RetrieveInvoiceItem parameters: - description: The ID of the desired invoice item. in: path name: invoiceitem required: true type: string responses: '200': description: Successful response. schema: "$ref": "#/definitions/invoice_item" default: description: Error response. schema: "$ref": "#/definitions/error" post: description: "Updates the amount or description of an invoice item on an upcoming invoice. Updating an invoice item is only possible before the invoice it’s attached to is closed.
" operationId: UpdateInvoiceItem parameters: - description: Body parameters for the request. in: body name: payload required: false schema: properties: amount: description: The integer amount in **%s** of the charge to be applied to the upcoming invoice. If you want to apply a credit to the customer's account, pass a negative amount. title: amount type: - integer description: description: An arbitrary string which you can attach to the invoice item. The description is displayed in the invoice for easy tracking. title: description type: - string discountable: description: Controls whether discounts apply to this invoice item. 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 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 type: - object responses: '200': description: Successful response. schema: "$ref": "#/definitions/invoice_item" default: description: Error response. schema: "$ref": "#/definitions/error" "/v1/invoices": get: description: "You can list all invoices, or list the invoices for a specific customer. The invoices are returned sorted by creation date, with the most recently created invoices appearing first.
" operationId: AllInvoices parameters: - description: 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: The identifier of the customer whose invoices to return. in: query name: customer required: false type: string - description: The identifier of the subscription whose invoices to return. in: query name: subscription required: false type: string - description: '' in: query name: date required: false type: integer responses: '200': description: Successful response. schema: properties: data: items: "$ref": "#/definitions/invoice" 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/invoices" type: - string required: - data - has_more - object - url type: - object default: description: Error response. schema: "$ref": "#/definitions/error" post: description:If you need to invoice your customer outside the regular billing cycle, you can create an invoice that pulls in all pending invoice items, including prorations. The customer’s billing cycle and regular subscription won’t be affected.
Once you create the invoice, it’ll be picked up and paid automatically, though you can choose to pay it right away.
operationId: CreateInvoice parameters: - description: Body parameters for the request. in: body name: payload required: false 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 type: - integer metadata: description: '' title: metadata type: - object statement_descriptor: description: Extra information about a charge for the customer's credit card statement. title: statement_descriptor type: - string subscription: description: The ID of the subscription to invoice. If not set, the created invoice will include all pending invoice items for the customer. If set, the created invoice will exclude pending invoice items that pertain to other subscriptions. title: subscription type: - string tax_percent: description: The percent tax rate applied to the invoice, represented as a decimal number. title: tax_percent type: - number required: - customer responses: '200': description: Successful response. schema: "$ref": "#/definitions/invoice" default: description: Error response. schema: "$ref": "#/definitions/error" "/v1/invoices/upcoming": get: description: "At any time, you can preview the upcoming invoice for a customer. This will show you all the charges that are pending, including subscription renewal charges, invoice item charges, etc. It will also show you any discount that is applicable to the customer.
Note that when you are viewing an upcoming invoice, you are simply viewing a preview – the invoice has not yet been created. As such, the upcoming invoice will not show up in invoice listing calls, and you cannot use the API to pay or edit the invoice. If you want to change the amount that your customer will be billed, you can add, remove, or update pending invoice items, or update the customer’s discount.
You
can preview the effects of updating a subscription, including a preview of
what proration will take place. To ensure that the actual proration is calculated
exactly the same as the previewed proration, you should pass a proration_date
parameter when doing the actual subscription update. The value passed in should
be the same as the subscription_proration_date returned on the
upcoming invoice resource. The recommended way to get only the prorations
being previewed is to consider only proration line items where period[start]
is equal to the subscription_proration_date on the upcoming invoice
resource.
Retrieves the invoice with the given ID.
" operationId: RetrieveInvoice parameters: - description: The identifier of the desired invoice. in: path name: invoice required: true type: string responses: '200': description: Successful response. schema: "$ref": "#/definitions/invoice" default: description: Error response. schema: "$ref": "#/definitions/error" post: description: "Until an invoice is paid, it is marked as open (closed=false). If you’d like to stop Stripe from automatically attempting payment on an invoice or would simply like to close the invoice out as no longer owed by the customer, you can update the closed parameter.
" operationId: UpdateInvoice parameters: - description: Body parameters for the request. in: body name: payload required: false 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 closed: description: Boolean representing whether an invoice is closed or not. To close an invoice, pass true. title: closed type: - boolean description: description: '' title: description type: - string forgiven: description: Boolean representing whether an invoice is forgiven or not. To forgive an invoice, pass true. Forgiving an invoice instructs us to update the subscription status as if the invoice were successfully paid. Once an invoice has been forgiven, it cannot be unforgiven or reopened. title: forgiven type: - boolean 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: - string tax_percent: description: The percent tax rate applied to the invoice, represented as a decimal number. The tax rate of an attempted, paid or forgiven invoice cannot be changed. title: tax_percent type: - number responses: '200': description: Successful response. schema: "$ref": "#/definitions/invoice" default: description: Error response. schema: "$ref": "#/definitions/error" "/v1/invoices/{invoice}/lines": get: description: "When retrieving an invoice, you’ll get a lines property containing the total count of line items and the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.
" operationId: AllInvoiceLines parameters: - description: The maximum number of line items to return. 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: The id of the invoice containing the lines to be retrieved. in: path name: invoice required: true type: string - description: In the case of upcoming invoices, the customer of the upcoming invoice is required. In other cases it is ignored. in: query name: customer required: false type: string - description: In the case of upcoming invoices, the subscription of the upcoming invoice is optional. In other cases it is ignored. in: query name: subscription required: false type: string - description: For upcoming invoices, preview updating the subscription given to this plan, or creating a new subscription to this plan if no `subscription` is given. Otherwise this parameter is ignored. in: query name: subscription_plan required: false type: string - description: For upcoming invoices, preview updating or creating a subscription with that quantity. If set, one of `subscription_plan` or `subscription` is required. Otherwise this parameter is ignored. in: query name: subscription_quantity required: false type: integer - description: For upcoming invoices, this decides whether the preview will show the result of applying prorations or not. If set, one of `subscription_plan` or `subscription`, and one of `subscription_plan`, `subscription_quantity` or `subscription_trial_end` are required. Otherwise this parameter is ignored. in: query name: subscription_prorate required: false type: boolean - description: For previewing upcoming invoices with proration, `subscription_proration_date` forces the proration to be calculated as though the update was done at the specified time. The time given must be within the current subscription period, and cannot be before the subscription was on its current plan.If set, `subscription`, and one of `subscription_plan`, `subscription_quantity` or `subscription_trial_end` are required. Also, `subscription_proration` cannot be set to false. Otherwise this parameter is ignored. in: query name: subscription_proration_date required: false type: integer - description: For upcoming invoices, preview updating or creating a subscription with that trial end. If set, one of `subscription_plan` or `subscription` is required. Otherwise this parameter is ignored. in: query name: subscription_trial_end required: false type: integer - description: '' in: query name: subscription_tax_percent required: false type: number - description: For upcoming invoices, preview applying this coupon to the invoice. If a `subscription` or `subscription_plan` is provided, the invoice returned will preview updating or creating a subscription with that coupon. Otherwise, it will preview applying that coupon to the customer for the next upcoming invoice from among the customer's subscriptions. Otherwise this parameter is ignored. in: query name: coupon required: false type: string - description: For upcoming invoices, preview updating the subscription with this list of items. Otherwise this parameter is ignored. in: query name: subscription_items required: false type: array responses: '200': description: Successful response. schema: properties: data: items: "$ref": "#/definitions/invoice_line_item" 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: InvoiceLinesList type: - object default: description: Error response. schema: "$ref": "#/definitions/error" "/v1/invoices/{invoice}/pay": post: description:Stripe automatically creates and then attempts to pay invoices for customers on subscriptions. We’ll also retry unpaid invoices according to your retry settings. However, if you’d like to attempt to collect payment on an invoice out of the normal retry schedule or for some other reason, you can do so.
operationId: PayInvoice parameters: - description: ID of invoice to pay. in: path name: invoice required: true type: string responses: '200': description: Successful response. schema: "$ref": "#/definitions/invoice" default: description: Error response. schema: "$ref": "#/definitions/error" "/v1/order_returns": get: description: "Returns a list of your order returns. The returns are returned sorted by creation date, with the most recently created return appearing first.
" operationId: AllOrderReturns parameters: - description: The order to retrieve returns for. in: query name: order required: false type: string - description: Date this return was created. in: query name: created required: false type: integer - 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 responses: '200': description: Successful response. schema: properties: data: items: "$ref": "#/definitions/order_return" 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/order_returns" type: - string required: - data - has_more - object - url type: - object default: description: Error response. schema: "$ref": "#/definitions/error" "/v1/order_returns/{id}": get: description: "Retrieves the details of an existing order return. Supply the unique order ID from either an order return creation request or the order return list, and Stripe will return the corresponding order information.
" operationId: RetrieveOrderReturn parameters: - description: The identifier of the order return to be retrieved. in: path name: id required: true type: string responses: '200': description: Successful response. schema: "$ref": "#/definitions/order_return" default: description: Error response. schema: "$ref": "#/definitions/error" "/v1/orders": get: description: "Returns a list of your orders. The orders are returned sorted by creation date, with the most recently created orders appearing first.
" operationId: AllOrders parameters: - description: 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 orders that have the given status. One of `created`, `paid`, `fulfilled`, or `refunded`. in: query name: status required: false type: string - description: Only return orders with the given IDs. in: query name: ids required: false type: array - description: Only return orders for the given customer. in: query name: customer required: false type: string - description: Date this order was created. in: query name: created required: false type: string - description: Only return orders with the given upstream order IDs. in: query name: upstream_ids required: false type: array - description: Filter orders based on when they were paid, fulfilled, canceled, or returned. in: query name: status_transitions required: false type: string responses: '200': description: Successful response. schema: properties: data: items: "$ref": "#/definitions/order" 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/orders" type: - string required: - data - has_more - object - url type: - object default: description: Error response. schema: "$ref": "#/definitions/error" post: description: '' operationId: CreateOrder parameters: - description: Body parameters for the request. in: body name: payload required: true schema: properties: coupon: description: A coupon code that represents a discount to be applied to this order. Must be one-time duration and in same currency as the order. title: coupon type: - string 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). title: currency type: - string customer: description: The ID of an existing customer to use for this order. If provided, the customer email and shipping address will be used to create the order. Subsequently, the customer will also be charged to pay the order. If `email` or `shipping` are also provided, they will override the values retrieved from the customer object. title: customer type: - string email: description: The email address of the customer placing the order. title: email type: - string items: description: List of items constituting the order. title: items type: - array 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 type: - object shipping: description: Shipping address for the order. Required if any of the SKUs are for products that have `shippable` set to true. title: shipping type: - object required: - currency responses: '200': description: Successful response. schema: "$ref": "#/definitions/order" default: description: Error response. schema: "$ref": "#/definitions/error" "/v1/orders/{id}": get: description: "Retrieves the details of an existing order. Supply the unique order ID from either an order creation request or the order list, and Stripe will return the corresponding order information.
" operationId: RetrieveOrder parameters: - description: The identifier of the order to be retrieved. in: path name: id required: true type: string responses: '200': description: Successful response. schema: "$ref": "#/definitions/order" default: description: Error response. schema: "$ref": "#/definitions/error" post: description: "Updates the specific order by setting the values of the parameters
passed. Any parameters not provided will be left unchanged. This request accepts
only the metadata, and status as arguments.
Return all or part of an order. The order must have a status
of paid or fulfilled before it can be returned.
Once all items have been returned, the order will become canceled
or returned depending on which status the order started in.
Returns a list of existing payouts sent to third-party bank accounts or that Stripe has sent you. The payouts are returned in sorted order, with the most recently created payouts appearing first.
" operationId: PayoutAll parameters: - description: 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: '' in: query name: arrival_date required: false type: integer - description: '' in: query name: created required: false type: integer - description: The ID of an external account - only return payouts sent to this external account. in: query name: destination required: false type: string - description: 'Only return payouts that have the given status: `pending`, `paid`, `failed`, `in_transit`, or `canceled`.' in: query name: status required: false type: string responses: '200': description: Successful response. schema: properties: data: items: "$ref": "#/definitions/payout" 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/payouts" type: - string required: - data - has_more - object - url title: PayoutList type: - object default: description: Error response. schema: "$ref": "#/definitions/error" post: description:To send funds to your own bank account, you create a new payout object. Your Stripe balance must be able to cover the payout amount, or you’ll receive an “Insufficient Funds” error.
If your API key is in test mode, money won’t actually be sent, though everything else will occur as if in live mode.
If you are creating a manual payout on a Stripe account that uses multiple payment source types, you’ll need to specify the source type balance that the payout should draw from. The balance object details available and pending amounts by source type.
operationId: PayoutCreate parameters: - description: Body parameters for the request. in: body name: payload required: true schema: properties: amount: description: A positive integer in cents representing how much to payout. title: amount 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). title: currency type: - string destination: description: The id of a bank account or a card to send the payout to. If no destination is supplied, the default external account for the specified currency will be used. title: destination type: - 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 type: - object method: description: The method used to send this payout, which can be `standard` or `instant`. `instant` is only supported for payouts to debit cards. (See [Instant payouts for marketplaces for more information](https://stripe.com/blog/instant-payouts-for-marketplaces).) title: method type: - string source_type: description: 'The source balance to draw this payout from. Balances for different payment sources are kept separately. You can find the amounts with the balances API. Valid options are: `alipay_account`, `bank_account`, `bitcoin_receiver`, and `card`.' title: source_type type: - string statement_descriptor: description: 'A string to be displayed on the recipient''s bank or card statement. This may be at most 22 characters. Attempting to use a `statement_descriptor` longer than 22 characters will return an error. Note: Most banks will truncate this information and/or display it inconsistently. Some may not display it at all.' title: statement_descriptor type: - string required: - amount - currency responses: '200': description: Successful response. schema: "$ref": "#/definitions/payout" default: description: Error response. schema: "$ref": "#/definitions/error" "/v1/payouts/{id}": get: description: "Retrieves the details of an existing payout. Supply the unique payout ID from either a payout creation request or the payout list, and Stripe will return the corresponding payout information.
" operationId: PayoutRetrieve parameters: - description: The identifier of the payout to be retrieved. in: path name: id required: true type: string responses: '200': description: Successful response. schema: "$ref": "#/definitions/payout" default: description: Error response. schema: "$ref": "#/definitions/error" post: description: "Updates the specified payout by setting the values of the parameters passed. Any parameters not provided will be left unchanged. This request accepts only the metadata as arguments.
" operationId: PayoutUpdate parameters: - description: The identifier of the payout to be updated. in: path name: id required: true type: string - description: Body parameters for the request. in: body name: payload required: false schema: properties: 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 type: - object responses: '200': description: Successful response. schema: "$ref": "#/definitions/payout" default: description: Error response. schema: "$ref": "#/definitions/error" "/v1/payouts/{id}/cancel": post: description: "A previously created payout can be canceled if it has not yet been paid out. Funds will be refunded to your available balance, and the fees you were originally charged on the payout will be refunded. You may not cancel automatic Stripe payouts.
" operationId: PayoutCancel parameters: - description: The identifier of the payout to be canceled. in: path name: id required: true type: string responses: '200': description: Successful response. schema: "$ref": "#/definitions/payout" default: description: Error response. schema: "$ref": "#/definitions/error" "/v1/plans": get: description: "Returns a list of your plans.
" operationId: AllPlans parameters: - 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: A filter on the list based on the object `created` field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with a number of different query options. in: query name: created required: false type: string responses: '200': description: Successful response. schema: properties: data: items: "$ref": "#/definitions/plan" 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/plans" type: - string required: - data - has_more - object - url type: - object default: description: Error response. schema: "$ref": "#/definitions/error" post: description:You can create plans easily via the plan management page of the Stripe dashboard. Plan creation is also accessible via the API if you need to create plans on the fly.
operationId: CreatePlan parameters: - description: Body parameters for the request. in: body name: payload required: true schema: properties: amount: description: A positive integer in **%s** (or 0 for a free plan) representing how much to charge (on a recurring basis). title: amount 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). title: currency type: - 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 type: - string interval: description: Specifies billing frequency. Either day, week, month or year. title: interval type: - string interval_count: description: The number of intervals between each subscription billing. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks). title: interval_count type: - integer 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 type: - object name: description: Name of the plan, to be displayed on invoices and in the web interface. title: name type: - string statement_descriptor: description: An arbitrary string to be displayed on your customer's credit card statement. This may be up to **22 characters**. As an example, if your website is `RunClub` and the item you're charging for is your Silver Plan, you may want to specify a `statement_descriptor` of `RunClub Silver Plan`. The statement description may not include `<>"'` characters, and will appear on your customer's statement in capital letters. Non-ASCII characters are automatically stripped. While most banks display this information consistently, some may display it incorrectly or not at all. title: statement_descriptor type: - string trial_period_days: description: Specifies a trial period in (an integer number of) days. If you include a trial period, the customer won't be billed for the first time until the trial period ends. If the customer cancels before the trial period is over, she'll never be billed at all. title: trial_period_days type: - integer required: - amount - currency - id - interval - name responses: '200': description: Successful response. schema: "$ref": "#/definitions/plan" default: description: Error response. schema: "$ref": "#/definitions/error" "/v1/plans/{plan}": delete: description:You can delete plans via the plan management page of the Stripe dashboard. However, deleting a plan does not affect any current subscribers to the plan; it merely means that new subscribers can’t be added to that plan. You can also delete plans via the API.
operationId: DeletePlan parameters: - description: The identifier of the plan to be deleted. in: path name: plan required: true type: string responses: '200': description: Successful response. schema: "$ref": "#/definitions/plan" default: description: Error response. schema: "$ref": "#/definitions/error" get: description: "Retrieves the plan with the given ID.
" operationId: RetrievePlan parameters: - description: The ID of the desired plan. in: path name: plan required: true type: string responses: '200': description: Successful response. schema: "$ref": "#/definitions/plan" default: description: Error response. schema: "$ref": "#/definitions/error" post: description: "Updates the name of a plan. Other plan details (price, interval, etc.) are, by design, not editable.
" operationId: UpdatePlan parameters: - description: The identifier of the plan to be updated. in: path name: plan required: true type: string - description: Body parameters for the request. in: body name: payload required: false schema: properties: 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 type: - object name: description: Name of the plan, to be displayed on invoices and in the web interface. title: name type: - string statement_descriptor: description: An arbitrary string to be displayed on your customer's credit card statement. This may be up to **22 characters**. As an example, if your website is `RunClub` and the item you're charging for is your Silver Plan, you may want to specify a `statement_descriptor` of `RunClub Silver Plan`. The statement description may not include `<>"'` characters, and will appear on your customer's statement in capital letters. Non-ASCII characters are automatically stripped. While most banks display this information consistently, some may display it incorrectly or not at all. title: statement_descriptor type: - string trial_period_days: description: Specifies a trial period in (an integer number of) days. If you include a trial period, the customer won't be billed for the first time until the trial period ends. If the customer cancels before the trial period is over, she'll never be billed at all. title: trial_period_days type: - integer responses: '200': description: Successful response. schema: "$ref": "#/definitions/plan" default: description: Error response. schema: "$ref": "#/definitions/error" "/v1/products": get: description: "Returns a list of your products. The products are returned sorted by creation date, with the most recently created products appearing first.
" operationId: AllProducts parameters: - description: Only return products that are active or inactive (e.g. pass `false` to list all inactive products). in: query name: active required: false type: boolean - description: Only return products with the given IDs. in: query name: ids required: false type: array - description: Only return products that can be shipped (i.e., physical, not digital products). in: query name: shippable required: false type: boolean - description: Only return products with the given url. in: query name: url 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 responses: '200': description: Successful response. schema: properties: data: items: "$ref": "#/definitions/product" 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/products" type: - string required: - data - has_more - object - url type: - object default: description: Error response. schema: "$ref": "#/definitions/error" post: description: "Creates a new product object.
" operationId: CreateProduct parameters: - description: Body parameters for the request. in: body name: payload required: true schema: properties: active: description: Whether or not the product is currently available for purchase. Defaults to `true`. title: active type: - boolean attributes: description: A list of up to 5 alphanumeric attributes that each SKU can provide values for (e.g. `["color", "size"]`). title: attributes type: - array caption: description: A short one-line description of the product, meant to be displayable to the customer. title: caption type: - string deactivate_on: description: An array of Connect application names or identifiers that should not be able to order the SKUs for this product. title: deactivate_on type: - array description: description: The product's description, meant to be displayable to the customer. title: description type: - string id: description: The identifier for the product. Must be unique. If not provided, an identifier will be randomly generated. title: id type: - 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: - array 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 product in a structured format. title: metadata type: - object name: description: The product's name, meant to be displayable to the customer. title: name type: - string package_dimensions: description: The dimensions of this product for shipping purposes. A SKU associated with this product can override this value by having its own `package_dimensions`. title: package_dimensions type: - object shippable: description: Whether this product is shipped (i.e. physical goods). Defaults to `true`. title: shippable type: - boolean url: description: A URL of a publicly-accessible webpage for this product. title: url type: - string required: - name responses: '200': description: Successful response. schema: "$ref": "#/definitions/product" default: description: Error response. schema: "$ref": "#/definitions/error" "/v1/products/{id}": delete: description: "Delete a product. Deleting a product is only possible if it has no SKUs associated with it.
" operationId: DeleteProduct parameters: - description: The ID of the product to delete. in: path name: id required: true type: string responses: '200': description: Successful response. schema: "$ref": "#/definitions/product" default: description: Error response. schema: "$ref": "#/definitions/error" get: description: "Retrieves the details of an existing product. Supply the unique product ID from either a product creation request or the product list, and Stripe will return the corresponding product information.
" operationId: RetrieveProduct parameters: - description: The identifier of the product to be retrieved. in: path name: id required: true type: string responses: '200': description: Successful response. schema: "$ref": "#/definitions/product" default: description: Error response. schema: "$ref": "#/definitions/error" post: description: "Updates the specific product by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
Note that
a product’s attributes are not editable. Instead, you would need
to deactivate the existing product and create a new one with the new attribute
values.
Returns a list of your recipients. The recipients are returned sorted by creation date, with the most recently created recipients appearing first.
" operationId: AllTransferRecipients parameters: - description: 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 recipients that are verified or unverified. in: query name: verified required: false type: boolean - description: '' in: query name: created required: false type: integer - description: '' in: query name: type required: false type: string responses: '200': description: Successful response. schema: properties: data: items: "$ref": "#/definitions/transfer_recipient" 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/recipients" type: - string required: - data - has_more - object - url type: - object default: description: Error response. schema: "$ref": "#/definitions/error" post: description: '' operationId: TransferRecipientCreate parameters: - description: Body parameters for the request. 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 - string card: description: '' title: card type: - object - string 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 metadata: description: '' title: metadata type: - object name: description: '' title: name type: - string tax_id: description: '' title: tax_id type: - string type: description: '' title: type type: - string required: - name - type responses: '200': description: Successful response. schema: "$ref": "#/definitions/transfer_recipient" default: description: Error response. schema: "$ref": "#/definitions/error" "/v1/recipients/{id}": delete: description: "Permanently deletes a recipient. It cannot be undone.
" operationId: TransferRecipientDelete parameters: - description: The identifier of the recipient to be deleted. in: path name: id required: true type: string responses: '200': description: Successful response. schema: "$ref": "#/definitions/transfer_recipient" default: description: Error response. schema: "$ref": "#/definitions/error" get: description: "Retrieves the details of an existing recipient. You need only supply the unique recipient identifier that was returned upon recipient creation.
" operationId: RetrieveTransferRecipient parameters: - description: The identifier of the recipient to be retrieved. in: path name: id required: true type: string responses: '200': description: Successful response. schema: "$ref": "#/definitions/transfer_recipient" default: description: Error response. schema: "$ref": "#/definitions/error" post: description: '' operationId: TransferRecipientUpdate parameters: - description: '' in: path name: id required: true type: string - description: Body parameters for the request. 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 - string card: description: '' title: card type: - object - string default_card: description: '' title: default_card type: - string 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 metadata: description: '' title: metadata type: - object name: description: '' title: name type: - string tax_id: description: '' title: tax_id type: - string type: description: '' title: type type: - string responses: '200': description: Successful response. schema: "$ref": "#/definitions/transfer_recipient" default: description: Error response. schema: "$ref": "#/definitions/error" "/v1/recipients/{id}/cards": get: description: '' operationId: AllTransferRecipientCards parameters: - 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: The ID of the recipient whose cards will be retrieved. in: path name: id required: true type: string responses: '200': description: Successful response. schema: 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 default: description: Error response. schema: "$ref": "#/definitions/error" post: description: '' operationId: CreateTransferRecipientCard parameters: - description: Body parameters for the request. in: body name: payload required: false 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 credit card details (with the options shown below). Whenever you create a new card for a recipient, Stripe will automatically validate the card. title: card type: - object - string required: - card responses: '200': description: Successful response. schema: "$ref": "#/definitions/card" default: description: Error response. schema: "$ref": "#/definitions/error" "/v1/recipients/{recipient}/cards/{id}": delete: description: '' operationId: DeleteTransferRecipientCard parameters: - description: '' in: path name: id required: true type: string - description: '' in: path name: recipient required: true type: string responses: '200': description: Successful response. schema: "$ref": "#/definitions/card" default: description: Error response. schema: "$ref": "#/definitions/error" get: description: '' operationId: RetrieveTransferRecipientCard parameters: - description: ID of card to retrieve. in: path name: id required: true type: string - description: '' in: path name: recipient required: true type: string responses: '200': description: Successful response. schema: "$ref": "#/definitions/card" default: description: Error response. schema: "$ref": "#/definitions/error" post: description: '' operationId: UpdateTransferRecipientCard parameters: - description: Body parameters for the request. 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 exp_month: description: '' title: exp_month type: - string exp_year: description: '' title: exp_year type: - string name: description: '' title: name type: - string responses: '200': description: Successful response. schema: "$ref": "#/definitions/card" default: description: Error response. schema: "$ref": "#/definitions/error" "/v1/refunds": get: description: "Returns a list of all refunds you’ve previously created. The refunds are returned in sorted order, with the most recent refunds appearing first. For convenience, the 10 most recent refunds are always available by default on the charge object.
" operationId: AllRefunds parameters: - description: 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 refunds for the charge specified by this charge ID. in: query name: charge required: false type: string responses: '200': description: Successful response. schema: properties: data: items: "$ref": "#/definitions/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. enum: - "/v1/refunds" type: - string required: - data - has_more - object - url type: - object default: description: Error response. schema: "$ref": "#/definitions/error" post: description: '' operationId: CreateChargeRefund parameters: - description: Body parameters for the request. in: body name: payload required: false schema: properties: amount: description: '' title: amount type: - integer charge: description: '' title: charge type: - string directive: description: '' title: directive type: - string metadata: description: '' title: metadata type: - object reason: description: '' title: reason type: - string refund_application_fee: description: '' title: refund_application_fee type: - boolean reverse_transfer: description: '' title: reverse_transfer type: - boolean required: - charge responses: '200': description: Successful response. schema: "$ref": "#/definitions/refund" default: description: Error response. schema: "$ref": "#/definitions/error" "/v1/refunds/{refund}": get: description: "Retrieves the details of an existing refund.
" operationId: RetrieveRefund parameters: - description: ID of refund to retrieve. in: path name: refund required: true type: string responses: '200': description: Successful response. schema: "$ref": "#/definitions/refund" default: description: Error response. schema: "$ref": "#/definitions/error" post: description: "Updates the specified refund by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
This request
only accepts metadata as an argument.
Returns a list of your SKUs. The SKUs are returned sorted by creation date, with the most recently created SKUs appearing first.
" operationId: AllSKUs parameters: - description: 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: The ID of the product whose SKUs will be retrieved. in: query name: product required: false type: string - description: Only return SKUs that are active or inactive (e.g. pass `false` to list all inactive products). in: query name: active required: false type: boolean - description: Only return SKUs with the given IDs. in: query name: ids required: false type: array - description: Only return SKUs that have the specified key/value pairs in this partially constructed dictionary. Can be specified only if `product` is also supplied. For instance, if the associated product has attributes `["color", "size"]`, passing in `attributes[color]=red` returns all the SKUs for this product that have `color` set to `red`. in: query name: attributes required: false type: string - description: Only return SKUs that are either in stock or out of stock (e.g. pass `false` to list all SKUs that are out of stock). If no value is provided, all SKUs are returned. in: query name: in_stock required: false type: boolean responses: '200': description: Successful response. schema: properties: data: items: "$ref": "#/definitions/sku" 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/skus" type: - string required: - data - has_more - object - url type: - object default: description: Error response. schema: "$ref": "#/definitions/error" post: description: "Creates a new SKU associated with a product.
" operationId: CreateSKU parameters: - description: Body parameters for the request. in: body name: payload required: true schema: properties: active: description: Whether or not the SKU is available for purchase. Default to `true`. title: active type: - boolean attributes: description: 'A dictionary of attributes and values for the attributes defined by the product. If, for example, a product''s attributes are `["size", "gender"]`, a valid SKU has the following dictionary of attributes: `{"size": "Medium", "gender": "Unisex"}`.' title: attributes type: - object 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). title: currency type: - string id: description: The identifier for the SKU. Must be unique. If not provided, an identifier will be randomly generated. title: id type: - string image: description: The URL of an image for this SKU, meant to be displayable to the customer. title: image type: - string 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 type: - object package_dimensions: description: The dimensions of this SKU for shipping purposes. title: package_dimensions type: - object price: description: The cost of the item as a nonnegative integer in the smallest currency unit (that is, 100 cents to charge $1.00, or 100 to charge ¥100, Japanese Yen being a 0-decimal currency). title: price type: - integer product: description: The ID of the product this SKU is associated with. title: product type: - string required: - currency - inventory - price - product responses: '200': description: Successful response. schema: "$ref": "#/definitions/sku" default: description: Error response. schema: "$ref": "#/definitions/error" "/v1/skus/{id}": delete: description: "Delete a SKU. Deleting a SKU is only possible until it has been used in an order.
" operationId: DeleteSKU parameters: - description: The identifier of the SKU to be deleted. in: path name: id required: true type: string responses: '200': description: Successful response. schema: "$ref": "#/definitions/sku" default: description: Error response. schema: "$ref": "#/definitions/error" get: description: "Retrieves the details of an existing SKU. Supply the unique SKU identifier from either a SKU creation request or from the product, and Stripe will return the corresponding SKU information.
" operationId: RetrieveSKU parameters: - description: The identifier of the SKU to be retrieved. in: path name: id required: true type: string responses: '200': description: Successful response. schema: "$ref": "#/definitions/sku" default: description: Error response. schema: "$ref": "#/definitions/error" post: description: "Updates the specific SKU by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
Note that
a SKU’s attributes are not editable. Instead, you would need
to deactivate the existing SKU and create a new one with the new attribute
values.
Creates a new source object.
" operationId: CreateSource parameters: - description: Body parameters for the request. in: body name: payload required: false schema: properties: amount: description: Amount associated with the source. This is the amount for which the source will be chargeable once ready. Required for `single-use` sources. title: amount 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. title: currency type: - 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 type: - 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 type: - object owner: description: Information about the owner of the payment instrument that may be used or required by particular source types. title: owner type: - object redirect: description: Parameters required for the redirect flow. Required if the source is authenticated by a redirect (`flow` is `redirect`). title: redirect type: - object token: description: An optional token used to create the source. When passed, token properties will override source parameters. title: token type: - string type: 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. title: usage type: - string required: - type responses: '200': description: Successful response. schema: "$ref": "#/definitions/source" default: description: Error response. schema: "$ref": "#/definitions/error" "/v1/sources/{source}": get: description: "Retrieves an existing source object. Supply the unique source ID from a source creation request and Stripe will return the corresponding up-to-date source object information.
" operationId: RetrieveSource parameters: - description: The identifier of the source to be retrieved. in: path name: source required: true type: string - description: The client secret of the source. Required if a publishable key is used to retrieve the source. in: query name: client_secret required: false type: string responses: '200': description: Successful response. schema: "$ref": "#/definitions/source" default: description: Error response. schema: "$ref": "#/definitions/error" post: description: "Updates the specified source by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
This request
accepts only the metadata and owner as arguments.
Returns a list of your subscription items for a given subscription.
" operationId: AllSubscriptionItems parameters: - 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: The ID of the subscription whose items will be retrieved. in: query name: subscription required: true type: string responses: '200': description: Successful response. schema: properties: data: items: "$ref": "#/definitions/subscription_item" 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/subscription_items" type: - string required: - data - has_more - object - url type: - object default: description: Error response. schema: "$ref": "#/definitions/error" post: description: "Adds a new item to an existing subscription. No existing items will be changed or replaced.
" operationId: CreateSubscriptionItem parameters: - description: Body parameters for the request. in: body name: payload required: true schema: properties: plan: description: The identifier of the plan to add to the subscription. title: plan type: - string prorate: description: Flag indicating whether to [prorate](/docs/subscriptions/upgrading-downgrading#understanding-proration) switching plans during a billing cycle. title: prorate type: - boolean proration_date: description: If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply the same proration that was previewed with the [upcoming invoice](#retrieve_customer_invoice) endpoint. title: proration_date type: - integer quantity: description: The quantity you'd like to apply to the subscription item you're creating. title: quantity type: - integer subscription: description: The identifier of the subscription to modify. title: subscription type: - string required: - plan - subscription responses: '200': description: Successful response. schema: "$ref": "#/definitions/subscription_item" default: description: Error response. schema: "$ref": "#/definitions/error" "/v1/subscription_items/{item}": delete: description: "Deletes an item from the subscription. Removing a subscription item from a subscription will not cancel the subscription.
" operationId: DeleteSubscriptionItem parameters: - description: The identifier of the subscription item to delete. in: path name: item required: true type: string - description: Body parameters for the request. in: body name: payload required: false schema: properties: prorate: description: Flag indicating whether to [prorate](/docs/subscriptions/upgrading-downgrading#understanding-proration) switching plans during a billing cycle. title: prorate type: - boolean proration_date: description: If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply the same proration that was previewed with the [upcoming invoice](#retrieve_customer_invoice) endpoint. title: proration_date type: - integer responses: '200': description: Successful response. schema: "$ref": "#/definitions/subscription_item" default: description: Error response. schema: "$ref": "#/definitions/error" get: description: "Retrieves the invoice item with the given ID.
" operationId: RetrieveSubscriptionItem parameters: - description: The identifier of the subscription item to retrieve. in: path name: item required: true type: string responses: '200': description: Successful response. schema: "$ref": "#/definitions/subscription_item" default: description: Error response. schema: "$ref": "#/definitions/error" post: description: "Updates the plan or quantity of an item on a current subscription.
" operationId: UpdateSubscriptionItem parameters: - description: The identifier of the subscription item to modify. in: path name: item required: true type: string - description: Body parameters for the request. in: body name: payload required: false schema: properties: plan: description: The identifier of the new plan for this subscription item. title: plan type: - string prorate: description: Flag indicating whether to [prorate](/docs/subscriptions/upgrading-downgrading#understanding-proration) switching plans during a billing cycle. title: prorate type: - boolean proration_date: description: If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply the same proration that was previewed with the [upcoming invoice](#retrieve_customer_invoice) endpoint. title: proration_date type: - integer quantity: description: The quantity you'd like to apply to the subscription item you're creating. title: quantity type: - integer responses: '200': description: Successful response. schema: "$ref": "#/definitions/subscription_item" default: description: Error response. schema: "$ref": "#/definitions/error" "/v1/subscriptions": get: description: "By default, returns a list of subscriptions that have not been
canceled. In order to list canceled subscriptions, specify status=canceled.
Creates a new subscription on an existing customer.
" operationId: CreateSubscription parameters: - description: Body parameters for the request. 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 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 type: - integer items: description: List of subscription items, each with an attached plan. title: items type: - array 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 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 isCancels a customer’s subscription. If you set the at_period_end
parameter to true, the subscription will remain active until the end of the
period, at which point it will be canceled and not renewed. By default, the
subscription is terminated immediately. In either case, the customer will
not be charged again for the subscription. Note, however, that any pending
invoice items that you’ve created will still be charged for at the end of
the period unless manually deleted. If you’ve
set the subscription to cancel at period end, any pending prorations will
also be left in place and collected at the end of the period, but if the subscription
is set to cancel immediately, pending prorations will be removed.
By default, all unpaid invoices for the customer will be closed upon subscription cancellation. We do this in order to prevent unexpected payment retries once the customer has canceled a subscription. However, you can reopen the invoices manually after subscription cancellation to have us proceed with automatic retries, or you could even re-attempt payment yourself on all unpaid invoices before allowing the customer to cancel the subscription at all.
operationId: DeleteCustomerSubscription parameters: - description: Body parameters for the request. in: body name: payload required: false schema: properties: at_period_end: 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 responses: '200': description: Successful response. schema: "$ref": "#/definitions/subscription" default: description: Error response. schema: "$ref": "#/definitions/error" get: description: "Retrieves the subscription with the given ID.
" operationId: RetrieveCustomerSubscription parameters: [] responses: '200': description: Successful response. schema: "$ref": "#/definitions/subscription" default: description: Error response. schema: "$ref": "#/definitions/error" post: description:Updates an existing subscription on a customer to match the specified parameters. When changing plans or quantities, we will optionally prorate the price we charge next month to make up for any price changes. To preview how the proration will be calculated, use the upcoming invoice endpoint.
operationId: UpdateCustomerSubscription parameters: - description: Body parameters for the request. 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 type: - integer 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: - string prorate: description: Flag telling us whether to prorate switching plans during a billing cycle. title: prorate type: - boolean proration_date: description: If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply exactly the same proration that was previewed with [upcoming invoice](#retrieve_customer_invoice) endpoint. It can also be used to implement custom proration logic, such as prorating by day instead of by second, by providing the time that you wish to use for proration calculations. title: proration_date type: - integer quantity: description: The quantity you'd like to apply to the subscription you're updating. For example, if your plan isRemoves the currently applied discount on a customer.
" operationId: DeleteCustomerDiscount parameters: [] responses: '200': description: Successful response. schema: "$ref": "#/definitions/discount" default: description: Error response. schema: "$ref": "#/definitions/error" "/v1/tokens": post: description: '' operationId: CreateBankAccountToken parameters: - description: Body parameters for the request. in: body name: payload required: false schema: properties: bank_account: description: '' title: bank_account type: - object - string payment_user_agent: description: '' title: payment_user_agent type: - string request_id: description: '' title: request_id type: - string responses: '200': description: Successful response. schema: "$ref": "#/definitions/token" default: description: Error response. schema: "$ref": "#/definitions/error" "/v1/tokens/{token}": get: description: "Retrieves the token with the given ID.
" operationId: RetrieveToken parameters: - description: The ID of the desired token. in: path name: token required: true type: string responses: '200': description: Successful response. schema: "$ref": "#/definitions/token" default: description: Error response. schema: "$ref": "#/definitions/error" "/v1/transfers": get: description: "Returns a list of existing transfers sent to connected accounts. The transfers are returned in sorted order, with the most recently created transfers appearing first.
" operationId: AllTransfers parameters: - description: 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: '' in: query name: created required: false type: integer - description: Only return transfers for the destination specified by this account ID. in: query name: destination required: false type: string - description: Only return transfers with the specified transfer group. in: query name: transfer_group required: false type: string responses: '200': description: Successful response. schema: properties: data: items: "$ref": "#/definitions/transfer" 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/transfers" type: - string required: - data - has_more - object - url title: TransferList type: - object default: description: Error response. schema: "$ref": "#/definitions/error" post: description: '' operationId: CreateTransfer parameters: - description: Body parameters for the request. in: body name: payload required: true schema: properties: amount: description: '' title: amount type: - integer currency: description: '' title: currency type: - string destination: description: '' title: destination type: - string metadata: description: '' title: metadata type: - object source_transaction: description: '' title: source_transaction type: - string source_type: description: '' title: source_type type: - string transfer_group: description: '' title: transfer_group type: - string required: - amount - currency responses: '200': description: Successful response. schema: "$ref": "#/definitions/transfer" default: description: Error response. schema: "$ref": "#/definitions/error" "/v1/transfers/{id}": get: description: "Retrieves the details of an existing transfer. Supply the unique transfer ID from either a transfer creation request or the transfer list, and Stripe will return the corresponding transfer information.
" operationId: RetrieveTransfer parameters: - description: The identifier of the transfer to be retrieved. in: path name: id required: true type: string responses: '200': description: Successful response. schema: "$ref": "#/definitions/transfer" default: description: Error response. schema: "$ref": "#/definitions/error" post: description: '' operationId: UpdateTransfer parameters: - description: '' in: path name: id required: true type: string - description: Body parameters for the request. in: body name: payload required: false schema: properties: metadata: description: '' title: metadata type: - object responses: '200': description: Successful response. schema: "$ref": "#/definitions/transfer" default: description: Error response. schema: "$ref": "#/definitions/error" "/v1/transfers/{id}/cancel": post: description: '' operationId: ReverseNonStripeTransferOnSlashCancel parameters: - description: '' in: path name: id required: true type: string responses: '200': description: Successful response. schema: "$ref": "#/definitions/legacy_transfer" default: description: Error response. schema: "$ref": "#/definitions/error" "/v1/transfers/{id}/reversals": get: description: "You can see a list of the reversals belonging to a specific
transfer. Note that the 10 most recent reversals are always available by default
on the transfer object. If you need more than those 10, you can use this API
method and the limit and starting_after parameters
to page through additional reversals.
By default, you can see the 10 most recent reversals stored directly on the transfer object, but you can also retrieve details about a specific reversal stored on the transfer.
" operationId: RetrieveTransferReversal parameters: - description: ID of the transfer reversed. in: path name: transfer required: true type: string - description: ID of reversal to retrieve. in: path name: id required: true type: string responses: '200': description: Successful response. schema: "$ref": "#/definitions/transfer_reversal" default: description: Error response. schema: "$ref": "#/definitions/error" post: description: "Updates the specified reversal by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
This request only accepts metadata and description as arguments.
" operationId: UpdateTransferReversal parameters: - description: '' in: path name: id required: true type: string - description: '' in: path name: transfer required: true type: string - description: Body parameters for the request. in: body name: payload required: false schema: properties: 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 type: - object responses: '200': description: Successful response. schema: "$ref": "#/definitions/transfer_reversal" default: description: Error response. schema: "$ref": "#/definitions/error" produces: - application/json schemes: - https swagger: '2.0'