List Renewable Rentals
list_renewable_line_rentalsUsage Instructions
List renewable line rentals using the supplied filters, including a billing-cycle filter when appropriate. The result contains reservation IDs and complete continuation references. Invoke the referenced tool with its arguments unchanged; do not substitute sale IDs for rental IDs. Requires resources.read.
Read-onlyThis tool reads data without modifying your account or resources.Not open-worldThis tool operates only within Textverified.Not destructiveThis tool is not expected to perform destructive changes.IdempotentRepeating this tool with the same input is not expected to add side effects.
Required scopes
resources.readInput Schema
billingCycleIdstring | nullpaginationobject | nullkeystring | nullrequireddirectionstring{
"type": "object",
"properties": {
"billingCycleId": {
"type": [
"string",
"null"
],
"default": null
},
"pagination": {
"type": [
"object",
"null"
],
"properties": {
"key": {
"type": [
"string",
"null"
]
},
"direction": {
"type": "string",
"enum": [
"Forward",
"Reverse"
]
}
},
"default": null,
"required": [
"key"
]
}
}
}Output Schema
dataarrayrequireditemsobjectcreatedAtstringrequiredidstringrequiredsaleobject | nullrequiredtoolstringrequiredargumentsobjectrequiredsaleIdstring | nullrequiredserviceNamestringrequiredlinkobjectrequiredtoolstringrequiredargumentsobjectrequiredstatestringrequiredbillingCycleobjectrequiredtoolstringrequiredargumentsobjectrequiredbillingCycleIdstringrequiredisIncludedForNextRenewalbooleanrequirednumberstringrequiredalwaysOnbooleanrequiredhasNextbooleanrequiredhasPreviousbooleanrequiredcountintegerrequiredlinksobjectrequiredcurrentobjectrequiredtoolstringrequiredargumentsobjectrequiredpreviousobject | nulltoolstringrequiredargumentsobjectrequirednextobject | nulltoolstringrequiredargumentsobjectrequired{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "date-time"
},
"id": {
"type": "string"
},
"sale": {
"type": [
"object",
"null"
],
"properties": {
"tool": {
"type": "string"
},
"arguments": {
"type": "object"
}
},
"required": [
"tool",
"arguments"
]
},
"saleId": {
"type": [
"string",
"null"
]
},
"serviceName": {
"type": "string"
},
"link": {
"type": "object",
"properties": {
"tool": {
"type": "string"
},
"arguments": {
"type": "object"
}
},
"required": [
"tool",
"arguments"
]
},
"state": {
"type": "string",
"enum": [
"VerificationPending",
"VerificationCompleted",
"VerificationCanceled",
"VerificationTimedOut",
"VerificationReported",
"VerificationRefunded",
"VerificationReused",
"VerificationReactivated",
"RenewableActive",
"RenewableOverdue",
"RenewableExpired",
"RenewableRefunded",
"NonrenewableActive",
"NonrenewableExpired",
"NonrenewableRefunded"
]
},
"billingCycle": {
"type": "object",
"properties": {
"tool": {
"type": "string"
},
"arguments": {
"type": "object"
}
},
"required": [
"tool",
"arguments"
]
},
"billingCycleId": {
"type": "string"
},
"isIncludedForNextRenewal": {
"type": "boolean"
},
"number": {
"type": "string"
},
"alwaysOn": {
"type": "boolean"
}
},
"required": [
"createdAt",
"id",
"sale",
"saleId",
"serviceName",
"link",
"state",
"billingCycle",
"billingCycleId",
"isIncludedForNextRenewal",
"number",
"alwaysOn"
]
}
},
"hasNext": {
"type": "boolean"
},
"hasPrevious": {
"type": "boolean"
},
"count": {
"type": "integer"
},
"links": {
"type": "object",
"properties": {
"current": {
"type": "object",
"properties": {
"tool": {
"type": "string"
},
"arguments": {
"type": "object"
}
},
"required": [
"tool",
"arguments"
]
},
"previous": {
"type": [
"object",
"null"
],
"properties": {
"tool": {
"type": "string"
},
"arguments": {
"type": "object"
}
},
"required": [
"tool",
"arguments"
]
},
"next": {
"type": [
"object",
"null"
],
"properties": {
"tool": {
"type": "string"
},
"arguments": {
"type": "object"
}
},
"required": [
"tool",
"arguments"
]
}
},
"required": [
"current"
]
}
},
"required": [
"data",
"hasNext",
"hasPrevious",
"count",
"links"
]
}