flowground for Business Customers
Stripe
Connector for

Stripe

The Stripe REST API. Please see https://stripe.com/docs/api for more details.
Specifications
  • Category: Office
  • Provider: n/a
  • Used API: -
  • Managed: -
  • License: Apache License 2.0
  • Programmed with: javascript
Prices

For productive use you need a project room, which is subject to a fee.

Prices and Editions

Technical Specifications

startFlow

OnInit
./lib/triggers/startFlow.js
OnStartup
-
OnClose
-

Attributes

-

Post3dSecure

Initiate 3D Secure authentication.

OnInit
./lib/actions/Post3dSecure.js
OnStartup
-
OnClose
-

Attributes

-

Get3dSecureThreeDSecure

Retrieves a 3D Secure object.

OnInit
./lib/actions/Get3dSecureThreeDSecure.js
OnStartup
-
OnClose
-

Attributes

-

DeleteAccount

With Connect, you may delete Custom accounts you manage.

Custom accounts created using test-mode keys can be deleted at any time. Custom 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.

OnInit
./lib/actions/DeleteAccount.js
OnStartup
-
OnClose
-

Attributes

-

GetAccount

Retrieves the details of an account.

OnInit
./lib/actions/GetAccount.js
OnStartup
-
OnClose
-

Attributes

-

PostAccount

Updates a connected Express or Custom account by setting the values of the parameters passed. Any parameters not provided are left unchanged. Most parameters can be changed only for Custom accounts. (These are marked Custom Only below.) Parameters marked Custom and Express are supported by both account types.

To update your own account, use the Dashboard. Refer to our Connect documentation to learn more about updating accounts.

OnInit
./lib/actions/PostAccount.js
OnStartup
-
OnClose
-

Attributes

-

PostAccountBankAccounts

Create an external account for a given account.

OnInit
./lib/actions/PostAccountBankAccounts.js
OnStartup
-
OnClose
-

Attributes

-

DeleteAccountBankAccountsId

Delete a specified external account for a given account.

OnInit
./lib/actions/DeleteAccountBankAccountsId.js
OnStartup
-
OnClose
-

Attributes

-

GetAccountBankAccountsId

Retrieve a specified external account for a given account.

OnInit
./lib/actions/GetAccountBankAccountsId.js
OnStartup
-
OnClose
-

Attributes

-

PostAccountBankAccountsId

Updates the metadata, account holder name, and account holder type of a bank account belonging to a Custom account, and optionally sets it as the default for its currency. Other bank account details are not editable by design.

You can re-enable a disabled bank account by performing an update call without providing any arguments or changes.

OnInit
./lib/actions/PostAccountBankAccountsId.js
OnStartup
-
OnClose
-

Attributes

-

GetAccountExternalAccounts

List external accounts for an account.

OnInit
./lib/actions/GetAccountExternalAccounts.js
OnStartup
-
OnClose
-

Attributes

-

PostAccountExternalAccounts

Create an external account for a given account.

OnInit
./lib/actions/PostAccountExternalAccounts.js
OnStartup
-
OnClose
-

Attributes

-

DeleteAccountExternalAccountsId

Delete a specified external account for a given account.

OnInit
./lib/actions/DeleteAccountExternalAccountsId.js
OnStartup
-
OnClose
-

Attributes

-

GetAccountExternalAccountsId

Retrieve a specified external account for a given account.

OnInit
./lib/actions/GetAccountExternalAccountsId.js
OnStartup
-
OnClose
-

Attributes

-

PostAccountExternalAccountsId

Updates the metadata, account holder name, and account holder type of a bank account belonging to a Custom account, and optionally sets it as the default for its currency. Other bank account details are not editable by design.

You can re-enable a disabled bank account by performing an update call without providing any arguments or changes.

OnInit
./lib/actions/PostAccountExternalAccountsId.js
OnStartup
-
OnClose
-

Attributes

-

PostAccountLoginLinks

Creates a single-use login link for an Express account to access their Stripe dashboard.

You may only create login links for Express accounts connected to your platform.

OnInit
./lib/actions/PostAccountLoginLinks.js
OnStartup
-
OnClose
-

Attributes

-

PutAccountLogout

Invalidates all sessions for a light account, for a platform to use during platform logout.

You may only log out Express accounts connected to your platform.

OnInit
./lib/actions/PutAccountLogout.js
OnStartup
-
OnClose
-

Attributes

-

GetAccountPeople

Returns a list of people associated with the account's legal entity. The people are returned sorted by creation date, with the most recent people appearing first.

OnInit
./lib/actions/GetAccountPeople.js
OnStartup
-
OnClose
-

Attributes

-

PostAccountPeople

Creates a new person.

OnInit
./lib/actions/PostAccountPeople.js
OnStartup
-
OnClose
-

Attributes

-

DeleteAccountPeoplePerson

Deletes an existing person's relationship to the account's legal entity.

OnInit
./lib/actions/DeleteAccountPeoplePerson.js
OnStartup
-
OnClose
-

Attributes

-

GetAccountPeoplePerson

Retrieves an existing person.

OnInit
./lib/actions/GetAccountPeoplePerson.js
OnStartup
-
OnClose
-

Attributes

-

PostAccountPeoplePerson

Updates an existing person.

OnInit
./lib/actions/PostAccountPeoplePerson.js
OnStartup
-
OnClose
-

Attributes

-

GetAccountPersons

Returns a list of people associated with the account's legal entity. The people are returned sorted by creation date, with the most recent people appearing first.

OnInit
./lib/actions/GetAccountPersons.js
OnStartup
-
OnClose
-

Attributes

-

PostAccountPersons

Creates a new person.

OnInit
./lib/actions/PostAccountPersons.js
OnStartup
-
OnClose
-

Attributes

-

DeleteAccountPersonsPerson

Deletes an existing person's relationship to the account's legal entity.

OnInit
./lib/actions/DeleteAccountPersonsPerson.js
OnStartup
-
OnClose
-

Attributes

-

GetAccountPersonsPerson

Retrieves an existing person.

OnInit
./lib/actions/GetAccountPersonsPerson.js
OnStartup
-
OnClose
-

Attributes

-

PostAccountPersonsPerson

Updates an existing person.

OnInit
./lib/actions/PostAccountPersonsPerson.js
OnStartup
-
OnClose
-

Attributes

-

PostAccountLinks

Creates an AccountLink object that returns a Stripe URL that the user can redirect their user to in order to take them through the Hosted Verification flow.

OnInit
./lib/actions/PostAccountLinks.js
OnStartup
-
OnClose
-

Attributes

-

GetAccounts

Returns a list of accounts connected to your platform via Connect. If you're not a platform, the list is empty.

OnInit
./lib/actions/GetAccounts.js
OnStartup
-
OnClose
-

Attributes

-

PostAccounts

With Connect, you can create Stripe accounts for your users. To do this, you'll first need to register your platform.

For Standard accounts, parameters other than country, email, and type are used to prefill the account application that we ask the account holder to complete.

OnInit
./lib/actions/PostAccounts.js
OnStartup
-
OnClose
-

Attributes

-

DeleteAccountsAccount

With Connect, you may delete Custom accounts you manage.

Custom accounts created using test-mode keys can be deleted at any time. Custom 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.

OnInit
./lib/actions/DeleteAccountsAccount.js
OnStartup
-
OnClose
-

Attributes

-

GetAccountsAccount

Retrieves the details of an account.

OnInit
./lib/actions/GetAccountsAccount.js
OnStartup
-
OnClose
-

Attributes

-

PostAccountsAccount

Updates a connected Express or Custom account by setting the values of the parameters passed. Any parameters not provided are left unchanged. Most parameters can be changed only for Custom accounts. (These are marked Custom Only below.) Parameters marked Custom and Express are supported by both account types.

To update your own account, use the Dashboard. Refer to our Connect documentation to learn more about updating accounts.

OnInit
./lib/actions/PostAccountsAccount.js
OnStartup
-
OnClose
-

Attributes

-

PostAccountsAccountBankAccounts

Create an external account for a given account.

OnInit
./lib/actions/PostAccountsAccountBankAccounts.js
OnStartup
-
OnClose
-

Attributes

-

DeleteAccountsAccountBankAccountsId

Delete a specified external account for a given account.

OnInit
./lib/actions/DeleteAccountsAccountBankAccountsId.js
OnStartup
-
OnClose
-

Attributes

-

GetAccountsAccountBankAccountsId

Retrieve a specified external account for a given account.

OnInit
./lib/actions/GetAccountsAccountBankAccountsId.js
OnStartup
-
OnClose
-

Attributes

-

PostAccountsAccountBankAccountsId

Updates the metadata, account holder name, and account holder type of a bank account belonging to a Custom account, and optionally sets it as the default for its currency. Other bank account details are not editable by design.

You can re-enable a disabled bank account by performing an update call without providing any arguments or changes.

