The payer policy of every domain the caller owns. A domain with nothing set reports the default: the owner pays, with no visitor cap.
Parameters
Output
Encoding
application/jsoncursor
string
Optional
Present when more entries exist.
domains
array
Required
No description available.
Try It
Requests are sent directly from your browser. Some servers may block requests due to CORS.
View raw schema
{
"type": "query",
"output": {
"schema": {
"type": "object",
"required": [
"domains"
],
"properties": {
"cursor": {
"type": "string",
"description": "Present when more entries exist."
},
"domains": {
"type": "array",
"items": {
"type": "object",
"required": [
"domain",
"payerPolicy",
"fallbackToOwner"
],
"properties": {
"domain": {
"type": "string",
"description": "The domain."
},
"updatedAt": {
"type": "string",
"format": "datetime",
"description": "When this last changed. Absent when the domain is using the default."
},
"payerPolicy": {
"type": "string",
"description": "owner or visitor.",
"knownValues": [
"owner",
"visitor"
]
},
"fallbackToOwner": {
"type": "boolean",
"description": "Under the visitor policy: whether a visitor who has run out falls back to the owner instead of being refused."
},
"visitorCapBytes": {
"type": "integer",
"description": "The most any one visitor can spend here per period."
},
"ownerBudgetBytes": {
"type": "integer",
"minimum": 0,
"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."
}
},
"description": "Whose allowance a domain's traffic uses."
}
}
}
},
"encoding": "application/json"
},
"parameters": {
"type": "params",
"properties": {
"limit": {
"type": "integer",
"default": 50,
"maximum": 100,
"minimum": 1,
"description": "Maximum entries to return."
},
"cursor": {
"type": "string",
"description": "Pagination cursor from a previous response."
}
}
},
"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."
}