({
...options,
...urlSearchParamsBodySerializer,
headers: {
'Content-Type': 'application/x-www-form-urlencoded',
...options?.headers
},
url: '/v1/accounts/{account}'
});
};
/**
* Updates a connected account by setting the values of the parameters passed. Any parameters not provided are
* left unchanged.
*
* For accounts where controller.requirement_collection
* is application, which includes Custom accounts, you can update any information on the account.
*
* For accounts where controller.requirement_collection
* is stripe, which includes Standard and Express accounts, you can update all information until you create
* an Account Link or Account Session to start Connect onboarding,
* after which some properties can no longer be updated.
*
* To update your own account, use the Dashboard. Refer to our
* Connect documentation to learn more about updating accounts.
*/
export const postAccountsAccount = (options: Options) => {
return (options?.client ?? client).post({
...options,
...urlSearchParamsBodySerializer,
headers: {
'Content-Type': 'application/x-www-form-urlencoded',
...options?.headers
},
url: '/v1/accounts/{account}'
});
};
/**
* Create an external account for a given account.
*/
export const postAccountsAccountBankAccounts = (options: Options) => {
return (options?.client ?? client).post({
...options,
...urlSearchParamsBodySerializer,
headers: {
'Content-Type': 'application/x-www-form-urlencoded',
...options?.headers
},
url: '/v1/accounts/{account}/bank_accounts'
});
};
/**
* Delete a specified external account for a given account.
*/
export const deleteAccountsAccountBankAccountsId = (options: Options) => {
return (options?.client ?? client).delete({
...options,
...urlSearchParamsBodySerializer,
headers: {
'Content-Type': 'application/x-www-form-urlencoded',
...options?.headers
},
url: '/v1/accounts/{account}/bank_accounts/{id}'
});
};
/**
* Retrieve a specified external account for a given account.
*/
export const getAccountsAccountBankAccountsId = (options: Options) => {
return (options?.client ?? client).get({
...options,
...urlSearchParamsBodySerializer,
headers: {
'Content-Type': 'application/x-www-form-urlencoded',
...options?.headers
},
url: '/v1/accounts/{account}/bank_accounts/{id}'
});
};
/**
* Updates the metadata, account holder name, account holder type of a bank account belonging to
* a connected account and optionally sets it as the default for its currency. Other bank account
* details are not editable by design.
*
* You can only update bank accounts when account.controller.requirement_collection is application, which includes Custom accounts.
*
* You can re-enable a disabled bank account by performing an update call without providing any
* arguments or changes.
*/
export const postAccountsAccountBankAccountsId = (options: Options) => {
return (options?.client ?? client).post({
...options,
...urlSearchParamsBodySerializer,
headers: {
'Content-Type': 'application/x-www-form-urlencoded',
...options?.headers
},
url: '/v1/accounts/{account}/bank_accounts/{id}'
});
};
/**
* Returns a list of capabilities associated with the account. The capabilities are returned sorted by creation date, with the most recent capability appearing first.
*/
export const getAccountsAccountCapabilities = (options: Options) => {
return (options?.client ?? client).get({
...options,
...urlSearchParamsBodySerializer,
headers: {
'Content-Type': 'application/x-www-form-urlencoded',
...options?.headers
},
url: '/v1/accounts/{account}/capabilities'
});
};
/**
* Retrieves information about the specified Account Capability.
*/
export const getAccountsAccountCapabilitiesCapability = (options: Options) => {
return (options?.client ?? client).get({
...options,
...urlSearchParamsBodySerializer,
headers: {
'Content-Type': 'application/x-www-form-urlencoded',
...options?.headers
},
url: '/v1/accounts/{account}/capabilities/{capability}'
});
};
/**
* Updates an existing Account Capability. Request or remove a capability by updating its requested parameter.
*/
export const postAccountsAccountCapabilitiesCapability = (options: Options) => {
return (options?.client ?? client).post({
...options,
...urlSearchParamsBodySerializer,
headers: {
'Content-Type': 'application/x-www-form-urlencoded',
...options?.headers
},
url: '/v1/accounts/{account}/capabilities/{capability}'
});
};
/**
* List external accounts for an account.
*/
export const getAccountsAccountExternalAccounts = (options: Options) => {
return (options?.client ?? client).get({
...options,
...urlSearchParamsBodySerializer,
headers: {
'Content-Type': 'application/x-www-form-urlencoded',
...options?.headers
},
url: '/v1/accounts/{account}/external_accounts'
});
};
/**
* Create an external account for a given account.
*/
export const postAccountsAccountExternalAccounts = (options: Options) => {
return (options?.client ?? client).post({
...options,
...urlSearchParamsBodySerializer,
headers: {
'Content-Type': 'application/x-www-form-urlencoded',
...options?.headers
},
url: '/v1/accounts/{account}/external_accounts'
});
};
/**
* Delete a specified external account for a given account.
*/
export const deleteAccountsAccountExternalAccountsId = (options: Options) => {
return (options?.client ?? client).delete({
...options,
...urlSearchParamsBodySerializer,
headers: {
'Content-Type': 'application/x-www-form-urlencoded',
...options?.headers
},
url: '/v1/accounts/{account}/external_accounts/{id}'
});
};
/**
* Retrieve a specified external account for a given account.
*/
export const getAccountsAccountExternalAccountsId = (options: Options) => {
return (options?.client ?? client).get({
...options,
...urlSearchParamsBodySerializer,
headers: {
'Content-Type': 'application/x-www-form-urlencoded',
...options?.headers
},
url: '/v1/accounts/{account}/external_accounts/{id}'
});
};
/**
* Updates the metadata, account holder name, account holder type of a bank account belonging to
* a connected account and optionally sets it as the default for its currency. Other bank account
* details are not editable by design.
*
* You can only update bank accounts when account.controller.requirement_collection is application, which includes Custom accounts.
*
* You can re-enable a disabled bank account by performing an update call without providing any
* arguments or changes.
*/
export const postAccountsAccountExternalAccountsId = (options: Options) => {
return (options?.client ?? client).post({
...options,
...urlSearchParamsBodySerializer,
headers: {
'Content-Type': 'application/x-www-form-urlencoded',
...options?.headers
},
url: '/v1/accounts/{account}/external_accounts/{id}'
});
};
/**
* Creates a single-use login link for a connected account to access the Express Dashboard.
*
* You can only create login links for accounts that use the Express Dashboard and are connected to your platform.
*/
export const postAccountsAccountLoginLinks = (options: Options) => {
return (options?.client ?? client).post({
...options,
...urlSearchParamsBodySerializer,
headers: {
'Content-Type': 'application/x-www-form-urlencoded',
...options?.headers
},
url: '/v1/accounts/{account}/login_links'
});
};
/**
* 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.
*/
export const getAccountsAccountPeople = (options: Options) => {
return (options?.client ?? client).get({
...options,
...urlSearchParamsBodySerializer,
headers: {
'Content-Type': 'application/x-www-form-urlencoded',
...options?.headers
},
url: '/v1/accounts/{account}/people'
});
};
/**
* Creates a new person.
*/
export const postAccountsAccountPeople = (options: Options) => {
return (options?.client ?? client).post({
...options,
...urlSearchParamsBodySerializer,
headers: {
'Content-Type': 'application/x-www-form-urlencoded',
...options?.headers
},
url: '/v1/accounts/{account}/people'
});
};
/**
* Deletes an existing person’s relationship to the account’s legal entity. Any person with a relationship for an account can be deleted through the API, except if the person is the account_opener. If your integration is using the executive parameter, you cannot delete the only verified executive on file.
*/
export const deleteAccountsAccountPeoplePerson = (options: Options) => {
return (options?.client ?? client).delete({
...options,
...urlSearchParamsBodySerializer,
headers: {
'Content-Type': 'application/x-www-form-urlencoded',
...options?.headers
},
url: '/v1/accounts/{account}/people/{person}'
});
};
/**
* Retrieves an existing person.
*/
export const getAccountsAccountPeoplePerson = (options: Options) => {
return (options?.client ?? client).get({
...options,
...urlSearchParamsBodySerializer,
headers: {
'Content-Type': 'application/x-www-form-urlencoded',
...options?.headers
},
url: '/v1/accounts/{account}/people/{person}'
});
};
/**
* Updates an existing person.
*/
export const postAccountsAccountPeoplePerson = (options: Options) => {
return (options?.client ?? client).post({
...options,
...urlSearchParamsBodySerializer,
headers: {
'Content-Type': 'application/x-www-form-urlencoded',
...options?.headers
},
url: '/v1/accounts/{account}/people/{person}'
});
};
/**
* 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.
*/
export const getAccountsAccountPersons = (options: Options) => {
return (options?.client ?? client).get({
...options,
...urlSearchParamsBodySerializer,
headers: {
'Content-Type': 'application/x-www-form-urlencoded',
...options?.headers
},
url: '/v1/accounts/{account}/persons'
});
};
/**
* Creates a new person.
*/
export const postAccountsAccountPersons = (options: Options) => {
return (options?.client ?? client).post({
...options,
...urlSearchParamsBodySerializer,
headers: {
'Content-Type': 'application/x-www-form-urlencoded',
...options?.headers
},
url: '/v1/accounts/{account}/persons'
});
};
/**
* Deletes an existing person’s relationship to the account’s legal entity. Any person with a relationship for an account can be deleted through the API, except if the person is the account_opener. If your integration is using the executive parameter, you cannot delete the only verified executive on file.
*/
export const deleteAccountsAccountPersonsPerson = (options: Options) => {
return (options?.client ?? client).delete({
...options,
...urlSearchParamsBodySerializer,
headers: {
'Content-Type': 'application/x-www-form-urlencoded',
...options?.headers
},
url: '/v1/accounts/{account}/persons/{person}'
});
};
/**
* Retrieves an existing person.
*/
export const getAccountsAccountPersonsPerson = (options: Options) => {
return (options?.client ?? client).get({
...options,
...urlSearchParamsBodySerializer,
headers: {
'Content-Type': 'application/x-www-form-urlencoded',
...options?.headers
},
url: '/v1/accounts/{account}/persons/{person}'
});
};
/**
* Updates an existing person.
*/
export const postAccountsAccountPersonsPerson = (options: Options) => {
return (options?.client ?? client).post({
...options,
...urlSearchParamsBodySerializer,
headers: {
'Content-Type': 'application/x-www-form-urlencoded',
...options?.headers
},
url: '/v1/accounts/{account}/persons/{person}'
});
};
/**
* With Connect, you can reject accounts that you have flagged as suspicious.
*
* Only accounts where your platform is liable for negative account balances, which includes Custom and Express accounts, can be rejected. Test-mode accounts can be rejected at any time. Live-mode accounts can only be rejected after all balances are zero.
*/
export const postAccountsAccountReject = (options: Options) => {
return (options?.client ?? client).post({
...options,
...urlSearchParamsBodySerializer,
headers: {
'Content-Type': 'application/x-www-form-urlencoded',
...options?.headers
},
url: '/v1/accounts/{account}/reject'
});
};
/**
* List apple pay domains.
*/
export const getApplePayDomains = (options?: Options) => {
return (options?.client ?? client).get({
...options,
...urlSearchParamsBodySerializer,
headers: {
'Content-Type': 'application/x-www-form-urlencoded',
...options?.headers
},
url: '/v1/apple_pay/domains'
});
};
/**
* Create an apple pay domain.
*/
export const postApplePayDomains = (options: Options) => {
return (options?.client ?? client).post({
...options,
...urlSearchParamsBodySerializer,
headers: {
'Content-Type': 'application/x-www-form-urlencoded',
...options?.headers
},
url: '/v1/apple_pay/domains'
});
};
/**
* Delete an apple pay domain.
*/
export const deleteApplePayDomainsDomain = (options: Options) => {
return (options?.client ?? client).delete({
...options,
...urlSearchParamsBodySerializer,
headers: {
'Content-Type': 'application/x-www-form-urlencoded',
...options?.headers
},
url: '/v1/apple_pay/domains/{domain}'
});
};
/**
* Retrieve an apple pay domain.
*/
export const getApplePayDomainsDomain = (options: Options) => {
return (options?.client ?? client).get({
...options,
...urlSearchParamsBodySerializer,
headers: {
'Content-Type': 'application/x-www-form-urlencoded',
...options?.headers
},
url: '/v1/apple_pay/domains/{domain}'
});
};
/**
* 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.
*/
export const getApplicationFees = (options?: Options) => {
return (options?.client ?? client).get({
...options,
...urlSearchParamsBodySerializer,
headers: {
'Content-Type': 'application/x-www-form-urlencoded',
...options?.headers
},
url: '/v1/application_fees'
});
};
/**
* 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.
*/
export const getApplicationFeesFeeRefundsId = (options: Options) => {
return (options?.client ?? client).get({
...options,
...urlSearchParamsBodySerializer,
headers: {
'Content-Type': 'application/x-www-form-urlencoded',
...options?.headers
},
url: '/v1/application_fees/{fee}/refunds/{id}'
});
};
/**
* 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.
*/
export const postApplicationFeesFeeRefundsId = (options: Options) => {
return (options?.client ?? client).post({
...options,
...urlSearchParamsBodySerializer,
headers: {
'Content-Type': 'application/x-www-form-urlencoded',
...options?.headers
},
url: '/v1/application_fees/{fee}/refunds/{id}'
});
};
/**
* Retrieves the details of an application fee that your account has collected. The same information is returned when refunding the application fee.
*/
export const getApplicationFeesId = (options: Options) => {
return (options?.client ?? client).get({
...options,
...urlSearchParamsBodySerializer,
headers: {
'Content-Type': 'application/x-www-form-urlencoded',
...options?.headers
},
url: '/v1/application_fees/{id}'
});
};
export const postApplicationFeesIdRefund = (options: Options) => {
return (options?.client ?? client).post({
...options,
...urlSearchParamsBodySerializer,
headers: {
'Content-Type': 'application/x-www-form-urlencoded',
...options?.headers
},
url: '/v1/application_fees/{id}/refund'
});
};
/**
* 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.
*/
export const getApplicationFeesIdRefunds = (options: Options) => {
return (options?.client ?? client).get({
...options,
...urlSearchParamsBodySerializer,
headers: {
'Content-Type': 'application/x-www-form-urlencoded',
...options?.headers
},
url: '/v1/application_fees/{id}/refunds'
});
};
/**
* 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.
*/
export const postApplicationFeesIdRefunds = (options: Options) => {
return (options?.client ?? client).post({
...options,
...urlSearchParamsBodySerializer,
headers: {
'Content-Type': 'application/x-www-form-urlencoded',
...options?.headers
},
url: '/v1/application_fees/{id}/refunds'
});
};
/**
* List all secrets stored on the given scope.
*/
export const getAppsSecrets = (options: Options) => {
return (options?.client ?? client).get({
...options,
...urlSearchParamsBodySerializer,
headers: {
'Content-Type': 'application/x-www-form-urlencoded',
...options?.headers
},
url: '/v1/apps/secrets'
});
};
/**
* Create or replace a secret in the secret store.
*/
export const postAppsSecrets = (options: Options) => {
return (options?.client ?? client).post({
...options,
...urlSearchParamsBodySerializer,
headers: {
'Content-Type': 'application/x-www-form-urlencoded',
...options?.headers
},
url: '/v1/apps/secrets'
});
};
/**
* Deletes a secret from the secret store by name and scope.
*/
export const postAppsSecretsDelete = (options: Options) => {
return (options?.client ?? client).post({
...options,
...urlSearchParamsBodySerializer,
headers: {
'Content-Type': 'application/x-www-form-urlencoded',
...options?.headers
},
url: '/v1/apps/secrets/delete'
});
};
/**
* Finds a secret in the secret store by name and scope.
*/
export const getAppsSecretsFind = (options: Options) => {
return (options?.client ?? client).get({
...options,
...urlSearchParamsBodySerializer,
headers: {
'Content-Type': 'application/x-www-form-urlencoded',
...options?.headers
},
url: '/v1/apps/secrets/find'
});
};
/**
* 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.
*/
export const getBalance = (options?: Options) => {
return (options?.client ?? client).get({
...options,
...urlSearchParamsBodySerializer,
headers: {
'Content-Type': 'application/x-www-form-urlencoded',
...options?.headers
},
url: '/v1/balance'
});
};
/**
* 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.
*
* Note that this endpoint was previously called “Balance history” and used the path /v1/balance/history.
*/
export const getBalanceHistory = (options?: Options) => {
return (options?.client ?? client).get({
...options,
...urlSearchParamsBodySerializer,
headers: {
'Content-Type': 'application/x-www-form-urlencoded',
...options?.headers
},
url: '/v1/balance/history'
});
};
/**
* Retrieves the balance transaction with the given ID.
*
* Note that this endpoint previously used the path /v1/balance/history/:id.
*/
export const getBalanceHistoryId = (options: Options) => {
return (options?.client ?? client).get({
...options,
...urlSearchParamsBodySerializer,
headers: {
'Content-Type': 'application/x-www-form-urlencoded',
...options?.headers
},
url: '/v1/balance/history/{id}'
});
};
/**
* 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.
*
* Note that this endpoint was previously called “Balance history” and used the path /v1/balance/history.
*/
export const getBalanceTransactions = (options?: Options) => {
return (options?.client ?? client).get({
...options,
...urlSearchParamsBodySerializer,
headers: {
'Content-Type': 'application/x-www-form-urlencoded',
...options?.headers
},
url: '/v1/balance_transactions'
});
};
/**
* Retrieves the balance transaction with the given ID.
*
* Note that this endpoint previously used the path /v1/balance/history/:id.
*/
export const getBalanceTransactionsId = (options: Options) => {
return (options?.client ?? client).get({
...options,
...urlSearchParamsBodySerializer,
headers: {
'Content-Type': 'application/x-www-form-urlencoded',
...options?.headers
},
url: '/v1/balance_transactions/{id}'
});
};
/**
* Creates a billing meter event adjustment
*/
export const postBillingMeterEventAdjustments = (options: Options) => {
return (options?.client ?? client).post({
...options,
...urlSearchParamsBodySerializer,
headers: {
'Content-Type': 'application/x-www-form-urlencoded',
...options?.headers
},
url: '/v1/billing/meter_event_adjustments'
});
};
/**
* Creates a billing meter event
*/
export const postBillingMeterEvents = (options: Options) => {
return (options?.client ?? client).post({
...options,
...urlSearchParamsBodySerializer,
headers: {
'Content-Type': 'application/x-www-form-urlencoded',
...options?.headers
},
url: '/v1/billing/meter_events'
});
};
/**
* Retrieve a list of billing meters.
*/
export const getBillingMeters = (options?: Options) => {
return (options?.client ?? client).get({
...options,
...urlSearchParamsBodySerializer,
headers: {
'Content-Type': 'application/x-www-form-urlencoded',
...options?.headers
},
url: '/v1/billing/meters'
});
};
/**
* Creates a billing meter
*/
export const postBillingMeters = (options: Options) => {
return (options?.client ?? client).post({
...options,
...urlSearchParamsBodySerializer,
headers: {
'Content-Type': 'application/x-www-form-urlencoded',
...options?.headers
},
url: '/v1/billing/meters'
});
};
/**
* Retrieves a billing meter given an ID
*/
export const getBillingMetersId = (options: Options) => {
return (options?.client ?? client).get({
...options,
...urlSearchParamsBodySerializer,
headers: {
'Content-Type': 'application/x-www-form-urlencoded',
...options?.headers
},
url: '/v1/billing/meters/{id}'
});
};
/**
* Updates a billing meter
*/
export const postBillingMetersId = (options: Options) => {
return (options?.client ?? client).post({
...options,
...urlSearchParamsBodySerializer,
headers: {
'Content-Type': 'application/x-www-form-urlencoded',
...options?.headers
},
url: '/v1/billing/meters/{id}'
});
};
/**
* Deactivates a billing meter
*/
export const postBillingMetersIdDeactivate = (options: Options) => {
return (options?.client ?? client).post({
...options,
...urlSearchParamsBodySerializer,
headers: {
'Content-Type': 'application/x-www-form-urlencoded',
...options?.headers
},
url: '/v1/billing/meters/{id}/deactivate'
});
};
/**
* Retrieve a list of billing meter event summaries.
*/
export const getBillingMetersIdEventSummaries = (options: Options) => {
return (options?.client ?? client).get({
...options,
...urlSearchParamsBodySerializer,
headers: {
'Content-Type': 'application/x-www-form-urlencoded',
...options?.headers
},
url: '/v1/billing/meters/{id}/event_summaries'
});
};
/**
* Reactivates a billing meter
*/
export const postBillingMetersIdReactivate = (options: Options) => {
return (options?.client ?? client).post({
...options,
...urlSearchParamsBodySerializer,
headers: {
'Content-Type': 'application/x-www-form-urlencoded',
...options?.headers
},
url: '/v1/billing/meters/{id}/reactivate'
});
};
/**
* Returns a list of configurations that describe the functionality of the customer portal.
*/
export const getBillingPortalConfigurations = (options?: Options) => {
return (options?.client ?? client).get({
...options,
...urlSearchParamsBodySerializer,
headers: {
'Content-Type': 'application/x-www-form-urlencoded',
...options?.headers
},
url: '/v1/billing_portal/configurations'
});
};
/**
* Creates a configuration that describes the functionality and behavior of a PortalSession
*/
export const postBillingPortalConfigurations = (options: Options) => {
return (options?.client ?? client).post({
...options,
...urlSearchParamsBodySerializer,
headers: {
'Content-Type': 'application/x-www-form-urlencoded',
...options?.headers
},
url: '/v1/billing_portal/configurations'
});
};
/**
* Retrieves a configuration that describes the functionality of the customer portal.
*/
export const getBillingPortalConfigurationsConfiguration = (options: Options) => {
return (options?.client ?? client).get({
...options,
...urlSearchParamsBodySerializer,
headers: {
'Content-Type': 'application/x-www-form-urlencoded',
...options?.headers
},
url: '/v1/billing_portal/configurations/{configuration}'
});
};
/**
* Updates a configuration that describes the functionality of the customer portal.
*/
export const postBillingPortalConfigurationsConfiguration = (options: Options) => {
return (options?.client ?? client).post({
...options,
...urlSearchParamsBodySerializer,
headers: {
'Content-Type': 'application/x-www-form-urlencoded',
...options?.headers
},
url: '/v1/billing_portal/configurations/{configuration}'
});
};
/**
* Creates a session of the customer portal.
*/
export const postBillingPortalSessions = (options: Options) => {
return (options?.client ?? client).post({
...options,
...urlSearchParamsBodySerializer,
headers: {
'Content-Type': 'application/x-www-form-urlencoded',
...options?.headers
},
url: '/v1/billing_portal/sessions'
});
};
/**
* Returns a list of charges you’ve previously created. The charges are returned in sorted order, with the most recent charges appearing first.
*/
export const getCharges = (options?: Options) => {
return (options?.client ?? client).get({
...options,
...urlSearchParamsBodySerializer,
headers: {
'Content-Type': 'application/x-www-form-urlencoded',
...options?.headers
},
url: '/v1/charges'
});
};
/**
* This method is no longer recommended—use the Payment Intents API
* to initiate a new payment instead. Confirmation of the PaymentIntent creates the Charge
* object used to request payment.
*/
export const postCharges = (options?: Options) => {
return (options?.client ?? client).post({
...options,
...urlSearchParamsBodySerializer,
headers: {
'Content-Type': 'application/x-www-form-urlencoded',
...options?.headers
},
url: '/v1/charges'
});
};
/**
* Search for charges you’ve previously created using Stripe’s Search Query Language.
* Don’t use search in read-after-write flows where strict consistency is necessary. Under normal operating
* conditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up
* to an hour behind during outages. Search functionality is not available to merchants in India.
*/
export const getChargesSearch = (options: Options) => {
return (options?.client ?? client).get({
...options,
...urlSearchParamsBodySerializer,
headers: {
'Content-Type': 'application/x-www-form-urlencoded',
...options?.headers
},
url: '/v1/charges/search'
});
};
/**
* 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.
*/
export const getChargesCharge = (options: Options) => {
return (options?.client ?? client).get({
...options,
...urlSearchParamsBodySerializer,
headers: {
'Content-Type': 'application/x-www-form-urlencoded',
...options?.headers
},
url: '/v1/charges/{charge}'
});
};
/**
* Updates the specified charge by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
*/
export const postChargesCharge = (options: Options) => {
return (options?.client ?? client).post({
...options,
...urlSearchParamsBodySerializer,
headers: {
'Content-Type': 'application/x-www-form-urlencoded',
...options?.headers
},
url: '/v1/charges/{charge}'
});
};
/**
* Capture the payment of an existing, uncaptured charge that was created with the capture option set to false.
*
* Uncaptured payments expire a set number of days after they are created (7 by default), after which they are marked as refunded and capture attempts will fail.
*
* Don’t use this method to capture a PaymentIntent-initiated charge. Use Capture a PaymentIntent.
*/
export const postChargesChargeCapture = (options: Options) => {
return (options?.client ?? client).post({
...options,
...urlSearchParamsBodySerializer,
headers: {
'Content-Type': 'application/x-www-form-urlencoded',
...options?.headers
},
url: '/v1/charges/{charge}/capture'
});
};
/**
* Retrieve a dispute for a specified charge.
*/
export const getChargesChargeDispute = (options: Options) => {
return (options?.client ?? client).get({
...options,
...urlSearchParamsBodySerializer,
headers: {
'Content-Type': 'application/x-www-form-urlencoded',
...options?.headers
},
url: '/v1/charges/{charge}/dispute'
});
};
export const postChargesChargeDispute = (options: Options) => {
return (options?.client ?? client).post({
...options,
...urlSearchParamsBodySerializer,
headers: {
'Content-Type': 'application/x-www-form-urlencoded',
...options?.headers
},
url: '/v1/charges/{charge}/dispute'
});
};
export const postChargesChargeDisputeClose = (options: Options) => {
return (options?.client ?? client).post({
...options,
...urlSearchParamsBodySerializer,
headers: {
'Content-Type': 'application/x-www-form-urlencoded',
...options?.headers
},
url: '/v1/charges/{charge}/dispute/close'
});
};
/**
* When you create a new refund, you must specify either a Charge or a PaymentIntent object.
*
* This action refunds a previously created charge that’s not refunded yet.
* Funds are refunded to the credit or debit card that’s originally charged.
*
* You can optionally refund only part of a charge.
* You can repeat this until the entire charge is refunded.
*
* After you entirely refund a charge, you can’t refund it again.
* This method raises an error when it’s called on an already-refunded charge,
* or when you attempt to refund more money than is left on a charge.
*/
export const postChargesChargeRefund = (options: Options) => {
return (options?.client ?? client).post({
...options,
...urlSearchParamsBodySerializer,
headers: {
'Content-Type': 'application/x-www-form-urlencoded',
...options?.headers
},
url: '/v1/charges/{charge}/refund'
});
};
/**
* 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.
*/
export const getChargesChargeRefunds = (options: Options) => {
return (options?.client ?? client).get({
...options,
...urlSearchParamsBodySerializer,
headers: {
'Content-Type': 'application/x-www-form-urlencoded',
...options?.headers
},
url: '/v1/charges/{charge}/refunds'
});
};
/**
* When you create a new refund, you must specify a Charge or a PaymentIntent object 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.
*/
export const postChargesChargeRefunds = (options: Options) => {
return (options?.client ?? client).post({
...options,
...urlSearchParamsBodySerializer,
headers: {
'Content-Type': 'application/x-www-form-urlencoded',
...options?.headers
},
url: '/v1/charges/{charge}/refunds'
});
};
/**
* Retrieves the details of an existing refund.
*/
export const getChargesChargeRefundsRefund = (options: Options) => {
return (options?.client ?? client).get({
...options,
...urlSearchParamsBodySerializer,
headers: {
'Content-Type': 'application/x-www-form-urlencoded',
...options?.headers
},
url: '/v1/charges/{charge}/refunds/{refund}'
});
};
/**
* Update a specified refund.
*/
export const postChargesChargeRefundsRefund = (options: Options) => {
return (options?.client ?? client).post({
...options,
...urlSearchParamsBodySerializer,
headers: {
'Content-Type': 'application/x-www-form-urlencoded',
...options?.headers
},
url: '/v1/charges/{charge}/refunds/{refund}'
});
};
/**
* Returns a list of Checkout Sessions.
*/
export const getCheckoutSessions = (options?: Options) => {
return (options?.client ?? client).get({
...options,
...urlSearchParamsBodySerializer,
headers: {
'Content-Type': 'application/x-www-form-urlencoded',
...options?.headers
},
url: '/v1/checkout/sessions'
});
};
/**
* Creates a Session object.
*/
export const postCheckoutSessions = (options?: Options) => {
return (options?.client ?? client).post({
...options,
...urlSearchParamsBodySerializer,
headers: {
'Content-Type': 'application/x-www-form-urlencoded',
...options?.headers
},
url: '/v1/checkout/sessions'
});
};
/**
* Retrieves a Session object.
*/
export const getCheckoutSessionsSession = (options: Options) => {
return (options?.client ?? client).get({
...options,
...urlSearchParamsBodySerializer,
headers: {
'Content-Type': 'application/x-www-form-urlencoded',
...options?.headers
},
url: '/v1/checkout/sessions/{session}'
});
};
/**
* A Session can be expired when it is in one of these statuses: open
*
* After it expires, a customer can’t complete a Session and customers loading the Session see a message saying the Session is expired.
*/
export const postCheckoutSessionsSessionExpire = (options: Options) => {
return (options?.client ?? client).post({
...options,
...urlSearchParamsBodySerializer,
headers: {
'Content-Type': 'application/x-www-form-urlencoded',
...options?.headers
},
url: '/v1/checkout/sessions/{session}/expire'
});
};
/**
* When retrieving a Checkout Session, there is an includable line_items property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.
*/
export const getCheckoutSessionsSessionLineItems = (options: Options) => {
return (options?.client ?? client).get