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
namespace BackofficeApi

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type PlanDetailsFreeUntil() = 
        member val StopAt:DateTime = new DateTime() with get,set

    type Period =
        | Monthly = 0
        | Yearly = 1

    [<AllowNullLiteral>]
    type PlanDetailsInvoice() = 
        member val Period:Period = new Period() with get,set
        member val Amount:Double = new Double() with get,set
        member val Currency:String = null with get,set

    [<AllowNullLiteral>]
    type PlanDetailsMonthlyStripe() = 
        member val Amount:Double = new Double() with get,set
        member val Currency:String = null with get,set
        member val FreeStartUpMonths:Nullable<Int32> = new Nullable<Int32>() with get,set

    [<AllowNullLiteral>]
    type PlanDetailsFreeOnClaim() = 
        member val Months:Int32 = new Int32() with get,set

    [<AllowNullLiteral>]
    type SubscriptionPlanDetailsUnion() = 
        member val FreeUntil:PlanDetailsFreeUntil = null with get,set
        member val Invoice:PlanDetailsInvoice = null with get,set
        member val MonthlyStripe:PlanDetailsMonthlyStripe = null with get,set
        member val FreeOnClaim:PlanDetailsFreeOnClaim = null with get,set

F# 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
				}
			}
		}
	]
}