Skip to content

Latest commit

 

History

History
98 lines (72 loc) · 3.83 KB

EntitlementApi.md

File metadata and controls

98 lines (72 loc) · 3.83 KB

frontier_api.EntitlementApi

All URIs are relative to http://127.0.0.1:7400

Method HTTP request Description
frontier_service_check_feature_entitlement POST /v1beta1/organizations/{orgId}/billing/{billingId}/check Check entitlement

frontier_service_check_feature_entitlement

V1beta1CheckFeatureEntitlementResponse frontier_service_check_feature_entitlement(org_id, billing_id, body)

Check entitlement

Check if a billing account is entitled to a feature.

Example

  • Basic Authentication (Basic):
import time
import os
import frontier_api
from frontier_api.models.frontier_service_check_feature_entitlement_request import FrontierServiceCheckFeatureEntitlementRequest
from frontier_api.models.v1beta1_check_feature_entitlement_response import V1beta1CheckFeatureEntitlementResponse
from frontier_api.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://127.0.0.1:7400
# See configuration.py for a list of all supported configuration parameters.
configuration = frontier_api.Configuration(
    host = "http://127.0.0.1:7400"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: Basic
configuration = frontier_api.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Enter a context with an instance of the API client
with frontier_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = frontier_api.EntitlementApi(api_client)
    org_id = 'org_id_example' # str | 
    billing_id = 'billing_id_example' # str | ID of the billing account to update the subscription for
    body = frontier_api.FrontierServiceCheckFeatureEntitlementRequest() # FrontierServiceCheckFeatureEntitlementRequest | 

    try:
        # Check entitlement
        api_response = api_instance.frontier_service_check_feature_entitlement(org_id, billing_id, body)
        print("The response of EntitlementApi->frontier_service_check_feature_entitlement:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling EntitlementApi->frontier_service_check_feature_entitlement: %s\n" % e)

Parameters

Name Type Description Notes
org_id str
billing_id str ID of the billing account to update the subscription for
body FrontierServiceCheckFeatureEntitlementRequest

Return type

V1beta1CheckFeatureEntitlementResponse

Authorization

Basic

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 A successful response. -
400 Bad Request - The request was malformed or contained invalid parameters. -
401 Unauthorized - Authentication is required -
403 Forbidden - User does not have permission to access the resource -
404 Not Found - The requested resource was not found -
500 Internal Server Error. Returned when theres is something wrong with Frontier server. -
0 An unexpected error response. -

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