BackofficeApi

<back to all web services

GetSubscriptionPlansRequest

Backoffice
Requires Authentication
Required role:Backoffice
The following routes are available for this service:
GET/subscription/get_plans
import Foundation
import ServiceStack

public class SubscriptionPlanDetailsUnion : Codable
{
    public var freeUntil:PlanDetailsFreeUntil
    public var invoice:PlanDetailsInvoice
    public var monthlyStripe:PlanDetailsMonthlyStripe
    public var freeOnClaim:PlanDetailsFreeOnClaim

    required public init(){}
}

public class PlanDetailsFreeUntil : Codable
{
    public var stopAt:Date

    required public init(){}
}

public class PlanDetailsInvoice : Codable
{
    public var period:Period
    public var amount:Double
    public var currency:String

    required public init(){}
}

public enum Period : String, Codable
{
    case Monthly
    case Yearly
}

public class PlanDetailsMonthlyStripe : Codable
{
    public var amount:Double
    public var currency:String
    public var freeStartUpMonths:Int?

    required public init(){}
}

public class PlanDetailsFreeOnClaim : Codable
{
    public var months:Int

    required public init(){}
}


Swift 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: backoffice-api.brovs.com 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	subscriptionPlans: 
	[
		{
			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
				}
			}
		}
	]
}