Skip to content

Latest commit

 

History

History
114 lines (83 loc) · 3.63 KB

SubscriptionPlansApi.md

File metadata and controls

114 lines (83 loc) · 3.63 KB
Raw

SubscriptionPlansApi

All URIs are relative to http://localhost

Method HTTP request Description
subscriptionPlansGetSubscriptionPlan GET /api/manage/v1/SubscriptionPlans/{id} Returns a subscription plan. Not all subscriptions can be issued for customer.
subscriptionPlansGetSubscriptionPlans GET /api/manage/v1/SubscriptionPlans Returns a list of active subscription plans that can be issued to the user.

subscriptionPlansGetSubscriptionPlan

SubscriptionPlanVM subscriptionPlansGetSubscriptionPlan(id)

Returns a subscription plan. Not all subscriptions can be issued for customer.

Example

// Import classes:
//import org.openapitools.client.infrastructure.*
//import cloud.fastreport.model.*

val apiInstance = SubscriptionPlansApi()
val id : kotlin.String = id_example // kotlin.String | Identifier of subsctiption plan
try {
    val result : SubscriptionPlanVM = apiInstance.subscriptionPlansGetSubscriptionPlan(id)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling SubscriptionPlansApi#subscriptionPlansGetSubscriptionPlan")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling SubscriptionPlansApi#subscriptionPlansGetSubscriptionPlan")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
id kotlin.String Identifier of subsctiption plan

Return type

SubscriptionPlanVM

Authorization

Configure ApiKey: ApiClient.username = "" ApiClient.password = "" Configure JWT: ApiClient.accessToken = ""

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

subscriptionPlansGetSubscriptionPlans

SubscriptionPlansVM subscriptionPlansGetSubscriptionPlans(skip, take)

Returns a list of active subscription plans that can be issued to the user.

If no active subscription plans, then the endpoint will return empty list

Example

// Import classes:
//import org.openapitools.client.infrastructure.*
//import cloud.fastreport.model.*

val apiInstance = SubscriptionPlansApi()
val skip : kotlin.Int = 56 // kotlin.Int | Variable for pagination, defautl value is 0
val take : kotlin.Int = 56 // kotlin.Int | Variable for pagination, default value is 10
try {
    val result : SubscriptionPlansVM = apiInstance.subscriptionPlansGetSubscriptionPlans(skip, take)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling SubscriptionPlansApi#subscriptionPlansGetSubscriptionPlans")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling SubscriptionPlansApi#subscriptionPlansGetSubscriptionPlans")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
skip kotlin.Int Variable for pagination, defautl value is 0 [optional] [default to 0]
take kotlin.Int Variable for pagination, default value is 10 [optional] [default to 10]

Return type

SubscriptionPlansVM

Authorization

Configure ApiKey: ApiClient.username = "" ApiClient.password = "" Configure JWT: ApiClient.accessToken = ""

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json