Schedule Rental Billing Cycle Upgrade
schedule_rental_billing_cycle_upgradeUsage Instructions
Schedule a billing-cycle upgrade for the rental identified by id using the selected request option. This changes the rental's billing plan and can affect charges. Inspect available options and obtain approval first; preserve the returned job identifier for subsequent inspection or cancellation. Requires resources.purchase. There is no idempotency key. After a timeout or ambiguous failure, inspect the affected resource and sales where applicable before retrying; repeating a mutation can repeat its side effects.
Read-writeThis tool may create, modify, or delete account resources.Not open-worldThis tool operates only within Textverified.DestructiveThis tool may permanently delete or irreversibly change data. Confirm before running it.Not idempotentRepeating this tool may repeat its side effects. Check the result before retrying.
Required scopes
resources.readresources.purchaseInput Schema
idstringrequiredrequestobject | nullrequireddesiredDurationstringrequired{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"request": {
"type": [
"object",
"null"
],
"properties": {
"desiredDuration": {
"type": "string",
"enum": [
"OneDay",
"ThreeDay",
"SevenDay",
"FourteenDay",
"ThirtyDay",
"NinetyDay",
"OneYear"
]
}
},
"required": [
"desiredDuration"
]
}
},
"required": [
"id",
"request"
]
}Output Schema
reservationIdstringrequireddesiredRentalDurationstringrequiredscheduledForstringrequiredcancellableBeforestringrequirednextRenewalAfterJobCompletedstringrequiredcostnumberrequiredstatestringrequiredidstringrequired{
"type": "object",
"properties": {
"reservationId": {
"type": "string"
},
"desiredRentalDuration": {
"type": "string",
"enum": [
"OneDay",
"ThreeDay",
"SevenDay",
"FourteenDay",
"ThirtyDay",
"NinetyDay",
"OneYear"
]
},
"scheduledFor": {
"type": "string",
"format": "date-time"
},
"cancellableBefore": {
"type": "string",
"format": "date-time"
},
"nextRenewalAfterJobCompleted": {
"type": "string",
"format": "date-time"
},
"cost": {
"type": "number"
},
"state": {
"type": "string",
"enum": [
"Created",
"Cancelled",
"Succeeded",
"Suspended"
]
},
"id": {
"type": "string"
}
},
"required": [
"reservationId",
"desiredRentalDuration",
"scheduledFor",
"cancellableBefore",
"nextRenewalAfterJobCompleted",
"cost",
"state",
"id"
]
}