Preview Billing Cycle Invoice
preview_next_billing_cycle_renewable_invoiceUsage Instructions
Preview the next renewable invoice for the billing cycle identified by id. Inspect included rentals and estimated cost before deciding whether to renew. This builds an estimate without persisting an invoice or spending credits; the eventual renewal can differ if prices or rental state change. Requires resources.purchase.
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.readresources.purchaseInput Schema
idstringrequired{
"type": "object",
"properties": {
"id": {
"type": "string"
}
},
"required": [
"id"
]
}Output Schema
billingCycleIdstringrequiredrenewalEstimateobjectrequiredcreatedAtstringrequiredidstringrequiredexcludedRentalsarrayrequireditemsobjectnumberstringrequiredrentalobjectrequiredtoolstringrequiredargumentsobjectrequiredrenewalCostnumberrequiredserviceNamestringrequiredalreadyRenewedbooleanrequiredincludedAddOnsarrayrequireditemsobjectaddOnIdstringrequireddescriptionstringrequiredrenewalCostnumberrequiredalreadyRenewedbooleanrequiredexcludedAddOnsarrayrequireditemsrefincludedRentalsarrayrequireditemsrefisPaidForbooleanrequiredtotalCostnumberrequired{
"type": "object",
"properties": {
"billingCycleId": {
"type": "string"
},
"renewalEstimate": {
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "date-time"
},
"id": {
"type": "string"
},
"excludedRentals": {
"type": "array",
"items": {
"type": "object",
"properties": {
"number": {
"type": "string"
},
"rental": {
"type": "object",
"properties": {
"tool": {
"type": "string"
},
"arguments": {
"type": "object"
}
},
"required": [
"tool",
"arguments"
]
},
"renewalCost": {
"type": "number"
},
"serviceName": {
"type": "string"
},
"alreadyRenewed": {
"type": "boolean"
},
"includedAddOns": {
"type": "array",
"items": {
"type": "object",
"properties": {
"addOnId": {
"type": "string"
},
"description": {
"type": "string"
},
"renewalCost": {
"type": "number"
},
"alreadyRenewed": {
"type": "boolean"
}
},
"required": [
"addOnId",
"description",
"renewalCost",
"alreadyRenewed"
]
}
},
"excludedAddOns": {
"type": "array",
"items": {
"$ref": "#/properties/renewalEstimate/properties/excludedRentals/items/properties/includedAddOns/items"
}
}
},
"required": [
"number",
"rental",
"renewalCost",
"serviceName",
"alreadyRenewed",
"includedAddOns",
"excludedAddOns"
]
}
},
"includedRentals": {
"type": "array",
"items": {
"$ref": "#/properties/renewalEstimate/properties/excludedRentals/items"
}
},
"isPaidFor": {
"type": "boolean"
},
"totalCost": {
"type": "number"
}
},
"required": [
"createdAt",
"id",
"excludedRentals",
"includedRentals",
"isPaidFor",
"totalCost"
]
}
},
"required": [
"billingCycleId",
"renewalEstimate"
]
}