{ "name": "GetCustomerSubscriptions", "fully_qualified_name": "StripeApi.GetCustomerSubscriptions@0.1.0", "description": "Retrieve a customer's active subscriptions.\n\nUse 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.", "toolkit": { "name": "ArcadeStripeApi", "description": null, "version": "0.1.0" }, "input": { "parameters": [ { "name": "customer_id", "required": true, "description": "The unique identifier for the customer whose subscriptions are being 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": "pagination_ending_before_cursor", "required": false, "description": "An object ID to define your position in pagination. Use this cursor to fetch the previous page of subscriptions.", "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": "fields_to_expand", "required": false, "description": "A list of fields in the response that should be expanded for additional details.", "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": "subscription_limit", "required": false, "description": "The maximum number of subscription objects to return. Must be between 1 and 100, defaulting to 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_object_id", "required": false, "description": "An object ID used as a cursor to fetch the next page of subscriptions in a paginated 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." }, "inferrable": true, "http_endpoint_parameter_name": "starting_after" } ] }, "output": { "description": "Response from the API endpoint 'GetCustomersCustomerSubscriptions'.", "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}/subscriptions", "http_method": "GET", "headers": {}, "parameters": [ { "name": "ending_before", "tool_parameter_name": "pagination_ending_before_cursor", "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": "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": "subscription_limit", "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_object_id", "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": "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 } ] } }