PUT /admin/billing/subscription/{tenant_id}
Modify the subscription configuration for a specified tenant, supporting changes to plan and auto_renew settings. Plan changes are prorated.
Billing Service `bearerAuth` application/json
Request Parameters
| Name | In | Type | Required | Default | Example | Constraints | Description |
|---|
tenant_id |
path |
string |
Yes |
|
|
|
Tenant ID |
Request Body
Schema: dto.UpdateSubscriptionRequestDTO
| Field | Type | Required | Example | Constraints | Description |
|---|
auto_renew |
boolean |
No |
False |
|
|
billing_cycle |
string |
No |
yearly |
|
|
plan |
string |
No |
enterprise |
|
|
Responses
| Status | Description | Schema |
|---|
| 200 | Subscription update successful | dto.SubscriptionDetailResponse |
| 400 | Invalid request parameters | object |
| 401 | Unauthorized | object |
| 403 | No permission | object |
| 500 | Internal server error | object |
Referenced Schemas
dto.SubscriptionDetailResponse
| Field | Type | Required | Example | Constraints | Description |
|---|
code |
integer |
No |
|
|
|
data |
dto.SubscriptionResponse |
No |
|
|
|
message |
string |
No |
|
|
|
timestamp |
string |
No |
|
|
|
dto.SubscriptionResponse
| Field | Type | Required | Example | Constraints | Description |
|---|
admin_user_id |
string |
No |
usr_abc123 |
|
|
amount |
number |
No |
499 |
|
|
auto_renew |
boolean |
No |
True |
|
|
billing_cycle |
string |
No |
monthly |
|
|
cancel_at_period_end |
boolean |
No |
False |
|
|
currency |
string |
No |
CNY |
|
|
current_period_end |
string |
No |
2026-02-01T00:00:00Z |
|
|
current_period_start |
string |
No |
2026-01-01T00:00:00Z |
|
|
grace_period_days |
integer |
No |
7 |
|
|
plan_id |
string |
No |
pro |
|
|
status |
string |
No |
active |
|
|
tenant_id |
string |
No |
tnt_xyz789 |
|
|
trial_end_date |
string |
No |
2026-01-15T00:00:00Z |
|
|
Autional API Wiki