OnInit
./lib/actions/PostAccountsAccountBankAccountsId.js
OnStartup
-
OnClose
-

Attributes

-

GetAccountsAccountExternalAccounts

List external accounts for an account.

OnInit
./lib/actions/GetAccountsAccountExternalAccounts.js
OnStartup
-
OnClose
-

Attributes

-

PostAccountsAccountExternalAccounts

Create an external account for a given account.

OnInit
./lib/actions/PostAccountsAccountExternalAccounts.js
OnStartup
-
OnClose
-

Attributes

-

DeleteAccountsAccountExternalAccountsId

Delete a specified external account for a given account.

OnInit
./lib/actions/DeleteAccountsAccountExternalAccountsId.js
OnStartup
-
OnClose
-

Attributes

-

GetAccountsAccountExternalAccountsId

Retrieve a specified external account for a given account.

OnInit
./lib/actions/GetAccountsAccountExternalAccountsId.js
OnStartup
-
OnClose
-

Attributes

-

PostAccountsAccountExternalAccountsId

Updates the metadata, account holder name, and account holder type of a bank account belonging to a Custom account, and optionally sets it as the default for its currency. Other bank account details are not editable by design.

You can re-enable a disabled bank account by performing an update call without providing any arguments or changes.

OnInit
./lib/actions/PostAccountsAccountExternalAccountsId.js
OnStartup
-
OnClose
-

Attributes

-

PostAccountsAccountLoginLinks

Creates a single-use login link for an Express account to access their Stripe dashboard.

You may only create login links for Express accounts connected to your platform.

OnInit
./lib/actions/PostAccountsAccountLoginLinks.js
OnStartup
-
OnClose
-

Attributes

-

PutAccountsAccountLogout

Invalidates all sessions for a light account, for a platform to use during platform logout.

You may only log out Express accounts connected to your platform.

OnInit
./lib/actions/PutAccountsAccountLogout.js
OnStartup
-
OnClose
-

Attributes

-

GetAccountsAccountPeople

Returns a list of people associated with the account's legal entity. The people are returned sorted by creation date, with the most recent people appearing first.

OnInit
./lib/actions/GetAccountsAccountPeople.js
OnStartup
-
OnClose
-

Attributes

-

PostAccountsAccountPeople

Creates a new person.

OnInit
./lib/actions/PostAccountsAccountPeople.js
OnStartup
-
OnClose
-

Attributes

-

DeleteAccountsAccountPeoplePerson

Deletes an existing person's relationship to the account's legal entity.

OnInit
./lib/actions/DeleteAccountsAccountPeoplePerson.js
OnStartup
-
OnClose
-

Attributes

-

GetAccountsAccountPeoplePerson

Retrieves an existing person.

OnInit
./lib/actions/GetAccountsAccountPeoplePerson.js
OnStartup
-
OnClose
-

Attributes

-

PostAccountsAccountPeoplePerson

Updates an existing person.

OnInit
./lib/actions/PostAccountsAccountPeoplePerson.js
OnStartup
-
OnClose
-

Attributes

-

GetAccountsAccountPersons

Returns a list of people associated with the account's legal entity. The people are returned sorted by creation date, with the most recent people appearing first.

OnInit
./lib/actions/GetAccountsAccountPersons.js
OnStartup
-
OnClose
-

Attributes

-

PostAccountsAccountPersons

Creates a new person.

OnInit
./lib/actions/PostAccountsAccountPersons.js
OnStartup
-
OnClose
-

Attributes

-

DeleteAccountsAccountPersonsPerson

Deletes an existing person's relationship to the account's legal entity.

OnInit
./lib/actions/DeleteAccountsAccountPersonsPerson.js
OnStartup
-
OnClose
-

Attributes

-

GetAccountsAccountPersonsPerson

Retrieves an existing person.

OnInit
./lib/actions/GetAccountsAccountPersonsPerson.js
OnStartup
-
OnClose
-

Attributes

-

PostAccountsAccountPersonsPerson

Updates an existing person.

OnInit
./lib/actions/PostAccountsAccountPersonsPerson.js
OnStartup
-
OnClose
-

Attributes

-

PostAccountsAccountReject

With Connect, you may flag accounts as suspicious.

Test-mode Custom and Express accounts can be rejected at any time. Accounts created using live-mode keys may only be rejected once all balances are zero.

OnInit
./lib/actions/PostAccountsAccountReject.js
OnStartup
-
OnClose
-

Attributes

-

GetApplePayDomains

List apple pay domains.

OnInit
./lib/actions/GetApplePayDomains.js
OnStartup
-
OnClose
-

Attributes

-

PostApplePayDomains

Create an apple pay domain.

OnInit
./lib/actions/PostApplePayDomains.js
OnStartup
-
OnClose
-

Attributes

-

DeleteApplePayDomainsDomain

Delete an apple pay domain.

OnInit
./lib/actions/DeleteApplePayDomainsDomain.js
OnStartup
-
OnClose
-

Attributes

-

GetApplePayDomainsDomain

Retrieve an apple pay domain.

OnInit
./lib/actions/GetApplePayDomainsDomain.js
OnStartup
-
OnClose
-

Attributes

-

GetApplicationFees

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.

OnInit
./lib/actions/GetApplicationFees.js
OnStartup
-
OnClose
-

Attributes

-

GetApplicationFeesFeeRefundsId

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.

OnInit
./lib/actions/GetApplicationFeesFeeRefundsId.js
OnStartup
-
OnClose
-

Attributes

-

PostApplicationFeesFeeRefundsId

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.

OnInit
./lib/actions/PostApplicationFeesFeeRefundsId.js
OnStartup
-
OnClose
-

Attributes

-

GetApplicationFeesId

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

OnInit
./lib/actions/GetApplicationFeesId.js
OnStartup
-
OnClose
-

Attributes

-

PostApplicationFeesIdRefund

OnInit
./lib/actions/PostApplicationFeesIdRefund.js
OnStartup
-
OnClose
-

Attributes

-

GetApplicationFeesIdRefunds

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.

OnInit
./lib/actions/GetApplicationFeesIdRefunds.js
OnStartup
-
OnClose
-

Attributes

-

PostApplicationFeesIdRefunds

Refunds an application fee that has previously been collected but not yet refunded. Funds will be refunded to the Stripe account from which the fee was originally collected.

You can optionally refund only part of an application fee. You can do so multiple times, until the entire fee has been refunded.

Once entirely refunded, an application fee can't be refunded again. This method will raise an error when called on an already-refunded application fee, or when trying to refund more money than is left on an application fee.

OnInit
./lib/actions/PostApplicationFeesIdRefunds.js
OnStartup
-
OnClose
-

Attributes

-

GetBalance

Retrieves the current account balance, based on the authentication that was used to make the request. For a sample request, see Accounting for negative balances.

OnInit
./lib/actions/GetBalance.js
OnStartup
-
OnClose
-

Attributes

-

GetBalanceHistory

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.

OnInit
./lib/actions/GetBalanceHistory.js
OnStartup
-
OnClose
-

Attributes

-

GetBalanceHistoryId

Retrieves the balance transaction with the given ID.

OnInit
./lib/actions/GetBalanceHistoryId.js
OnStartup
-
OnClose
-

Attributes

-

GetBitcoinReceivers

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

OnInit
./lib/actions/GetBitcoinReceivers.js
OnStartup
-
OnClose
-

Attributes

-

GetBitcoinReceiversId

Retrieves the Bitcoin receiver with the given ID.

OnInit
./lib/actions/GetBitcoinReceiversId.js
OnStartup
-
OnClose
-

Attributes

-

GetBitcoinReceiversReceiverTransactions

List bitcoin transacitons for a given receiver.

OnInit
./lib/actions/GetBitcoinReceiversReceiverTransactions.js
OnStartup
-
OnClose
-

Attributes

-

GetBitcoinTransactions

List bitcoin transacitons for a given receiver.

OnInit
./lib/actions/GetBitcoinTransactions.js
OnStartup
-
OnClose
-

Attributes

-

GetCharges

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

OnInit
./lib/actions/GetCharges.js
OnStartup
-
OnClose
-

Attributes

-

PostCharges

To charge a credit card or other payment source, you create a Charge object. If your API key is in test mode, the supplied payment source (e.g., card) won't actually be charged, although everything else will occur as if in live mode. (Stripe assumes that the charge would have completed successfully).

OnInit
./lib/actions/PostCharges.js
OnStartup
-
OnClose
-

Attributes

-

GetChargesCharge

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.

OnInit
./lib/actions/GetChargesCharge.js
OnStartup
-
OnClose
-

Attributes

-

PostChargesCharge

Updates the specified charge by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

OnInit
./lib/actions/PostChargesCharge.js
OnStartup
-
OnClose
-

Attributes

-

PostChargesChargeCapture

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.

OnInit
./lib/actions/PostChargesChargeCapture.js
OnStartup
-
OnClose
-

