{ "name": "PauseSubscription", "fully_qualified_name": "SquareupApi.PauseSubscription@2.0.0", "description": "Schedule a pause for an active subscription.\n\nUse this tool to pause an active subscription by scheduling a `PAUSE` action. Call it when you need to temporarily halt a subscription's services.", "toolkit": { "name": "ArcadeSquareupApi", "description": null, "version": "2.0.0" }, "input": { "parameters": [ { "name": "subscription_id", "required": true, "description": "The unique ID of the subscription you want to pause.", "value_schema": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "The ID of the subscription to pause." }, "inferrable": true, "http_endpoint_parameter_name": "subscription_id" }, { "name": "pause_effective_date", "required": false, "description": "The `YYYY-MM-DD`-formatted date when the scheduled `PAUSE` action occurs. If unspecified or within the current billing cycle, the subscription pauses at the start of the next cycle.", "value_schema": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "The `YYYY-MM-DD`-formatted date when the scheduled `PAUSE` action takes place on the subscription.\n\nWhen this date is unspecified or falls within the current billing cycle, the subscription is paused\non the starting date of the next billing cycle." }, "inferrable": true, "http_endpoint_parameter_name": "pause_effective_date" }, { "name": "pause_cycle_count", "required": false, "description": "Specify the number of billing cycles to pause the subscription. A 'RESUME' action will be scheduled at the end of this period. Do not set 'resume_effective_date' or 'resume_change_timing' if this is used.", "value_schema": { "val_type": "integer", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "The number of billing cycles the subscription will be paused before it is reactivated. \n\nWhen this is set, a `RESUME` action is also scheduled to take place on the subscription at \nthe end of the specified pause cycle duration. In this case, neither `resume_effective_date` \nnor `resume_change_timing` may be specified." }, "inferrable": true, "http_endpoint_parameter_name": "pause_cycle_duration" }, { "name": "reactivation_date", "required": false, "description": "The date (YYYY-MM-DD) when the subscription is reactivated by a scheduled `RESUME` action. Must be at least one billing cycle after `pause_effective_date`.", "value_schema": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "The date when the subscription is reactivated by a scheduled `RESUME` action. \nThis date must be at least one billing cycle ahead of `pause_effective_date`." }, "inferrable": true, "http_endpoint_parameter_name": "resume_effective_date" }, { "name": "resume_change_timing", "required": false, "description": "Specifies when the subscription resume action takes place. Options are 'IMMEDIATE' or 'END_OF_BILLING_CYCLE'.", "value_schema": { "val_type": "string", "inner_val_type": null, "enum": [ "IMMEDIATE", "END_OF_BILLING_CYCLE" ], "properties": null, "inner_properties": null, "description": "Supported timings when a pending change, as an action, takes place to a subscription." }, "inferrable": true, "http_endpoint_parameter_name": "resume_change_timing" }, { "name": "pause_reason", "required": false, "description": "The reason provided by the user for pausing the subscription. It should convey the rationale behind the pause action.", "value_schema": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "The user-provided reason to pause the subscription." }, "inferrable": true, "http_endpoint_parameter_name": "pause_reason" } ] }, "output": { "description": "Response from the API endpoint 'PauseSubscription'.", "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": { "provider_id": "arcade-squareup", "provider_type": "oauth2", "id": null, "oauth2": { "scopes": [ "ITEMS_READ", "INVOICES_WRITE", "CUSTOMERS_READ", "SUBSCRIPTIONS_WRITE", "ORDERS_WRITE", "PAYMENTS_WRITE" ] } }, "secrets": null, "metadata": null }, "deprecation_message": null, "metadata": { "object_type": "api_wrapper_tool", "version": "1.1.0", "description": "Tools that enable LLMs to interact directly with the squareup API." }, "http_endpoint": { "metadata": { "object_type": "http_endpoint", "version": "1.2.0", "description": "" }, "url": "https://connect.squareup.com/v2/subscriptions/{subscription_id}/pause", "http_method": "POST", "headers": {}, "parameters": [ { "name": "subscription_id", "tool_parameter_name": "subscription_id", "description": "The ID of the subscription to pause.", "value_schema": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "The ID of the subscription to pause." }, "accepted_as": "path", "required": true, "deprecated": false, "default": null, "documentation_urls": [] }, { "name": "pause_effective_date", "tool_parameter_name": "pause_effective_date", "description": "The `YYYY-MM-DD`-formatted date when the scheduled `PAUSE` action takes place on the subscription.\n\nWhen this date is unspecified or falls within the current billing cycle, the subscription is paused\non the starting date of the next billing cycle.", "value_schema": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "The `YYYY-MM-DD`-formatted date when the scheduled `PAUSE` action takes place on the subscription.\n\nWhen this date is unspecified or falls within the current billing cycle, the subscription is paused\non the starting date of the next billing cycle." }, "accepted_as": "body", "required": false, "deprecated": false, "default": null, "documentation_urls": [] }, { "name": "pause_cycle_duration", "tool_parameter_name": "pause_cycle_count", "description": "The number of billing cycles the subscription will be paused before it is reactivated. \n\nWhen this is set, a `RESUME` action is also scheduled to take place on the subscription at \nthe end of the specified pause cycle duration. In this case, neither `resume_effective_date` \nnor `resume_change_timing` may be specified.", "value_schema": { "val_type": "integer", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "The number of billing cycles the subscription will be paused before it is reactivated. \n\nWhen this is set, a `RESUME` action is also scheduled to take place on the subscription at \nthe end of the specified pause cycle duration. In this case, neither `resume_effective_date` \nnor `resume_change_timing` may be specified." }, "accepted_as": "body", "required": false, "deprecated": false, "default": null, "documentation_urls": [] }, { "name": "resume_effective_date", "tool_parameter_name": "reactivation_date", "description": "The date when the subscription is reactivated by a scheduled `RESUME` action. \nThis date must be at least one billing cycle ahead of `pause_effective_date`.", "value_schema": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "The date when the subscription is reactivated by a scheduled `RESUME` action. \nThis date must be at least one billing cycle ahead of `pause_effective_date`." }, "accepted_as": "body", "required": false, "deprecated": false, "default": null, "documentation_urls": [] }, { "name": "resume_change_timing", "tool_parameter_name": "resume_change_timing", "description": "Supported timings when a pending change, as an action, takes place to a subscription.", "value_schema": { "val_type": "string", "inner_val_type": null, "enum": [ "IMMEDIATE", "END_OF_BILLING_CYCLE" ], "properties": null, "inner_properties": null, "description": "Supported timings when a pending change, as an action, takes place to a subscription." }, "accepted_as": "body", "required": false, "deprecated": false, "default": null, "documentation_urls": [] }, { "name": "pause_reason", "tool_parameter_name": "pause_reason", "description": "The user-provided reason to pause the subscription.", "value_schema": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "The user-provided reason to pause the subscription." }, "accepted_as": "body", "required": false, "deprecated": false, "default": null, "documentation_urls": [] } ], "documentation_urls": [], "secrets": [ { "arcade_key": "auth_token", "parameter_name": "Authorization", "accepted_as": "header", "formatted_value": "Bearer {authorization}", "description": "The OAuth token to use for authentication.", "is_auth_token": true } ], "request_body_spec": "{\n \"required\": true,\n \"description\": \"An object containing the fields to POST for the request.\\n\\nSee the corresponding object definition for field details.\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"description\": \"Defines input parameters in a request to the\\n[PauseSubscription](api-endpoint:Subscriptions-PauseSubscription) endpoint.\",\n \"x-release-status\": \"BETA\",\n \"properties\": {\n \"pause_effective_date\": {\n \"type\": \"string\",\n \"description\": \"The `YYYY-MM-DD`-formatted date when the scheduled `PAUSE` action takes place on the subscription.\\n\\nWhen this date is unspecified or falls within the current billing cycle, the subscription is paused\\non the starting date of the next billing cycle.\",\n \"nullable\": true\n },\n \"pause_cycle_duration\": {\n \"type\": \"integer\",\n \"description\": \"The number of billing cycles the subscription will be paused before it is reactivated. \\n\\nWhen this is set, a `RESUME` action is also scheduled to take place on the subscription at \\nthe end of the specified pause cycle duration. In this case, neither `resume_effective_date` \\nnor `resume_change_timing` may be specified.\",\n \"format\": \"int64\",\n \"nullable\": true\n },\n \"resume_effective_date\": {\n \"type\": \"string\",\n \"description\": \"The date when the subscription is reactivated by a scheduled `RESUME` action. \\nThis date must be at least one billing cycle ahead of `pause_effective_date`.\",\n \"nullable\": true\n },\n \"resume_change_timing\": {\n \"type\": \"string\",\n \"enum\": [\n \"IMMEDIATE\",\n \"END_OF_BILLING_CYCLE\"\n ],\n \"x-enum-elements\": [\n {\n \"name\": \"IMMEDIATE\",\n \"description\": \"The action occurs immediately.\"\n },\n {\n \"name\": \"END_OF_BILLING_CYCLE\",\n \"description\": \"The action occurs at the end of the billing cycle.\"\n }\n ],\n \"description\": \"Supported timings when a pending change, as an action, takes place to a subscription.\",\n \"x-release-status\": \"BETA\"\n },\n \"pause_reason\": {\n \"type\": \"string\",\n \"description\": \"The user-provided reason to pause the subscription.\",\n \"maxLength\": 255,\n \"nullable\": true\n }\n }\n }\n }\n }\n}", "use_request_body_schema_mode": false, "validate_request_body_schema": false } }