BusinessApi

<back to all web services

GetSubscriptionPlansRequest

Business
Requires Authentication
Required role:Business
The following routes are available for this service:
GET/subscription/get_plans
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


open class SubscriptionPlanDetailsUnion
{
    open var freeUntil:PlanDetailsFreeUntil? = null
    open var invoice:PlanDetailsInvoice? = null
    open var monthlyStripe:PlanDetailsMonthlyStripe? = null
    open var freeOnClaim:PlanDetailsFreeOnClaim? = null
}

open class PlanDetailsFreeUntil
{
    open var stopAt:Date? = null
}

open class PlanDetailsInvoice
{
    open var period:Period? = null
    open var amount:Double? = null
    open var currency:String? = null
}

enum class Period
{
    Monthly,
    Yearly,
}

open class PlanDetailsMonthlyStripe
{
    open var amount:Double? = null
    open var currency:String? = null
    open var freeStartUpMonths:Int? = null
}

open class PlanDetailsFreeOnClaim
{
    open var months:Int? = null
}

Kotlin GetSubscriptionPlansRequest DTOs

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.

GET /subscription/get_plans HTTP/1.1 
Host: business-api.brovs.com 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	subscriptionPlan: 
	[
		{
			id: 0,
			canBeSelectedByClient: False,
			slug: String,
			subscriptionPlanDetails: 
			{
				freeUntil: 
				{
					stopAt: 0001-01-01
				},
				invoice: 
				{
					period: Monthly,
					amount: 0,
					currency: String
				},
				monthlyStripe: 
				{
					amount: 0,
					currency: String,
					freeStartUpMonths: 0
				},
				freeOnClaim: 
				{
					months: 0
				}
			}
		}
	]
}