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