at.marque.partner.createCheckout
Schema Diff
+3 -3
Compatibility Analysis
Backward Compatible
No changes detected.
1
1
{
2
2
"$type": "com.atproto.lexicon.schema",
3
3
"defs": {
4
4
"item": {
5
5
"properties": {
6
6
"autoRenew": {
7
7
"description": "Mark the domain to auto-renew before expiry using the user's saved payment method. Defaults to false. Auto-renewal is charged separately from this order.",
8
8
"type": "boolean"
9
9
},
10
10
"domain": {
11
11
"description": "Fully qualified domain name to register.",
12
12
"maxLength": 253,
13
13
"type": "string"
14
14
},
15
15
"whoisPrivacy": {
16
16
"description": "Whether to redact the registrant's details from public WHOIS. Defaults to true (privacy on) when omitted; set false to publish the registrant's contact data. Silently ignored for TLDs that do not allow it, and for TLDs whose registry redacts WHOIS regardless (see whoisPrivacyAllowed from listPricing / checkAvailability).",
17
17
"type": "boolean"
18
18
},
19
19
"years": {
20
20
"description": "Registration period in years. Defaults to the TLD minimum.",
21
21
"maximum": 10,
22
22
"minimum": 1,
23
23
"type": "integer"
24
24
}
25
25
},
26
26
"required": [
27
27
"domain"
28
28
],
29
29
"type": "object"
30
30
},
31
31
"main": {
32
32
"description": "Prices and validates the requested domains, ensures a registrant contact for the authenticated user, and returns a hosted Stripe Checkout URL. Call this proxied through the user's PDS (atproto-proxy: did:web:marque.at:api#marque_registrar) with a token holding the at.marque.partnerApi permission set: the authenticated user (the JWT iss) becomes the owner of the domains, and is the one billed on Stripe. The owning DID is taken from that authenticated session, never from input. The end user completes payment on Stripe's hosted page (where they see and confirm the exact domains and amount) and is redirected to successUrl with an order query parameter (successUrl?order=<orderId>) on success, or to cancelUrl if they abandon. Domains are not registered until payment is captured; poll at.marque.partner.getOrder with the returned orderId for provisioning status, then write the at.marque.domain and at.marque.dns records into the user's repository yourself. Only new registrations are supported here (no transfers or renewals).",
33
33
"errors": [
34
34
{
35
-
"description": "A requested TLD is not offered.",
36
-
"name": "UnsupportedTld"
35
+
"description": "The request is malformed: no items, too many items (max 50), or an item with an invalid domain.",
36
+
"name": "InvalidRequest"
37
37
},
38
38
{
39
-
"description": "A requested domain is not available to register.",
39
+
"description": "A requested domain cannot be registered: it is taken, on an unsupported TLD, or could not be verified with the registry. The message identifies the domain.",
40
40
"name": "Unavailable"
41
41
},
42
42
{
43
43
"description": "The registrant is missing a required field (including state/province where the country requires it) or is missing an extra field a specific TLD mandates. The message names what is missing.",
44
44
"name": "InvalidRegistrant"
45
45
},
46
46
{
47
47
"description": "successUrl or cancelUrl is not a valid absolute https URL.",
48
48
"name": "InvalidCallback"
49
49
}
50
50
],
51
51
"input": {
52
52
"encoding": "application/json",
53
53
"schema": {
54
54
"properties": {
55
55
"cancelUrl": {
56
56
"description": "Where Stripe redirects if the user cancels.",
57
57
"format": "uri",
58
58
"type": "string"
59
59
},
60
60
"items": {
61
61
"description": "Domains to register in this order, 1 to 50. Every domain must currently be available (verify with checkAvailability first); if any is unavailable or on an unsupported TLD the whole call fails.",
62
62
"items": {
63
63
"ref": "#item",
64
64
"type": "ref"
65
65
},
66
66
"maxLength": 50,
67
67
"minLength": 1,
68
68
"type": "array"
69
69
},
70
70
"registrant": {
71
71
"ref": "#registrant",
72
72
"type": "ref"
73
73
},
74
74
"successUrl": {
75
75
"description": "Where Stripe redirects after successful payment. An order parameter carrying the order id is appended.",
76
76
"format": "uri",
77
77
"type": "string"
78
78
}
79
79
},
80
80
"required": [
81
81
"items",
82
82
"registrant",
83
83
"successUrl",
84
84
"cancelUrl"
85
85
],
86
86
"type": "object"
87
87
}
88
88
},
89
89
"output": {
90
90
"encoding": "application/json",
91
91
"schema": {
92
92
"properties": {
93
93
"checkoutUrl": {
94
94
"description": "Hosted Stripe Checkout URL to send the user to.",
95
95
"format": "uri",
96
96
"type": "string"
97
97
},
98
98
"currency": {
99
99
"description": "ISO 4217 currency code of subtotalCents. Currently always usd.",
100
100
"type": "string"
101
101
},
102
102
"orderId": {
103
103
"description": "Opaque order id; pass to getOrder to poll status.",
104
104
"type": "string"
105
105
},
106
106
"subtotalCents": {
107
107
"description": "Order subtotal in cents, before tax. Tax (if any) is computed by Stripe on the hosted page and added on top, so the amount the user pays may be higher.",
108
108
"type": "integer"
109
109
}
110
110
},
111
111
"required": [
112
112
"orderId",
113
113
"checkoutUrl",
114
114
"subtotalCents",
115
115
"currency"
116
116
],
117
117
"type": "object"
118
118
}
119
119
},
120
120
"type": "procedure"
121
121
},
122
122
"registrant": {
123
123
"description": "The person or organization that will own the domains (the WHOIS registrant). Marque creates one registrant contact from these fields and uses it as the registrant, admin, tech, and billing contact for every domain in this order. Collect these in the partner's UI; the end user never visits Marque. All names and addresses must be real and accurate. Most gTLDs require the registrant email to be verifiable, so a registry verification email may be sent to it after registration; an unverified address can cause some TLDs to suspend the domain until confirmed. Certain TLDs require extra fields beyond these (for example a tax/VAT or national ID); those orders fail with InvalidRegistrant naming the missing field, and are not yet supported through this endpoint.",
124
124
"properties": {
125
125
"city": {
126
126
"description": "City or locality.",
127
127
"maxLength": 255,
128
128
"type": "string"
129
129
},
130
130
"companyRegistrationNumber": {
131
131
"description": "Optional. Company/commercial register number. Required by some TLDs when registering to an organization (organization set).",
132
132
"maxLength": 64,
133
133
"type": "string"
134
134
},
135
135
"country": {
136
136
"description": "ISO 3166-1 alpha-2 country code, uppercase, e.g. US, GB, DE. Determines which address/state rules apply.",
137
137
"maxLength": 2,
138
138
"minLength": 2,
139
139
"type": "string"
140
140
},
141
141
"email": {
142
142
"description": "Registrant email. Must be a real, monitored address: registries may send a verification message here, and registry/transfer notifications go to it.",
143
143
"maxLength": 320,
144
144
"type": "string"
145
145
},
146
146
"firstName": {
147
147
"description": "Registrant's legal given name.",
148
148
"maxLength": 255,
149
149
"type": "string"
150
150
},
151
151
"lastName": {
152
152
"description": "Registrant's legal family name.",
153
153
"maxLength": 255,
154
154
"type": "string"
155
155
},
156
156
"organization": {
157
157
"description": "Optional. If set, the domain is registered to this organization rather than an individual. Leave empty for a personal registration.",
158
158
"maxLength": 255,
159
159
"type": "string"
160
160
},
161
161
"passportNumber": {
162
162
"description": "Optional. Passport or national identity document number. Required by a few ccTLDs for individual registrants.",
163
163
"maxLength": 64,
164
164
"type": "string"
165
165
},
166
166
"phoneAreaCode": {
167
167
"description": "Optional area/city code, for regions that use one separately from the subscriber number.",
168
168
"maxLength": 16,
169
169
"type": "string"
170
170
},
171
171
"phoneCountryCode": {
172
172
"description": "International calling code with a leading plus, e.g. +1 for US/CA or +44 for UK. Required.",
173
173
"maxLength": 8,
174
174
"type": "string"
175
175
},
176
176
"phoneSubscriber": {
177
177
"description": "Local subscriber number, digits only. Combined with phoneCountryCode (and phoneAreaCode) to form the full phone number. Required.",
178
178
"maxLength": 32,
179
179
"type": "string"
180
180
},
181
181
"socialSecurityNumber": {
182
182
"description": "Optional. National identification / social security number, where a TLD mandates it (e.g. certain Nordic or Latin American ccTLDs). Handle as sensitive data.",
183
183
"maxLength": 64,
184
184
"type": "string"
185
185
},
186
186
"state": {
187
187
"description": "State, province, or region. Required for countries that mandate one (e.g. US, CA, AU, BR); send the full name or its ISO 3166-2 code (e.g. 'California' or 'CA'). Omit for countries that do not use one.",
188
188
"maxLength": 255,
189
189
"type": "string"
190
190
},
191
191
"street": {
192
192
"description": "Street address including house/building number, e.g. '123 Main St'.",
193
193
"maxLength": 255,
194
194
"type": "string"
195
195
},
196
196
"taxIdType": {
197
197
"description": "Optional. Type of the tax identifier in taxIdValue, e.g. 'vat' for an EU VAT number or a registry-specific code. Send together with taxIdValue. Some TLDs (notably several EU ccTLDs registered to an organization) require a VAT number.",
198
198
"maxLength": 32,
199
199
"type": "string"
200
200
},
201
201
"taxIdValue": {
202
202
"description": "Optional. The tax identifier itself, e.g. an EU VAT number like DE123456789. Paired with taxIdType.",
203
203
"maxLength": 64,
204
204
"type": "string"
205
205
},
206
206
"zipcode": {
207
207
"description": "Postal/ZIP code. Required even where the country's format is loose.",
208
208
"maxLength": 32,
209
209
"type": "string"
210
210
}
211
211
},
212
212
"required": [
213
213
"firstName",
214
214
"lastName",
215
215
"email",
216
216
"street",
217
217
"city",
218
218
"zipcode",
219
219
"country",
220
220
"phoneCountryCode",
221
221
"phoneSubscriber"
222
222
],
223
223
"type": "object"
224
224
}
225
225
},
226
226
"description": "Create a hosted Stripe Checkout session to register one or more domains for the calling user.",
227
227
"id": "at.marque.partner.createCheckout",
228
228
"lexicon": 1
229
229
}