BackofficeApi

<back to all web services

UpdateSubscriptionPlanRequest

Backoffice
Requires Authentication
Required role:Backoffice
The following routes are available for this service:
PUT/subscription/update_plan
UpdateSubscriptionPlanRequest Parameters:
NameParameterData TypeRequiredDescription
IdbodylongNo
CanBeSelectedByClientbodyboolNo
SubscriptionPlanDetailsbodySubscriptionPlanDetailsUnionYes
SubscriptionPlanDetailsUnion Parameters:
NameParameterData TypeRequiredDescription
FreeUntilformPlanDetailsFreeUntilNo
InvoiceformPlanDetailsInvoiceNo
MonthlyStripeformPlanDetailsMonthlyStripeNo
FreeOnClaimformPlanDetailsFreeOnClaimNo
PlanDetailsFreeUntil Parameters:
NameParameterData TypeRequiredDescription
StopAtformDateTimeNo
PlanDetailsInvoice Parameters:
NameParameterData TypeRequiredDescription
PeriodformPeriodNo
AmountformdoubleNo
CurrencyformstringNo
Period Enum:
Monthly
Yearly
PlanDetailsMonthlyStripe Parameters:
NameParameterData TypeRequiredDescription
AmountformdoubleNo
CurrencyformstringNo
FreeStartUpMonthsformint?No
PlanDetailsFreeOnClaim Parameters:
NameParameterData TypeRequiredDescription
MonthsformintNo
UpdateSubscriptionPlanResponse Parameters:
NameParameterData TypeRequiredDescription
SuccessformboolNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + 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
}