0
# Account Management
1
2
Account and billing management including plan upgrades, payment methods, subscription management, and account deletion.
3
4
## Capabilities
5
6
### Plan Management
7
8
Upgrade or downgrade account plans to access different feature sets and resource limits.
9
10
```javascript { .api }
11
/**
12
* Upgrade or downgrade account plan
13
* @param hooks - Optional lifecycle hooks
14
* @returns Command function
15
*/
16
function plan(hooks?: HookConfig): CommandFunction;
17
```
18
19
**CLI Usage:**
20
```bash
21
# View available plans
22
surge plan
23
24
# Select specific plan
25
surge plan professional
26
27
# Interactive plan selection
28
surge plan --interactive
29
```
30
31
**Available Plans:**
32
- **Free**: Basic static hosting with surge.sh subdomains
33
- **Professional**: Custom domains, SSL, increased limits
34
- **Plus**: Enhanced features and higher resource limits
35
- **Enterprise**: Custom solutions and dedicated support
36
37
**Library Usage:**
38
```javascript
39
surge.plan({})(process.argv.slice(2));
40
```
41
42
### Payment Methods
43
44
Manage payment methods and billing information for account subscriptions.
45
46
```javascript { .api }
47
/**
48
* Manage payment methods and billing information
49
* @param hooks - Optional lifecycle hooks
50
* @returns Command function
51
*/
52
function card(hooks?: HookConfig): CommandFunction;
53
```
54
55
**CLI Usage:**
56
```bash
57
# Add or update payment method
58
surge card
59
60
# View current payment method
61
surge card --show
62
63
# Remove payment method
64
surge card --remove
65
```
66
67
**Payment Features:**
68
- **Credit/Debit Cards**: Visa, MasterCard, American Express
69
- **Secure Processing**: PCI-compliant payment handling
70
- **Automatic Billing**: Recurring subscription charges
71
- **Billing History**: Access to payment records
72
- **Invoice Generation**: Downloadable invoices
73
74
**Library Usage:**
75
```javascript
76
surge.card({})(process.argv.slice(2));
77
```
78
79
### Surge Plus Features
80
81
Enable Surge Plus plan features for specific domains.
82
83
```javascript { .api }
84
/**
85
* Enable Surge Plus plan features for domain
86
* @param hooks - Optional lifecycle hooks
87
* @returns Command function
88
*/
89
function plus(hooks?: HookConfig): CommandFunction;
90
```
91
92
**CLI Usage:**
93
```bash
94
# Enable Plus features for domain
95
surge plus example.com
96
97
# Interactive domain selection
98
surge plus
99
```
100
101
**Plus Features:**
102
- **Custom Domains**: Use your own domain names
103
- **SSL Certificates**: Free SSL for custom domains
104
- **Increased Limits**: Higher bandwidth and storage
105
- **Advanced Analytics**: Detailed traffic insights
106
- **Priority Support**: Faster response times
107
108
**Library Usage:**
109
```javascript
110
surge.plus({})(process.argv.slice(2));
111
```
112
113
### Account Deletion
114
115
Permanently delete account and all associated data.
116
117
```javascript { .api }
118
/**
119
* Permanently delete account and all data
120
* @param hooks - Optional lifecycle hooks
121
* @returns Command function
122
*/
123
function nuke(hooks?: HookConfig): CommandFunction;
124
```
125
126
**CLI Usage:**
127
```bash
128
# Delete account (requires confirmation)
129
surge nuke
130
```
131
132
**⚠️ Warning: This action is irreversible and will:**
133
- Delete all deployed projects
134
- Remove all domains and DNS configurations
135
- Cancel active subscriptions
136
- Permanently delete account data
137
- Release all reserved domain names
138
139
**Library Usage:**
140
```javascript
141
surge.nuke({})(process.argv.slice(2));
142
```
143
144
## Subscription Management
145
146
### Plan Comparison
147
148
| Feature | Free | Professional | Plus | Enterprise |
149
|---------|------|-------------|------|------------|
150
| Projects | 1 | Unlimited | Unlimited | Unlimited |
151
| Custom Domains | ❌ | ✅ | ✅ | ✅ |
152
| SSL Certificates | surge.sh only | ✅ | ✅ | ✅ |
153
| Bandwidth | 1GB/month | 100GB/month | 1TB/month | Custom |
154
| Storage | 100MB | 1GB | 10GB | Custom |
155
| Analytics | Basic | Advanced | Advanced | Custom |
156
| Support | Community | Email | Priority | Dedicated |
157
158
### Billing Cycles
159
160
**Monthly Billing:**
161
- Charged monthly on signup date
162
- Can cancel anytime
163
- Prorated refunds for downgrades
164
165
**Annual Billing:**
166
- 2 months free with annual payment
167
- Billed once per year
168
- No refunds after 30 days
169
170
### Usage Monitoring
171
172
Monitor account usage and limits:
173
174
```bash
175
# View current usage
176
surge usage
177
178
# Check plan limits
179
surge plan --limits
180
181
# Usage alerts
182
surge config --usage-alerts 80%
183
```
184
185
## Payment Processing
186
187
### Supported Payment Methods
188
189
**Credit/Debit Cards:**
190
- Visa, MasterCard, American Express, Discover
191
- International cards supported
192
- Automatic payment processing
193
194
**Alternative Payment Methods:**
195
- PayPal (available in select regions)
196
- Bank transfers (enterprise plans)
197
- Wire transfers (enterprise plans)
198
199
### Security Features
200
201
**Payment Security:**
202
- PCI DSS Level 1 compliance
203
- Encrypted card storage
204
- Fraud detection and prevention
205
- Secure payment processing via Stripe
206
207
**Account Security:**
208
- Two-factor authentication available
209
- Account activity monitoring
210
- Secure API token management
211
- Access logs and audit trails
212
213
### Billing Management
214
215
**Invoice Access:**
216
```bash
217
# Download invoices
218
surge card --invoices
219
220
# View billing history
221
surge card --history
222
223
# Update billing address
224
surge card --address
225
```
226
227
**Automatic Renewal:**
228
- Subscriptions auto-renew by default
229
- Email notifications before renewal
230
- Grace period for failed payments
231
- Automatic retry for failed charges
232
233
## Enterprise Features
234
235
### Custom Solutions
236
237
Enterprise plans include:
238
239
- **Dedicated Infrastructure**: Isolated hosting environment
240
- **Custom Domains**: Unlimited custom domain support
241
- **Advanced SSL**: EV certificates and custom CA support
242
- **SLA Guarantees**: Uptime and performance guarantees
243
- **Dedicated Support**: Direct access to technical team
244
245
### Enterprise Configuration
246
247
```bash
248
# Configure enterprise settings
249
surge config --enterprise
250
251
# Set custom limits
252
surge config --bandwidth-limit 10TB
253
surge config --storage-limit 100GB
254
255
# Configure dedicated support
256
surge config --support-tier dedicated
257
```
258
259
### White-Label Solutions
260
261
- **Custom Branding**: Your brand on deployment interface
262
- **API Integration**: Full API access for automation
263
- **Custom Domains**: your-company.hosting-platform.com
264
- **Reseller Options**: Offer hosting to your customers
265
266
## Account Security
267
268
### Authentication Security
269
270
**Two-Factor Authentication:**
271
```bash
272
# Enable 2FA
273
surge config --2fa enable
274
275
# Generate backup codes
276
surge config --2fa backup-codes
277
278
# Disable 2FA
279
surge config --2fa disable
280
```
281
282
**API Token Management:**
283
```bash
284
# Generate new API token
285
surge token --generate
286
287
# Revoke API token
288
surge token --revoke TOKEN_ID
289
290
# List active tokens
291
surge token --list
292
```
293
294
### Access Control
295
296
**Account Permissions:**
297
- Owner: Full account access
298
- Admin: All features except billing
299
- Developer: Deploy and manage projects
300
- Viewer: Read-only access to analytics
301
302
**IP Restrictions:**
303
```bash
304
# Restrict access by IP
305
surge config --ip-whitelist 192.168.1.0/24
306
307
# Remove IP restrictions
308
surge config --ip-whitelist remove
309
```
310
311
## Data Management
312
313
### Data Export
314
315
Export account data for backup or migration:
316
317
```bash
318
# Export all project data
319
surge export --format json
320
321
# Export specific project
322
surge export example.surge.sh --format tar.gz
323
324
# Export analytics data
325
surge analytics example.surge.sh --export
326
```
327
328
### Data Retention
329
330
**Project Data:**
331
- Active projects: Retained indefinitely
332
- Deleted projects: 30-day recovery period
333
- Account deletion: Immediate permanent deletion
334
335
**Analytics Data:**
336
- Real-time: 24 hours
337
- Daily aggregates: 90 days
338
- Monthly summaries: 2 years
339
- Enterprise: Custom retention periods
340
341
### GDPR Compliance
342
343
**Data Rights:**
344
- Access: View all personal data
345
- Portability: Export data in standard formats
346
- Erasure: Complete data deletion
347
- Rectification: Correct inaccurate data
348
349
```bash
350
# Request data export (GDPR)
351
surge gdpr --export
352
353
# Delete personal data (GDPR)
354
surge gdpr --delete
355
```
356
357
## Troubleshooting
358
359
### Payment Issues
360
361
**Failed Payments:**
362
- Verify card details and expiration
363
- Check available credit limit
364
- Contact bank for international transactions
365
- Update payment method if needed
366
367
**Billing Disputes:**
368
```bash
369
# Contact billing support
370
surge support --billing
371
372
# Request refund
373
surge card --refund REQUEST_ID
374
375
# Dispute charge
376
surge card --dispute CHARGE_ID
377
```
378
379
### Account Access Issues
380
381
**Locked Account:**
382
- Check for failed payment
383
- Verify email address
384
- Contact support for assistance
385
- Review terms of service compliance
386
387
**Lost Credentials:**
388
```bash
389
# Reset password
390
surge login --reset-password
391
392
# Generate new API token
393
surge token --regenerate
394
395
# Recovery via support
396
surge support --account-recovery
397
```
398
399
### Subscription Problems
400
401
**Plan Changes:**
402
- Verify payment method before upgrade
403
- Check prorated billing for plan changes
404
- Contact support for custom requirements
405
406
**Cancellation:**
407
```bash
408
# Cancel subscription
409
surge plan --cancel
410
411
# Downgrade to free plan
412
surge plan free
413
414
# Export data before cancellation
415
surge export --all
416
```