Attributes

-

GetChargesChargeDispute

Retrieve a dispute for a specified charge.

OnInit
./lib/actions/GetChargesChargeDispute.js
OnStartup
-
OnClose
-

Attributes

-

PostChargesChargeDispute

OnInit
./lib/actions/PostChargesChargeDispute.js
OnStartup
-
OnClose
-

Attributes

-

PostChargesChargeDisputeClose

OnInit
./lib/actions/PostChargesChargeDisputeClose.js
OnStartup
-
OnClose
-

Attributes

-

PostChargesChargeRefund

When you create a new refund, you must specify a charge on which to create it.

Creating a new refund will refund a charge that has previously been created but not yet refunded. Funds will be refunded to the credit or debit card that was originally charged.

You can optionally refund only part of a charge. You can do so multiple times, until the entire charge has been refunded.

Once entirely refunded, a charge can't be refunded again. This method will raise an error when called on an already-refunded charge, or when trying to refund more money than is left on a charge.

OnInit
./lib/actions/PostChargesChargeRefund.js
OnStartup
-
OnClose
-

Attributes

-

GetChargesChargeRefunds

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.

OnInit
./lib/actions/GetChargesChargeRefunds.js
OnStartup
-
OnClose
-

Attributes

-

PostChargesChargeRefunds

Create a refund.

OnInit
./lib/actions/PostChargesChargeRefunds.js
OnStartup
-
OnClose
-

Attributes

-

GetChargesChargeRefundsRefund

Retrieves the details of an existing refund.

OnInit
./lib/actions/GetChargesChargeRefundsRefund.js
OnStartup
-
OnClose
-

Attributes

-

PostChargesChargeRefundsRefund

Update a specified refund.

OnInit
./lib/actions/PostChargesChargeRefundsRefund.js
OnStartup
-
OnClose
-

Attributes

-

PostCheckoutSessions

Creates a Session object.

OnInit
./lib/actions/PostCheckoutSessions.js
OnStartup
-
OnClose
-

Attributes

-

GetCountrySpecs

Lists all Country Spec objects available in the API.

OnInit
./lib/actions/GetCountrySpecs.js
OnStartup
-
OnClose
-

Attributes

-

GetCountrySpecsCountry

Returns a Country Spec for a given Country code.

OnInit
./lib/actions/GetCountrySpecsCountry.js
OnStartup
-
OnClose
-

Attributes

-

GetCoupons

Returns a list of your coupons.

OnInit
./lib/actions/GetCoupons.js
OnStartup
-
OnClose
-

Attributes

-

PostCoupons

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 100 will have a final total of 0 if a coupon with an amount_off of 200 is applied to it and an invoice with a subtotal of 300 will have a final total of 100 if a coupon with an amount_off of 200 is applied to it.

OnInit
./lib/actions/PostCoupons.js
OnStartup
-
OnClose
-

Attributes

-

DeleteCouponsCoupon

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.

OnInit
./lib/actions/DeleteCouponsCoupon.js
OnStartup
-
OnClose
-

Attributes

-

GetCouponsCoupon

Retrieves the coupon with the given ID.

OnInit
./lib/actions/GetCouponsCoupon.js
OnStartup
-
OnClose
-

Attributes

-

PostCouponsCoupon

Updates the metadata of a coupon. Other coupon details (currency, duration, amount_off) are, by design, not editable.

OnInit
./lib/actions/PostCouponsCoupon.js
OnStartup
-
OnClose
-

Attributes

-

GetCustomers

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

OnInit
./lib/actions/GetCustomers.js
OnStartup
-
OnClose
-

Attributes

-

PostCustomers

Creates a new customer object.

OnInit
./lib/actions/PostCustomers.js
OnStartup
-
OnClose
-

Attributes

-

DeleteCustomersCustomer

Permanently deletes a customer. It cannot be undone. Also immediately cancels any active subscriptions on the customer.

OnInit
./lib/actions/DeleteCustomersCustomer.js
OnStartup
-
OnClose
-

Attributes

-

GetCustomersCustomer

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

OnInit
./lib/actions/GetCustomersCustomer.js
OnStartup
-
OnClose
-

Attributes

-

PostCustomersCustomer

Updates the specified customer by setting the values of the parameters passed. Any parameters not provided will be left unchanged. For example, if you pass the source parameter, that becomes the customer's active source (e.g., a card) to be used for all charges in the future. When you update a customer to a new valid card source by passing the source parameter: for each of the customer's current subscriptions, if the subscription bills automatically and is in the past_due state, then the latest open invoice for the subscription with automatic collection enabled will be retried. This retry will not count as an automatic retry, and will not affect the next regularly scheduled payment for the invoice. Changing the default_source for a customer will not trigger this behavior.

This request accepts mostly the same arguments as the customer creation call.

OnInit
./lib/actions/PostCustomersCustomer.js
OnStartup
-
OnClose
-

Attributes

-

GetCustomersCustomerBankAccounts

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.

OnInit
./lib/actions/GetCustomersCustomerBankAccounts.js
OnStartup
-
OnClose
-

Attributes

-

PostCustomersCustomerBankAccounts

When you create a new credit card, you must specify a customer or recipient on which to create it.

If the card's owner has no default card, then the new card will become the default. However, if the owner already has a default, then it will not change. To change the default, you should either update the customer to have a new default_source, or update the recipient to have a new default_card.

OnInit
./lib/actions/PostCustomersCustomerBankAccounts.js
OnStartup
-
OnClose
-

Attributes

-

DeleteCustomersCustomerBankAccountsId

Delete a specified source for a given customer.

OnInit
./lib/actions/DeleteCustomersCustomerBankAccountsId.js
OnStartup
-
OnClose
-

Attributes

-

GetCustomersCustomerBankAccountsId

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.

OnInit
./lib/actions/GetCustomersCustomerBankAccountsId.js
OnStartup
-
OnClose
-

Attributes

-

PostCustomersCustomerBankAccountsId

Update a specified source for a given customer.

OnInit
./lib/actions/PostCustomersCustomerBankAccountsId.js
OnStartup
-
OnClose
-

Attributes

-

PostCustomersCustomerBankAccountsIdVerify

Verify a specified bank account for a given customer.

OnInit
./lib/actions/PostCustomersCustomerBankAccountsIdVerify.js
OnStartup
-
OnClose
-

Attributes

-

GetCustomersCustomerCards

You can see a list of the cards belonging to a customer. Note that the 10 most recent sources are always available on the Customer 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 cards.

OnInit
./lib/actions/GetCustomersCustomerCards.js
OnStartup
-
OnClose
-

Attributes

-

PostCustomersCustomerCards

When you create a new credit card, you must specify a customer or recipient on which to create it.

If the card's owner has no default card, then the new card will become the default. However, if the owner already has a default, then it will not change. To change the default, you should either update the customer to have a new default_source, or update the recipient to have a new default_card.

OnInit
./lib/actions/PostCustomersCustomerCards.js
OnStartup
-
OnClose
-

Attributes

-

DeleteCustomersCustomerCardsId

Delete a specified source for a given customer.

OnInit
./lib/actions/DeleteCustomersCustomerCardsId.js
OnStartup
-
OnClose
-

Attributes

-

GetCustomersCustomerCardsId

You can always see the 10 most recent cards directly on a customer; this method lets you retrieve details about a specific card stored on the customer.

OnInit
./lib/actions/GetCustomersCustomerCardsId.js
OnStartup
-
OnClose
-

Attributes

-

PostCustomersCustomerCardsId

Update a specified source for a given customer.

OnInit
./lib/actions/PostCustomersCustomerCardsId.js
OnStartup
-
OnClose
-

Attributes

-

DeleteCustomersCustomerDiscount

Removes the currently applied discount on a customer.

OnInit
./lib/actions/DeleteCustomersCustomerDiscount.js
OnStartup
-
OnClose
-

Attributes

-

GetCustomersCustomerDiscount

OnInit
./lib/actions/GetCustomersCustomerDiscount.js
OnStartup
-
OnClose
-

Attributes

-

GetCustomersCustomerSources

List sources for a specified customer.

OnInit
./lib/actions/GetCustomersCustomerSources.js
OnStartup
-
OnClose
-

Attributes

-

PostCustomersCustomerSources

When you create a new credit card, you must specify a customer or recipient on which to create it.

If the card's owner has no default card, then the new card will become the default. However, if the owner already has a default, then it will not change. To change the default, you should either update the customer to have a new default_source, or update the recipient to have a new default_card.

OnInit
./lib/actions/PostCustomersCustomerSources.js
OnStartup
-
OnClose
-

Attributes

-

DeleteCustomersCustomerSourcesId

Delete a specified source for a given customer.

OnInit
./lib/actions/DeleteCustomersCustomerSourcesId.js
OnStartup
-
OnClose
-

Attributes

-

