Stripe API
Tools that enable LLMs to interact directly with the Stripe API.
1.0.0
Overview
The StripeApi toolkit enables LLMs to directly interact with the Stripe API, facilitating seamless operations related to payments, account management, and customer interactions.
Capabilities
- Manage customer accounts, payment methods, and transactions.
- Retrieve detailed financial data and reports.
- Perform search operations for financial entities following Stripe's Search Query Language.
- Delete accounts, invoices, and payment methods efficiently.
OAuth
This toolkit does not support OAuth as authentication.
Secrets
- Secret Type: api_key
- Example: STRIPE_API_KEY
Available tools(220)
| Tool name | Description | Secrets | |
|---|---|---|---|
Delete a person's relationship to an account in Stripe.
Deletes a person's relationship to the account's legal entity in Stripe, except for the account_opener or the sole verified executive. | 1 | ||
Remove a person's relationship from a Stripe account.
This tool deletes an existing person's relationship to a Stripe account's legal entity. It cannot delete the account opener or the only verified executive, if applicable. | 1 | ||
Delete an Apple Pay domain from Stripe.
Use this tool to delete a specific Apple Pay domain registered with your Stripe account. This is useful for managing domains no longer required for Apple Pay services. | 1 | ||
Deletes a customer's existing tax ID.
This tool is used to remove an existing tax ID associated with a specific customer in Stripe. Call this tool to manage customer tax ID records by deleting unnecessary or outdated entries. | 1 | ||
Delete a specified external account for a given account.
Use this tool to delete an external account linked to a specific account. Ideal for managing external accounts by removing unwanted or outdated entries. | 1 | ||
Delete an external bank account for a specified account.
Use this tool to remove a specified external bank account from a given account. It confirms the successful deletion. | 1 | ||
Permanently delete a draft invoice.
Use this tool to permanently delete a draft invoice that is not finalized or associated with a subscription. Once deleted, this action cannot be undone. | 1 | ||
Delete an invoice item from a draft or unattached invoice.
Use this tool to delete an invoice item that isn't attached to a final invoice or is part of a draft invoice. | 1 | ||
Delete a specific feature from a product.
Use this tool to delete a feature attached to a specific product by providing the product and feature identifiers. | 1 | ||
Delete managed accounts via Stripe Connect.
Use this tool to delete accounts you manage through Stripe Connect. Suitable for test-mode accounts anytime and live-mode accounts except those with standard dashboard access or negative balances. Ensure all balances are zero before deletion. | 1 | ||
Delete a coupon in Stripe without affecting current users.
Use this tool to delete a coupon on Stripe, preventing new customers from redeeming it. Existing customers with the coupon remain unaffected. | 1 | ||
Permanently delete a Stripe customer and cancel subscriptions.
Use this tool to permanently delete a customer in Stripe. This action cannot be undone and will immediately cancel any active subscriptions associated with the customer. | 1 | ||
Delete a specified plan from Stripe.
Use this tool to delete a plan in Stripe, preventing new subscriptions to that plan while keeping existing subscribers unaffected. | 1 | ||
Delete a product from Stripe if eligible.
This tool deletes a product from Stripe, provided the product has no prices or SKUs associated with it. Use this to remove products when cleaning up a catalog or managing inventory. | 1 | ||
Delete a Stripe Radar ValueList and its items.
Use this tool to delete a specified ValueList object in Stripe Radar, along with all its contained items. Ensure the ValueList is not referenced in any rules before calling this tool. | 1 | ||
Delete a Stripe webhook endpoint by ID.
Use this tool to delete a specific webhook endpoint in Stripe by providing its ID, helping manage webhook configurations. | 1 | ||
Delete a tax ID from an account or customer.
Use this tool to delete an existing tax ID associated with an account or customer in Stripe. | 1 | ||
Deletes a terminal configuration.
Use this tool to delete a specific terminal configuration in Stripe by providing the configuration ID. | 1 | ||
Deletes a specified terminal location in Stripe.
Use this tool to delete a specific terminal location in Stripe by providing the location identifier. It removes the location object from the terminal services. | 1 | ||
Delete a terminal reader from the Stripe account.
This tool is used to delete a terminal reader object in a Stripe account. It should be called when there is a need to remove a specific reader. | 1 | ||
Deletes a test clock in Stripe's test environment.
This tool is used to delete a specific test clock from Stripe's test environment. Call this tool when you need to remove a test clock that is no longer needed. | 1 | ||
Download the PDF for a finalized Stripe quote.
Use this tool to retrieve the PDF document for a completed quote from Stripe. It's useful when you need to obtain the finalized quote in PDF format for record-keeping or sharing purposes. | 1 | ||
Retrieve capabilities associated with a Stripe account.
This tool returns a list of capabilities for a specified Stripe account, sorted by their creation date. | 1 | ||
Retrieve details of a specific account capability.
This tool fetches information about a specific capability of an account in Stripe. It should be called when there's a need to understand the capabilities available on an account. | 1 | ||
Retrieve active entitlements for a customer from Stripe.
This tool fetches a list of active entitlements for a specific customer using Stripe's API. It's used when you need to know what entitlements a customer currently has. | 1 |
Selected tools
No tools selected.
Click "Show all tools" to add tools.
Requirements
Select tools to see requirements
StripeApi.DeleteAccountPerson
Delete a person's relationship to an account in Stripe. Deletes a person's relationship to the account's legal entity in Stripe, except for the account_opener or the sole verified executive.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
account_id | string | Required | The unique identifier of the account from which a person's relationship will be deleted. This must be a valid Stripe account ID. |
person_id | string | Required | A unique identifier for the person whose relationship to the account will be deleted. This is required and must be a valid person ID in Stripe. |
Requirements
Output
json— Response from the API endpoint 'DeleteAccountsAccountPersonsPerson'.StripeApi.DeleteAccountPersonRelationship
Remove a person's relationship from a Stripe account. This tool deletes an existing person's relationship to a Stripe account's legal entity. It cannot delete the account opener or the only verified executive, if applicable.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
account_id | string | Required | The unique identifier for the Stripe account from which the person's relationship will be removed. This ID is required to specify the correct account. |
person_id | string | Required | The unique identifier of the person whose relationship to the account is to be removed. |
Requirements
Output
json— Response from the API endpoint 'DeleteAccountsAccountPeoplePerson'.StripeApi.DeleteApplePayDomain
Delete an Apple Pay domain from Stripe. Use this tool to delete a specific Apple Pay domain registered with your Stripe account. This is useful for managing domains no longer required for Apple Pay services.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
apple_pay_domain_to_delete | string | Required | The domain name of the Apple Pay domain you wish to delete from your Stripe account. |
Requirements
Output
json— Response from the API endpoint 'DeleteApplePayDomainsDomain'.StripeApi.DeleteCustomerTaxId
Deletes a customer's existing tax ID. This tool is used to remove an existing tax ID associated with a specific customer in Stripe. Call this tool to manage customer tax ID records by deleting unnecessary or outdated entries.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
customer_identifier | string | Required | The unique identifier for the customer whose tax ID will be deleted. This is a string provided by Stripe. |
tax_id | string | Required | The unique identifier of the tax ID to be deleted for the customer. |
Requirements
Output
json— Response from the API endpoint 'DeleteCustomersCustomerTaxIdsId'.StripeApi.DeleteExternalAccount
Delete a specified external account for a given account. Use this tool to delete an external account linked to a specific account. Ideal for managing external accounts by removing unwanted or outdated entries.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
account_identifier | string | Required | The unique identifier of the account from which the external account will be deleted. |
external_account_id | string | Required | Unique identifier for the external account to be deleted. |
Requirements
Output
json— Response from the API endpoint 'DeleteAccountsAccountExternalAccountsId'.StripeApi.DeleteExternalBankAccount
Delete an external bank account for a specified account. Use this tool to remove a specified external bank account from a given account. It confirms the successful deletion.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
account_identifier | string | Required | The account ID from which you want to delete an external bank account. |
external_account_id | string | Required | The unique identifier of the external bank account to be deleted. |
Requirements
Output
json— Response from the API endpoint 'DeleteAccountsAccountBankAccountsId'.StripeApi.DeleteInvoiceDraft
Permanently delete a draft invoice. Use this tool to permanently delete a draft invoice that is not finalized or associated with a subscription. Once deleted, this action cannot be undone.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
invoice_id | string | Required | The unique identifier of the draft invoice to be permanently deleted. Cannot be used on finalized invoices or those associated with subscriptions. |
Requirements
Output
json— Response from the API endpoint 'DeleteInvoicesInvoice'.StripeApi.DeleteInvoiceItem
Delete an invoice item from a draft or unattached invoice. Use this tool to delete an invoice item that isn't attached to a final invoice or is part of a draft invoice.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
invoice_item_id | string | Required | The unique identifier of the invoice item to be deleted. It must be either unattached or part of a draft invoice. |
Requirements
Output
json— Response from the API endpoint 'DeleteInvoiceitemsInvoiceitem'.StripeApi.DeleteProductFeature
Delete a specific feature from a product. Use this tool to delete a feature attached to a specific product by providing the product and feature identifiers.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
feature_id | string | Required | The identifier of the feature to be deleted from the product. |
product_id | string | Required | The unique identifier of the product from which the feature is to be deleted. This is required to specify which product's feature should be removed. |
Requirements
Output
json— Response from the API endpoint 'DeleteProductsProductFeaturesId'.StripeApi.DeleteStripeConnectedAccount
Delete managed accounts via Stripe Connect. Use this tool to delete accounts you manage through Stripe Connect. Suitable for test-mode accounts anytime and live-mode accounts except those with standard dashboard access or negative balances. Ensure all balances are zero before deletion.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
account_id_to_delete | string | Required | The unique identifier of the Stripe account to be deleted. Ensure this is a managed account with zero balance. |
Requirements
Output
json— Response from the API endpoint 'DeleteAccountsAccount'.StripeApi.DeleteStripeCoupon
Delete a coupon in Stripe without affecting current users. Use this tool to delete a coupon on Stripe, preventing new customers from redeeming it. Existing customers with the coupon remain unaffected.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
coupon_id | string | Required | The unique identifier of the coupon to delete on Stripe. This ID specifies which coupon should be deleted. |
Requirements
Output
json— Response from the API endpoint 'DeleteCouponsCoupon'.StripeApi.DeleteStripeCustomer
Permanently delete a Stripe customer and cancel subscriptions. Use this tool to permanently delete a customer in Stripe. This action cannot be undone and will immediately cancel any active subscriptions associated with the customer.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
customer_id | string | Required | The unique identifier of the customer to be deleted. This ID is required and should match the customer in the Stripe system. |
Requirements
Output
json— Response from the API endpoint 'DeleteCustomersCustomer'.StripeApi.DeleteStripePlan
Delete a specified plan from Stripe. Use this tool to delete a plan in Stripe, preventing new subscriptions to that plan while keeping existing subscribers unaffected.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
plan_id | string | Required | The unique identifier of the plan to be deleted in Stripe. |
Requirements
Output
json— Response from the API endpoint 'DeletePlansPlan'.StripeApi.DeleteStripeProduct
Delete a product from Stripe if eligible. This tool deletes a product from Stripe, provided the product has no prices or SKUs associated with it. Use this to remove products when cleaning up a catalog or managing inventory.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
product_id_to_delete | string | Required | The unique identifier of the product to delete. Ensure the product has no prices or SKUs associated with it. |
Requirements
Output
json— Response from the API endpoint 'DeleteProductsId'.StripeApi.DeleteStripeValueList
Delete a Stripe Radar ValueList and its items. Use this tool to delete a specified ValueList object in Stripe Radar, along with all its contained items. Ensure the ValueList is not referenced in any rules before calling this tool.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
value_list_id | string | Required | The unique identifier of the ValueList to be deleted. Ensure it is not referenced in any rules before deletion. |
Requirements
Output
json— Response from the API endpoint 'DeleteRadarValueListsValueList'.StripeApi.DeleteStripeWebhookEndpoint
Delete a Stripe webhook endpoint by ID. Use this tool to delete a specific webhook endpoint in Stripe by providing its ID, helping manage webhook configurations.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
webhook_endpoint_id | string | Required | The unique identifier for the Stripe webhook endpoint you wish to delete. This ID is required to specify which endpoint should be removed from your Stripe configurations. |
Requirements
Output
json— Response from the API endpoint 'DeleteWebhookEndpointsWebhookEndpoint'.StripeApi.DeleteTaxId
Delete a tax ID from an account or customer. Use this tool to delete an existing tax ID associated with an account or customer in Stripe.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
tax_id | string | Required | The identifier of the tax ID to be deleted. This should be the specific tax ID string associated with an account or customer in Stripe. |
Requirements
Output
json— Response from the API endpoint 'DeleteTaxIdsId'.StripeApi.DeleteTerminalConfiguration
Deletes a terminal configuration. Use this tool to delete a specific terminal configuration in Stripe by providing the configuration ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
configuration_id_to_delete | string | Required | The ID of the terminal configuration you want to delete from Stripe. |
Requirements
Output
json— Response from the API endpoint 'DeleteTerminalConfigurationsConfiguration'.StripeApi.DeleteTerminalLocation
Deletes a specified terminal location in Stripe. Use this tool to delete a specific terminal location in Stripe by providing the location identifier. It removes the location object from the terminal services.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
location_identifier | string | Required | The unique identifier of the terminal location to delete. |
Requirements
Output
json— Response from the API endpoint 'DeleteTerminalLocationsLocation'.StripeApi.DeleteTerminalReader
Delete a terminal reader from the Stripe account. This tool is used to delete a terminal reader object in a Stripe account. It should be called when there is a need to remove a specific reader.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
terminal_reader_id | string | Required | The ID of the terminal reader to be deleted from the Stripe account. |
Requirements
Output
json— Response from the API endpoint 'DeleteTerminalReadersReader'.StripeApi.DeleteTestClock
Deletes a test clock in Stripe's test environment. This tool is used to delete a specific test clock from Stripe's test environment. Call this tool when you need to remove a test clock that is no longer needed.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
test_clock_id | string | Required | The unique identifier of the test clock to be deleted from Stripe's test environment. |
Requirements
Output
json— Response from the API endpoint 'DeleteTestHelpersTestClocksTestClock'.StripeApi.DownloadQuotePdf
Download the PDF for a finalized Stripe quote. Use this tool to retrieve the PDF document for a completed quote from Stripe. It's useful when you need to obtain the finalized quote in PDF format for record-keeping or sharing purposes.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
quote_id | string | Required | The unique identifier for the finalized quote to download as a PDF. This ID is required to retrieve the specific quote. |
expand_fields | array<string> | Optional | A list of fields in the quote response that should be expanded for additional detail. |
Requirements
Output
json— Response from the API endpoint 'GetQuotesQuotePdf'.StripeApi.GetAccountCapabilities
Retrieve capabilities associated with a Stripe account. This tool returns a list of capabilities for a specified Stripe account, sorted by their creation date.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
account_id | string | Required | The ID of the Stripe account for which to retrieve capabilities. This is a required field. |
fields_to_expand | array<string> | Optional | A list of fields to expand in the response, specified as strings. |
Requirements
Output
json— Response from the API endpoint 'GetAccountsAccountCapabilities'.StripeApi.GetAccountCapabilityDetails
Retrieve details of a specific account capability. This tool fetches information about a specific capability of an account in Stripe. It should be called when there's a need to understand the capabilities available on an account.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
account_id | string | Required | The unique identifier for the Stripe account whose capability information is being requested. |
account_capability_identifier | string | Required | A unique identifier string for the specific capability of the account to be retrieved. This is essential to specify which capability's details you want to fetch from Stripe. |
expand_fields | array<string> | Optional | List of fields in the response to expand for detailed information. |
Requirements
Output
json— Response from the API endpoint 'GetAccountsAccountCapabilitiesCapability'.StripeApi.GetActiveEntitlements
Retrieve active entitlements for a customer from Stripe. This tool fetches a list of active entitlements for a specific customer using Stripe's API. It's used when you need to know what entitlements a customer currently has.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
customer_id | string | Required | The unique identifier of the customer whose active entitlements are being retrieved. |
pagination_ending_before | string | Optional | An object ID cursor to fetch the previous page of the list of active entitlements. |
expand_fields_in_response | array<string> | Optional | An array of field names to be expanded in the response from Stripe. Use this to include additional details related to specific entities. |
max_number_of_entitlements | integer | Optional | Maximum number of active entitlements to retrieve for the customer, between 1 and 100. Default is 10. |
pagination_starting_after | string | Optional | Use this to specify where to start the list pagination. Provide the object ID from where the list should continue. |
Requirements
Output
json— Response from the API endpoint 'GetEntitlementsActiveEntitlements'.StripeApi.GetApplicationFeeRefunds
Retrieve refunds for a specific application fee. Use this tool to access more than the default 10 refunds associated with a specific application fee, using pagination parameters if needed.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
application_fee_id | string | Required | The unique identifier of the application fee for which refunds are being retrieved. This ID specifies which fee's refunds should be listed. |
pagination_cursor_ending_before | string | Optional | An object ID cursor used for pagination to fetch the previous page of refunds. |
fields_to_expand | array<string> | Optional | List of fields in the response to expand for additional details. |
maximum_number_of_refunds | integer | Optional | The maximum number of refund objects to return, ranging from 1 to 100. Defaults to 10 if not specified. |
pagination_starting_after | string | Optional | An object ID to fetch the next page of refunds after this ID, used for pagination. |
Requirements
Output
json— Response from the API endpoint 'GetApplicationFeesIdRefunds'.StripeApi.GetBalanceSettings
Retrieve balance settings for a connected Stripe account. Use this tool to obtain the balance settings associated with a specific connected account in Stripe. Useful for managing and reviewing account financial settings.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
fields_to_expand | array<string> | Optional | A list of fields in the response that should be expanded for the connected Stripe account's balance settings. |
Requirements
Output
json— Response from the API endpoint 'GetBalanceSettings'.StripeApi.GetBalanceTransactionById
Retrieve details of a balance transaction by ID. Call this tool to get comprehensive information about a specific balance transaction using its ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
transaction_id | string | Required | The unique identifier of the balance transaction to be retrieved. |
fields_to_expand | array<string> | Optional | A list of fields in the response that should be expanded for additional details. |
Requirements
Output
json— Response from the API endpoint 'GetBalanceTransactionsId'.StripeApi.GetBillingAlert
Retrieve billing alert details by ID. This tool retrieves billing alert information from Stripe using a specific alert ID. It should be called when you need details about a particular billing alert.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
billing_alert_id | string | Required | The unique identifier of the billing alert to retrieve details for. |
expand_fields | array<string> | Optional | List of fields in the response that should be expanded. |
Requirements
Output
json— Response from the API endpoint 'GetBillingAlertsId'.StripeApi.GetBillingAlerts
Retrieve active and inactive billing alerts. Use this tool to list all current billing alerts, both active and inactive, from Stripe.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
filter_by_alert_type | string | Optional | Filter results to only include alerts of the specified type. Accepts 'usage_threshold'. |
pagination_ending_before | string | Optional | A pagination cursor. Use this ID to fetch the previous page of the list if starting from a specific object. |
expand_response_fields | array<string> | Optional | List of fields in the response that should be expanded. Each field should be a string. |
result_limit | integer | Optional | Specify the maximum number of billing alerts to be returned. Accepts an integer from 1 to 100. Defaults to 10 if not provided. |
filter_by_meter | string | Optional | Filter results to only include alerts related to a specific meter type. |
pagination_starting_after | string | Optional | Cursor indicating the starting point for fetching the next page of alerts. Use an object ID from a previous response. |
Requirements
Output
json— Response from the API endpoint 'GetBillingAlerts'.StripeApi.GetBillingCreditGrants
Retrieve a list of billing credit grants. Use this tool to retrieve information about billing credit grants from Stripe. It should be called when you need details about existing credit grants.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
customer_id | string | Optional | The unique identifier of the customer whose credit grants you want to retrieve. |
pagination_ending_before | string | Optional | An object ID to fetch the previous page of the list. Use the last received object's ID from the current page. |
fields_to_expand | array<string> | Optional | A list of fields to be expanded in the response for detailed information. |
credit_grant_limit | integer | Optional | The maximum number of credit grants to return, between 1 and 100. Defaults to 10 if not specified. |
pagination_starting_after_cursor | string | Optional | A cursor (object ID) for pagination to fetch the next page in the list. Use the ID from the last object in the previous list. |
Requirements
Output
json— Response from the API endpoint 'GetBillingCreditGrants'.StripeApi.GetBillingMeterEventSummaries
Retrieve billing meter event summaries by meter ID. Call this tool to get a list of billing meter event summaries for a specific meter ID, providing insights into billing events and activities.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
customer_id | string | Required | The unique identifier of the customer for which to fetch event summaries. |
stop_aggregating_until | integer | Required | The exclusive timestamp to stop aggregating meter events. Ensure it aligns with minute boundaries. |
start_time_timestamp | integer | Required | The timestamp to begin aggregating meter events (inclusive). Must align with minute boundaries. |
meter_id | string | Required | The unique identifier for the billing meter to fetch event summaries for. |
pagination_ending_before_id | string | Optional | An object ID for pagination, used to fetch the previous page of a list. Aligns the list cursor to end before the specified object ID. |
fields_to_expand | array<string> | Optional | A list of fields in the response that should be expanded for detailed results. |
number_of_objects_limit | integer | Optional | A limit on the number of billing meter event summaries to be returned. Must be between 1 and 100, with a default of 10. |
pagination_starting_after_id | string | Optional | The object ID to use as a cursor to fetch the next page of the list for pagination. |
granularity_for_event_summaries | string | Optional | Specifies the granularity for event summaries: 'hour' or 'day'. If not set, returns a single summary for the time range. |
Requirements
Output
json— Response from the API endpoint 'GetBillingMetersIdEventSummaries'.StripeApi.GetBillingMeters
Retrieve a list of billing meters from Stripe.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
pagination_ending_before | string | Optional | An object ID cursor to fetch the previous page, used for pagination. |
fields_to_expand | array<string> | Optional | An array of strings specifying which fields in the response should be expanded. |
number_of_billing_meters | integer | Optional | Specify the number of billing meters to return, ranging from 1 to 100 (default is 10). |
pagination_starting_after_cursor | string | Optional | Cursor ID to define your starting point in the list for pagination. Use this to fetch the next page of results. |
filter_status | string | Optional | Filter results to include only billing meters with the specified status. Options are 'active' or 'inactive'. |
Requirements
Output
json— Response from the API endpoint 'GetBillingMeters'.StripeApi.GetBillingPortalConfigurations
Retrieve customer portal configurations from Stripe. Provides configurations that describe the functionality of the billing customer portal. Useful for understanding available setups and settings for customer management.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
pagination_cursor_ending_before | string | Optional | A cursor for pagination to get the previous page in the list, using an object ID. |
fields_to_expand | array<string> | Optional | List of fields in the response to be expanded. Each entry should be a string representing a field name. |
result_limit | integer | Optional | Specify the number of configurations to return, between 1 and 100. Default is 10. |
pagination_start_after_id | string | Optional | A cursor object ID used to fetch the next page of the list for pagination. |
only_active_configurations | boolean | Optional | Set to true to list only active configurations, or false to list inactive ones. |
return_default_configurations_only | boolean | Optional | Set to true to return only default configurations, or false to return non-default configurations. |
Requirements
Output
json— Response from the API endpoint 'GetBillingPortalConfigurations'.StripeApi.GetChargeDisputeDetails
Retrieve details of a dispute for a specific charge. Use this tool to fetch information about a dispute associated with a particular charge. This is helpful when you need to understand the dispute details for a specific transaction processed via Stripe.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
charge_id | string | Required | The unique identifier of the charge for which you want to retrieve dispute details. |
fields_to_expand_in_dispute_response | array<string> | Optional | List of fields to expand in the dispute response for additional details. |
Requirements
Output
json— Response from the API endpoint 'GetChargesChargeDispute'.StripeApi.GetChargeRefunds
Retrieve refunds for a specific charge on Stripe. This tool retrieves a list of refunds associated with a specific charge on Stripe. It provides access to more than the 10 most recent refunds by allowing pagination through the 'limit' and 'starting_after' parameters.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
charge_id | string | Required | The unique identifier of the charge for which to retrieve refunds. This ID is required to specify the particular charge. |
pagination_ending_before | string | Optional | Specify an object ID to fetch the previous page of refunds before this object. |
fields_to_expand | array<string> | Optional | List of fields to expand in the response for more detailed information. |
object_return_limit | integer | Optional | Specify the number of refunds to return, ranging from 1 to 100. Defaults to 10 if not set. |
pagination_starting_after | string | Optional | ID of the object to start retrieving the next page from. Used for pagination in refund lists. |
Requirements
Output
json— Response from the API endpoint 'GetChargesChargeRefunds'.StripeApi.GetCheckoutSessionLineItems
Fetch line items from a Stripe Checkout Session. Use this tool to retrieve line items associated with a specific Stripe Checkout Session, including a paginated list if required.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
checkout_session_id | string | Required | The unique identifier for the Stripe Checkout Session. This ID is required to retrieve associated line items. |
cursor_ending_before | string | Optional | An object ID used for pagination to retrieve the page before the specified object in the list. |
fields_to_expand | array<string> | Optional | A list of fields in the response that should be expanded for additional details. |
item_limit | integer | Optional | Sets the maximum number of line items to return, ranging from 1 to 100. Default is 10. |
pagination_starting_after | string | Optional | A string representing the object ID to start the list after, for pagination purposes. |
Requirements
Output
json— Response from the API endpoint 'GetCheckoutSessionsSessionLineItems'.StripeApi.GetClimateOrderDetails
Retrieve details of a specific Climate order. Use this tool to get information about a Climate order based on its ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
order_id | string | Required | Unique identifier for the Climate order to retrieve details. |
fields_to_expand | array<string> | Optional | A list of fields in the response that should be expanded for more detailed information. |
Requirements
Output
json— Response from the API endpoint 'GetClimateOrdersOrder'.StripeApi.GetConfirmationTokenInfo
Retrieves details of an existing confirmation token. This tool is used to retrieve information about a specific ConfirmationToken object in the Stripe system. It should be called when there is a need to obtain the details of a previously generated confirmation token.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
confirmation_token | string | Required | The unique identifier of the confirmation token to retrieve details for. This is required. |
fields_to_expand | array<string> | Optional | A list of fields to expand in the response for additional details. Each field should be specified as a string. |
Requirements
Output
json— Response from the API endpoint 'GetConfirmationTokensConfirmationToken'.StripeApi.GetCountrySpecifications
Retrieve country specifications using a country code. This tool is used to obtain the specifications for a specific country by providing its country code. It should be called when information related to the country's financial regulations, formats, or other specifications is needed.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
country_code | string | Required | The ISO 3166-1 alpha-2 country code for which you want to retrieve specifications. For example, 'US' for the United States. |
fields_to_expand | array<string> | Optional | A list of fields in the response to be expanded. Each field should be specified as a string. |
Requirements
Output
json— Response from the API endpoint 'GetCountrySpecsCountry'.StripeApi.GetCouponDetails
Retrieve details of a coupon by its ID. Use this tool to fetch information about a specific coupon available in your Stripe account, identified by its unique ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
coupon_id | string | Required | The unique identifier of the coupon to retrieve details. |
expanded_fields | array<string> | Optional | A list of fields in the response that should be expanded for additional details. |
Requirements
Output
json— Response from the API endpoint 'GetCouponsCoupon'.StripeApi.GetCreditBalanceTransaction
Retrieve a credit balance transaction by ID. Use this tool to obtain information about a specific credit balance transaction using its ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
transaction_id | string | Required | Unique identifier for the credit balance transaction to be retrieved. |
fields_to_expand | array<string> | Optional | An array of field names to expand in the response. Allows accessing nested information related to the transaction. |
Requirements
Output
json— Response from the API endpoint 'GetBillingCreditBalanceTransactionsId'.StripeApi.GetCreditBalanceTransactions
Retrieve a list of credit balance transactions. This tool calls the Stripe API endpoint to fetch credit balance transactions. It should be used to review or analyze credit activity associated with billing accounts.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
customer_id | string | Required | The unique identifier of the customer for which to fetch credit balance transactions. |
credit_grant_id | string | Optional | The identifier for the specific credit grant to fetch its credit balance transactions. |
pagination_ending_cursor | string | Optional | A pagination cursor ID to fetch the previous page of the list. Use an object ID to identify your position. |
fields_to_expand | array<string> | Optional | List of fields in the response that should be expanded for additional details. |
max_transactions_to_return | integer | Optional | Specify the maximum number of transactions to return, ranging between 1 and 100. The default is 10. |
pagination_starting_after | string | Optional | An object ID cursor to fetch the next page of credit balance transactions. |
Requirements
Output
json— Response from the API endpoint 'GetBillingCreditBalanceTransactions'.StripeApi.GetCreditReversalDetails
Retrieve details of a specific CreditReversal using its ID. Use this tool to fetch information about an existing CreditReversal by providing its unique ID. Ideal for confirming details or reviewing the status of a CreditReversal transaction.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
credit_reversal_id | string | Required | The unique ID of the CreditReversal to retrieve details for. This ID is obtained from the CreditReversal creation request or list. |
fields_to_expand | array<string> | Optional | A list of fields in the response that should be expanded for more detailed information. |
Requirements
Output
json— Response from the API endpoint 'GetTreasuryCreditReversalsCreditReversal'.StripeApi.GetCreditReversals
Retrieve a list of Credit Reversals from Stripe's Treasury. This tool fetches a list of Credit Reversals from Stripe's Treasury endpoint. It should be used when detailed information about credit reversals is needed.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
financial_account_id | string | Required | The ID of the FinancialAccount associated with the CreditReversals to be returned. |
pagination_ending_before | string | Optional | A cursor object ID for pagination to fetch the previous list page. |
fields_to_expand | array<string> | Optional | A list of fields to be expanded in the response for detailed information. |
max_objects_returned | integer | Optional | Sets the maximum number of credit reversals to be returned. Valid range is 1 to 100, defaulting to 10. |
filter_by_received_credit_id | string | Optional | Filter Credit Reversals to only include those associated with the specified ReceivedCredit ID. |
pagination_starting_after_cursor | string | Optional | An object ID used to fetch the next page of the list in a paginated response. |
credit_reversal_status | string | Optional | Filter CreditReversals based on their status. Possible values are: canceled, posted, processing. |
Requirements
Output
json— Response from the API endpoint 'GetTreasuryCreditReversals'.StripeApi.GetCurrentAccountBalance
Retrieve the current account balance from Stripe. Use this tool to get the current account balance based on the authentication used. It's helpful for accessing up-to-date financial data from the Stripe account.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
fields_to_expand | array<string> | Optional | List of fields to expand in the response for additional details. |
Requirements
Output
json— Response from the API endpoint 'GetBalance'.StripeApi.GetCustomerBalanceTransaction
Retrieve a specific customer balance transaction from Stripe. This tool retrieves details about a specific balance transaction that impacted a customer's balance in Stripe.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
customer_id | string | Required | The unique identifier for the customer. This is required to retrieve the specific balance transaction. |
transaction_id | string | Required | The unique identifier for the customer balance transaction to retrieve. |
fields_to_expand | array<string> | Optional | A list of fields to expand in the response for additional details. |
Requirements
Output
json— Response from the API endpoint 'GetCustomersCustomerBalanceTransactionsTransaction'.StripeApi.GetCustomerBalanceTransactions
Retrieve a customer's balance transaction updates. Fetches a list of transactions that have updated a customer's balance within Stripe.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
customer_id | string | Required | The unique identifier of the customer. This ID is used to retrieve balance transaction updates for that specific customer. |
pagination_ending_before_cursor | string | Optional | A cursor ID used to fetch the previous page of balance transactions in pagination. |
fields_to_expand | array<string> | Optional | A list of fields in the response that should be expanded. |
result_limit | integer | Optional | Sets the maximum number of balance transactions to retrieve, ranging from 1 to 100. Default is 10. |
pagination_starting_after_cursor | string | Optional | A cursor for pagination. Use the object ID from the last received page to fetch the next page. |
Requirements
Output
json— Response from the API endpoint 'GetCustomersCustomerBalanceTransactions'.StripeApi.GetCustomerBankAccountDetails
Retrieve details of a customer's bank account from Stripe. Use this tool to get specific details about a bank account associated with a Stripe customer. It helps when you need information beyond the most recent sources shown by default.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
customer_id | string | Required | The unique identifier for the Stripe customer whose bank account details are being retrieved. |
bank_account_id | string | Required | The unique identifier for the specific bank account associated with the Stripe customer. |
fields_to_expand | array<string> | Optional | List of fields in the response to expand for detailed information. |
Requirements
Output
json— Response from the API endpoint 'GetCustomersCustomerBankAccountsId'.StripeApi.GetCustomerBankAccounts
Retrieve bank accounts for a specific customer. Call this tool to obtain a list of bank accounts associated with a particular customer. Useful for viewing more than the 10 most recent bank accounts when paginating.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
customer_id | string | Required | The unique identifier of the customer whose bank accounts you want to retrieve. This ID is required to access the bank account details associated with a specific customer. |
pagination_ending_before | string | Optional | An object ID used as a cursor to fetch the previous page of bank accounts in a paginated list. |
fields_to_expand | array<string> | Optional | List of fields to expand in the response. Specify which aspects of the response should be expanded for detailed information. |
result_limit | integer | Optional | The maximum number of bank accounts to return, ranging from 1 to 100. Defaults to 10 if not specified. |
pagination_cursor_starting_after | string | Optional | A string specifying the object ID to define your place in the list for pagination. Use this to fetch the next page of bank accounts. |
Requirements
Output
json— Response from the API endpoint 'GetCustomersCustomerBankAccounts'.StripeApi.GetCustomerCardDetails
Retrieve details about a specific card for a customer. This tool retrieves information about a specific card associated with a customer, allowing you to access details beyond the most recent 10 cards available directly on the customer object.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
customer_id | string | Required | The unique identifier for the customer whose card details are being retrieved. This is required to specify which customer's card information you want to access. |
card_id | string | Required | The unique identifier of the card to retrieve details for. This is specific to the card associated with the customer. |
fields_to_expand | array<string> | Optional | A list of fields in the response that should be expanded for more detailed information. |
Requirements
Output
json— Response from the API endpoint 'GetCustomersCustomerCardsId'.StripeApi.GetCustomerCards
Retrieve a list of cards belonging to a customer. Use this tool to access a list of cards for a specific customer in the Stripe system. This is useful when more than the 10 most recent card sources are needed.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
customer_id | string | Required | The unique identifier for the customer whose cards are to be retrieved. This ID is required to obtain the card list. |
pagination_ending_before | string | Optional | Object ID to define the cursor's place in pagination, used to fetch the previous page of the card list. |
fields_to_expand | array<string> | Optional | List of fields in the response to be expanded for additional details. |
card_retrieval_limit | integer | Optional | Specify the maximum number of cards to retrieve. The limit must be between 1 and 100, with a default of 10 if not specified. |
pagination_starting_after_cursor | string | Optional | An object ID indicating the position to start fetching the next page of the card list. Use this for pagination. |
Requirements
Output
json— Response from the API endpoint 'GetCustomersCustomerCards'.StripeApi.GetCustomerCashBalance
Retrieve a customer's cash balance on Stripe. This tool retrieves the cash balance of a specific customer from Stripe. It should be called when there's a need to check the available balance for a customer account.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
customer_id | string | Required | The unique identifier of the customer whose cash balance is being retrieved. This ID is used to specify which customer's balance should be returned. |
fields_to_expand | array<string> | Optional | An array of strings specifying which fields in the response should be expanded for additional details. |
Requirements
Output
json— Response from the API endpoint 'GetCustomersCustomerCashBalance'.StripeApi.GetCustomerCashBalanceTransactions
Retrieve transactions modifying a customer's cash balance. This tool returns a list of transactions that have modified a customer's cash balance. Use this to track financial changes in a customer's account.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
customer_id | string | Required | The unique identifier of the customer whose cash balance transactions are to be retrieved. This ID is required for the API call. |
pagination_cursor_ending_before | string | Optional | A string representing the ID used for pagination to fetch the previous page of transactions. |
expand_fields | array<string> | Optional | List of fields to expand in the response for detailed information. |
transaction_limit | integer | Optional | The number of transactions to return, between 1 and 100. Default is 10. |
pagination_starting_after_cursor | string | Optional | Object ID cursor for pagination to continue listing transactions after a specified object. |
Requirements
Output
json— Response from the API endpoint 'GetCustomersCustomerCashBalanceTransactions'.StripeApi.GetCustomerPaymentMethod
Retrieve a customer's specific payment method. This tool retrieves detailed information about a specific PaymentMethod linked to a given customer. It should be called when there is a need to access or verify details of a particular payment method for a customer in Stripe.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
customer_id | string | Required | The unique identifier for the customer whose payment method information is being retrieved. This ID should be a string matching the customer's record in Stripe. |
payment_method_id | string | Required | The unique identifier for the payment method to retrieve for the customer. |
fields_to_expand | array<string> | Optional | List of fields in the payment method response that should be expanded for more details. |
Requirements
Output
json— Response from the API endpoint 'GetCustomersCustomerPaymentMethodsPaymentMethod'.StripeApi.GetCustomerPaymentMethods
Retrieve payment methods for a specific customer. This tool should be called to obtain a list of payment methods associated with a particular customer in Stripe.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
customer_id | string | Required | Unique identifier for the customer whose payment methods are to be retrieved. |
enable_redisplay_setting | string | Optional | Indicates if the payment method can be shown again in a checkout flow. Options: 'always', 'limited', 'unspecified'. |
pagination_ending_before_id | string | Optional | An object ID used to paginate backwards by defining the end of the list. |
response_fields_to_expand | array<string> | Optional | A list of fields to expand in the response for detailed information. |
max_payment_methods_returned | integer | Optional | Limit the number of payment methods returned. Accepts a value between 1 and 100, with a default of 10. |
pagination_starting_after_cursor | string | Optional | Cursor for pagination that defines the start point in the list. Use the ID of the last object from the previous page. |
payment_method_type_filter | string | Optional | Specify a payment method type to filter the list. Without filtering, all types are included. Choose from options like 'card', 'paypal', etc. |
Requirements
Output
json— Response from the API endpoint 'GetCustomersCustomerPaymentMethods'.StripeApi.GetCustomerPortalConfiguration
Retrieve customer portal configuration details. Fetches the configuration that outlines the functionality of the billing portal for a specific customer.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
configuration_id | string | Required | The unique identifier for the customer portal configuration to retrieve. |
expand_fields_in_response | array<string> | Optional | A list of field names in the response that should be expanded for more detailed information. |
Requirements
Output
json— Response from the API endpoint 'GetBillingPortalConfigurationsConfiguration'.StripeApi.GetCustomerSubscriptions
Retrieve a customer's active subscriptions. Use this tool to obtain a list of active subscriptions for a specific customer. Useful for viewing subscription details beyond the default 10 most recent active subscriptions available on the customer object.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
customer_id | string | Required | The unique identifier for the customer whose subscriptions are being retrieved. |
pagination_ending_before_cursor | string | Optional | An object ID to define your position in pagination. Use this cursor to fetch the previous page of subscriptions. |
fields_to_expand | array<string> | Optional | A list of fields in the response that should be expanded for additional details. |
subscription_limit | integer | Optional | The maximum number of subscription objects to return. Must be between 1 and 100, defaulting to 10. |
pagination_starting_after_object_id | string | Optional | An object ID used as a cursor to fetch the next page of subscriptions in a paginated list. |
Requirements
Output
json— Response from the API endpoint 'GetCustomersCustomerSubscriptions'.StripeApi.GetCustomerTaxId
Retrieve a specific customer's tax ID information. This tool retrieves the tax ID object for a specified customer using the given tax ID identifier.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
customer_identifier | string | Required | The unique identifier of the customer whose tax ID is to be retrieved. |
tax_id_identifier | string | Required | The unique identifier of the customer's tax ID to be retrieved. |
expand_response_fields | array<string> | Optional | A list of field names in the response that should be expanded for more detailed information. |
Requirements
Output
json— Response from the API endpoint 'GetCustomersCustomerTaxIdsId'.StripeApi.GetCustomerTaxIds
Retrieve a customer's tax IDs from their profile. Call this tool to get a list of all tax IDs associated with a specific customer. It gathers the tax identification numbers stored in a customer's account on Stripe.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
customer_id | string | Required | The ID of the customer for whom the tax IDs are being retrieved. This is a required field. |
pagination_ending_before | string | Optional | Cursor object ID to fetch the previous page in a paginated list. Use the ID from the starting object of the current list. |
expand_fields | array<string> | Optional | A list of fields in the response that should be expanded. Provide field names as strings. |
max_number_of_tax_ids | integer | Optional | Specify the maximum number of tax IDs to return. Accepts an integer between 1 and 100, with a default value of 10. |
pagination_starting_after | string | Optional | An object ID from the current list to continue fetching the next page in pagination. |
Requirements
Output
json— Response from the API endpoint 'GetCustomersCustomerTaxIds'.StripeApi.GetDebitReversalsList
Retrieves a list of debit reversals from Stripe. Use this tool to obtain a list of debit reversals from the Stripe Treasury API, which provides details on reversed debit transactions.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
financial_account_id | string | Required | The ID of the FinancialAccount to retrieve associated debit reversals. |
pagination_ending_before_cursor | string | Optional | A cursor object ID for pagination. Use this to fetch the previous page of the list. |
fields_to_expand | array<string> | Optional | A list of fields in the response to expand for obtaining additional nested information. |
max_number_of_debit_reversals | integer | Optional | The maximum number of debit reversals to return. Must be between 1 and 100. Defaults to 10 if not specified. |
filter_by_received_debit_id | string | Optional | The ID of the ReceivedDebit to filter debit reversals by. Only returns reversals for this specific ID. |
resolution_status | string | Optional | Filter DebitReversals based on the resolution ('lost' or 'won'). |
pagination_starting_after_cursor | string | Optional | An object ID that serves as a pagination cursor for fetching the next page of results. |
filter_by_status | string | Optional | Specify the status of DebitReversals to return. Options are: 'canceled', 'completed', or 'processing'. |
Requirements
Output
json— Response from the API endpoint 'GetTreasuryDebitReversals'.StripeApi.GetDeprecatedExchangeRates
Retrieves deprecated exchange rates for a given currency. This tool fetches exchange rates from one currency to all supported currencies using the deprecated Exchange Rate API from Stripe. Use this only if the newer FX Quotes API is not suitable for your needs.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
currency_rate_id | string | Required | The currency code (e.g., 'USD') to retrieve exchange rates for. Use the deprecated Exchange Rate API responsibly. |
expand_fields | array<string> | Optional | List of fields to be expanded in the response. Each field is specified as a string. |
Requirements
Output
json— Response from the API endpoint 'GetExchangeRatesRateId'.StripeApi.GetExchangeRates
Retrieve Stripe's supported foreign currency exchange rates. Fetches current exchange rates for foreign currencies supported by Stripe. Note: This API is deprecated; consider using the FX Quotes API instead.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
pagination_ending_before_currency | string | Optional | The currency code to define your position for fetching the previous page in the exchange rate list. |
response_fields_to_expand | array<string> | Optional | List of fields in the response to be expanded for detailed information. |
result_limit | integer | Optional | Set the maximum number of exchange rate objects to return, ranging from 1 up to the maximum number supported by Stripe. |
pagination_starting_currency | string | Optional | The currency code to define the starting point in the paginated list of exchange rates. |
Requirements
Output
json— Response from the API endpoint 'GetExchangeRates'.StripeApi.GetExternalBankAccountDetails
Retrieve details of a specific external bank account for an account. Use this tool to obtain details of a specified external bank account associated with a given account using its ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
account_id | string | Required | The unique identifier for the account associated with the external bank account. |
external_account_id | string | Required | Unique identifier for the external bank account to retrieve its details. |
fields_to_expand | array<string> | Optional | List of fields in the response to expand for additional detail. |
Requirements
Output
json— Response from the API endpoint 'GetAccountsAccountBankAccountsId'.StripeApi.GetFileDetails
Retrieve details of an existing file object from Stripe. Fetches the details of a file object using its unique file ID on Stripe. Useful for accessing metadata and information about uploaded files.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
file_id | string | Required | The unique identifier for the file object whose details you want to retrieve. |
fields_to_expand | array<string> | Optional | A list of fields in the response that should be expanded for additional details. |
Requirements
Output
json— Response from the API endpoint 'GetFilesFile'.StripeApi.GetFinancialAccountDetails
Retrieve details of a specific financial account. Use this tool to obtain comprehensive information about a specific financial account using its identifier.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
financial_account_id | string | Required | The unique identifier of the financial account to be retrieved. This ID is required to fetch the account details. |
fields_to_expand | array<string> | Optional | A list of strings specifying which fields in the financial account details should be expanded in the response. |
Requirements
Output
json— Response from the API endpoint 'GetTreasuryFinancialAccountsFinancialAccount'.StripeApi.GetFinancialAccountFeatures
Retrieve features of a financial account. This tool retrieves information about the features associated with a specified financial account in Stripe's treasury service. Use it to get detailed features of a financial account when needed.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
financial_account_id | string | Required | The ID of the financial account for which to retrieve feature information. This is required. |
expand_response_fields | array<string> | Optional | A list of fields in the response that should be expanded for more detailed information. |
Requirements
Output
json— Response from the API endpoint 'GetTreasuryFinancialAccountsFinancialAccountFeatures'.StripeApi.GetFinancialAccountOwners
Retrieve owners of a specified financial account. This tool is used to list all the owners of a given financial account. It is essential when you need to verify or display the ownership details of an account.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
ownership_object_id | string | Required | The ID of the ownership object from which to fetch the account owners. |
account_id | string | Required | The unique identifier of the financial account to retrieve its owners. |
pagination_cursor_ending_before | string | Optional | An ID to fetch the previous page in pagination, defining your place in the list. |
fields_to_expand | array<string> | Optional | A list of field names in the response to be expanded, specified as an array of strings. |
object_limit | integer | Optional | Specifies the maximum number of account owners to return, ranging from 1 to 100, with a default of 10. |
pagination_starting_after_cursor | string | Optional | A cursor indicating the starting point for pagination in a list. Use the object ID from the previous response to fetch the next page. |
Requirements
Output
json— Response from the API endpoint 'GetFinancialConnectionsAccountsAccountOwners'.StripeApi.GetFinancialConnectionsAccountDetails
Retrieve details of a Financial Connections Account. Call this tool to get detailed information about a specific Financial Connections Account using the account identifier.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
financial_account_identifier | string | Required | The unique identifier for the Financial Connections Account to retrieve details for. |
fields_to_expand | array<string> | Optional | List of fields in the response to be expanded for additional details. |
Requirements
Output
json— Response from the API endpoint 'GetFinancialConnectionsAccountsAccount'.StripeApi.GetFinancialTransactionDetails
Retrieve details of a specific financial transaction. This tool fetches details for a specific Financial Connections transaction, useful for accessing transaction information.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
transaction_id | string | Required | The unique identifier of the financial transaction to retrieve details for. |
fields_to_expand | array<string> | Optional | List of fields to expand in the response to show additional details. |
Requirements
Output
json— Response from the API endpoint 'GetFinancialConnectionsTransactionsTransaction'.StripeApi.GetInboundTransfers
Retrieve inbound transfers for a financial account. This tool fetches a list of inbound transfers sent from a specified financial account using Stripe's treasury services.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
financial_account_id | string | Required | The ID of the FinancialAccount to retrieve associated inbound transfers. |
pagination_ending_before_id | string | Optional | The object ID defining your place in the list to fetch the previous page. Use this for pagination. |
expand_response_fields | array<string> | Optional | List of fields in the response to be expanded for detailed information. |
transfer_limit | integer | Optional | Set the maximum number of inbound transfer objects to return, ranging from 1 to 100. Default is 10. |
pagination_starting_after_object_id | string | Optional | Cursor for pagination to fetch the next page by using the object ID from the end of the previous result set. |
filter_by_transfer_status | string | Optional | Filter inbound transfers by their status: 'processing', 'succeeded', 'failed', or 'canceled'. |
Requirements
Output
json— Response from the API endpoint 'GetTreasuryInboundTransfers'.StripeApi.GetInvoiceItemDetails
Retrieve details of a specific invoice item by ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
invoice_item_id | string | Required | The ID of the invoice item to retrieve details for. |
fields_to_expand | array<string> | Optional | List of fields in the response to expand for more detailed information. |
Requirements
Output
json— Response from the API endpoint 'GetInvoiceitemsInvoiceitem'.StripeApi.GetInvoiceLineItems
Fetch line items from a specific invoice. Use this tool to get the line items and their total count from a specific invoice. This is useful when you need detailed information about the charges in an invoice.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
invoice_id | string | Required | The unique identifier for the invoice to retrieve line items from. Provide this ID to specify which invoice's line items you want to access. |
pagination_ending_before_cursor | string | Optional | A cursor ID to fetch the previous page of line items in the invoice list. |
fields_to_expand | array<string> | Optional | List the fields in the invoice line items response that should be expanded for more details. |
max_line_items_to_return | integer | Optional | The maximum number of line items to return. It can range from 1 to 100, with a default of 10. |
pagination_start_after | string | Optional | An object ID defining your place in the list for pagination, used to fetch the next page of invoice line items. |
Requirements
Output
json— Response from the API endpoint 'GetInvoicesInvoiceLines'.StripeApi.GetInvoiceRenderingTemplates
Retrieve all invoice rendering templates by creation date. This tool fetches a list of all invoice rendering templates, organized by creation date with the latest ones first. Use it to access and manage invoice templates efficiently.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
pagination_ending_before | string | Optional | A pagination cursor indicating the object ID to end before when listing templates. Use this to fetch the previous page. |
fields_to_expand | array<string> | Optional | A list of fields in the response that should be expanded for more detailed information. |
result_limit | integer | Optional | Specify the maximum number of invoice rendering templates to return, ranging from 1 to 100. Defaults to 10. |
pagination_starting_after | string | Optional | Object ID defining your place in the list to fetch the next page. |
template_status | string | Optional | Filter templates by their status: 'active' or 'archived'. |
Requirements
Output
json— Response from the API endpoint 'GetInvoiceRenderingTemplates'.StripeApi.GetIssuingCardDetails
Retrieve details of a specific issuing card. Use this tool to get detailed information about an Issuing Card object from Stripe. It should be called when you need to fetch the details of a specific card.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
card_id | string | Required | The unique identifier of the issuing card you want to retrieve details for. This is required. |
fields_to_expand | array<string> | Optional | An array of fields to expand in the response for additional details. |
Requirements
Output
json— Response from the API endpoint 'GetIssuingCardsCard'.StripeApi.GetIssuingTokenInfo
Retrieve details of an Issuing Token. Use this tool to obtain information about a specific Issuing Token from Stripe.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
issuing_token_id | string | Required | The unique identifier of the Issuing Token to retrieve information for. This is required to specify which token's details are needed from Stripe. |
fields_to_expand | array<string> | Optional | A list of fields in the response to be expanded for detailed information. |
Requirements
Output
json— Response from the API endpoint 'GetIssuingTokensToken'.StripeApi.GetLatestPhysicalBundles
Retrieve the latest physical bundle objects from Stripe. This tool fetches a list of physical bundle objects from Stripe, sorted by creation date with the newest first. It's useful for obtaining the most recent physical bundles.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
pagination_end_before_id | string | Optional | An object ID used for pagination to fetch the previous page of the list. |
fields_to_expand | array<string> | Optional | List of response fields to expand for more detailed information. |
number_of_bundles_limit | integer | Optional | Specify the maximum number of physical bundle objects to return, ranging from 1 to 100. Default is 10. |
pagination_starting_after_id | string | Optional | Provide the object ID to continue pagination from the next item after it in the list. |
filter_status | string | Optional | Filter physical bundles by status. Options include 'active', 'inactive', or 'review'. |
filter_by_bundle_type | string | Optional | Specify the type of physical bundles to return. Options are 'custom' or 'standard'. |
Requirements
Output
json— Response from the API endpoint 'GetIssuingPhysicalBundles'.StripeApi.GetLinkedAccountDetails
Retrieve details of a financial connections account. Use this tool to get detailed information about a specific financial connections account linked with Stripe. It should be called when account information is needed.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
account_id | string | Required | The unique identifier for the financial connections account to retrieve details for. |
expand_fields | array<string> | Optional | List of fields in the response to be expanded for more detailed information. |
Requirements
Output
json— Response from the API endpoint 'GetLinkedAccountsAccount'.StripeApi.GetLinkedAccountOwners
Retrieve owners of a specific linked account. Use this tool to list all the owners associated with a specific account. This can be helpful for verifying account ownership or managing account permissions.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
ownership_object_id | string | Required | The unique ID of the ownership object to retrieve owners from. This is required to specify which account's owners to list. |
linked_account_id | string | Required | The unique identifier of the account to retrieve owners for. This is required to specify which account's owners you want to list. |
pagination_ending_before | string | Optional | Cursor ID for pagination to fetch the previous page. Use the object ID from the start of the current list result. |
expanded_fields | array<string> | Optional | List of fields to be expanded in the response. Specify field names to include more data in the response. |
number_of_owners_to_return | integer | Optional | Specify the number of account owners to retrieve, ranging from 1 to 100. Default is 10. |
pagination_starting_after | string | Optional | Cursor for pagination to specify the starting point for the next page of results using an object ID. |
Requirements
Output
json— Response from the API endpoint 'GetLinkedAccountsAccountOwners'.StripeApi.GetOutboundTransferDetails
Retrieve details of a specific outbound transfer. Use this tool to get the details of an existing OutboundTransfer by providing the unique OutboundTransfer ID. It helps in tracking and managing outbound transfers.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
outbound_transfer_id | string | Required | The unique identifier for the outbound transfer to retrieve details for. |
fields_to_expand | array<string> | Optional | A list of fields in the response to be expanded for more details. |
Requirements
Output
json— Response from the API endpoint 'GetTreasuryOutboundTransfersOutboundTransfer'.StripeApi.GetOutboundTransfers
Retrieve outbound transfers from a financial account. This tool returns a list of outbound transfers sent from a specified financial account using Stripe's Treasury API.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
financial_account_id | string | Required | The ID of the financial account to retrieve outbound transfers from. |
pagination_cursor_ending_before | string | Optional | Cursor for pagination to fetch the previous page of the outbound transfers list using an object ID. |
fields_to_expand | array<string> | Optional | List of fields in the response to be expanded. Provide field names as strings. |
limit_transfers | integer | Optional | The number of outbound transfers to return. Valid range is 1 to 100, default is 10. |
pagination_starting_after | string | Optional | A cursor for pagination to fetch the next page of the list, using an object ID from a previous request. |
outbound_transfer_status_filter | string | Optional | Filter outbound transfers by status, such as 'processing', 'canceled', 'failed', 'posted', or 'returned'. |
Requirements
Output
json— Response from the API endpoint 'GetTreasuryOutboundTransfers'.StripeApi.GetPaymentLinkLineItems
Retrieve the line items for a specific payment link. Use this tool to get the line items associated with a specific payment link from Stripe. It provides the initial set of line items and a URL for the full list if needed.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
payment_link_id | string | Required | The unique identifier for the payment link whose line items need to be retrieved. |
pagination_ending_before | string | Optional | An object ID that serves as a pagination cursor to fetch the previous page of the list. |
fields_to_expand | array<string> | Optional | A list of fields in the response that should be expanded for more detailed information. |
item_limit | integer | Optional | Specifies the maximum number of line items to retrieve, ranging from 1 to 100. Default is 10. |
pagination_starting_after | string | Optional | An object ID used as a cursor to fetch the next page of the list when paginating. Use the ID of the last object from the previous response. |
Requirements
Output
json— Response from the API endpoint 'GetPaymentLinksPaymentLinkLineItems'.StripeApi.GetPaymentMethodDomainDetails
Retrieve details of a specific payment method domain. This tool fetches information about a specified payment method domain. It should be called when details about an existing payment method domain are needed.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
payment_method_domain_id | string | Required | The unique identifier of the payment method domain to retrieve details for. |
fields_to_expand | array<string> | Optional | A list of fields in the response that should be expanded for additional details. |
Requirements
Output
json— Response from the API endpoint 'GetPaymentMethodDomainsPaymentMethodDomain'.StripeApi.GetProductDetails
Retrieve details of a specific product by ID. Use this tool to get information about an existing product by providing its unique ID. This is useful for accessing product details from Stripe's catalog.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
product_id | string | Required | The unique identifier for the product to retrieve details. Obtainable from product creation requests or product lists. |
fields_to_expand | array<string> | Optional | List of fields in the response to be expanded for more detailed information. |
Requirements
Output
json— Response from the API endpoint 'GetProductsId'.StripeApi.GetProductFeatureDetails
Retrieve details of a feature attached to a product. Use this tool to obtain information about a specific feature associated with a product by providing the product and feature IDs.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
product_feature_id | string | Required | The unique identifier of the product feature to retrieve details for. |
product_id | string | Required | The unique identifier of the product associated with the feature. |
fields_to_expand | array<string> | Optional | A list of fields in the response to expand for detailed information. |
Requirements
Output
json— Response from the API endpoint 'GetProductsProductFeaturesId'.StripeApi.GetProductFeatures
Retrieve features for a specific product. Use this tool to obtain a list of features associated with a given product in Stripe. Ideal for when you need detailed information about a product's capabilities or offerings.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
product_id | string | Required | The unique identifier of the product for which you want to retrieve features. This is a required field. |
pagination_ending_cursor | string | Optional | An object ID that defines your position in the list for pagination, used to fetch the previous page. |
fields_to_expand | array<string> | Optional | A list of fields in the response that should be expanded for additional details. |
number_of_features_to_return | integer | Optional | Specifies the number of product features to return. Must be between 1 and 100, with a default of 10. |
pagination_starting_after_cursor | string | Optional | Cursor for pagination to fetch the next page of product features. Use the object ID from the last item on the previous page. |
Requirements
Output
json— Response from the API endpoint 'GetProductsProductFeatures'.StripeApi.GetPromotionCodeDetails
Retrieve details of a specific promotion code. This tool retrieves information about a promotion code using its ID. It can be used to access details such as discount amounts, expiration dates, and other relevant data tied to the specific promotion code.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
promotion_code_id | string | Required | The unique identifier of the promotion code to retrieve details for. |
fields_to_expand | array<string> | Optional | A list of fields in the response to be expanded. Provide field names as strings. |
Requirements
Output
json— Response from the API endpoint 'GetPromotionCodesPromotionCode'.StripeApi.GetQuoteLineItems
Fetch line items from a specified quote. Use this tool to retrieve a list of line items associated with a specific quote. This includes both a summary of the first few items and a URL for accessing the complete, paginated list.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
quote_identifier | string | Required | The unique identifier of the quote whose line items are to be retrieved. |
pagination_cursor_ending_before | string | Optional | The object ID to define your place in the list for fetching the previous page. |
fields_to_expand | array<string> | Optional | List of field names to expand in the response for detailed information. |
max_items_to_return | integer | Optional | Specifies the maximum number of line items to return, ranging from 1 to 100. Defaults to 10 if not specified. |
pagination_starting_after_cursor | string | Optional | The object ID to define your place in the list for pagination, used to fetch the next page after the specified object. |
Requirements
Output
json— Response from the API endpoint 'GetQuotesQuoteLineItems'.StripeApi.GetReceivedCreditDetails
Retrieve details of a specific ReceivedCredit by ID. This tool is used to obtain details about a specific ReceivedCredit in the Stripe Treasury. It requires the unique ReceivedCredit ID to fetch the information.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
received_credit_id | string | Required | The unique identifier of the ReceivedCredit to retrieve details for. This ID is required to fetch the specific credit's information. |
fields_to_expand | array<string> | Optional | A list of fields in the response to expand for additional details. |
Requirements
Output
json— Response from the API endpoint 'GetTreasuryReceivedCreditsId'.StripeApi.GetReceivedDebits
Retrieve a list of received debits from Stripe Treasury. Call this tool to obtain a list of received debits, which can be useful for financial reporting or auditing purposes.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
financial_account_id | string | Required | The ID of the FinancialAccount from which funds were pulled. |
pagination_cursor_previous_page | string | Optional | A cursor for pagination to fetch the previous page of the list. Use an object ID received in a previous response. |
expand_fields | array<string> | Optional | List of fields in the response to expand for more detailed information. |
max_number_of_debits | integer | Optional | Specify the maximum number of received debits to return. Accepts an integer between 1 and 100, default is 10. |
pagination_starting_after | string | Optional | An object ID for pagination to fetch the next page, starting after this ID. |
debit_status_filter | string | Optional | Filter results by status: 'succeeded' or 'failed'. |
Requirements
Output
json— Response from the API endpoint 'GetTreasuryReceivedDebits'.StripeApi.GetReportRunDetails
Retrieve details of an existing report run. Use this tool to obtain specific information about a previously created report run in Stripe's reporting system.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
report_run_id | string | Required | The unique identifier for the report run you want to retrieve details for. This ID is provided by Stripe when the report run is created. |
fields_to_expand | array<string> | Optional | List of fields to expand in the response to include more detailed information. |
Requirements
Output
json— Response from the API endpoint 'GetReportingReportRunsReportRun'.StripeApi.GetReviewDetails
Retrieve details of a specific review on Stripe. This tool fetches the details of a particular review from Stripe, using the review's unique identifier.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
review_identifier | string | Required | The unique identifier of the review to be retrieved from Stripe. This is a required parameter. |
expand_fields | array<string> | Optional | List of fields in the review response to be expanded for detailed information. |
Requirements
Output
json— Response from the API endpoint 'GetReviewsReview'.StripeApi.GetScheduledQueryRuns
Retrieve a list of scheduled query runs from Stripe. Use this tool to get information on scheduled query runs managed by Stripe's Sigma service. It retrieves a list of all the scheduled query runs that have occurred.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
pagination_cursor_ending_before | string | Optional | A cursor object ID for pagination to fetch the previous page of the list. |
fields_to_expand | array<string> | Optional | A list of fields in the response that should be expanded. |
object_limit | integer | Optional | Specify the number of objects to return, between 1 and 100. Default is 10. |
pagination_starting_after | string | Optional | Cursor for pagination, to fetch the next page starting after the specified object ID. |
Requirements
Output
json— Response from the API endpoint 'GetSigmaScheduledQueryRuns'.StripeApi.GetSourceTransactions
Retrieve transactions for a specific source. Use this tool to list all transactions associated with a specific source in Stripe. It should be called when transaction details for a given source are needed.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
source_id | string | Required | The unique identifier of the source to retrieve transactions for. Required to specify the target of the retrieval. |
pagination_ending_before | string | Optional | An object ID for pagination to fetch the previous page of the list. Use the ID of the first object from the current list. |
fields_to_expand | array<string> | Optional | A list of field names in the response that should be expanded for detailed information. |
transaction_limit | integer | Optional | Maximum number of transactions to return. Must be between 1 and 100, default is 10. |
pagination_starting_after | string | Optional | An object ID used as a cursor to fetch the next page of the list. Use this to continue listing transactions after a known last object ID. |
Requirements
Output
json— Response from the API endpoint 'GetSourcesSourceSourceTransactions'.StripeApi.GetSpecificTransferReversalDetails
Retrieve details about a specific transfer reversal. This tool retrieves details of a specific reversal associated with a transfer. Use it to access more than the 10 most recent reversals or to obtain specific information about a particular reversal.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
reversal_id | string | Required | The unique identifier of the transfer reversal to retrieve details for. |
transfer_id | string | Required | The unique identifier for the transfer to retrieve reversal details from. This is required to specify which transfer you're inquiring about. |
expand_fields | array<string> | Optional | List of fields in the response to be expanded for detailed information. |
Requirements
Output
json— Response from the API endpoint 'GetTransfersTransferReversalsId'.StripeApi.GetStripeAccountDetails
Retrieve details of a Stripe account. Use this tool to get information about a specific Stripe account, such as its status and settings.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
expand_fields | array<string> | Optional | A list of fields to specify which fields in the Stripe account response should be expanded. |
Requirements
Output
json— Response from the API endpoint 'GetAccount'.StripeApi.GetStripeEntitlementFeatures
Retrieve a list of entitlement features from Stripe. Call this tool to obtain a list of features related to entitlements from Stripe's API.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
pagination_ending_before | string | Optional | Cursor for pagination defining the position in list. Use to fetch previous page by providing object ID. |
fields_to_expand | array<string> | Optional | List of fields in the response to be expanded. |
object_return_limit | integer | Optional | Specify the number of features to return, ranging between 1 and 100. Defaults to 10 if not provided. |
filter_by_lookup_key | string | Optional | Filter results to only include features with the specified lookup key. |
pagination_starting_after | string | Optional | A cursor for pagination. Use the object ID from the last item of your current list to fetch the next page. |
include_archived_features | boolean | Optional | Set to true to include only archived features, or false to exclude them. |
Requirements
Output
json— Response from the API endpoint 'GetEntitlementsFeatures'.StripeApi.GetStripeExternalAccountDetails
Retrieve details of a specific Stripe external account. This tool fetches information about a specified external account for a given Stripe account. It should be used to obtain details about linked bank accounts or cards associated with a Stripe account.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
stripe_account_id | string | Required | The unique identifier for the Stripe account containing the external account. |
external_account_id | string | Required | Unique identifier for the external account to be retrieved from Stripe. |
fields_to_expand | array<string> | Optional | List of fields to expand in the response for additional details. |
Requirements
Output
json— Response from the API endpoint 'GetAccountsAccountExternalAccountsId'.StripeApi.GetStripePaymentLinks
Retrieve a list of Stripe payment links. This tool calls the Stripe API to fetch a list of all your payment links. It should be used when you need to access or display your payment links managed through Stripe.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
pagination_ending_before | string | Optional | An object ID cursor to define the starting point in the list for pagination, retrieving the previous page. |
fields_to_expand | array<string> | Optional | List of fields in the response that should be expanded. Use field names as strings. |
object_return_limit | integer | Optional | Specifies the maximum number of payment link objects to retrieve, ranging from 1 to 100. Default is 10. |
pagination_starting_after_cursor | string | Optional | The object ID to define your place in the list for pagination. Use it to fetch the next page of payment links. |
include_active_payment_links | boolean | Optional | Return active payment links only. Set to `false` to list inactive payment links. |
Requirements
Output
json— Response from the API endpoint 'GetPaymentLinks'.StripeApi.GetStripePayoutDetails
Retrieve details of a specific Stripe payout. This tool retrieves information about an existing payout from Stripe using the unique payout ID. It should be used when you need detailed information about a specific payout.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
payout_id | string | Required | The unique ID of the payout to retrieve details for from Stripe. |
fields_to_expand | array<string> | Optional | List of fields in the payout response to expand for more details. |
Requirements
Output
json— Response from the API endpoint 'GetPayoutsPayout'.StripeApi.GetStripeReportTypeDetails
Retrieve details for a specific Stripe Report Type. Use this tool to get detailed information about a specific Stripe Report Type. Some report types may require a live-mode API key.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
stripe_report_type_id | string | Required | The unique identifier for the Stripe Report Type to retrieve details about. |
fields_to_expand | array<string> | Optional | List of fields in the response to expand for more detailed information. |
Requirements
Output
json— Response from the API endpoint 'GetReportingReportTypesReportType'.StripeApi.GetStripeReportTypes
Retrieve a comprehensive list of Stripe report types. This tool calls the Stripe endpoint to return a full list of available Report Types. Use it when you need to know all report types that Stripe can generate.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
expand_fields | array<string> | Optional | A list of fields in the Stripe report types response to be expanded for more detailed information. |
Requirements
Output
json— Response from the API endpoint 'GetReportingReportTypes'.StripeApi.GetStripeSourceTransaction
Retrieve a Stripe source transaction by ID. Fetches information of an existing source transaction using the source ID and transaction ID from Stripe.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
source_id | string | Required | The unique ID of the Stripe source. Use this to specify which source's transaction to retrieve. |
stripe_source_transaction_id | string | Required | The unique identifier for the source transaction to retrieve from Stripe. This ID is obtained from previous source creation requests. |
fields_to_expand | array<string> | Optional | An array of strings specifying which fields in the response should be expanded. |
Requirements
Output
json— Response from the API endpoint 'GetSourcesSourceSourceTransactionsSourceTransaction'.StripeApi.GetStripeWebhookEndpoints
Retrieve a list of your Stripe webhook endpoints. This tool is used to retrieve a list of webhook endpoints configured in your Stripe account. It is helpful for managing and verifying your current webhook setup.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
pagination_ending_before | string | Optional | A cursor (object ID) for pagination to fetch the previous page of webhook endpoints. |
expand_fields | array<string> | Optional | A list of field names to expand in the response, allowing for detailed data retrieval. |
object_limit | integer | Optional | The number of webhook endpoints to return, ranging from 1 to 100. Defaults to 10 if not specified. |
pagination_starting_after_id | string | Optional | An object ID used for pagination to fetch the next page in a list. Use the last object's ID from the current list. |
Requirements
Output
json— Response from the API endpoint 'GetWebhookEndpoints'.StripeApi.GetSubscriptionDetails
Retrieve details of a subscription by its ID. This tool is used to fetch details about a specific subscription using its exposed ID. It should be called when subscription information is needed.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
subscription_id | string | Required | The ID of the subscription to retrieve details for. It is required to fetch the subscription information. |
fields_to_expand | array<string> | Optional | List of fields in the subscription response to be expanded for detailed information. |
Requirements
Output
json— Response from the API endpoint 'GetSubscriptionsSubscriptionExposedId'.StripeApi.GetSubscriptionDiscount
Retrieve discount details for a customer's subscription. Use this tool to get the discount information associated with a specific subscription for a particular customer in Stripe.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
customer_id | string | Required | The unique identifier of the customer whose subscription discount details are being retrieved. |
subscription_id | string | Required | The unique identifier for the customer's subscription to retrieve discount details. |
fields_to_expand | array<string> | Optional | List of fields to expand in the response for more detailed information. |
Requirements
Output
json— Response from the API endpoint 'GetCustomersCustomerSubscriptionsSubscriptionExposedIdDiscount'.StripeApi.GetSubscriptionItems
Retrieve subscription items for a subscription. This tool returns a list of subscription items associated with a specified subscription. It should be called when there's a need to view or manage the items within a specific subscription.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
subscription_id | string | Required | The unique identifier of the subscription to retrieve its items. |
pagination_ending_before | string | Optional | Object ID for pagination to fetch the previous page of subscription items. |
expand_fields | array<string> | Optional | List of fields in the response to be expanded. Specify each field as a string. |
max_items_to_return | integer | Optional | Specify the number of subscription items to return, ranging from 1 to 100. Defaults to 10. |
pagination_starting_after | string | Optional | A cursor object ID to define your place for pagination, fetching the next page of the list. |
Requirements
Output
json— Response from the API endpoint 'GetSubscriptionItems'.StripeApi.GetTaxCodeDetails
Retrieve details for a specific tax code by ID. This tool fetches information about an existing tax code using its unique ID. It's useful for obtaining detailed tax code data from Stripe.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
tax_code_id | string | Required | The unique ID of the tax code to retrieve. Use this to fetch specific tax code details from Stripe. |
fields_to_expand | array<string> | Optional | List of fields to be expanded in the response. |
Requirements
Output
json— Response from the API endpoint 'GetTaxCodesId'.StripeApi.GetTaxCodesList
Retrieve all available tax codes for products from Stripe. Use this tool to get a list of all tax codes that can be added to products for specific tax calculations in Stripe.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
pagination_cursor_ending_before | string | Optional | A cursor (object ID) to fetch the previous page of the tax codes list in pagination. Use to define your place in the list when stepping backwards. |
fields_to_expand | array<string> | Optional | Specifies which fields in the tax codes response should be expanded for more detailed information. |
object_return_limit | integer | Optional | Set the maximum number of tax codes to return, ranging from 1 to 100, with a default of 10. |
pagination_starting_after_cursor | string | Optional | An object ID used as a cursor to fetch the next page of the list. Use it for pagination to continue from the last retrieved item. |
Requirements
Output
json— Response from the API endpoint 'GetTaxCodes'.StripeApi.GetTaxRegistrationInfo
Retrieve details of a specific tax registration. Use this tool to obtain information about a specific tax registration by providing the registration ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
registration_id | string | Required | The unique identifier for the tax registration. Provide this to retrieve specific registration details. |
fields_to_expand | array<string> | Optional | A list of fields in the response that should be expanded to provide more detailed information. |
Requirements
Output
json— Response from the API endpoint 'GetTaxRegistrationsId'.StripeApi.GetTaxRegistrations
Retrieve a list of tax registration objects from Stripe. Use this tool to get detailed information about tax registrations on Stripe. It returns a list of registration objects that are currently registered.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
pagination_ending_before | string | Optional | An object ID used as a cursor to define your position in the list for pagination. Use this to fetch the previous page of objects. |
response_fields_to_expand | array<string> | Optional | List of fields to be expanded in the response, allowing for detailed information retrieval. |
object_limit | integer | Optional | Specifies the number of tax registration objects to return, ranging from 1 to 100. Defaults to 10 if not specified. |
pagination_starting_after_object_id | string | Optional | A cursor for pagination. Use the object ID to fetch the next page of the list when applicable. |
tax_registration_status | string | Optional | Specifies the status of the tax registration. Options: active, all, expired, scheduled. |
Requirements
Output
json— Response from the API endpoint 'GetTaxRegistrations'.StripeApi.GetTaxSettings
Retrieve merchant tax settings in Stripe. This tool fetches the tax settings for a merchant from Stripe, providing detailed information about tax configurations.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
expand_fields | array<string> | Optional | A list of field names in the response to expand for more detailed information. |
Requirements
Output
json— Response from the API endpoint 'GetTaxSettings'.StripeApi.GetTerminalConfigurations
Retrieve a list of terminal Configuration objects. Call this tool to obtain a list of Stripe terminal configurations. It retrieves all available Configuration objects used by terminals.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
pagination_ending_before | string | Optional | A string cursor for pagination to fetch the previous page, defined by an object ID. |
fields_to_expand | array<string> | Optional | List of fields in the response to expand for additional details. |
maximum_objects_to_return | integer | Optional | Set the maximum number of terminal Configuration objects to retrieve, ranging from 1 to 100. Default is 10. |
pagination_starting_after_id | string | Optional | An object ID for pagination, defining the start position for the next page of the list. Use this to continue listing from a specific object. |
only_return_account_default_configurations | boolean | Optional | If true, only return the account default configurations; if false, return non-default configurations. |
Requirements
Output
json— Response from the API endpoint 'GetTerminalConfigurations'.StripeApi.GetTerminalLocations
Retrieve a list of terminal location objects from Stripe. This tool calls the Stripe API to fetch a list of terminal location objects. It should be used when you need information about available terminal locations.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
pagination_ending_before_cursor | string | Optional | The object ID to define your place in pagination, used to fetch the previous page of the list. |
fields_to_expand | array<string> | Optional | A list of fields to expand in the response for more detailed information. |
results_limit | integer | Optional | The maximum number of terminal location objects to return. Acceptable values are between 1 and 100; default is 10. |
pagination_starting_after | string | Optional | A cursor indicating the position in the list to start fetching the next set of terminal locations. Use this with the object ID received at the end of the previous page. |
Requirements
Output
json— Response from the API endpoint 'GetTerminalLocations'.StripeApi.GetTerminalReaders
Retrieve a list of terminal reader objects. Use this tool to obtain a list of Stripe terminal readers. It is useful when you need to manage or view details of connected terminal devices.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
filter_by_device_type | string | Optional | Specify the type of device to filter terminal readers. Options include: 'bbpos_chipper2x', 'bbpos_wisepad3', 'bbpos_wisepos_e', 'mobile_phone_reader', 'simulated_stripe_s700', 'simulated_wisepos_e', 'stripe_m2', 'stripe_s700', 'verifone_P400'. |
pagination_cursor_ending_before | string | Optional | A cursor for pagination, used to fetch the previous page based on object ID. |
expand_response_fields | array<string> | Optional | List of fields to expand in the response, specified as strings. |
object_return_limit | integer | Optional | Specifies the maximum number of terminal reader objects to return, ranging from 1 to 100. Default is 10. |
filter_by_location_id | string | Optional | Specify the location ID to filter readers to a specific location only. |
filter_by_serial_number | string | Optional | Provide a serial number to filter the list of terminal readers by this specific serial number. |
pagination_start_object_id | string | Optional | The object ID used as a cursor to define your starting point in the list for pagination, fetching the next page. |
filter_by_status | string | Optional | Filter terminal readers by their status, either 'offline' or 'online'. |
Requirements
Output
json— Response from the API endpoint 'GetTerminalReaders'.StripeApi.GetTestClocksList
Retrieve a list of your test clocks from Stripe. Use this tool to obtain a list of test clocks for testing purposes in Stripe environments.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
pagination_cursor_ending_before | string | Optional | A cursor ID for pagination to fetch the previous page of the list. Use an object ID. |
expand_response_fields | array<string> | Optional | List of fields to expand in the response. Specify fields you want expanded for more details. |
number_of_objects_limit | integer | Optional | Specify the number of test clocks to return, between 1 and 100, with a default of 10. |
pagination_starting_after_cursor | string | Optional | An object ID for pagination. Use this ID to fetch the next page of the list of test clocks. |
Requirements
Output
json— Response from the API endpoint 'GetTestHelpersTestClocks'.StripeApi.GetTransactionLineItems
Retrieve line items for a specified transaction. Use this tool to get the line items of a committed standalone transaction from Stripe as a collection.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
transaction_id | string | Required | The unique identifier for the transaction. Use this to retrieve its line items from Stripe. |
pagination_ending_id | string | Optional | Cursor ID for paginating backwards to fetch the previous page of transaction line items. |
expand_fields | array<string> | Optional | Specify which response fields to expand. Provide an array of strings with field names. |
number_of_items_to_return | integer | Optional | Specifies the number of line items to return, between 1 and 100. Defaults to 10 if not specified. |
pagination_starting_after | string | Optional | A cursor ID for pagination to fetch the next page of the list. Use the last object's ID from the current page. |
Requirements
Output
json— Response from the API endpoint 'GetTaxTransactionsTransactionLineItems'.StripeApi.GetTransferDetails
Retrieve details of an existing transfer using its ID. Use this tool to fetch information about a specific transfer by providing its unique ID from a previous request or list.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
transfer_id | string | Required | The unique identifier for the transfer you want to retrieve details about. This ID is obtained from a transfer creation request or the transfer list. |
fields_to_expand | array<string> | Optional | A list of fields in the transfer response to expand for more detailed information. |
Requirements
Output
json— Response from the API endpoint 'GetTransfersTransfer'.StripeApi.GetTransferReversals
Retrieve reversals of a specific transfer. Use this tool to get a list of reversals for a specific transfer in Stripe. This is useful when more than the 10 most recent reversals are needed, allowing pagination using limit and starting_after parameters.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
transfer_id | string | Required | The unique identifier of the transfer for which to retrieve reversals. |
pagination_ending_before | string | Optional | An object ID cursor to navigate to the previous page in the list of reversals. |
expand_fields_in_response | array<string> | Optional | List of response fields to expand in the results for detailed data. |
fetch_limit | integer | Optional | Set the maximum number of reversal objects to return, ranging from 1 to 100. Default is 10. |
pagination_start_cursor | string | Optional | The object ID to define your place in the list for pagination. Use this to fetch the next page, starting after the given object ID. |
Requirements
Output
json— Response from the API endpoint 'GetTransfersIdReversals'.StripeApi.GetTreasuryPaymentMethods
Retrieve a list of PaymentMethods for Treasury flows. This tool retrieves a list of PaymentMethods specifically for Treasury flows. It should be used when you want to access payment methods for these specific purposes, rather than customer-attached payment methods.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
customer_id | string | Optional | The ID of the customer whose PaymentMethods will be retrieved for Treasury flows. This is used to filter the payment methods specific to a customer. |
pagination_ending_before | string | Optional | An object ID to fetch the previous page of the list in pagination. Use to navigate to earlier records. |
expand_response_fields | array<string> | Optional | Specifies which fields in the payment methods response should be expanded for more details. |
result_limit | integer | Optional | The maximum number of payment methods to return, between 1 and 100. Default is 10. |
starting_after_payment_method | string | Optional | An object ID cursor to paginate through the list of payment methods. Use it to fetch the next page after a given object. |
filter_payment_method_type | string | Optional | Filter the list based on the payment method type. Use specific payment method values like 'card', 'paypal', etc., if expecting only one type. |
Requirements
Output
json— Response from the API endpoint 'GetPaymentMethods'.StripeApi.GetUpfrontQuoteLineItems
Retrieve computed upfront line items from a quote. Use this tool to get the computed upfront line items for a specific quote from Stripe. Ideal for viewing details of the initial line items associated with a quote, including accessing a URL for the full list if needed.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
quote_id | string | Required | The unique ID of the quote for which to retrieve upfront line items. This ID is required to specify the quote in context. |
pagination_ending_before_id | string | Optional | A cursor indicating the last object ID to fetch the previous page in a paginated list of upfront line items. |
fields_to_expand | array<string> | Optional | A list of fields to expand in the response for more detailed information. Each entry should be a string representing a field. |
max_line_items_to_return | integer | Optional | The maximum number of line items to retrieve, between 1 and 100. Default is 10. |
pagination_starting_object_id | string | Optional | An object ID used to fetch the next page of results in pagination, such as `obj_foo`. |
Requirements
Output
json— Response from the API endpoint 'GetQuotesQuoteComputedUpfrontLineItems'.StripeApi.ListApplePayDomains
Retrieve a list of Apple Pay domains. Use this tool to get a list of all Apple Pay domains associated with your Stripe account.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
domain_name_filter | string | Optional | Filter the list by a specific domain name. Leave empty to return all domains. |
pagination_ending_before_id | string | Optional | Object ID for pagination to fetch the previous page of the list. |
expand_fields | array<string> | Optional | An array of fields to expand in the response for additional details. |
max_domains_to_return | integer | Optional | Specify the number of Apple Pay domains to retrieve, between 1 and 100. Defaults to 10 if not set. |
pagination_starting_after_cursor | string | Optional | An object ID for pagination to retrieve the next page of the list. |
Requirements
Output
json— Response from the API endpoint 'GetApplePayDomains'.StripeApi.ListClimateOrders
Retrieve all Climate order objects from Stripe. The tool fetches and lists all Climate order objects from the Stripe service. These orders are sorted by creation date, with the most recent ones appearing first.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
pagination_ending_before_cursor | string | Optional | A cursor ID to paginate backwards through the list, fetching the page before the specified object ID for Climate orders. |
expand_fields | array<string> | Optional | A list of fields in the response to expand. Provide each field name as a string in an array. |
maximum_objects_to_return | integer | Optional | The number of Climate order objects to retrieve, ranging from 1 to 100. Default is 10. |
pagination_starting_after_cursor | string | Optional | An object ID used as a cursor to define your place in the pagination list to retrieve the next page. |
Requirements
Output
json— Response from the API endpoint 'GetClimateOrders'.StripeApi.ListClimateProducts
Retrieve a list of all available Climate products. Use this tool to get information about all available Climate product objects from the Stripe service.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
pagination_ending_before | string | Optional | An object ID cursor to fetch the previous page in a paginated list. Use to define your place in the list. |
fields_to_expand | array<string> | Optional | Specify which fields in the response should be expanded as a list of strings. |
objects_limit | integer | Optional | The maximum number of Climate product objects to return, ranging from 1 to 100. Default is 10. |
pagination_starting_after_id | string | Optional | A cursor (object ID) to define your starting point in the list for pagination. Used to fetch the next page after the specified object ID. |
Requirements
Output
json— Response from the API endpoint 'GetClimateProducts'.StripeApi.ListClimateSuppliers
Retrieve a list of all available Climate suppliers. This tool calls the Stripe API to list all available Climate supplier objects. It should be used when you need information about climate suppliers for Stripe-related services.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
pagination_ending_before | string | Optional | The object ID to use as a cursor for fetching the previous page of suppliers in the list. |
fields_to_expand | array<string> | Optional | List of fields in the response that should be expanded. |
result_limit | integer | Optional | Specify the number of Climate supplier objects to return, ranging from 1 to 100, with a default of 10. |
pagination_starting_after_cursor | string | Optional | Object ID for pagination to fetch the next page of the Climate suppliers list. |
Requirements
Output
json— Response from the API endpoint 'GetClimateSuppliers'.StripeApi.ListCustomerPaymentSources
Retrieve payment sources for a specified customer. Use this tool to list all payment sources for a given customer ID in Stripe.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
customer_id | string | Required | The unique identifier for the customer whose payment sources you want to retrieve. |
pagination_ending_before | string | Optional | A cursor for pagination to fetch the previous page. Use an object ID from your list request. |
expand_response_fields | array<string> | Optional | List of fields in the response to be expanded for additional details. |
max_payment_sources_to_return | integer | Optional | Set the maximum number of payment sources to return, from 1 to 100. Defaults to 10 if not specified. |
filter_by_object_type | string | Optional | Filter payment sources based on a specific object type (e.g., card, bank_account). |
pagination_start_cursor | string | Optional | An object ID (string) that specifies your place in the list to fetch the next page. Use it for pagination. |
Requirements
Output
json— Response from the API endpoint 'GetCustomersCustomerSources'.StripeApi.ListExternalAccounts
Retrieve external accounts linked to a Stripe account. This tool retrieves the external accounts associated with a specified Stripe account. It should be called when you need details about the financial accounts linked to a specific Stripe account ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
stripe_account_id | string | Required | The unique identifier for the Stripe account whose external accounts you want to retrieve. |
pagination_ending_before | string | Optional | A cursor used to define your position in the list for pagination. It specifies the object ID before which the list should end. |
expand_response_fields | array<string> | Optional | A list of fields in the response to expand for detailed information. |
max_results_per_page | integer | Optional | Specify the number of external accounts to retrieve, ranging from 1 to 100. Default is 10. |
filter_by_object_type | string | Optional | Specify the type of external accounts to filter: 'bank_account' or 'card'. |
pagination_starting_after_object_id | string | Optional | Object ID for pagination to fetch the next page of results. Use the ID of the last object from the current list. |
Requirements
Output
json— Response from the API endpoint 'GetAccountsAccountExternalAccounts'.StripeApi.ListPaymentMethodConfigurations
Retrieve available payment method configurations from Stripe. Use this tool to get a list of payment method configurations from the Stripe API. It should be called when you need to access the available configurations for payments.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
filter_by_connect_application | string | Optional | Specify the Connect application ID to filter the payment method configurations by. |
pagination_ending_before_id | string | Optional | Object ID that defines your place in the list for pagination, used to fetch the previous page. |
expand_fields | array<string> | Optional | List of fields in the response that should be expanded. Provide field names as strings in an array. |
max_results | integer | Optional | Specify the maximum number of payment method configurations to be returned, ranging from 1 to 100. Defaults to 10 if not specified. |
pagination_starting_after_id | string | Optional | The object ID to define your place in the list for pagination, used to fetch the next page of results. |
Requirements
Output
json— Response from the API endpoint 'GetPaymentMethodConfigurations'.StripeApi.ListPaymentMethodDomains
Retrieve details of existing payment method domains. Use this tool to get a list of all payment method domains and their associated details. This can be helpful for managing or reviewing your payment configurations.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
domain_name | string | Optional | Specify the domain name for the payment method domain object you want to represent. |
pagination_cursor_ending_before | string | Optional | A cursor ID to fetch the previous page of the payment method domain list in pagination. |
fields_to_expand | array<string> | Optional | List of fields in the response to expand for more detailed information. |
limit_number_of_returned_objects | integer | Optional | Specify the number of payment method domains to return, ranging from 1 to 100. Default is 10. |
pagination_cursor_starting_after | string | Optional | An object ID cursor to fetch the next page in the list. |
include_enabled_domains | boolean | Optional | Include only enabled payment method domains in the results. If false, all domains will be included regardless of status. |
Requirements
Output
json— Response from the API endpoint 'GetPaymentMethodDomains'.StripeApi.RemoveCustomerDiscount
Remove the current discount applied to a customer. This tool removes the discount that is currently applied to a specific customer when called. It should be used when there is a need to update or clear a customer's discount information.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
customer_id | string | Required | The unique identifier for the customer whose discount is to be removed. |
Requirements
Output
json— Response from the API endpoint 'DeleteCustomersCustomerDiscount'.StripeApi.RemoveCustomerSubscriptionDiscount
Removes the discount from a customer's subscription. This tool is used to remove the currently applied discount on a specific customer's subscription.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
customer_id | string | Required | The unique identifier for the customer whose subscription discount should be removed. |
subscription_id | string | Required | The unique identifier for the customer's subscription from which the discount will be removed. |
Requirements
Output
json— Response from the API endpoint 'DeleteCustomersCustomerSubscriptionsSubscriptionExposedIdDiscount'.StripeApi.RemoveRadarValueListItem
Remove an item from a Stripe Radar value list. Use this tool to delete a specific ValueListItem from its parent value list in Stripe Radar.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
radar_value_list_item_id | string | Required | The unique identifier of the ValueListItem to be removed from the Stripe Radar value list. |
Requirements
Output
json— Response from the API endpoint 'DeleteRadarValueListItemsItem'.StripeApi.RemoveSubscriptionDiscount
Remove the discount from a subscription. This tool should be called to remove the currently applied discount on a given subscription in the Stripe service.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
subscription_id | string | Required | The unique identifier for the subscription from which the discount will be removed. |
Requirements
Output
json— Response from the API endpoint 'DeleteSubscriptionsSubscriptionExposedIdDiscount'.StripeApi.RetrieveAccountDetails
Retrieve details of a specific account. Use this tool to obtain detailed information about a specific account using its identifier.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
account_id | string | Required | The unique identifier of the account to retrieve details for. |
fields_to_expand | array<string> | Optional | A list of fields to expand in the response for detailed account information. |
Requirements
Output
json— Response from the API endpoint 'GetAccountsAccount'.StripeApi.RetrieveActiveEntitlement
Retrieve details of an active entitlement by ID. This tool retrieves information about an active entitlement using its ID. It should be used to fetch details related to a specific active entitlement in Stripe.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
entitlement_id | string | Required | The unique identifier of the active entitlement to retrieve. |
fields_to_expand | array<string> | Optional | List of fields in the response that should be expanded for additional details. |
Requirements
Output
json— Response from the API endpoint 'GetEntitlementsActiveEntitlementsId'.StripeApi.RetrieveApplePayDomain
Retrieve details of an Apple Pay domain. Use this tool to get information about a specific Apple Pay domain by providing the domain name.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
apple_pay_domain_name | string | Required | The domain name of the Apple Pay site to retrieve details for. This should be a valid domain string. |
fields_to_expand | array<string> | Optional | A list of fields to expand in the response for additional details. |
Requirements
Output
json— Response from the API endpoint 'GetApplePayDomainsDomain'.StripeApi.RetrieveApplicationFeeDetails
Retrieve details of a specific application fee. Use this tool to get information about an application fee collected by your account. It provides the same details as when refunding the fee.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
application_fee_id | string | Required | The unique identifier of the application fee to retrieve details for. |
fields_to_expand | array<string> | Optional | A list of fields to expand in the response for detailed information. |
Requirements
Output
json— Response from the API endpoint 'GetApplicationFeesId'.StripeApi.RetrieveApplicationFeeRefundDetail
Retrieve details of a specific application fee refund. Use this tool to obtain detailed information about a specific refund related to an application fee, beyond the 10 most recent refunds available by default.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
application_fee_id | string | Required | The ID of the application fee associated with the refund to retrieve details for. |
refund_id | string | Required | The unique identifier of the specific refund to retrieve details for. This is required to access a particular refund. |
fields_to_expand | array<string> | Optional | List of fields to expand in the response for additional detail. |
Requirements
Output
json— Response from the API endpoint 'GetApplicationFeesFeeRefundsId'.StripeApi.RetrieveBalanceTransactionById
Retrieve details of a balance transaction by ID. Call this tool to get the details of a specific balance transaction using its ID. Useful for accessing historical balance changes for specific transactions.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
balance_transaction_id | string | Required | The unique identifier for the balance transaction to retrieve. |
fields_to_expand | array<string> | Optional | A list of fields in the response that should be expanded for detailed information. |
Requirements
Output
json— Response from the API endpoint 'GetBalanceHistoryId'.StripeApi.RetrieveBillingMeter
Retrieve billing meter details by ID. Use this tool to get information about a billing meter by providing its ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
billing_meter_id | string | Required | The ID of the billing meter to be retrieved. |
fields_to_expand | array<string> | Optional | A list of field names to expand in the billing meter response for additional details. |
Requirements
Output
json— Response from the API endpoint 'GetBillingMetersId'.StripeApi.RetrieveCashBalanceTransaction
Retrieve a cash balance transaction for a customer. This tool retrieves information about a specific cash balance transaction that affected a customer's cash balance in Stripe.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
customer_id | string | Required | The unique identifier of the customer whose cash balance transaction is to be retrieved. |
transaction_id | string | Required | The unique identifier for the cash balance transaction to be retrieved. |
expand_fields_in_response | array<string> | Optional | List of fields to expand in the response for additional details. |
Requirements
Output
json— Response from the API endpoint 'GetCustomersCustomerCashBalanceTransactionsTransaction'.StripeApi.RetrieveCheckoutSession
Retrieve a specific Stripe checkout session. This tool retrieves detailed information about a specific Checkout Session from Stripe. It should be called when there's a need to access the data for a particular session, identified by its session ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
session_id | string | Required | The unique identifier for the Checkout Session you want to retrieve. This is required to specify which session's details to access. |
fields_to_expand | array<string> | Optional | A list of fields in the checkout session response that should be expanded for more detailed information. |
Requirements
Output
json— Response from the API endpoint 'GetCheckoutSessionsSession'.StripeApi.RetrieveClimateProductDetails
Retrieve details of a specific Climate product from Stripe. This tool retrieves the details of a Climate product using the provided product ID from Stripe's API.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
product_id | string | Required | The unique identifier of the Climate product to retrieve details for. |
fields_to_expand | array<string> | Optional | List of fields in the response to expand for additional details. |
Requirements
Output
json— Response from the API endpoint 'GetClimateProductsProduct'.StripeApi.RetrieveClimateSupplier
Fetches details of a specific Climate supplier. Use this tool to get detailed information about a Climate supplier using the supplier's identifier. It is useful for accessing supplier profiles managed by Stripe's Climate initiative.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
supplier_identifier | string | Required | The unique identifier for the Climate supplier to be retrieved. This is required to fetch the supplier's information. |
fields_to_expand | array<string> | Optional | List of fields to expand in the response for detailed information on the Climate supplier. |
Requirements
Output
json— Response from the API endpoint 'GetClimateSuppliersSupplier'.StripeApi.RetrieveCountrySpecs
Retrieve all country specification objects from the API. This tool calls the Stripe API to list all available Country Spec objects, providing information about country-specific details.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
pagination_ending_before | string | Optional | The object ID to specify your place in the list for pagination, retrieving the previous page of results. |
expand_response_fields | array<string> | Optional | An array of strings specifying fields in the response to be expanded for more detailed information. |
number_of_country_specs_to_return | integer | Optional | Number of country specification objects to return, ranging from 1 to 100. The default is 10. |
pagination_starting_after_id | string | Optional | Object ID to define your place in the list for pagination. Use it to fetch the next page if available, based on the last object from a previous list call. |
Requirements
Output
json— Response from the API endpoint 'GetCountrySpecs'.StripeApi.RetrieveCreditGrant
Retrieve details of a specific credit grant using its ID. Call this tool to get information about a specific credit grant by providing its ID. Useful for checking credit grant details within billing systems.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
credit_grant_id | string | Required | The unique identifier for the credit grant to retrieve details for. |
fields_to_expand | array<string> | Optional | List of fields in the response that should be expanded to include additional details. |
Requirements
Output
json— Response from the API endpoint 'GetBillingCreditGrantsId'.StripeApi.RetrieveCreditNote
Retrieve details of a specific credit note by ID. Use this tool to get information about a credit note using its unique identifier. Ideal for retrieving specific credit note details from the Stripe service.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
credit_note_id | string | Required | The unique identifier of the credit note to be retrieved. |
fields_to_expand | array<string> | Optional | A list of fields in the response to be expanded for detailed information. |
Requirements
Output
json— Response from the API endpoint 'GetCreditNotesId'.StripeApi.RetrieveCreditNoteLines
Fetch line items from a specified credit note. This tool retrieves line items from a given credit note, providing details and the option to access the full paginated list if needed.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
credit_note_id | string | Required | The unique identifier of the credit note to retrieve line items from. |
pagination_ending_before | string | Optional | The object ID to paginate before, fetching the previous page in the list. |
fields_to_expand | array<string> | Optional | List of fields in the response to be expanded. Allows detailed retrieval of related objects. |
max_objects_to_return | integer | Optional | Specify the number of credit note line items to return. Must be between 1 and 100, default is 10. |
pagination_starting_after | string | Optional | An object ID used for pagination to fetch the next page of the list. This ID should be the last object from a previous set of data. |
Requirements
Output
json— Response from the API endpoint 'GetCreditNotesCreditNoteLines'.StripeApi.RetrieveCustomerDetails
Retrieve details of a specific customer. This tool retrieves information about a specific customer from Stripe's database using their unique customer ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
customer_id | string | Required | The unique identifier for the customer to retrieve details for. This is a string provided by Stripe. |
expand_response_fields | array<string> | Optional | List of fields to expand in the response for detailed information. |
Requirements
Output
json— Response from the API endpoint 'GetCustomersCustomer'.StripeApi.RetrieveCustomerDiscount
Retrieve a customer's discount information. Use this tool to get information about a specific customer's discount in Stripe. It provides details on any discounts applied to a customer's account.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
customer_id | string | Required | The unique identifier for the customer whose discount information you want to retrieve. |
fields_to_expand | array<string> | Optional | List of fields in the response to expand. Use to get additional related information. |
Requirements
Output
json— Response from the API endpoint 'GetCustomersCustomerDiscount'.StripeApi.RetrieveCustomerPaymentSource
Retrieve a specified source for a given customer. Use this tool to get details about a specific payment source associated with a customer in Stripe.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
customer_id | string | Required | The unique identifier for the customer whose payment source needs to be retrieved. |
source_id | string | Required | The unique identifier of the payment source to retrieve for the specified customer. |
fields_to_expand | array<string> | Optional | List of fields to expand in the response for detailed information. |
Requirements
Output
json— Response from the API endpoint 'GetCustomersCustomerSourcesId'.StripeApi.RetrieveDebitReversal
Retrieve details of a specific debit reversal. Use this tool to get information about a specific DebitReversal object by ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
debit_reversal_id | string | Required | The unique identifier of the DebitReversal object to be retrieved. |
expand_fields | array<string> | Optional | List of fields to expand in the DebitReversal response. Provide an array of field names as strings. |
Requirements
Output
json— Response from the API endpoint 'GetTreasuryDebitReversalsDebitReversal'.StripeApi.RetrieveDisputeById
Retrieve details of a dispute using its ID. This tool is used to fetch detailed information about a specific dispute by providing its ID. It should be called when detailed information about a particular dispute is needed.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
dispute_id | string | Required | The unique identifier of the dispute to be retrieved. This ID can be used to fetch detailed information about the specific dispute. |
fields_to_expand | array<string> | Optional | A list of fields in the dispute response that should be expanded for additional details. |
Requirements
Output
json— Response from the API endpoint 'GetDisputesDispute'.StripeApi.RetrieveEarlyFraudWarningDetails
Retrieve details of an early fraud warning. Fetches information about a previously created early fraud warning. Useful for examining potential fraudulent activity and understanding associated risks.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
early_fraud_warning_id | string | Required | The unique identifier of the early fraud warning to retrieve details for. |
fields_to_expand | array<string> | Optional | List of fields in the response that should be expanded for additional details. |
Requirements
Output
json— Response from the API endpoint 'GetRadarEarlyFraudWarningsEarlyFraudWarning'.StripeApi.RetrieveFeatureDetails
Fetches details for a specific feature by ID. Use this tool to retrieve detailed information about a specific feature using its ID within the Stripe system.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
feature_id | string | Required | The unique identifier of the feature to retrieve details for. |
fields_to_expand | array<string> | Optional | List of fields in the response to be expanded for more detailed information. |
Requirements
Output
json— Response from the API endpoint 'GetEntitlementsFeaturesId'.StripeApi.RetrieveFileLink
Fetches a file link using its ID. Use this tool to retrieve information about a specific file link by providing its ID. Ideal for accessing details about file links stored in Stripe.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
file_link_id | string | Required | The ID of the file link to retrieve details for. This is used to fetch the specific file link from Stripe. |
fields_to_expand | array<string> | Optional | An array of strings specifying which fields in the response should be expanded for additional details. |
Requirements
Output
json— Response from the API endpoint 'GetFileLinksLink'.StripeApi.RetrieveFinancialConnectionsSession
Retrieve details of a Financial Connections Session. Use this tool to obtain detailed information about a specific Financial Connections Session from Stripe.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
financial_connection_session_id | string | Required | The unique identifier of the Financial Connections Session to retrieve. |
fields_to_expand | array<string> | Optional | An array of strings specifying which fields in the response should be expanded for additional details. |
Requirements
Output
json— Response from the API endpoint 'GetFinancialConnectionsSessionsSession'.StripeApi.RetrieveFinancialSessionDetails
Retrieve details of a financial connection session. Use this tool to get information about a specific financial connection session through Stripe. It's useful for accessing session details based on a session identifier.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
session_identifier | string | Required | The unique identifier for the financial connection session to retrieve details for. |
fields_to_expand | array<string> | Optional | An array of fields in the response that should be expanded to include more details. |
Requirements
Output
json— Response from the API endpoint 'GetLinkAccountSessionsSession'.StripeApi.RetrieveForwardingRequest
Fetch a specific ForwardingRequest object using its ID. Use this tool to retrieve information about a ForwardingRequest by providing its unique ID. Ideal for accessing details of a specific forwarding request in the Stripe service.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
forwarding_request_id | string | Required | The unique identifier for the ForwardingRequest object to be retrieved. |
fields_to_expand | array<string> | Optional | List of fields to expand in the response for detailed information. |
Requirements
Output
json— Response from the API endpoint 'GetForwardingRequestsId'.StripeApi.RetrieveInboundTransferDetails
Retrieve details of a specific inbound transfer. Use this tool to get information about a specific inbound transfer by providing its ID. It retrieves all associated details of the inbound transfer from the Stripe service.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
inbound_transfer_id | string | Required | The unique identifier of the inbound transfer to retrieve details for. |
expand_fields | array<string> | Optional | Specify which fields in the response should be expanded for detailed information. Provide them as a list of strings. |
Requirements
Output
json— Response from the API endpoint 'GetTreasuryInboundTransfersId'.StripeApi.RetrieveInvoiceById
Retrieve details of an invoice using its ID. This tool should be called to obtain information about a specific invoice by providing its ID. It retrieves details associated with the given invoice ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
invoice_id | string | Required | The unique identifier for the invoice to retrieve. |
expand_fields_in_response | array<string> | Optional | A list of fields in the invoice response that should be expanded for more detailed information. |
Requirements
Output
json— Response from the API endpoint 'GetInvoicesInvoice'.StripeApi.RetrieveInvoicePayment
Fetch the details of a specific invoice payment by ID. Use this tool to retrieve the payment details for a given invoice ID from the Stripe service.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
invoice_payment_id | string | Required | The ID of the invoice payment to retrieve details for. This ID is required to fetch the payment information. |
fields_to_expand | array<string> | Optional | List of fields to be expanded in the response. Each field should be specified as a string. |
Requirements
Output
json— Response from the API endpoint 'GetInvoicePaymentsInvoicePayment'.StripeApi.RetrieveInvoiceTemplate
Fetch an invoice rendering template by ID. Use this tool to retrieve details of a specific invoice rendering template from Stripe. By default, it returns the latest version of the template, but you can specify a version to retrieve an older version.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
invoice_template_id | string | Required | The unique identifier for the invoice rendering template you want to retrieve. |
fields_to_expand | array<string> | Optional | A list of fields in the response that should be expanded for detailed information. |
template_version | integer | Optional | Specify the version number of the invoice rendering template to retrieve. If omitted, the latest version is returned. |
Requirements
Output
json— Response from the API endpoint 'GetInvoiceRenderingTemplatesTemplate'.StripeApi.RetrieveIssuingAuthorization
Fetches details of an Issuing Authorization object. Use this tool to retrieve a specific Issuing Authorization object from Stripe by providing the authorization ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
authorization_id | string | Required | The unique identifier for the Issuing Authorization object to retrieve. |
expand_fields | array<string> | Optional | List of strings specifying which fields in the response should be expanded. |
Requirements
Output
json— Response from the API endpoint 'GetIssuingAuthorizationsAuthorization'.StripeApi.RetrieveIssuingCardholder
Retrieve details of an issuing cardholder. This tool retrieves the details of an issuing cardholder from the Stripe API. It should be called when you need specific information about a cardholder associated with a Stripe issuing account.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
cardholder_id | string | Required | The unique identifier of the cardholder to retrieve details for, in string format. |
fields_to_expand | array<string> | Optional | An array of field names to expand in the response for additional details. |
Requirements
Output
json— Response from the API endpoint 'GetIssuingCardholdersCardholder'.StripeApi.RetrieveIssuingDispute
Fetch the details of a specific issuing dispute. Use this tool to retrieve an Issuing Dispute object from Stripe by providing the dispute identifier.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
dispute_id | string | Required | The unique identifier of the Issuing Dispute to be retrieved. |
fields_to_expand | array<string> | Optional | A list of fields in the dispute response that should be expanded for more detailed information. |
Requirements
Output
json— Response from the API endpoint 'GetIssuingDisputesDispute'.StripeApi.RetrieveIssuingSettlement
Fetch details of an Issuing Settlement object. Use this tool to retrieve information about a specific Issuing Settlement in the Stripe platform. It is useful for getting the details of settlements related to issuing transactions.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
settlement_id | string | Required | The unique identifier of the Issuing Settlement to retrieve details for. |
fields_to_expand | array<string> | Optional | List of fields to be expanded in the response for detailed information. |
Requirements
Output
json— Response from the API endpoint 'GetIssuingSettlementsSettlement'.StripeApi.RetrieveIssuingTransaction
Fetch details of an issuing transaction by ID. This tool retrieves information about a specific issuing transaction using its unique ID. It is used to gather details on transactions processed through Stripe's issuing services.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
transaction_id | string | Required | The unique identifier for the issuing transaction to be retrieved. |
fields_to_expand | array<string> | Optional | A list of fields in the response that should be expanded for more detailed information. |
Requirements
Output
json— Response from the API endpoint 'GetIssuingTransactionsTransaction'.StripeApi.RetrieveMandateInfo
Retrieve detailed information of a mandate. Fetches details about a Mandate object from Stripe when provided with a specific mandate ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mandate_id | string | Required | The unique identifier for the mandate to retrieve details for. It should be a valid string representing the mandate ID in Stripe. |
fields_to_expand | array<string> | Optional | List of fields to expand in the response for more detailed information. |
Requirements
Output
json— Response from the API endpoint 'GetMandatesMandate'.StripeApi.RetrieveOutboundPaymentDetails
Retrieve details of an existing OutboundPayment by ID. Use this tool to obtain details of a specific OutboundPayment using its unique ID from Stripe's treasury service.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
outbound_payment_id | string | Required | The unique identifier of the OutboundPayment to retrieve details for. |
fields_to_expand | array<string> | Optional | List of fields to expand in the response for detailed information. |
Requirements
Output
json— Response from the API endpoint 'GetTreasuryOutboundPaymentsId'.StripeApi.RetrievePaymentIntentDetails
Retrieve details of a specific PaymentIntent using its ID. Use this tool to get information about a PaymentIntent that has already been created. Suitable for retrieving details client-side with a publishable key.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
payment_intent_id | string | Required | The unique identifier of the PaymentIntent to retrieve details for. Required to specify which PaymentIntent you are interested in. |
payment_intent_client_secret | string | Optional | The client secret for the PaymentIntent, required when using a publishable key to retrieve the source. |
fields_to_expand | array<string> | Optional | A list of fields to expand in the response for additional details. |
Requirements
Output
json— Response from the API endpoint 'GetPaymentIntentsIntent'.StripeApi.RetrievePaymentLinkInfo
Retrieve detailed information about a payment link. Use this tool to get information about a specific payment link from Stripe. It's useful for checking the status or details of payment links.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
payment_link_id | string | Required | The unique identifier of the payment link to retrieve details for. |
expand_fields | array<string> | Optional | List of fields to expand in the response for detailed information. |
Requirements
Output
json— Response from the API endpoint 'GetPaymentLinksPaymentLink'.StripeApi.RetrievePaymentMethodConfiguration
Retrieve a specific payment method configuration. This tool is used to get details about a specific payment method configuration from Stripe.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
payment_method_configuration_id | string | Required | The unique identifier for the payment method configuration to retrieve. |
fields_to_expand | array<string> | Optional | List of fields in the response to be expanded for more detailed information. |
Requirements
Output
json— Response from the API endpoint 'GetPaymentMethodConfigurationsConfiguration'.StripeApi.RetrievePersonAccountDetails
Retrieve details of a person linked to an account. This tool retrieves details of an existing person associated with a specified account in Stripe. It should be called when you need to fetch information about a specific person related to an account on the Stripe platform.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
account_id | string | Required | The identifier of the Stripe account to which the person is linked. This is required to specify which account's person details need to be retrieved. |
person_identifier | string | Required | The unique identifier of the person whose details need to be retrieved. This ID is associated with the person's account in Stripe. |
fields_to_expand | array<string> | Optional | A list of fields in the response to be expanded for detailed information. |
Requirements
Output
json— Response from the API endpoint 'GetAccountsAccountPersonsPerson'.StripeApi.RetrievePersonalizationDesign
Retrieve a personalization design object by ID. Use this tool to get the details of a specific personalization design by providing its ID. Ideal for retrieving information related to issuing personalization designs.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
personalization_design_id | string | Required | The ID of the personalization design to retrieve. This is used to specify which design object's details are desired. |
fields_to_expand | array<string> | Optional | List of fields in the response to be expanded for additional details. |
Requirements
Output
json— Response from the API endpoint 'GetIssuingPersonalizationDesignsPersonalizationDesign'.StripeApi.RetrievePersonInformation
Retrieve information about a person in a Stripe account. Use this tool to obtain details of a specific person associated with a Stripe account. Ideal for scenarios where user requests involve checking or verifying personal information linked to an account.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
stripe_account_id | string | Required | The unique identifier of the Stripe account from which to retrieve the person's information. This is required to access the account details linked to this person. |
person_identifier | string | Required | The unique identifier of the person to retrieve within the Stripe account. This ID is required to fetch the specific person's details. |
fields_to_expand | array<string> | Optional | A list of fields in the response that should be expanded for detailed information. |
Requirements
Output
json— Response from the API endpoint 'GetAccountsAccountPeoplePerson'.StripeApi.RetrievePhysicalBundle
Retrieve details of a physical bundle. Use this tool to get information about a specific physical bundle in the Stripe issuing service. Useful for accessing current data about a particular bundle.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
physical_bundle_id | string | Required | The unique identifier of the physical bundle to retrieve. |
fields_to_expand | array<string> | Optional | Comma-separated list of fields in the response to be expanded for additional details. |
Requirements
Output
json— Response from the API endpoint 'GetIssuingPhysicalBundlesPhysicalBundle'.StripeApi.RetrieveQuoteById
Fetches quote details using a specified ID. Use this tool to retrieve information about a specific quote by providing its ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
quote_id | string | Required | The unique identifier of the quote to retrieve details for. |
fields_to_expand | array<string> | Optional | List of fields in the response to be expanded for additional details. |
Requirements
Output
json— Response from the API endpoint 'GetQuotesQuote'.StripeApi.RetrieveQuotesList
Fetches a list of your available quotes. Use this tool to retrieve a list of quotes you have created or received. It provides details on each quote you have within your Stripe account.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
customer_id | string | Optional | The ID of the customer to retrieve quotes for. |
pagination_ending_before_cursor | string | Optional | A string cursor indicating the object ID before which results are returned for pagination purposes. Use it to fetch the previous page of the list. |
fields_to_expand | array<string> | Optional | A list of fields to expand in the response. Each field is specified as a string. |
result_limit | integer | Optional | Sets the maximum number of quote objects to retrieve, between 1 and 100. Default is 10. |
pagination_starting_after | string | Optional | Object ID for pagination to fetch the list after the specified item. Use to get the next page. |
quote_status | string | Optional | The status of the quote. Possible values are 'accepted', 'canceled', 'draft', or 'open'. |
test_clock_id | string | Optional | The ID of the test clock to filter quotes. Must be set with the customer parameter. |
Requirements
Output
json— Response from the API endpoint 'GetQuotes'.StripeApi.RetrieveRadarValuelist
Retrieve details of a specific Radar ValueList. Fetches information about a specified Radar ValueList object using its identifier.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
identifier_of_radar_valuelist | string | Required | The unique identifier of the Radar ValueList to retrieve details for. It is required to fetch the specific ValueList object. |
expand_fields | array<string> | Optional | List of fields in the response to expand for additional details. |
Requirements
Output
json— Response from the API endpoint 'GetRadarValueListsValueList'.StripeApi.RetrieveReceivedDebitDetails
Retrieve details of a specific ReceivedDebit by ID. Use this tool to get information about an existing ReceivedDebit by providing its unique ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
received_debit_id | string | Required | The unique ID of the ReceivedDebit to retrieve details for. This ID is required. |
fields_to_expand | array<string> | Optional | List of response fields to expand for detailed information. |
Requirements
Output
json— Response from the API endpoint 'GetTreasuryReceivedDebitsId'.StripeApi.RetrieveRefundDetails
Retrieve details of an existing refund. Use this tool to obtain information about a specific refund by its identifier.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
refund_id | string | Required | The unique identifier of the refund to retrieve details for. |
expand_fields | array<string> | Optional | Specify which fields in the response should be expanded. Provide an array of field paths. |
Requirements
Output
json— Response from the API endpoint 'GetRefundsRefund'.StripeApi.RetrieveRefundDetailsByCharge
Fetches details of a refund associated to a specific charge. Use this tool to get detailed information about a specific refund by providing the charge ID and refund ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
charge_id | string | Required | The unique identifier for the charge associated with the refund. |
refund_id | string | Required | The ID of the refund to retrieve details for. This is required to specify the refund you want to look up. |
fields_to_expand | array<string> | Optional | List of fields in the refund details to be expanded in the response. |
Requirements
Output
json— Response from the API endpoint 'GetChargesChargeRefundsRefund'.StripeApi.RetrieveScheduledQueryRunDetails
Fetches details of a Stripe Sigma scheduled query run. This tool retrieves the details of a specific scheduled query run from Stripe Sigma. Use this when you need information about the execution of a scheduled query run.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
scheduled_query_run_id | string | Required | The unique identifier for the scheduled query run you wish to retrieve details for. |
fields_to_expand | array<string> | Optional | A list of fields in the response that should be expanded for additional detail. |
Requirements
Output
json— Response from the API endpoint 'GetSigmaScheduledQueryRunsScheduledQueryRun'.StripeApi.RetrieveSetupIntentDetails
Fetch details of an existing Stripe SetupIntent. Use this tool to retrieve information about a specific SetupIntent created in Stripe. Requires the intent ID and optionally a client secret for client-side retrieval using a publishable key.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
setup_intent_id | string | Required | The unique identifier for the SetupIntent to be retrieved. |
setup_intent_client_secret | string | Optional | The client secret for retrieving SetupIntent using a publishable key. Required for client-side retrieval. |
fields_to_expand | array<string> | Optional | A list of fields to expand in the response, such as nested objects. Each field should be specified as a string. |
Requirements
Output
json— Response from the API endpoint 'GetSetupIntentsIntent'.StripeApi.RetrieveShippingRateDetails
Retrieve details of a specific shipping rate using its ID. This tool retrieves the shipping rate object associated with the provided shipping rate ID. Call this tool to get detailed information about a particular shipping rate from Stripe.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
shipping_rate_id | string | Required | The unique identifier for the shipping rate to retrieve details for. |
fields_to_expand | array<string> | Optional | List of fields to expand in the response for more detailed information. |
Requirements
Output
json— Response from the API endpoint 'GetShippingRatesShippingRateToken'.StripeApi.RetrieveSourceMandateNotification
Retrieve details of a specific mandate notification. This tool retrieves information about a specific Source MandateNotification from Stripe. It should be used when you need to access details regarding a mandate notification for a given source.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mandate_notification_id | string | Required | The unique identifier of the mandate notification to retrieve details for. |
source_id | string | Required | The unique identifier of the source to retrieve information for. This is required to specify which source's mandate notification you want to access. |
fields_to_expand | array<string> | Optional | List of fields in the response that should be expanded for additional details. |
Requirements
Output
json— Response from the API endpoint 'GetSourcesSourceMandateNotificationsMandateNotification'.StripeApi.RetrieveStripeChargeDetails
Retrieve details of a specific Stripe charge via its unique ID. Use this tool to get details of a previously created charge on Stripe by providing the charge's unique ID. It returns information such as amount, currency, status, and more.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
charge_id | string | Required | The unique identifier of the charge. Use this to retrieve its details. |
fields_to_expand | array<string> | Optional | List of fields in the response to expand for more detailed information. |
Requirements
Output
json— Response from the API endpoint 'GetChargesCharge'.StripeApi.RetrieveStripeEventDetails
Retrieve details of a Stripe event using its unique ID. Use this tool to get information about a Stripe event created in the last 30 days. You need to provide the unique event identifier, typically received through a webhook.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
event_identifier | string | Required | The unique identifier of the event to retrieve details for. Typically received via a webhook and must have been created in the last 30 days. |
fields_to_expand_in_response | array<string> | Optional | List of fields to be expanded in the response. Provide field names as strings. |
Requirements
Output
json— Response from the API endpoint 'GetEventsId'.StripeApi.RetrieveStripePaymentMethod
Retrieve details of a specific Stripe payment method. Use this tool to get information about a PaymentMethod object attached to a Stripe account. For payment methods attached to a customer, use the appropriate endpoint.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
payment_method_id | string | Required | The unique identifier of the Stripe PaymentMethod to be retrieved. Required for fetching details of a specific payment method. |
fields_to_expand | array<string> | Optional | A list of fields in the response to be expanded for additional details. |
Requirements
Output
json— Response from the API endpoint 'GetPaymentMethodsPaymentMethod'.StripeApi.RetrieveStripePlan
Retrieve details of a specific Stripe plan by ID. Use this tool to get detailed information about a Stripe plan using its ID. It retrieves the plan's data directly from the Stripe service.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
stripe_plan_id | string | Required | The unique identifier for the Stripe plan to retrieve details about. This is required to obtain a specific plan's information. |
fields_to_expand | array<string> | Optional | A list of fields to expand in the response for more detailed information. |
Requirements
Output
json— Response from the API endpoint 'GetPlansPlan'.StripeApi.RetrieveStripePrice
Fetches price details using a specific ID from Stripe. This tool retrieves detailed information about a price by its ID from the Stripe platform. It should be called when specific pricing information is needed for products or services managed via Stripe.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
price_id | string | Required | The unique identifier for the price you want to retrieve from Stripe. |
fields_to_expand | array<string> | Optional | A list of fields in the response that should be expanded to include additional details. |
Requirements
Output
json— Response from the API endpoint 'GetPricesPrice'.StripeApi.RetrieveStripeSource
Retrieve updated details of a Stripe source object. This tool should be called when you need to get the current information of a specific source object in Stripe using its unique source ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
stripe_source_id | string | Required | The unique identifier of the Stripe source object to retrieve its current information. |
source_client_secret | string | Optional | The client secret of the source. Required if a publishable key is used to retrieve the source. |
fields_to_expand | array<string> | Optional | List of fields in the response to be expanded for additional details. |
Requirements
Output
json— Response from the API endpoint 'GetSourcesSource'.StripeApi.RetrieveStripeSubscriptionById
Retrieve a Stripe subscription by its ID. This tool retrieves a subscription from Stripe using the provided subscription ID for a specific customer. Use it when you need details about a specific subscription.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
customer_id | string | Required | The unique identifier for the customer whose subscription is being retrieved. Provide this to specify which customer's subscription details to fetch. |
subscription_id | string | Required | The identifier of the subscription to retrieve. Required to fetch the specific subscription details. |
fields_to_expand | array<string> | Optional | List of fields to expand in the subscription response, allowing for additional details. |
Requirements
Output
json— Response from the API endpoint 'GetCustomersCustomerSubscriptionsSubscriptionExposedId'.StripeApi.RetrieveStripeToken
Retrieve details of a Stripe token using its ID. Use this tool to fetch information about a specific Stripe token by providing its ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
stripe_token_id | string | Required | The ID of the Stripe token you want to retrieve details about. |
fields_to_expand | array<string> | Optional | A list of fields in the response that should be expanded for more detail. |
Requirements
Output
json— Response from the API endpoint 'GetTokensToken'.StripeApi.RetrieveStripeTopupDetails
Retrieve details of a Stripe top-up using its ID. This tool retrieves the details of a previously created Stripe top-up. It requires the unique top-up ID and returns the corresponding top-up information.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
topup_id | string | Required | The unique ID of the Stripe top-up you want to retrieve details for. |
expand_fields | array<string> | Optional | A list of fields in the response to be expanded. Specify field names as strings. |
Requirements
Output
json— Response from the API endpoint 'GetTopupsTopup'.StripeApi.RetrieveStripeVerificationReport
Retrieve details of an existing Stripe verification report. Use this tool to fetch detailed information of a specific identity verification report from Stripe. This is useful for reviewing identity verification results or audit purposes.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
verification_report_id | string | Required | The unique identifier of the verification report to fetch from Stripe. |
fields_to_expand | array<string> | Optional | A list of fields in the response to expand for additional detail. |
Requirements
Output
json— Response from the API endpoint 'GetIdentityVerificationReportsReport'.StripeApi.RetrieveSubscriptionItem
Retrieve details of a specific subscription item. This tool retrieves information about a subscription item using its ID. It can be used to access the specifics of a subscription item within a subscription plan to understand its configuration and parameters.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
subscription_item_id | string | Required | The unique identifier of the subscription item to retrieve details for. |
fields_to_expand | array<string> | Optional | A list of fields in the response to be expanded for detailed information. |
Requirements
Output
json— Response from the API endpoint 'GetSubscriptionItemsItem'.StripeApi.RetrieveSubscriptionSchedule
Get details of an existing subscription schedule by ID. This tool retrieves the detailed information of an existing subscription schedule using its unique identifier. It should be called when detailed information about a subscription schedule is needed.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
subscription_schedule_id | string | Required | The unique identifier for the subscription schedule to retrieve details for. |
fields_to_expand_in_response | array<string> | Optional | A list of fields to expand in the response for additional details. |
Requirements
Output
json— Response from the API endpoint 'GetSubscriptionSchedulesSchedule'.StripeApi.RetrieveTaxCalculation
Retrieve a specific tax calculation by its ID. This tool retrieves details of a Tax Calculation object using its unique ID, provided the calculation has not expired. It is useful for obtaining information on specific tax calculations.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
tax_calculation_id | string | Required | The unique identifier for the Tax Calculation object to retrieve. |
fields_to_expand | array<string> | Optional | List of fields to expand in the response. Use to get detailed subfields of tax calculations. |
Requirements
Output
json— Response from the API endpoint 'GetTaxCalculationsCalculation'.StripeApi.RetrieveTaxCalculationLineItems
Retrieve line items for a Stripe tax calculation. Use this tool to get the line items of a tax calculation from Stripe, provided the calculation hasn't expired.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
tax_calculation_id | string | Required | The ID of the tax calculation to retrieve line items for. Ensure that the calculation has not expired. |
pagination_cursor_ending_before | string | Optional | An object ID to define your place in the list for pagination, used to fetch the previous page. |
fields_to_expand | array<string> | Optional | A list of fields in the response to be expanded. Use this to include additional data in the output. |
object_return_limit | integer | Optional | Specifies the number of objects to return, between 1 and 100. Default is 10. |
pagination_starting_after_item_id | string | Optional | An object ID used for pagination to fetch the next page of results. |
Requirements
Output
json— Response from the API endpoint 'GetTaxCalculationsCalculationLineItems'.StripeApi.RetrieveTaxId
Retrieve an account or customer's tax_id object. Use this tool to retrieve detailed information about a specific tax_id associated with an account or customer on Stripe.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
tax_id_identifier | string | Required | The unique identifier for the tax_id object to be retrieved. This is a required field to specify which tax_id you want information about. |
fields_to_expand | array<string> | Optional | List of fields in the response that should be expanded for detailed information. |
Requirements
Output
json— Response from the API endpoint 'GetTaxIdsId'.StripeApi.RetrieveTaxRate
Fetches a tax rate by its ID from Stripe. Use this tool to retrieve specific tax rate information from Stripe using the tax rate ID. It provides the details associated with the particular tax rate.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
tax_rate_id | string | Required | The unique identifier for the tax rate to be retrieved from Stripe. This ID is required to fetch the specific tax rate details. |
expand_fields | array<string> | Optional | A list of fields to be expanded in the response. This allows you to retrieve additional nested information related to the tax rate. |
Requirements
Output
json— Response from the API endpoint 'GetTaxRatesTaxRate'.StripeApi.RetrieveTaxTransaction
Retrieve details of a specific tax transaction. This tool retrieves a Tax Transaction object from the Stripe API, providing detailed information about a specific tax transaction.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
transaction_id | string | Required | Unique identifier for the tax transaction to retrieve. |
expand_response_fields | array<string> | Optional | A list of fields to expand in the tax transaction response for additional details. |
Requirements
Output
json— Response from the API endpoint 'GetTaxTransactionsTransaction'.StripeApi.RetrieveTerminalConfiguration
Retrieves a terminal configuration object for Stripe.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
configuration_id | string | Required | The unique identifier of the terminal configuration to retrieve. |
expand_fields | array<string> | Optional | A list of fields in the terminal configuration response that should be expanded for more details. |
Requirements
Output
json— Response from the API endpoint 'GetTerminalConfigurationsConfiguration'.StripeApi.RetrieveTerminalLocation
Fetches details of a terminal location by ID. Use this tool to obtain information about a specific terminal location from Stripe by providing the location ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
location_id | string | Required | The unique identifier for the terminal location to retrieve information for. |
fields_to_expand | array<string> | Optional | List of fields in the response to expand for additional details. |
Requirements
Output
json— Response from the API endpoint 'GetTerminalLocationsLocation'.StripeApi.RetrieveTerminalReader
Retrieve details of a terminal reader. This tool retrieves a specific terminal reader object from the Stripe API. It should be called when detailed information about a particular reader is needed.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
terminal_reader_id | string | Required | The unique identifier for the terminal reader to retrieve. It should be a string value. |
fields_to_expand | array<string> | Optional | A list of fields in the response that should be expanded for more detail. |
Requirements
Output
json— Response from the API endpoint 'GetTerminalReadersReader'.StripeApi.RetrieveTestClock
Retrieve details of a Stripe test clock. This tool retrieves information about a specific test clock within Stripe's test environment. It should be used to gather details about test clocks for testing purposes.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
test_clock_id | string | Required | The unique identifier of the test clock to retrieve from Stripe. |
expand_fields | array<string> | Optional | A list of strings specifying which fields in the response should be expanded for additional details. |
Requirements
Output
json— Response from the API endpoint 'GetTestHelpersTestClocksTestClock'.StripeApi.RetrieveTransactionEntry
Fetches details of a specific treasury transaction entry. Use this tool to retrieve detailed information about a specific transaction entry from Stripe's treasury system by providing the transaction entry ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
transaction_entry_id | string | Required | The unique identifier of the treasury transaction entry to retrieve. |
fields_to_expand | array<string> | Optional | An array of field names to include in the response for additional detail. |
Requirements
Output
json— Response from the API endpoint 'GetTreasuryTransactionEntriesId'.StripeApi.RetrieveTreasuryTransactionDetails
Retrieve details of a specific treasury transaction. This tool retrieves the details of an existing treasury transaction by its ID. Use it when you need to access specific information about a treasury transaction in Stripe.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
transaction_id | string | Required | The ID of the treasury transaction you want to retrieve details for. |
fields_to_expand | array<string> | Optional | List of fields in the treasury transaction response to be expanded, specified as an array of strings. |
Requirements
Output
json— Response from the API endpoint 'GetTreasuryTransactionsId'.StripeApi.RetrieveValueListItem
Retrieve details of a specific ValueListItem in Stripe Radar. This tool retrieves information about a specific ValueListItem object from Stripe's Radar service, which can be used to manage elements within its fraud prevention tools.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
value_list_item_id | string | Required | The unique identifier of the ValueListItem to retrieve from Stripe's Radar service. |
fields_to_expand | array<string> | Optional | A list of fields in the ValueListItem response to expand for additional details. |
Requirements
Output
json— Response from the API endpoint 'GetRadarValueListItemsItem'.StripeApi.RetrieveVerificationSessionDetails
Retrieve details of a Stripe verification session. Use this tool to get information about a specific Stripe VerificationSession. It's helpful when the session status is 'requires_input' to obtain a valid client_secret or URL for re-submission.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
verification_session_id | string | Required | The unique identifier of the Stripe VerificationSession to be retrieved. |
expand_response_fields | array<string> | Optional | A list of fields in the response to be expanded for additional details. Use this to customize the verbosity of the response. |
Requirements
Output
json— Response from the API endpoint 'GetIdentityVerificationSessionsSession'.StripeApi.RetrieveWebhookEndpoint
Retrieve details of a specified webhook endpoint by ID. This tool retrieves information about a Stripe webhook endpoint using its ID. Use it when you need to get details such as status, URL, and events for a specific webhook endpoint.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
webhook_endpoint_id | string | Required | The unique identifier for the Stripe webhook endpoint you want to retrieve. |
fields_to_expand | array<string> | Optional | A list of fields to expand in the response, specified as strings. |
Requirements
Output
json— Response from the API endpoint 'GetWebhookEndpointsWebhookEndpoint'.StripeApi.SearchStripeCustomers
Search and retrieve customer data from Stripe. Use this tool to search for customers that have been previously created in Stripe using their Search Query Language. Note that search may not reflect the most recent updates instantly and may experience delays during outages. This tool is not available for use in India.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
search_query_string | string | Required | The search query string used to search for customers. Refer to Stripe's Search Query Language documentation for syntax and supported fields. |
expand_response_fields | array<string> | Optional | A list of fields in the response that should be expanded. Provide the field names as strings. |
customer_result_limit | integer | Optional | Specifies the maximum number of customer records to return, between 1 and 100. Default is 10. |
pagination_cursor | string | Optional | Cursor for paginating through results. Use 'next_page' from a previous response for subsequent results. Omit on the first call. |
Requirements
Output
json— Response from the API endpoint 'GetCustomersSearch'.StripeApi.SearchStripeInvoices
Search for previously created Stripe invoices. This tool searches for invoices you've previously created using Stripe's Search Query Language. It should not be used in read-after-write flows needing strict consistency. Data is typically searchable within a minute but could take up to an hour during outages. Not available for merchants in India.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
search_query_string | string | Required | The search query string using Stripe's Search Query Language. Refer to Stripe's documentation for syntax and supported fields. |
fields_to_expand | array<string> | Optional | A list of fields in the response to be expanded for additional details. Provide field names as strings. |
result_limit | integer | Optional | Defines the maximum number of invoice records to return, ranging from 1 to 100. Defaults to 10 if not specified. |
pagination_cursor | string | Optional | A cursor for pagination to retrieve subsequent pages. Use the next_page value from a previous response; exclude for the first call. |
Requirements
Output
json— Response from the API endpoint 'GetInvoicesSearch'.StripeApi.SearchStripePaymentIntents
Search previously created Stripe PaymentIntents. Use this tool to search for PaymentIntents that you have previously created on Stripe using their Search Query Language. Note that search results might be slightly delayed, so avoid using this tool in scenarios needing strict consistency immediately after data changes.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
search_query_string | string | Required | The search query to find specific PaymentIntents using Stripe's Search Query Language. Refer to the documentation for query syntax and fields. |
expand_fields | array<string> | Optional | A list of specific fields in the response that should be expanded. Use field names as strings. |
result_limit | integer | Optional | Number of PaymentIntent objects to return, ranging from 1 to 100, with a default of 10. |
pagination_cursor | string | Optional | Cursor for pagination. Use the 'next_page' value from a previous response to request more results. |
Requirements
Output
json— Response from the API endpoint 'GetPaymentIntentsSearch'.StripeApi.SearchStripePrices
Search for previously created Stripe prices. Use this tool to search for prices you have previously created on Stripe using the Stripe Search Query Language. Note that this function should not be used for read-after-write flows where strict consistency is necessary, as data may take some time to propagate.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
search_query_string | string | Required | The search query string for prices using Stripe's Search Query Language. Refer to the documentation for syntax and supported fields. |
fields_to_expand | array<string> | Optional | List of fields in the response that should be expanded. |
result_limit | integer | Optional | Specifies the maximum number of price objects to return. Must be between 1 and 100, with a default of 10. |
pagination_cursor | string | Optional | Cursor for paginating through results. Omit on first call; use 'next_page' from a prior response for additional results. |
Requirements
Output
json— Response from the API endpoint 'GetPricesSearch'.StripeApi.SearchStripeProducts
Search for previously created products on Stripe. Use this tool to search for products you have created on Stripe. It utilizes Stripe's Search Query Language for querying. Note that the search may not be suitable for transactions needing strict consistency, as data may be slightly outdated. Also, this service isn't available in India.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
search_query_string | string | Required | The search query string to find products. Refer to Stripe's Search Query Language for syntax and available fields. |
response_fields_to_expand | array<string> | Optional | List of specific fields to expand in the response for detailed information. Use field names as strings. |
results_limit | integer | Optional | Specifies the maximum number of product results to return, ranging from 1 to 100. Defaults to 10 if not set. |
pagination_cursor | string | Optional | A cursor for paginating through the results. Use the 'next_page' value from the previous response for subsequent pages. Do not include this on the first call. |
Requirements
Output
json— Response from the API endpoint 'GetProductsSearch'.StripeApi.SearchStripeSubscriptions
Search previously created Stripe subscriptions. Use this tool to search for subscriptions created with Stripe using their Search Query Language. This is ideal for retrieving subscription data, but not suitable for scenarios requiring strict consistency, such as immediately after creating or updating data. Note: This functionality isn't available for merchants in India.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
search_query_string | string | Required | The search query string used to filter Stripe subscriptions. Refer to the Stripe Search Query Language documentation for syntax and query fields. |
expand_fields | array<string> | Optional | A list of fields in the Stripe subscription response to be expanded. This allows accessing additional data for each subscription object. |
result_limit | integer | Optional | Specify the maximum number of subscription results to return, from 1 to 100. Default is 10. |
pagination_cursor | string | Optional | Cursor for paginating through results. Omit on first call; use next_page value from a prior response for subsequent results. |
Requirements
Output
json— Response from the API endpoint 'GetSubscriptionsSearch'.StripeApi.StripeSearchCharges
Search for previously created charges using Stripe. Use this tool to search for charges you've created with Stripe using their Search Query Language. It's not suitable for scenarios needing strict consistency. Data may take up to an hour to appear during outages, and the feature is unavailable in India.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
search_query_string | string | Required | The search query string using Stripe's Search Query Language to filter charge results. Refer to Stripe's documentation for syntax and fields. |
fields_to_expand | array<string> | Optional | A list of fields in the response that should be expanded for additional detail. |
result_limit | integer | Optional | Specify the number of charge objects to return. The limit can be between 1 and 100, with a default of 10. |
pagination_cursor | string | Optional | Cursor for pagination. Use the 'next_page' value from the previous response for subsequent requests. Omit on the first call. |
Requirements
Output
json— Response from the API endpoint 'GetChargesSearch'.