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
using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using BusinessApi;

namespace BusinessApi
{
    public enum Period
    {
        Monthly,
        Yearly,
    }

    public partial class PlanDetailsFreeOnClaim
    {
        public int Months { get; set; }
    }

    public partial class PlanDetailsFreeUntil
    {
        public DateTime StopAt { get; set; }
    }

    public partial class PlanDetailsInvoice
    {
        public Period Period { get; set; }
        public double Amount { get; set; }
        public string? Currency { get; set; }
    }

    public partial class PlanDetailsMonthlyStripe
    {
        public double Amount { get; set; }
        public string? Currency { get; set; }
        public int? FreeStartUpMonths { get; set; }
    }

    public partial class SubscriptionPlanDetailsUnion
    {
        public PlanDetailsFreeUntil? FreeUntil { get; set; }
        public PlanDetailsInvoice? Invoice { get; set; }
        public PlanDetailsMonthlyStripe? MonthlyStripe { get; set; }
        public PlanDetailsFreeOnClaim? FreeOnClaim { get; set; }
    }

}

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