at.marque.partner.createCheckout
Schema Diff
+36 -7
Compatibility Analysis
Breaking Changes Detected
1 breaking change, 3 non-breaking changes.
Breaking Changes (1)
- RequiredEdgeAdded RequiredEdgeAdded { vertex_id: "at.marque.partner.createCheckout:output", src: "at.marque.partner.createCheckout:output", tgt: "at.marque.partner.createCheckout:output.paymentMethod", kind: "prop", name: Some("paymentMethod") }
Non-Breaking Changes (3)
- AddedVertex AddedVertex { vertex_id: "at.marque.partner.createCheckout:input.paymentMethod" }
- AddedVertex AddedVertex { vertex_id: "at.marque.partner.createCheckout:output.paymentMethod" }
- AddedEdge AddedEdge { src: "at.marque.partner.createCheckout:input", tgt: "at.marque.partner.createCheckout:input.paymentMethod", kind: "prop", name: Some("paymentMethod") }
Migration Guidance
Added Elements
AddedVertex { vertex_id: "at.marque.partner.createCheckout:input.paymentMethod" }AddedVertex { vertex_id: "at.marque.partner.createCheckout:output.paymentMethod" }
Additional Notes
- Breaking: RequiredEdgeAdded { vertex_id: "at.marque.partner.createCheckout:output", src: "at.marque.partner.createCheckout:output", tgt: "at.marque.partner.createCheckout:output.paymentMethod", kind: "prop", name: Some("paymentMethod") }
- Non-breaking: AddedEdge { src: "at.marque.partner.createCheckout:input", tgt: "at.marque.partner.createCheckout:input.paymentMethod", kind: "prop", name: Some("paymentMethod") }
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
-
"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#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).",
32
+
"description": "Prices and validates the requested domains, ensures a registrant contact for the authenticated user, and returns a hosted checkout URL. Call this proxied through the user's PDS (atproto-proxy: did:web:marque.at#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 billed by the selected payment provider. The owning DID is taken from that authenticated session, never from input. The end user completes payment on the provider's hosted page 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 confirmed; 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
35
"description": "The request is malformed: no items, too many items (max 50), or an item with an invalid domain.",
36
36
"name": "InvalidRequest"
37
37
},
38
38
{
39
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
+
},
50
+
{
51
+
"description": "paymentMethod is not stripe or nowpayments.",
52
+
"name": "InvalidPaymentMethod"
53
+
},
54
+
{
55
+
"description": "The selected payment provider is not configured.",
56
+
"name": "PaymentMethodUnavailable"
57
+
},
58
+
{
59
+
"description": "The selected payment provider could not create a hosted checkout.",
60
+
"name": "PaymentProviderError"
49
61
}
50
62
],
51
63
"input": {
52
64
"encoding": "application/json",
53
65
"schema": {
54
66
"properties": {
55
67
"cancelUrl": {
56
-
"description": "Where Stripe redirects if the user cancels.",
68
+
"description": "Where the payment provider redirects if the user cancels.",
57
69
"format": "uri",
58
70
"type": "string"
59
71
},
60
72
"items": {
61
73
"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
74
"items": {
63
75
"ref": "#item",
64
76
"type": "ref"
65
77
},
66
78
"maxLength": 50,
67
79
"minLength": 1,
68
80
"type": "array"
69
81
},
82
+
"paymentMethod": {
83
+
"description": "Hosted payment provider. Defaults to stripe when omitted. Use nowpayments for cryptocurrency checkout.",
84
+
"knownValues": [
85
+
"stripe",
86
+
"nowpayments"
87
+
],
88
+
"type": "string"
89
+
},
70
90
"registrant": {
71
91
"ref": "#registrant",
72
92
"type": "ref"
73
93
},
74
94
"successUrl": {
75
-
"description": "Where Stripe redirects after successful payment. An order parameter carrying the order id is appended.",
95
+
"description": "Where the payment provider redirects after successful payment. An order parameter carrying the order id is appended.",
76
96
"format": "uri",
77
97
"type": "string"
78
98
}
79
99
},
80
100
"required": [
81
101
"items",
82
102
"registrant",
83
103
"successUrl",
84
104
"cancelUrl"
85
105
],
86
106
"type": "object"
87
107
}
88
108
},
89
109
"output": {
90
110
"encoding": "application/json",
91
111
"schema": {
92
112
"properties": {
93
113
"checkoutUrl": {
94
-
"description": "Hosted Stripe Checkout URL to send the user to.",
114
+
"description": "Hosted checkout URL from the selected payment provider.",
95
115
"format": "uri",
96
116
"type": "string"
97
117
},
98
118
"currency": {
99
119
"description": "ISO 4217 currency code of subtotalCents. Currently always usd.",
100
120
"type": "string"
101
121
},
102
122
"orderId": {
103
123
"description": "Opaque order id; pass to getOrder to poll status.",
104
124
"type": "string"
105
125
},
126
+
"paymentMethod": {
127
+
"description": "Payment provider selected for this order.",
128
+
"knownValues": [
129
+
"stripe",
130
+
"nowpayments"
131
+
],
132
+
"type": "string"
133
+
},
106
134
"subtotalCents": {
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.",
135
+
"description": "Order subtotal in cents, before provider-specific tax or conversion adjustments. The amount shown on the hosted page may be higher.",
108
136
"type": "integer"
109
137
}
110
138
},
111
139
"required": [
112
140
"orderId",
113
141
"checkoutUrl",
114
142
"subtotalCents",
115
-
"currency"
143
+
"currency",
144
+
"paymentMethod"
116
145
],
117
146
"type": "object"
118
147
}
119
148
},
120
149
"type": "procedure"
121
150
},
122
151
"registrant": {
123
152
"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
153
"properties": {
125
154
"city": {
126
155
"description": "City or locality.",
127
156
"maxLength": 255,
128
157
"type": "string"
129
158
},
130
159
"companyRegistrationNumber": {
131
160
"description": "Optional. Company/commercial register number. Required by some TLDs when registering to an organization (organization set).",
132
161
"maxLength": 64,
133
162
"type": "string"
134
163
},
135
164
"country": {
136
165
"description": "ISO 3166-1 alpha-2 country code, uppercase, e.g. US, GB, DE. Determines which address/state rules apply.",
137
166
"maxLength": 2,
138
167
"minLength": 2,
139
168
"type": "string"
140
169
},
141
170
"email": {
142
171
"description": "Registrant email. Must be a real, monitored address: registries may send a verification message here, and registry/transfer notifications go to it.",
143
172
"maxLength": 320,
144
173
"type": "string"
145
174
},
146
175
"firstName": {
147
176
"description": "Registrant's legal given name.",
148
177
"maxLength": 255,
149
178
"type": "string"
150
179
},
151
180
"lastName": {
152
181
"description": "Registrant's legal family name.",
153
182
"maxLength": 255,
154
183
"type": "string"
155
184
},
156
185
"organization": {
157
186
"description": "Optional. If set, the domain is registered to this organization rather than an individual. Leave empty for a personal registration.",
158
187
"maxLength": 255,
159
188
"type": "string"
160
189
},
161
190
"passportNumber": {
162
191
"description": "Optional. Passport or national identity document number. Required by a few ccTLDs for individual registrants.",
163
192
"maxLength": 64,
164
193
"type": "string"
165
194
},
166
195
"phoneAreaCode": {
167
196
"description": "Optional area/city code, for regions that use one separately from the subscriber number.",
168
197
"maxLength": 16,
169
198
"type": "string"
170
199
},
171
200
"phoneCountryCode": {
172
201
"description": "International calling code with a leading plus, e.g. +1 for US/CA or +44 for UK. Required.",
173
202
"maxLength": 8,
174
203
"type": "string"
175
204
},
176
205
"phoneSubscriber": {
177
206
"description": "Local subscriber number, digits only. Combined with phoneCountryCode (and phoneAreaCode) to form the full phone number. Required.",
178
207
"maxLength": 32,
179
208
"type": "string"
180
209
},
181
210
"socialSecurityNumber": {
182
211
"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
212
"maxLength": 64,
184
213
"type": "string"
185
214
},
186
215
"state": {
187
216
"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
217
"maxLength": 255,
189
218
"type": "string"
190
219
},
191
220
"street": {
192
221
"description": "Street address including house/building number, e.g. '123 Main St'.",
193
222
"maxLength": 255,
194
223
"type": "string"
195
224
},
196
225
"taxIdType": {
197
226
"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
227
"maxLength": 32,
199
228
"type": "string"
200
229
},
201
230
"taxIdValue": {
202
231
"description": "Optional. The tax identifier itself, e.g. an EU VAT number like DE123456789. Paired with taxIdType.",
203
232
"maxLength": 64,
204
233
"type": "string"
205
234
},
206
235
"zipcode": {
207
236
"description": "Postal/ZIP code. Required even where the country's format is loose.",
208
237
"maxLength": 32,
209
238
"type": "string"
210
239
}
211
240
},
212
241
"required": [
213
242
"firstName",
214
243
"lastName",
215
244
"email",
216
245
"street",
217
246
"city",
218
247
"zipcode",
219
248
"country",
220
249
"phoneCountryCode",
221
250
"phoneSubscriber"
222
251
],
223
252
"type": "object"
224
253
}
225
254
},
226
-
"description": "Create a hosted Stripe Checkout session to register one or more domains for the calling user.",
255
+
"description": "Create a hosted payment checkout to register one or more domains for the calling user.",
227
256
"id": "at.marque.partner.createCheckout",
228
257
"lexicon": 1
229
258
}