GetCustomersCustomerSourcesId

Retrieve a specified source for a given customer.

OnInit
./lib/actions/GetCustomersCustomerSourcesId.js
OnStartup
-
OnClose
-

Attributes

-

PostCustomersCustomerSourcesId

Update a specified source for a given customer.

OnInit
./lib/actions/PostCustomersCustomerSourcesId.js
OnStartup
-
OnClose
-

Attributes

-

PostCustomersCustomerSourcesIdVerify

Verify a specified bank account for a given customer.

OnInit
./lib/actions/PostCustomersCustomerSourcesIdVerify.js
OnStartup
-
OnClose
-

Attributes

-

GetCustomersCustomerSubscriptions

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.

OnInit
./lib/actions/GetCustomersCustomerSubscriptions.js
OnStartup
-
OnClose
-

Attributes

-

PostCustomersCustomerSubscriptions

Creates a new subscription on an existing customer.

OnInit
./lib/actions/PostCustomersCustomerSubscriptions.js
OnStartup
-
OnClose
-

Attributes

-

DeleteCustomersCustomerSubscriptionsSubscriptionExposedId

Cancels 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. Otherwise, with the default false value, 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 the end of the period, 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, upon subscription cancellation, Stripe will stop automatic collection of all finalized invoices for the customer. This is intended to prevent unexpected payment attempts after the customer has canceled a subscription. However, you can resume automatic collection of the invoices manually after subscription cancellation to have us proceed. Or, you could check for unpaid invoices before allowing the customer to cancel the subscription at all.

OnInit
./lib/actions/DeleteCustomersCustomerSubscriptionsSubscriptionExposedId.js
OnStartup
-
OnClose
-

Attributes

-

GetCustomersCustomerSubscriptionsSubscriptionExposedId

Retrieves the subscription with the given ID.

OnInit
./lib/actions/GetCustomersCustomerSubscriptionsSubscriptionExposedId.js
OnStartup
-
OnClose
-

Attributes

-

PostCustomersCustomerSubscriptionsSubscriptionExposedId

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.

OnInit
./lib/actions/PostCustomersCustomerSubscriptionsSubscriptionExposedId.js
OnStartup
-
OnClose
-

Attributes

-

DeleteCustomersCustomerSubscriptionsSubscriptionExposedIdDiscount

Removes the currently applied discount on a customer.

OnInit
./lib/actions/DeleteCustomersCustomerSubscriptionsSubscriptionExposedIdDiscount.js
OnStartup
-
OnClose
-

Attributes

-

GetCustomersCustomerSubscriptionsSubscriptionExposedIdDiscount

OnInit
./lib/actions/GetCustomersCustomerSubscriptionsSubscriptionExposedIdDiscount.js
OnStartup
-
OnClose
-

Attributes

-

GetDisputes

Returns a list of your disputes.

OnInit
./lib/actions/GetDisputes.js
OnStartup
-
OnClose
-

Attributes

-

GetDisputesDispute

Retrieves the dispute with the given ID.

OnInit
./lib/actions/GetDisputesDispute.js
OnStartup
-
OnClose
-

Attributes

-

PostDisputesDispute

When you get a dispute, contacting your customer is always the best first step. If that doesn't work, you can submit evidence 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. To figure out which evidence fields to provide, see our guide to dispute types.

OnInit
./lib/actions/PostDisputesDispute.js
OnStartup
-
OnClose
-

Attributes

-

PostDisputesDisputeClose

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.

OnInit
./lib/actions/PostDisputesDisputeClose.js
OnStartup
-
OnClose
-

Attributes

-

PostEphemeralKeys

Creates a short-lived API key for a given resource.

OnInit
./lib/actions/PostEphemeralKeys.js
OnStartup
-
OnClose
-

Attributes

-

DeleteEphemeralKeysKey

Invalidates a short-lived API key for a given resource.

OnInit
./lib/actions/DeleteEphemeralKeysKey.js
OnStartup
-
OnClose
-

Attributes

-

GetEvents

List events, going back up to 30 days. Each event data is rendered according to Stripe API version at its creation time, specified in event object api_version attribute (not according to your current Stripe API version or Stripe-Version header).

OnInit
./lib/actions/GetEvents.js
OnStartup
-
OnClose
-

Attributes

-

GetEventsId

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

OnInit
./lib/actions/GetEventsId.js
OnStartup
-
OnClose
-

Attributes

-

PostEventsIdRetry

Resend an event. This only works in testmode

OnInit
./lib/actions/PostEventsIdRetry.js
OnStartup
-
OnClose
-

Attributes

-

GetExchangeRates

Returns a list of objects that contain the rates at which foreign currencies are converted to one another. Only shows the currencies for which Stripe supports.

OnInit
./lib/actions/GetExchangeRates.js
OnStartup
-
OnClose
-

Attributes

-

GetExchangeRatesCurrency

Retrieves the exchange rates from the given currency to every supported currency.

OnInit
./lib/actions/GetExchangeRatesCurrency.js
OnStartup
-
OnClose
-

Attributes

-

GetFileLinks

Returns a list of file links.

OnInit
./lib/actions/GetFileLinks.js
OnStartup
-
OnClose
-

Attributes

-

PostFileLinks

Creates a new file link object.

OnInit
./lib/actions/PostFileLinks.js
OnStartup
-
OnClose
-

Attributes

-

GetFileLinksLink

Retrieves the file link with the given ID.

OnInit
./lib/actions/GetFileLinksLink.js
OnStartup
-
OnClose
-

Attributes

-

PostFileLinksLink

Updates an existing file link object. Expired links can no longer be updated.

OnInit
./lib/actions/PostFileLinksLink.js
OnStartup
-
OnClose
-

Attributes

-

GetFiles

Returns a list of the files that your account has access to. The files are returned sorted by creation date, with the most recently created files appearing first.

OnInit
./lib/actions/GetFiles.js
OnStartup
-
OnClose
-

Attributes

-

PostFiles

To upload a file to Stripe, you'll need to send a request of type multipart/form-data. The request should contain the file you would like to upload, as well as the parameters for creating a file.

All of Stripe's officially supported API libraries should have support for sending multipart/form-data.

OnInit
./lib/actions/PostFiles.js
OnStartup
-
OnClose
-

Attributes

-

GetFilesFile

Retrieves the details of an existing file object. Supply the unique file ID from a file, and Stripe will return the corresponding file object.

OnInit
./lib/actions/GetFilesFile.js
OnStartup
-
OnClose
-

Attributes

-

GetInvoiceitems

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

OnInit
./lib/actions/GetInvoiceitems.js
OnStartup
-
OnClose
-

Attributes

-

PostInvoiceitems

Creates an item to be added to a draft invoice. If no invoice is specified, the item will be on the next invoice created for the customer specified.

OnInit
./lib/actions/PostInvoiceitems.js
OnStartup
-
OnClose
-

Attributes

-

DeleteInvoiceitemsInvoiceitem

Deletes an invoice item, removing it from an invoice. Deleting invoice items is only possible when they're not attached to invoices, or if it's attached to a draft invoice.

OnInit
./lib/actions/DeleteInvoiceitemsInvoiceitem.js
OnStartup
-
OnClose
-

Attributes

-

GetInvoiceitemsInvoiceitem

Retrieves the invoice item with the given ID.

OnInit
./lib/actions/GetInvoiceitemsInvoiceitem.js
OnStartup
-
OnClose
-

Attributes

-

PostInvoiceitemsInvoiceitem

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.

OnInit
./lib/actions/PostInvoiceitemsInvoiceitem.js
OnStartup
-
OnClose
-

Attributes

-

GetInvoices

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.

OnInit
./lib/actions/GetInvoices.js
OnStartup
-
OnClose
-

Attributes

-

PostInvoices

This endpoint creates a draft invoice for a given customer. The draft invoice created pulls in all pending invoice items on that customer, including prorations.

OnInit
./lib/actions/PostInvoices.js
OnStartup
-
OnClose
-

Attributes

-

GetInvoicesUpcoming

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.

OnInit
./lib/actions/GetInvoicesUpcoming.js
OnStartup
-
OnClose
-

Attributes

-

GetInvoicesUpcomingLines

When retrieving an upcoming 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.

OnInit
./lib/actions/GetInvoicesUpcomingLines.js
OnStartup
-
OnClose
-

Attributes

-

DeleteInvoicesInvoice

Permanently deletes a draft invoice. This cannot be undone. Attempts to delete invoices that are no longer in a draft state will fail; once an invoice has been finalized, it must be voided.

OnInit
./lib/actions/DeleteInvoicesInvoice.js
OnStartup
-
OnClose
-

Attributes

-

GetInvoicesInvoice

Retrieves the invoice with the given ID.

OnInit
./lib/actions/GetInvoicesInvoice.js
OnStartup
-
OnClose
-

Attributes

-

PostInvoicesInvoice

