Changes a paid plan with proration for the rest of the period. --plan free ends the paid plan at the end of the period already paid for. If data is over the new plan’s limits the workspace becomes read-only (reads keep working) and nothing is ever deleted; upgrading restores it.
Usage
overlane billing plan --plan PLAN [--interval month|year] [--seats N] [--dry-run]Flags
| Flag | Type | Required | Default | Description |
|---|---|---|---|---|
--plan |
one of free, pro, team, business |
yes | The plan | |
--interval |
one of month, year |
no | Billing period; annual billing is cheaper per month | |
--seats |
string | no | Seats (Business needs at least 10; Pro is one person) | |
--dry-run |
boolean | no | Print the requests and file changes this command would make, then stop. Needs no credentials. |
Examples
overlane billing plan --plan team --seats 4
overlane billing plan --plan free --dry-runBehavior
- Effect:
write(changes local or hosted state). - Needs credentials: yes. Uses the network: yes.
- Supports
--dry-run: yes. Accepts--force: no. - Machine-readable description:
overlane schema billing plan.
Result
With --json (the default when stdout is not a terminal) the command prints this JSON Schema’s shape on stdout.
{
"anyOf": [
{
"type": "object",
"properties": {
"subscription": {
"type": "object",
"properties": {
"tenantId": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"pattern": "^[A-Za-z0-9][A-Za-z0-9_.:-]*$",
"description": "tenant identifier"
},
"plan": {
"type": "string",
"enum": [
"free",
"pro",
"team",
"business",
"enterprise"
]
},
"interval": {
"type": "string",
"enum": [
"month",
"year"
]
},
"seats": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"status": {
"type": "string",
"enum": [
"active",
"past_due",
"canceled",
"incomplete"
]
},
"stripeCustomerId": {
"type": "string",
"minLength": 1
},
"stripeSubscriptionId": {
"type": "string",
"minLength": 1
},
"currentPeriodStart": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"currentPeriodEnd": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"cancelAtPeriodEnd": {
"type": "boolean"
},
"readOnly": {
"type": "boolean"
},
"readOnlyReason": {
"type": "string",
"enum": [
"downgrade_over_limit",
"payment_failed"
]
},
"updatedAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
}
},
"required": [
"tenantId",
"plan",
"interval",
"seats",
"status",
"currentPeriodStart",
"currentPeriodEnd",
"cancelAtPeriodEnd",
"readOnly",
"updatedAt"
],
"additionalProperties": false
},
"prorationCents": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"overLimit": {
"type": "array",
"items": {
"type": "object",
"properties": {
"what": {
"type": "string",
"minLength": 1
},
"used": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"limit": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"what",
"used",
"limit"
],
"additionalProperties": false
}
},
"deleted": {
"type": "number",
"const": 0
}
},
"required": [
"subscription",
"prorationCents",
"overLimit",
"deleted"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"dryRun": {
"type": "boolean",
"const": true
},
"service": {
"type": "string"
},
"requests": {
"type": "array",
"items": {
"type": "object",
"properties": {
"method": {
"type": "string"
},
"path": {
"type": "string"
},
"body": {},
"note": {
"type": "string"
}
},
"required": [
"method",
"path"
],
"additionalProperties": false
}
},
"commands": {
"type": "array",
"items": {
"type": "string"
}
},
"writes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"path": {
"type": "string"
},
"action": {
"type": "string",
"enum": [
"write",
"append",
"delete"
]
},
"description": {
"type": "string"
}
},
"required": [
"path",
"action",
"description"
],
"additionalProperties": false
}
},
"notes": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"dryRun",
"requests",
"commands",
"writes",
"notes"
],
"additionalProperties": false
}
]
}See exit codes for the status the process returns.