List Billing Cycles
list_billing_cyclesUsage Instructions
List billing cycles with pagination. Use cycle IDs returned here to inspect invoices or manage a particular rental billing group. Follow links.next or links.previous by invoking its tool with the complete arguments unchanged. 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
paginationobject | nullkeystring | nullrequireddirectionstring{
"type": "object",
"properties": {
"pagination": {
"type": [
"object",
"null"
],
"properties": {
"key": {
"type": [
"string",
"null"
]
},
"direction": {
"type": "string",
"enum": [
"Forward",
"Reverse"
]
}
},
"default": null,
"required": [
"key"
]
}
}
}Output Schema
dataarrayrequireditemsobjectidstringrequiredbillingCycleEndsAtstringrequiredemailNotificationsEnabledbooleanrequiredstatestringrequiredhasNextbooleanrequiredhasPreviousbooleanrequiredcountintegerrequiredlinksobjectrequiredcurrentobjectrequiredtoolstringrequiredargumentsobjectrequiredpreviousobject | nulltoolstringrequiredargumentsobjectrequirednextobject | nulltoolstringrequiredargumentsobjectrequired{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"billingCycleEndsAt": {
"type": "string",
"format": "date-time"
},
"emailNotificationsEnabled": {
"type": "boolean"
},
"state": {
"type": "string"
}
},
"required": [
"id",
"billingCycleEndsAt",
"emailNotificationsEnabled",
"state"
]
}
},
"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"
]
}