Draft invoices are fully editable. Once an invoice is finalized, monetary values, as well as billing, become uneditable.

If you would like to stop the Stripe Billing engine from automatically finalizing, reattempting payments on, sending reminders for, or automatically reconciling invoices, pass auto_advance=false.

OnInit
./lib/actions/PostInvoicesInvoice.js
OnStartup
-
OnClose
-

Attributes

-

PostInvoicesInvoiceFinalize

Stripe automatically finalizes drafts before sending and attempting payment on invoices. However, if you'd like to finalize a draft invoice manually, you can do so using this method.

OnInit
./lib/actions/PostInvoicesInvoiceFinalize.js
OnStartup
-
OnClose
-

Attributes

-

GetInvoicesInvoiceLines

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.

OnInit
./lib/actions/GetInvoicesInvoiceLines.js
OnStartup
-
OnClose
-

Attributes

-

PostInvoicesInvoiceMarkUncollectible

Marking an invoice as uncollectible is useful for keeping track of bad debts that can be written off for accounting purposes.

OnInit
./lib/actions/PostInvoicesInvoiceMarkUncollectible.js
OnStartup
-
OnClose
-

Attributes

-

PostInvoicesInvoicePay

Stripe automatically creates and then attempts to collect payment on invoices for customers on subscriptions according to your subscriptions settings. However, if you'd like to attempt payment on an invoice out of the normal collection schedule or for some other reason, you can do so.

OnInit
./lib/actions/PostInvoicesInvoicePay.js
OnStartup
-
OnClose
-

Attributes

-

PostInvoicesInvoiceSend

Stripe will automatically send invoices to customers according to your subscriptions settings. However, if you'd like to manually send an invoice to your customer out of the normal schedule, you can do so. When sending invoices that have already been paid, there will be no reference to the payment in the email.

Requests made in test-mode result in no emails being sent, despite sending an invoice.sent event.

OnInit
./lib/actions/PostInvoicesInvoiceSend.js
OnStartup
-
OnClose
-

Attributes

-

PostInvoicesInvoiceVoid

Mark a finalized invoice as void. This cannot be undone. Voiding an invoice is similar to deletion, however it only applies to finalized invoices and maintains a papertrail where the invoice can still be found.

OnInit
./lib/actions/PostInvoicesInvoiceVoid.js
OnStartup
-
OnClose
-

Attributes

-

GetIssuerFraudRecords

Returns a list of issuer fraud records.

OnInit
./lib/actions/GetIssuerFraudRecords.js
OnStartup
-
OnClose
-

Attributes

-

GetIssuerFraudRecordsIssuerFraudRecord

Retrieves the details of an issuer fraud record that has previously been created.

Please refer to the issuer fraud record object reference for more details.

OnInit
./lib/actions/GetIssuerFraudRecordsIssuerFraudRecord.js
OnStartup
-
OnClose
-

Attributes

-

GetIssuingAuthorizations

Returns a list of Issuing Authorization objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

OnInit
./lib/actions/GetIssuingAuthorizations.js
OnStartup
-
OnClose
-

Attributes

-

GetIssuingAuthorizationsAuthorization

Retrieves an Issuing Authorization object.

OnInit
./lib/actions/GetIssuingAuthorizationsAuthorization.js
OnStartup
-
OnClose
-

Attributes

-

PostIssuingAuthorizationsAuthorization

Updates the specified Issuing Authorization object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

OnInit
./lib/actions/PostIssuingAuthorizationsAuthorization.js
OnStartup
-
OnClose
-

Attributes

-

PostIssuingAuthorizationsAuthorizationApprove

Approves a pending Issuing Authorization object.

OnInit
./lib/actions/PostIssuingAuthorizationsAuthorizationApprove.js
OnStartup
-
OnClose
-

Attributes

-

PostIssuingAuthorizationsAuthorizationDecline

Declines a pending Issuing Authorization object.

OnInit
./lib/actions/PostIssuingAuthorizationsAuthorizationDecline.js
OnStartup
-
OnClose
-

Attributes

-

GetIssuingCardholders

Returns a list of Issuing Cardholder objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

OnInit
./lib/actions/GetIssuingCardholders.js
OnStartup
-
OnClose
-

Attributes

-

PostIssuingCardholders

Creates a new Issuing Cardholder object that can be issued cards.

OnInit
./lib/actions/PostIssuingCardholders.js
OnStartup
-
OnClose
-

Attributes

-

GetIssuingCardholdersCardholder

Retrieves an Issuing Cardholder object.

OnInit
./lib/actions/GetIssuingCardholdersCardholder.js
OnStartup
-
OnClose
-

Attributes

-

PostIssuingCardholdersCardholder

Updates the specified Issuing Cardholder object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

OnInit
./lib/actions/PostIssuingCardholdersCardholder.js
OnStartup
-
OnClose
-

Attributes

-

GetIssuingCards

Returns a list of Issuing Card objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

OnInit
./lib/actions/GetIssuingCards.js
OnStartup
-
OnClose
-

Attributes

-

PostIssuingCards

Creates an Issuing Card object.

OnInit
./lib/actions/PostIssuingCards.js
OnStartup
-
OnClose
-

Attributes

-

GetIssuingCardsCard

Retrieves an Issuing Card object.

OnInit
./lib/actions/GetIssuingCardsCard.js
OnStartup
-
OnClose
-

Attributes

-

PostIssuingCardsCard

Updates the specified Issuing Card object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

OnInit
./lib/actions/PostIssuingCardsCard.js
OnStartup
-
OnClose
-

Attributes

-

GetIssuingCardsCardDetails

For virtual cards only. Retrieves an Issuing Card_details object that contains the sensitive details of a virtual card.

OnInit
./lib/actions/GetIssuingCardsCardDetails.js
OnStartup
-
OnClose
-

Attributes

-

GetIssuingCardsCardPin

Retrieves the PIN for a card object, subject to cardholder verification, see Retrieve and update cardholder PIN

OnInit
./lib/actions/GetIssuingCardsCardPin.js
OnStartup
-
OnClose
-

Attributes

-

PostIssuingCardsCardPin

Updates the PIN for a card, subject to cardholder verification. See Retrieve and update cardholder PIN

OnInit
./lib/actions/PostIssuingCardsCardPin.js
OnStartup
-
OnClose
-

Attributes

-

GetIssuingDisputes

Returns a list of Issuing Dispute objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

OnInit
./lib/actions/GetIssuingDisputes.js
OnStartup
-
OnClose
-

Attributes

-

PostIssuingDisputes

Creates an Issuing Dispute object.

OnInit
./lib/actions/PostIssuingDisputes.js
OnStartup
-
OnClose
-

Attributes

-

GetIssuingDisputesDispute

Retrieves an Issuing Dispute object.

OnInit
./lib/actions/GetIssuingDisputesDispute.js
OnStartup
-
OnClose
-

Attributes

-

PostIssuingDisputesDispute

Updates the specified Issuing Dispute object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

OnInit
./lib/actions/PostIssuingDisputesDispute.js
OnStartup
-
OnClose
-

Attributes

-

GetIssuingSettlements

Returns a list of Issuing Settlement objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

OnInit
./lib/actions/GetIssuingSettlements.js
OnStartup
-
OnClose
-

Attributes

-

GetIssuingSettlementsSettlement

Retrieves an Issuing Settlement object.

OnInit
./lib/actions/GetIssuingSettlementsSettlement.js
OnStartup
-
OnClose
-

Attributes

-

PostIssuingSettlementsSettlement

Updates the specified Issuing Settlement object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

OnInit
./lib/actions/PostIssuingSettlementsSettlement.js
OnStartup
-
OnClose
-

Attributes

-

GetIssuingTransactions

Returns a list of Issuing Transaction objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

OnInit
./lib/actions/GetIssuingTransactions.js
OnStartup
-
OnClose
-

Attributes

-

GetIssuingTransactionsTransaction

Retrieves an Issuing Transaction object.

OnInit
./lib/actions/GetIssuingTransactionsTransaction.js
OnStartup
-
OnClose
-

Attributes

-

PostIssuingTransactionsTransaction

Updates the specified Issuing Transaction object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

OnInit
./lib/actions/PostIssuingTransactionsTransaction.js
OnStartup
-
OnClose
-

Attributes

-

PostIssuingVerifications

Some actions (eg: updating a PIN) need confirmation from the cardholder

OnInit
./lib/actions/PostIssuingVerifications.js
OnStartup
-
OnClose
-

Attributes

-

GetOrderReturns

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

OnInit
./lib/actions/GetOrderReturns.js
OnStartup
-
OnClose
-

Attributes

-

GetOrderReturnsId

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.

OnInit
./lib/actions/GetOrderReturnsId.js
OnStartup
-
OnClose
-

Attributes

-

GetOrders

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

OnInit
./lib/actions/GetOrders.js
OnStartup
-
OnClose
-

