| Required role: | Backoffice |
| PUT | /subscription/update_plan |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | body | long | No | |
| CanBeSelectedByClient | body | bool | No | |
| SubscriptionPlanDetails | body | SubscriptionPlanDetailsUnion | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| FreeUntil | form | PlanDetailsFreeUntil | No | |
| Invoice | form | PlanDetailsInvoice | No | |
| MonthlyStripe | form | PlanDetailsMonthlyStripe | No | |
| FreeOnClaim | form | PlanDetailsFreeOnClaim | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| StopAt | form | DateTime | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Period | form | Period | No | |
| Amount | form | double | No | |
| Currency | form | string | No |
| Monthly | |
| Yearly |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Amount | form | double | No | |
| Currency | form | string | No | |
| FreeStartUpMonths | form | int? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Months | form | int | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Success | form | bool | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
PUT /subscription/update_plan HTTP/1.1
Host: backoffice-api.brovs.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
id: 0,
canBeSelectedByClient: False,
subscriptionPlanDetails:
{
freeUntil:
{
stopAt: 0001-01-01
},
invoice:
{
period: Monthly,
amount: 0,
currency: String
},
monthlyStripe:
{
amount: 0,
currency: String,
freeStartUpMonths: 0
},
freeOnClaim:
{
months: 0
}
}
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
success: False
}