Stripe Starter toolkit auto-generated from the official [OpenAPI specification](https://raw.githubusercontent.com/stripe/openapi/refs/heads/master/openapi/spec3.json).
400 lines
15 KiB
JSON
400 lines
15 KiB
JSON
{
|
|
"name": "GetCustomerPaymentMethods",
|
|
"fully_qualified_name": "StripeApi.GetCustomerPaymentMethods@0.1.0",
|
|
"description": "Retrieve payment methods for a specific customer.\n\nThis tool should be called to obtain a list of payment methods associated with a particular customer in Stripe.",
|
|
"toolkit": {
|
|
"name": "ArcadeStripeApi",
|
|
"description": null,
|
|
"version": "0.1.0"
|
|
},
|
|
"input": {
|
|
"parameters": [
|
|
{
|
|
"name": "customer_id",
|
|
"required": true,
|
|
"description": "Unique identifier for the customer whose payment methods are to be retrieved.",
|
|
"value_schema": {
|
|
"val_type": "string",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": ""
|
|
},
|
|
"inferrable": true,
|
|
"http_endpoint_parameter_name": "customer"
|
|
},
|
|
{
|
|
"name": "enable_redisplay_setting",
|
|
"required": false,
|
|
"description": "Indicates if the payment method can be shown again in a checkout flow. Options: 'always', 'limited', 'unspecified'.",
|
|
"value_schema": {
|
|
"val_type": "string",
|
|
"inner_val_type": null,
|
|
"enum": [
|
|
"always",
|
|
"limited",
|
|
"unspecified"
|
|
],
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow."
|
|
},
|
|
"inferrable": true,
|
|
"http_endpoint_parameter_name": "allow_redisplay"
|
|
},
|
|
{
|
|
"name": "pagination_ending_before_id",
|
|
"required": false,
|
|
"description": "An object ID used to paginate backwards by defining the end of the list.",
|
|
"value_schema": {
|
|
"val_type": "string",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list."
|
|
},
|
|
"inferrable": true,
|
|
"http_endpoint_parameter_name": "ending_before"
|
|
},
|
|
{
|
|
"name": "response_fields_to_expand",
|
|
"required": false,
|
|
"description": "A list of fields to expand in the response for detailed information.",
|
|
"value_schema": {
|
|
"val_type": "array",
|
|
"inner_val_type": "string",
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "Specifies which fields in the response should be expanded."
|
|
},
|
|
"inferrable": true,
|
|
"http_endpoint_parameter_name": "expand"
|
|
},
|
|
{
|
|
"name": "max_payment_methods_returned",
|
|
"required": false,
|
|
"description": "Limit the number of payment methods returned. Accepts a value between 1 and 100, with a default of 10.",
|
|
"value_schema": {
|
|
"val_type": "integer",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10."
|
|
},
|
|
"inferrable": true,
|
|
"http_endpoint_parameter_name": "limit"
|
|
},
|
|
{
|
|
"name": "pagination_starting_after_cursor",
|
|
"required": false,
|
|
"description": "Cursor for pagination that defines the start point in the list. Use the ID of the last object from the previous page.",
|
|
"value_schema": {
|
|
"val_type": "string",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list."
|
|
},
|
|
"inferrable": true,
|
|
"http_endpoint_parameter_name": "starting_after"
|
|
},
|
|
{
|
|
"name": "payment_method_type_filter",
|
|
"required": false,
|
|
"description": "Specify a payment method type to filter the list. Without filtering, all types are included. Choose from options like 'card', 'paypal', etc.",
|
|
"value_schema": {
|
|
"val_type": "string",
|
|
"inner_val_type": null,
|
|
"enum": [
|
|
"acss_debit",
|
|
"affirm",
|
|
"afterpay_clearpay",
|
|
"alipay",
|
|
"alma",
|
|
"amazon_pay",
|
|
"au_becs_debit",
|
|
"bacs_debit",
|
|
"bancontact",
|
|
"billie",
|
|
"blik",
|
|
"boleto",
|
|
"card",
|
|
"cashapp",
|
|
"crypto",
|
|
"customer_balance",
|
|
"eps",
|
|
"fpx",
|
|
"giropay",
|
|
"grabpay",
|
|
"ideal",
|
|
"kakao_pay",
|
|
"klarna",
|
|
"konbini",
|
|
"kr_card",
|
|
"link",
|
|
"mb_way",
|
|
"mobilepay",
|
|
"multibanco",
|
|
"naver_pay",
|
|
"nz_bank_account",
|
|
"oxxo",
|
|
"p24",
|
|
"pay_by_bank",
|
|
"payco",
|
|
"paynow",
|
|
"paypal",
|
|
"pix",
|
|
"promptpay",
|
|
"revolut_pay",
|
|
"samsung_pay",
|
|
"satispay",
|
|
"sepa_debit",
|
|
"sofort",
|
|
"swish",
|
|
"twint",
|
|
"us_bank_account",
|
|
"wechat_pay",
|
|
"zip"
|
|
],
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "An optional filter on the list, based on the object `type` field. Without the filter, the list includes all current and future payment method types. If your integration expects only one type of payment method in the response, make sure to provide a type value in the request."
|
|
},
|
|
"inferrable": true,
|
|
"http_endpoint_parameter_name": "type"
|
|
}
|
|
]
|
|
},
|
|
"output": {
|
|
"description": "Response from the API endpoint 'GetCustomersCustomerPaymentMethods'.",
|
|
"available_modes": [
|
|
"value",
|
|
"error",
|
|
"null"
|
|
],
|
|
"value_schema": {
|
|
"val_type": "json",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": null
|
|
}
|
|
},
|
|
"requirements": {
|
|
"authorization": null,
|
|
"secrets": [
|
|
{
|
|
"key": "STRIPE_API_KEY"
|
|
}
|
|
],
|
|
"metadata": null
|
|
},
|
|
"deprecation_message": null,
|
|
"metadata": {
|
|
"object_type": "api_wrapper_tool",
|
|
"version": "1.0.0",
|
|
"description": "Tools that enable LLMs to interact directly with the Stripe API."
|
|
},
|
|
"http_endpoint": {
|
|
"metadata": {
|
|
"object_type": "http_endpoint",
|
|
"version": "1.0.0",
|
|
"description": ""
|
|
},
|
|
"url": "https://api.stripe.com/v1/customers/{customer}/payment_methods",
|
|
"http_method": "GET",
|
|
"headers": {},
|
|
"parameters": [
|
|
{
|
|
"name": "allow_redisplay",
|
|
"tool_parameter_name": "enable_redisplay_setting",
|
|
"description": "This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow.",
|
|
"value_schema": {
|
|
"val_type": "string",
|
|
"inner_val_type": null,
|
|
"enum": [
|
|
"always",
|
|
"limited",
|
|
"unspecified"
|
|
],
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow."
|
|
},
|
|
"accepted_as": "query",
|
|
"required": false,
|
|
"deprecated": false,
|
|
"documentation_urls": []
|
|
},
|
|
{
|
|
"name": "ending_before",
|
|
"tool_parameter_name": "pagination_ending_before_id",
|
|
"description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.",
|
|
"value_schema": {
|
|
"val_type": "string",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list."
|
|
},
|
|
"accepted_as": "query",
|
|
"required": false,
|
|
"deprecated": false,
|
|
"documentation_urls": []
|
|
},
|
|
{
|
|
"name": "expand",
|
|
"tool_parameter_name": "response_fields_to_expand",
|
|
"description": "Specifies which fields in the response should be expanded.",
|
|
"value_schema": {
|
|
"val_type": "array",
|
|
"inner_val_type": "string",
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "Specifies which fields in the response should be expanded."
|
|
},
|
|
"accepted_as": "query",
|
|
"required": false,
|
|
"deprecated": false,
|
|
"documentation_urls": []
|
|
},
|
|
{
|
|
"name": "limit",
|
|
"tool_parameter_name": "max_payment_methods_returned",
|
|
"description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.",
|
|
"value_schema": {
|
|
"val_type": "integer",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10."
|
|
},
|
|
"accepted_as": "query",
|
|
"required": false,
|
|
"deprecated": false,
|
|
"documentation_urls": []
|
|
},
|
|
{
|
|
"name": "starting_after",
|
|
"tool_parameter_name": "pagination_starting_after_cursor",
|
|
"description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.",
|
|
"value_schema": {
|
|
"val_type": "string",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list."
|
|
},
|
|
"accepted_as": "query",
|
|
"required": false,
|
|
"deprecated": false,
|
|
"documentation_urls": []
|
|
},
|
|
{
|
|
"name": "type",
|
|
"tool_parameter_name": "payment_method_type_filter",
|
|
"description": "An optional filter on the list, based on the object `type` field. Without the filter, the list includes all current and future payment method types. If your integration expects only one type of payment method in the response, make sure to provide a type value in the request.",
|
|
"value_schema": {
|
|
"val_type": "string",
|
|
"inner_val_type": null,
|
|
"enum": [
|
|
"acss_debit",
|
|
"affirm",
|
|
"afterpay_clearpay",
|
|
"alipay",
|
|
"alma",
|
|
"amazon_pay",
|
|
"au_becs_debit",
|
|
"bacs_debit",
|
|
"bancontact",
|
|
"billie",
|
|
"blik",
|
|
"boleto",
|
|
"card",
|
|
"cashapp",
|
|
"crypto",
|
|
"customer_balance",
|
|
"eps",
|
|
"fpx",
|
|
"giropay",
|
|
"grabpay",
|
|
"ideal",
|
|
"kakao_pay",
|
|
"klarna",
|
|
"konbini",
|
|
"kr_card",
|
|
"link",
|
|
"mb_way",
|
|
"mobilepay",
|
|
"multibanco",
|
|
"naver_pay",
|
|
"nz_bank_account",
|
|
"oxxo",
|
|
"p24",
|
|
"pay_by_bank",
|
|
"payco",
|
|
"paynow",
|
|
"paypal",
|
|
"pix",
|
|
"promptpay",
|
|
"revolut_pay",
|
|
"samsung_pay",
|
|
"satispay",
|
|
"sepa_debit",
|
|
"sofort",
|
|
"swish",
|
|
"twint",
|
|
"us_bank_account",
|
|
"wechat_pay",
|
|
"zip"
|
|
],
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "An optional filter on the list, based on the object `type` field. Without the filter, the list includes all current and future payment method types. If your integration expects only one type of payment method in the response, make sure to provide a type value in the request."
|
|
},
|
|
"accepted_as": "query",
|
|
"required": false,
|
|
"deprecated": false,
|
|
"documentation_urls": []
|
|
},
|
|
{
|
|
"name": "customer",
|
|
"tool_parameter_name": "customer_id",
|
|
"description": "",
|
|
"value_schema": {
|
|
"val_type": "string",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": ""
|
|
},
|
|
"accepted_as": "path",
|
|
"required": true,
|
|
"deprecated": false,
|
|
"documentation_urls": []
|
|
}
|
|
],
|
|
"documentation_urls": [],
|
|
"secrets": [
|
|
{
|
|
"arcade_key": "STRIPE_API_KEY",
|
|
"parameter_name": "Authorization",
|
|
"accepted_as": "header",
|
|
"formatted_value": "Bearer {authorization}",
|
|
"description": "",
|
|
"is_auth_token": false
|
|
}
|
|
]
|
|
}
|
|
}
|