at.marque.partner.listPricing
Schema Diff
+2 -1
Compatibility Analysis
Backward Compatible
No changes detected.
1
1
{
2
2
"id": "at.marque.partner.listPricing",
3
3
"defs": {
4
4
"tld": {
5
5
"type": "object",
6
6
"required": [
7
7
"tld",
8
8
"registerPrice",
9
9
"renewPrice",
10
10
"transferPrice"
11
11
],
12
12
"properties": {
13
13
"tld": {
14
14
"type": "string",
15
15
"description": "The TLD including leading dot, e.g. .com."
16
16
},
17
17
"popular": {
18
18
"type": "boolean",
19
19
"description": "Whether this TLD is featured as popular."
20
20
},
21
21
"maxPeriod": {
22
22
"type": "integer",
23
23
"description": "Maximum registration period in years. Upper bound for an item's years in createCheckout; a larger value is capped to this."
24
24
},
25
25
"minPeriod": {
26
26
"type": "integer",
27
27
"description": "Minimum registration period in years. Use as the lower bound for an item's years in createCheckout; a smaller value is raised to this."
28
28
},
29
29
"renewPrice": {
30
30
"type": "integer",
31
31
"description": "Renewal price per year, in whole US dollars."
32
32
},
33
33
"tldUnicode": {
34
34
"type": "string",
35
35
"description": "Unicode display form of the TLD, if it differs from the ASCII form."
36
36
},
37
37
"registerPrice": {
38
38
"type": "integer",
39
39
"description": "Registration price per year, in whole US dollars."
40
40
},
41
41
"transferPrice": {
42
42
"type": "integer",
43
43
"description": "Transfer price, in whole US dollars."
44
44
},
45
45
"transferAddsYear": {
46
46
"type": "boolean",
47
47
"description": "Whether a transfer of this TLD adds a year of registration."
48
48
},
49
49
"whoisPrivacyAllowed": {
50
50
"type": "boolean",
51
51
"description": "Whether WHOIS privacy can be enabled for this TLD. When false, the years field in createCheckout still applies but whoisPrivacy is ignored."
52
52
}
53
53
}
54
54
},
55
55
"main": {
56
56
"type": "query",
57
57
"output": {
58
58
"schema": {
59
59
"type": "object",
60
60
"required": [
61
61
"tlds"
62
62
],
63
63
"properties": {
64
64
"tlds": {
65
65
"type": "array",
66
66
"items": {
67
67
"ref": "#tld",
68
68
"type": "ref"
69
-
}
69
+
},
70
+
"description": "All offered TLDs, one entry each."
70
71
}
71
72
}
72
73
},
73
74
"encoding": "application/json"
74
75
},
75
76
"description": "Return the full catalog of available TLDs with register, renew, and transfer prices. Call it proxied through the user's PDS (atproto-proxy: did:web:marque.at:api#marque_registrar) with an at.marque.partnerApi-scoped token. Prices are in whole US dollars and may change; they exclude tax and any premium-domain surcharge (use checkAvailability for the price of a specific domain). Does not include premium pricing, which is per-domain."
76
77
}
77
78
},
78
79
"$type": "com.atproto.lexicon.schema",
79
80
"lexicon": 1,
80
81
"description": "List the TLDs Marque offers and their prices, for partner integrations."
81
82
}