Attributes

-

PostOrders

Creates a new order object.

OnInit
./lib/actions/PostOrders.js
OnStartup
-
OnClose
-

Attributes

-

GetOrdersId

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.

OnInit
./lib/actions/GetOrdersId.js
OnStartup
-
OnClose
-

Attributes

-

PostOrdersId

Updates the specific order by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

OnInit
./lib/actions/PostOrdersId.js
OnStartup
-
OnClose
-

Attributes

-

PostOrdersIdPay

Pay an order by providing a source to create a payment.

OnInit
./lib/actions/PostOrdersIdPay.js
OnStartup
-
OnClose
-

Attributes

-

PostOrdersIdReturns

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.

OnInit
./lib/actions/PostOrdersIdReturns.js
OnStartup
-
OnClose
-

Attributes

-

GetPaymentIntents

Returns a list of PaymentIntents.

OnInit
./lib/actions/GetPaymentIntents.js
OnStartup
-
OnClose
-

Attributes

-

PostPaymentIntents

Creates a PaymentIntent object.

OnInit
./lib/actions/PostPaymentIntents.js
OnStartup
-
OnClose
-

Attributes

-

GetPaymentIntentsIntent

Retrieves the details of a PaymentIntent that has previously been created.

Client-side retrieval using a publishable key is allowed when the client_secret is provided in the query string.

When retrieved with a publishable key, only a subset of properties will be returned. Please refer to the payment intent object reference for more details.

OnInit
./lib/actions/GetPaymentIntentsIntent.js
OnStartup
-
OnClose
-

Attributes

-

PostPaymentIntentsIntent

Updates a PaymentIntent object.

OnInit
./lib/actions/PostPaymentIntentsIntent.js
OnStartup
-
OnClose
-

Attributes

-

PostPaymentIntentsIntentCancel

A PaymentIntent object can be canceled when it is in one of these statuses: requires_payment_method, requires_capture, requires_confirmation, requires_action.

Once canceled, no additional charges will be made by the PaymentIntent and any operations on the PaymentIntent will fail with an error. For PaymentIntents with status='requires_capture', the remaining amount_capturable will automatically be refunded.

OnInit
./lib/actions/PostPaymentIntentsIntentCancel.js
OnStartup
-
OnClose
-

Attributes

-

PostPaymentIntentsIntentCapture

Capture the funds of an existing uncaptured PaymentIntent where required_action="requires_capture".

Uncaptured PaymentIntents will be canceled exactly seven days after they are created.

OnInit
./lib/actions/PostPaymentIntentsIntentCapture.js
OnStartup
-
OnClose
-

Attributes

-

PostPaymentIntentsIntentConfirm

Confirm that your customer intends to pay with current or provided source. Upon confirmation, the PaymentIntent will attempt to initiate a payment.

If the selected source requires additional authentication steps, the PaymentIntent will transition to the requires_action status and suggest additional actions via next_source_action. If payment fails, the PaymentIntent will transition to the requires_payment_method status. If payment succeeds, the PaymentIntent will transition to the succeeded status (or requires_capture, if capture_method is set to manual).

When using a publishable key, the client_secret must be provided to confirm the PaymentIntent.

OnInit
./lib/actions/PostPaymentIntentsIntentConfirm.js
OnStartup
-
OnClose
-

Attributes

-

GetPayouts

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.

OnInit
./lib/actions/GetPayouts.js
OnStartup
-
OnClose
-

Attributes

-

PostPayouts

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.

OnInit
./lib/actions/PostPayouts.js
OnStartup
-
OnClose
-

Attributes

-

GetPayoutsPayout

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.

OnInit
./lib/actions/GetPayoutsPayout.js
OnStartup
-
OnClose
-

Attributes

-

PostPayoutsPayout

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.

OnInit
./lib/actions/PostPayoutsPayout.js
OnStartup
-
OnClose
-

Attributes

-

PostPayoutsPayoutCancel

A previously created payout can be canceled if it has not yet been paid out. Funds will be refunded to your available balance. You may not cancel automatic Stripe payouts.

OnInit
./lib/actions/PostPayoutsPayoutCancel.js
OnStartup
-
OnClose
-

Attributes

-

GetPlans

Returns a list of your plans.

OnInit
./lib/actions/GetPlans.js
OnStartup
-
OnClose
-

Attributes

-

PostPlans

You can create plans using the API, or in the Stripe Dashboard.

OnInit
./lib/actions/PostPlans.js
OnStartup
-
OnClose
-

Attributes

-

DeletePlansPlan

Deleting plans means new subscribers can't be added. Existing subscribers aren't affected.

OnInit
./lib/actions/DeletePlansPlan.js
OnStartup
-
OnClose
-

Attributes

-

GetPlansPlan

Retrieves the plan with the given ID.

OnInit
./lib/actions/GetPlansPlan.js
OnStartup
-
OnClose
-

Attributes

-

PostPlansPlan

Updates the specified plan by setting the values of the parameters passed. Any parameters not provided are left unchanged. By design, you cannot change a plan's ID, amount, currency, or billing cycle.

OnInit
./lib/actions/PostPlansPlan.js
OnStartup
-
OnClose
-

Attributes

-

GetProducts

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

OnInit
./lib/actions/GetProducts.js
OnStartup
-
OnClose
-

Attributes

-

PostProducts

Creates a new product object. To create a product for use with subscriptions, see Subscriptions Products.

OnInit
./lib/actions/PostProducts.js
OnStartup
-
OnClose
-

Attributes

-

DeleteProductsId

Delete a product. Deleting a product with type=good is only possible if it has no SKUs associated with it. Deleting a product with type=service is only possible if it has no plans associated with it.

OnInit
./lib/actions/DeleteProductsId.js
OnStartup
-
OnClose
-

Attributes

-

GetProductsId

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.

OnInit
./lib/actions/GetProductsId.js
OnStartup
-
OnClose
-

Attributes

-

PostProductsId

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.

OnInit
./lib/actions/PostProductsId.js
OnStartup
-
OnClose
-

Attributes

-

GetRadarValueListItems

Returns a list of ValueListItem objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

OnInit
./lib/actions/GetRadarValueListItems.js
OnStartup
-
OnClose
-

Attributes

-

PostRadarValueListItems

Creates a new ValueListItem object, which is added to the specified parent value list.

OnInit
./lib/actions/PostRadarValueListItems.js
OnStartup
-
OnClose
-

Attributes

-

DeleteRadarValueListItemsItem

Deletes a ValueListItem object, removing it from its parent value list.

OnInit
./lib/actions/DeleteRadarValueListItemsItem.js
OnStartup
-
OnClose
-

Attributes

-

GetRadarValueListItemsItem

Retrieves a ValueListItem object.

OnInit
./lib/actions/GetRadarValueListItemsItem.js
OnStartup
-
OnClose
-

Attributes

-

GetRadarValueLists

Returns a list of ValueList objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

OnInit
./lib/actions/GetRadarValueLists.js
OnStartup
-
OnClose
-

Attributes

-

PostRadarValueLists

Creates a new ValueList object, which can then be referenced in rules.

OnInit
./lib/actions/PostRadarValueLists.js
OnStartup
-
OnClose
-

Attributes

-

DeleteRadarValueListsValueList

Deletes a ValueList object, also deleting any items contained within the value list. To be deleted, a value list must not be referenced in any rules.

OnInit
./lib/actions/DeleteRadarValueListsValueList.js
OnStartup
-
OnClose
-

Attributes

-

GetRadarValueListsValueList

Retrieves a ValueList object.

OnInit
./lib/actions/GetRadarValueListsValueList.js
OnStartup
-
OnClose
-

Attributes

-

PostRadarValueListsValueList

Updates a ValueList object by setting the values of the parameters passed. Any parameters not provided will be left unchanged. Note that item_type is immutable.

OnInit
./lib/actions/PostRadarValueListsValueList.js
OnStartup
-
OnClose
-

Attributes

-

GetRecipients

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

OnInit
./lib/actions/GetRecipients.js
OnStartup
-
OnClose
-

Attributes

-

PostRecipients

Creates a new Recipient object and verifies the recipient's identity. Also verifies the recipient's bank account information or debit card, if either is provided.

OnInit
./lib/actions/PostRecipients.js
OnStartup
-
OnClose
-

Attributes

-

DeleteRecipientsId

Permanently deletes a recipient. It cannot be undone.

OnInit
./lib/actions/DeleteRecipientsId.js
OnStartup
-
OnClose
-

Attributes

-

GetRecipientsId

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

OnInit
./lib/actions/GetRecipientsId.js
OnStartup
-
OnClose
-

Attributes

-

PostRecipientsId

Updates the specified recipient by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

If you update the name or tax ID, the identity verification will automatically be rerun. If you update the bank account, the bank account validation will automatically be rerun.

OnInit
./lib/actions/PostRecipientsId.js
OnStartup
-
OnClose
-

