space.highport.manage.listDomainBilling

The payer policy of every domain the caller owns. A domain with nothing set reports the default: the owner pays, with no visitor cap.

Details · query
Kindquery
Authoritymanage.highport.space
Indexed
cid bafyreie23i7gxswv56hmbftebxylpkq6qdjxi7l5y2olma4qrgvnv6qfbm

Checks

Valid
JSONDownload
{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "main": {
      "description": "The payer policy of every domain the caller owns. A domain with nothing set reports the default: the owner pays, with no visitor cap.",
      "output": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "cursor": {
              "description": "Present when more entries exist.",
              "type": "string"
            },
            "domains": {
              "items": {
                "description": "Whose allowance a domain's traffic uses.",
                "properties": {
                  "domain": {
                    "description": "The domain.",
                    "type": "string"
                  },
                  "fallbackToOwner": {
                    "description": "Under the visitor policy: whether a visitor who has run out falls back to the owner instead of being refused.",
                    "type": "boolean"
                  },
                  "ownerBudgetBytes": {
                    "description": "How many bytes of the owner's allowance this site may spend per period on readers who are not signed in. 0 requires sign-in for everything. When set, it determines payerPolicy and fallbackToOwner; when omitted, those two apply as set.",
                    "minimum": 0,
                    "type": "integer"
                  },
                  "payerPolicy": {
                    "description": "owner or visitor.",
                    "knownValues": [
                      "owner",
                      "visitor"
                    ],
                    "type": "string"
                  },
                  "updatedAt": {
                    "description": "When this last changed. Absent when the domain is using the default.",
                    "format": "datetime",
                    "type": "string"
                  },
                  "visitorCapBytes": {
                    "description": "The most any one visitor can spend here per period.",
                    "type": "integer"
                  }
                },
                "required": [
                  "domain",
                  "payerPolicy",
                  "fallbackToOwner"
                ],
                "type": "object"
              },
              "type": "array"
            }
          },
          "required": [
            "domains"
          ],
          "type": "object"
        }
      },
      "parameters": {
        "properties": {
          "cursor": {
            "description": "Pagination cursor from a previous response.",
            "type": "string"
          },
          "limit": {
            "default": 50,
            "description": "Maximum entries to return.",
            "maximum": 100,
            "minimum": 1,
            "type": "integer"
          }
        },
        "type": "params"
      },
      "type": "query"
    }
  },
  "id": "space.highport.manage.listDomainBilling",
  "lexicon": 1
}