Skip to content

Latest commit

 

History

History
146 lines (93 loc) · 4.54 KB

SubscriptionPlansAPI.md

File metadata and controls

146 lines (93 loc) · 4.54 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(ctx, id).Execute()

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

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/fastreports/gofrcloud"
)

func main() {
	id := "id_example" // string | Identifier of subsctiption plan

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.SubscriptionPlansAPI.SubscriptionPlansGetSubscriptionPlan(context.Background(), id).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `SubscriptionPlansAPI.SubscriptionPlansGetSubscriptionPlan``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `SubscriptionPlansGetSubscriptionPlan`: SubscriptionPlanVM
	fmt.Fprintf(os.Stdout, "Response from `SubscriptionPlansAPI.SubscriptionPlansGetSubscriptionPlan`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id string Identifier of subsctiption plan

Other Parameters

Other parameters are passed through a pointer to a apiSubscriptionPlansGetSubscriptionPlanRequest struct via the builder pattern

Name Type Description Notes

Return type

SubscriptionPlanVM

Authorization

ApiKey, JWT

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

SubscriptionPlansGetSubscriptionPlans

SubscriptionPlansVM SubscriptionPlansGetSubscriptionPlans(ctx).Skip(skip).Take(take).Execute()

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

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/fastreports/gofrcloud"
)

func main() {
	skip := int32(56) // int32 | Variable for pagination, defautl value is 0 (optional) (default to 0)
	take := int32(56) // int32 | Variable for pagination, default value is 10 (optional) (default to 10)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.SubscriptionPlansAPI.SubscriptionPlansGetSubscriptionPlans(context.Background()).Skip(skip).Take(take).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `SubscriptionPlansAPI.SubscriptionPlansGetSubscriptionPlans``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `SubscriptionPlansGetSubscriptionPlans`: SubscriptionPlansVM
	fmt.Fprintf(os.Stdout, "Response from `SubscriptionPlansAPI.SubscriptionPlansGetSubscriptionPlans`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiSubscriptionPlansGetSubscriptionPlansRequest struct via the builder pattern

Name Type Description Notes
skip int32 Variable for pagination, defautl value is 0 [default to 0]
take int32 Variable for pagination, default value is 10 [default to 10]

Return type

SubscriptionPlansVM

Authorization

ApiKey, JWT

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]