Attributes

-

GetRefunds

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.

OnInit
./lib/actions/GetRefunds.js
OnStartup
-
OnClose
-

Attributes

-

PostRefunds

Create a refund.

OnInit
./lib/actions/PostRefunds.js
OnStartup
-
OnClose
-

Attributes

-

GetRefundsRefund

Retrieves the details of an existing refund.

OnInit
./lib/actions/GetRefundsRefund.js
OnStartup
-
OnClose
-

Attributes

-

PostRefundsRefund

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.

OnInit
./lib/actions/PostRefundsRefund.js
OnStartup
-
OnClose
-

Attributes

-

GetReportingReportRuns

Returns a list of Report Runs, with the most recent appearing first. (Requires a live-mode API key.)

OnInit
./lib/actions/GetReportingReportRuns.js
OnStartup
-
OnClose
-

Attributes

-

PostReportingReportRuns

Creates a new object and begin running the report. (Requires a live-mode API key.)

OnInit
./lib/actions/PostReportingReportRuns.js
OnStartup
-
OnClose
-

Attributes

-

GetReportingReportRunsReportRun

Retrieves the details of an existing Report Run. (Requires a live-mode API key.)

OnInit
./lib/actions/GetReportingReportRunsReportRun.js
OnStartup
-
OnClose
-

Attributes

-

GetReportingReportTypes

Returns a full list of Report Types. (Requires a live-mode API key.)

OnInit
./lib/actions/GetReportingReportTypes.js
OnStartup
-
OnClose
-

Attributes

-

GetReportingReportTypesReportType

Retrieves the details of a Report Type. (Requires a live-mode API key.)

OnInit
./lib/actions/GetReportingReportTypesReportType.js
OnStartup
-
OnClose
-

Attributes

-

GetReviews

Returns a list of Review objects that have open set to true. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

OnInit
./lib/actions/GetReviews.js
OnStartup
-
OnClose
-

Attributes

-

GetReviewsReview

Retrieves a Review object.

OnInit
./lib/actions/GetReviewsReview.js
OnStartup
-
OnClose
-

Attributes

-

PostReviewsReviewApprove

Approves a Review object, closing it and removing it from the list of reviews.

OnInit
./lib/actions/PostReviewsReviewApprove.js
OnStartup
-
OnClose
-

Attributes

-

GetSigmaScheduledQueryRuns

Returns a list of scheduled query runs.

OnInit
./lib/actions/GetSigmaScheduledQueryRuns.js
OnStartup
-
OnClose
-

Attributes

-

GetSigmaScheduledQueryRunsScheduledQueryRun

Retrieves the details of an scheduled query run.

OnInit
./lib/actions/GetSigmaScheduledQueryRunsScheduledQueryRun.js
OnStartup
-
OnClose
-

Attributes

-

GetSkus

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

OnInit
./lib/actions/GetSkus.js
OnStartup
-
OnClose
-

Attributes

-

PostSkus

Creates a new SKU associated with a product.

OnInit
./lib/actions/PostSkus.js
OnStartup
-
OnClose
-

Attributes

-

DeleteSkusId

Delete a SKU. Deleting a SKU is only possible until it has been used in an order.

OnInit
./lib/actions/DeleteSkusId.js
OnStartup
-
OnClose
-

Attributes

-

GetSkusId

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.

OnInit
./lib/actions/GetSkusId.js
OnStartup
-
OnClose
-

Attributes

-

PostSkusId

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.

OnInit
./lib/actions/PostSkusId.js
OnStartup
-
OnClose
-

Attributes

-

PostSources

Creates a new source object.

OnInit
./lib/actions/PostSources.js
OnStartup
-
OnClose
-

Attributes

-

GetSourcesSource

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.

OnInit
./lib/actions/GetSourcesSource.js
OnStartup
-
OnClose
-

Attributes

-

PostSourcesSource

Updates the specified source by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

This request accepts the metadata and owner as arguments. It is also possible to update type specific information for selected payment methods. Please refer to our payment method guides for more detail.

OnInit
./lib/actions/PostSourcesSource.js
OnStartup
-
OnClose
-

Attributes

-

GetSourcesSourceMandateNotificationsMandateNotification

Retrieves a new Source MandateNotification.

OnInit
./lib/actions/GetSourcesSourceMandateNotificationsMandateNotification.js
OnStartup
-
OnClose
-

Attributes

-

GetSourcesSourceSourceTransactions

List source transactions for a given source.

OnInit
./lib/actions/GetSourcesSourceSourceTransactions.js
OnStartup
-
OnClose
-

Attributes

-

GetSourcesSourceSourceTransactionsSourceTransaction

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

OnInit
./lib/actions/GetSourcesSourceSourceTransactionsSourceTransaction.js
OnStartup
-
OnClose
-

Attributes

-

PostSourcesSourceVerify

Verify a given source.

OnInit
./lib/actions/PostSourcesSourceVerify.js
OnStartup
-
OnClose
-

Attributes

-

GetSubscriptionItems

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

OnInit
./lib/actions/GetSubscriptionItems.js
OnStartup
-
OnClose
-

Attributes

-

PostSubscriptionItems

Adds a new item to an existing subscription. No existing items will be changed or replaced.

OnInit
./lib/actions/PostSubscriptionItems.js
OnStartup
-
OnClose
-

Attributes

-

DeleteSubscriptionItemsItem

Deletes an item from the subscription. Removing a subscription item from a subscription will not cancel the subscription.

OnInit
./lib/actions/DeleteSubscriptionItemsItem.js
OnStartup
-
OnClose
-

Attributes

-

GetSubscriptionItemsItem

Retrieves the invoice item with the given ID.

OnInit
./lib/actions/GetSubscriptionItemsItem.js
OnStartup
-
OnClose
-

Attributes

-

PostSubscriptionItemsItem

Updates the plan or quantity of an item on a current subscription.

OnInit
./lib/actions/PostSubscriptionItemsItem.js
OnStartup
-
OnClose
-

Attributes

-

GetSubscriptionItemsSubscriptionItemUsageRecordSummaries

For the specified subscription item, returns a list of summary objects. Each object in the list provides usage information that's been summarized from multiple usage records and over a subscription billing period (e.g., 15 usage records in the billing plan's month of September).

The list is sorted in reverse-chronological order (newest first). The first list item represents the most current usage period that hasn't ended yet. Since new usage records can still be added, the returned summary information for the subscription item's ID should be seen as unstable until the subscription billing period ends.

OnInit
./lib/actions/GetSubscriptionItemsSubscriptionItemUsageRecordSummaries.js
OnStartup
-
OnClose
-

Attributes

-

PostSubscriptionItemsSubscriptionItemUsageRecords

Creates a usage record for a specified subscription item and date, and fills it with a quantity.

Usage records provide quantity information that Stripe uses to track how much a customer is using your service. With usage information and the pricing model set up by the metered billing plan, Stripe helps you send accurate invoices to your customers.

The default calculation for usage is to add up all the quantity values of the usage records within a billing period. You can change this default behavior with the billing plan's aggregate_usage parameter. When there is more than one usage record with the same timestamp, Stripe adds the quantity values together. In most cases, this is the desired resolution, however, you can change this behavior with the action parameter.

The default pricing model for metered billing is per-unit pricing. For finer granularity, you can configure metered billing to have a tiered pricing model.

OnInit
./lib/actions/PostSubscriptionItemsSubscriptionItemUsageRecords.js
OnStartup
-
OnClose
-

Attributes

-

GetSubscriptionSchedules

Retrieves the list of your subscription schedules.

OnInit
./lib/actions/GetSubscriptionSchedules.js
OnStartup
-
OnClose
-

Attributes

-

PostSubscriptionSchedules

Creates a new subscription schedule object.

OnInit
./lib/actions/PostSubscriptionSchedules.js
OnStartup
-
OnClose
-

Attributes

-

GetSubscriptionSchedulesSchedule

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

OnInit
./lib/actions/GetSubscriptionSchedulesSchedule.js
OnStartup
-
OnClose
-

Attributes

-

PostSubscriptionSchedulesSchedule

Updates an existing subscription schedule.

OnInit
./lib/actions/PostSubscriptionSchedulesSchedule.js
OnStartup
-
OnClose
-

Attributes

-

PostSubscriptionSchedulesScheduleCancel

Cancels a subscription schedule and its associated subscription immediately (if the subscription schedule has an active subscription). A subscription schedule can only be canceled if its status is not_started or active.

OnInit
./lib/actions/PostSubscriptionSchedulesScheduleCancel.js
OnStartup
-
OnClose
-

Attributes

-

PostSubscriptionSchedulesScheduleRelease

Releases the subscription schedule immediately, which will stop scheduling of its phases, but leave any existing subscription in place. A schedule can only be released if its status is not_started or active. If the subscription schedule is currently associated with a subscription, releasing it will remove its subscription property and set the subscription's ID to the released_subscription property.

