Get Billing Cycle Invoices
list_billing_cycle_invoicesUsage Instructions
List invoices associated with the billing cycle identified by id. Inspect invoice state before requesting renewal. Follow returned continuation references using their complete arguments, which preserve the billing cycle ID. IDs and pagination keys are opaque. 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
idstringrequiredpaginationobject | nullkeystring | nullrequireddirectionstring{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"pagination": {
"type": [
"object",
"null"
],
"properties": {
"key": {
"type": [
"string",
"null"
]
},
"direction": {
"type": "string",
"enum": [
"Forward",
"Reverse"
]
}
},
"default": null,
"required": [
"key"
]
}
},
"required": [
"id"
]
}Output Schema
dataarrayrequireditemsobjectcreatedAtstringrequiredidstringrequiredexcludedRentalsarrayrequireditemsobjectnumberstringrequiredrentalobjectrequiredtoolstringrequiredargumentsobjectrequiredrenewalCostnumberrequiredserviceNamestringrequiredalreadyRenewedbooleanrequiredincludedAddOnsarrayrequireditemsobjectaddOnIdstringrequireddescriptionstringrequiredrenewalCostnumberrequiredalreadyRenewedbooleanrequiredexcludedAddOnsarrayrequireditemsrefincludedRentalsarrayrequireditemsrefisPaidForbooleanrequiredtotalCostnumberrequiredhasNextbooleanrequiredhasPreviousbooleanrequiredcountintegerrequiredlinksobjectrequiredcurrentobjectrequiredtoolstringrequiredargumentsobjectrequiredpreviousobject | nulltoolstringrequiredargumentsobjectrequirednextobject | nulltoolstringrequiredargumentsobjectrequired{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"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/data/items/properties/excludedRentals/items/properties/includedAddOns/items"
}
}
},
"required": [
"number",
"rental",
"renewalCost",
"serviceName",
"alreadyRenewed",
"includedAddOns",
"excludedAddOns"
]
}
},
"includedRentals": {
"type": "array",
"items": {
"$ref": "#/properties/data/items/properties/excludedRentals/items"
}
},
"isPaidFor": {
"type": "boolean"
},
"totalCost": {
"type": "number"
}
},
"required": [
"createdAt",
"id",
"excludedRentals",
"includedRentals",
"isPaidFor",
"totalCost"
]
}
},
"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"
]
}