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

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 .xml suffix or ?format=xml

HTTP + XML

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: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetSubscriptionPlansResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BusinessApi.Dto">
  <SubscriptionPlan>
    <SubscriptionPlanDto>
      <CanBeSelectedByClient>false</CanBeSelectedByClient>
      <Id>0</Id>
      <Slug>String</Slug>
      <SubscriptionPlanDetails xmlns:d4p1="http://schemas.datacontract.org/2004/07/Entities.Common">
        <d4p1:FreeOnClaim>
          <d4p1:Months>0</d4p1:Months>
        </d4p1:FreeOnClaim>
        <d4p1:FreeUntil>
          <d4p1:StopAt>0001-01-01T00:00:00</d4p1:StopAt>
        </d4p1:FreeUntil>
        <d4p1:Invoice>
          <d4p1:Amount>0</d4p1:Amount>
          <d4p1:Currency>String</d4p1:Currency>
          <d4p1:Period>Monthly</d4p1:Period>
        </d4p1:Invoice>
        <d4p1:MonthlyStripe>
          <d4p1:Amount>0</d4p1:Amount>
          <d4p1:Currency>String</d4p1:Currency>
          <d4p1:FreeStartUpMonths>0</d4p1:FreeStartUpMonths>
        </d4p1:MonthlyStripe>
      </SubscriptionPlanDetails>
    </SubscriptionPlanDto>
  </SubscriptionPlan>
</GetSubscriptionPlansResponse>