OnInit
./lib/actions/PostSubscriptionSchedulesScheduleRelease.js
OnStartup
-
OnClose
-

Attributes

-

GetSubscriptionSchedulesScheduleRevisions

Retrieves the list of subscription schedule revisions for a subscription schedule.

OnInit
./lib/actions/GetSubscriptionSchedulesScheduleRevisions.js
OnStartup
-
OnClose
-

Attributes

-

GetSubscriptionSchedulesScheduleRevisionsRevision

Retrieves the details of an existing subscription schedule revision. You only need to supply the unique subscription schedule revision identifier that was returned upon subscription schedule creation or retrieval.

OnInit
./lib/actions/GetSubscriptionSchedulesScheduleRevisionsRevision.js
OnStartup
-
OnClose
-

Attributes

-

GetSubscriptions

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

OnInit
./lib/actions/GetSubscriptions.js
OnStartup
-
OnClose
-

Attributes

-

PostSubscriptions

Creates a new subscription on an existing customer.

OnInit
./lib/actions/PostSubscriptions.js
OnStartup
-
OnClose
-

Attributes

-

DeleteSubscriptionsSubscriptionExposedId

Cancels a customer's subscription immediately. 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 the end of the period, 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, upon subscription cancellation, Stripe will stop automatic collection of all finalized invoices for the customer. This is intended to prevent unexpected payment attempts after the customer has canceled a subscription. However, you can resume automatic collection of the invoices manually after subscription cancellation to have us proceed. Or, you could check for unpaid invoices before allowing the customer to cancel the subscription at all.

OnInit
./lib/actions/DeleteSubscriptionsSubscriptionExposedId.js
OnStartup
-
OnClose
-

Attributes

-

GetSubscriptionsSubscriptionExposedId

Retrieves the subscription with the given ID.

OnInit
./lib/actions/GetSubscriptionsSubscriptionExposedId.js
OnStartup
-
OnClose
-

Attributes

-

PostSubscriptionsSubscriptionExposedId

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.

OnInit
./lib/actions/PostSubscriptionsSubscriptionExposedId.js
OnStartup
-
OnClose
-

Attributes

-

DeleteSubscriptionsSubscriptionExposedIdDiscount

Removes the currently applied discount on a subscription.

OnInit
./lib/actions/DeleteSubscriptionsSubscriptionExposedIdDiscount.js
OnStartup
-
OnClose
-

Attributes

-

PostTerminalConnectionTokens

To connect to a reader the Stripe Terminal SDK needs to retrieve a short-lived connection token from Stripe, proxied through your server. On your backend, add an endpoint that creates and returns a connection token.

OnInit
./lib/actions/PostTerminalConnectionTokens.js
OnStartup
-
OnClose
-

Attributes

-

GetTerminalLocations

Returns a list of Location objects.

OnInit
./lib/actions/GetTerminalLocations.js
OnStartup
-
OnClose
-

Attributes

-

PostTerminalLocations

Creates a new Location object.

OnInit
./lib/actions/PostTerminalLocations.js
OnStartup
-
OnClose
-

Attributes

-

GetTerminalLocationsLocation

Retrieves a Location object.

OnInit
./lib/actions/GetTerminalLocationsLocation.js
OnStartup
-
OnClose
-

Attributes

-

PostTerminalLocationsLocation

Updates a Location object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

OnInit
./lib/actions/PostTerminalLocationsLocation.js
OnStartup
-
OnClose
-

Attributes

-

GetTerminalReaders

Returns a list of Reader objects.

OnInit
./lib/actions/GetTerminalReaders.js
OnStartup
-
OnClose
-

Attributes

-

PostTerminalReaders

Creates a new Reader object.

OnInit
./lib/actions/PostTerminalReaders.js
OnStartup
-
OnClose
-

Attributes

-

GetTerminalReadersReader

Retrieves a Reader object.

OnInit
./lib/actions/GetTerminalReadersReader.js
OnStartup
-
OnClose
-

Attributes

-

PostTerminalReadersReader

Updates a Reader object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

OnInit
./lib/actions/PostTerminalReadersReader.js
OnStartup
-
OnClose
-

Attributes

-

PostTokens

Creates a single-use token that represents a bank account's details. This token can be used with any API method in place of a bank account dictionary. This token can be used only once, by attaching it to a Custom account.

OnInit
./lib/actions/PostTokens.js
OnStartup
-
OnClose
-

Attributes

-

GetTokensToken

Retrieves the token with the given ID.

OnInit
./lib/actions/GetTokensToken.js
OnStartup
-
OnClose
-

Attributes

-

GetTopups

Returns a list of top-ups.

OnInit
./lib/actions/GetTopups.js
OnStartup
-
OnClose
-

Attributes

-

PostTopups

Top up the balance of an account

OnInit
./lib/actions/PostTopups.js
OnStartup
-
OnClose
-

Attributes

-

GetTopupsTopup

Retrieves the details of a top-up that has previously been created. Supply the unique top-up ID that was returned from your previous request, and Stripe will return the corresponding top-up information.

OnInit
./lib/actions/GetTopupsTopup.js
OnStartup
-
OnClose
-

Attributes

-

PostTopupsTopup

Updates the metadata of a top-up. Other top-up details are not editable by design.

OnInit
./lib/actions/PostTopupsTopup.js
OnStartup
-
OnClose
-

Attributes

-

PostTopupsTopupCancel

Cancels a top-up. Only pending top-ups can be canceled.

OnInit
./lib/actions/PostTopupsTopupCancel.js
OnStartup
-
OnClose
-

Attributes

-

GetTransfers

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.

OnInit
./lib/actions/GetTransfers.js
OnStartup
-
OnClose
-

Attributes

-

PostTransfers

To send funds from your Stripe account to a connected account, you create a new transfer object. Your Stripe balance must be able to cover the transfer amount, or you'll receive an "Insufficient Funds" error.

OnInit
./lib/actions/PostTransfers.js
OnStartup
-
OnClose
-

Attributes

-

GetTransfersIdReversals

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.

OnInit
./lib/actions/GetTransfersIdReversals.js
OnStartup
-
OnClose
-

Attributes

-

PostTransfersIdReversals

When you create a new reversal, you must specify a transfer to create it on.

When reversing transfers, you can optionally reverse part of the transfer. You can do so as many times as you wish until the entire transfer has been reversed.

Once entirely reversed, a transfer can't be reversed again. This method will return an error when called on an already-reversed transfer, or when trying to reverse more money than is left on a transfer.

OnInit
./lib/actions/PostTransfersIdReversals.js
OnStartup
-
OnClose
-

Attributes

-

GetTransfersTransfer

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.

OnInit
./lib/actions/GetTransfersTransfer.js
OnStartup
-
OnClose
-

Attributes

-

PostTransfersTransfer

Updates the specified transfer by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

This request accepts only metadata as an argument.

OnInit
./lib/actions/PostTransfersTransfer.js
OnStartup
-
OnClose
-

Attributes

-

GetTransfersTransferReversalsId

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.

OnInit
./lib/actions/GetTransfersTransferReversalsId.js
OnStartup
-
OnClose
-

Attributes

-

PostTransfersTransferReversalsId

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.

OnInit
./lib/actions/PostTransfersTransferReversalsId.js
OnStartup
-
OnClose
-

Attributes

-

GetWebhookEndpoints

Returns a list of your webhook endpoints.

OnInit
./lib/actions/GetWebhookEndpoints.js
OnStartup
-
OnClose
-

Attributes

-

PostWebhookEndpoints

A webhook endpoint must have a url and a list of enabled_events. You may optionally specify the Boolean connect parameter. If set to true, then a Connect webhook endpoint that notifies the specified url about events from all connected accounts is created; otherwise an account webhook endpoint that notifies the specified url only about events from your account is created. You can also create webhook endpoints in the webhooks settings section of the Dashboard.

OnInit
./lib/actions/PostWebhookEndpoints.js
OnStartup
-
OnClose
-

Attributes

-

DeleteWebhookEndpointsWebhookEndpoint

You can also delete webhook endpoints via the webhook endpoint management page of the Stripe dashboard.

OnInit
./lib/actions/DeleteWebhookEndpointsWebhookEndpoint.js
OnStartup
-
OnClose
-

Attributes

-

GetWebhookEndpointsWebhookEndpoint

Retrieves the webhook endpoint with the given ID.

OnInit
./lib/actions/GetWebhookEndpointsWebhookEndpoint.js
OnStartup
-
OnClose
-

Attributes

-

PostWebhookEndpointsWebhookEndpoint

Updates the webhook endpoint. You may edit the url, the list of enabled_events, and the status of your endpoint.

OnInit
./lib/actions/PostWebhookEndpointsWebhookEndpoint.js
OnStartup
-
OnClose
-

Attributes

-

No data available for terms

No data available for environment