PlansApi

All URIs are relative to https://api.getlago.com/api/v1

Method	HTTP request	Description
createPlan	POST /plans	Create a plan
destroyPlan	DELETE /plans/{code}	Delete a plan
findAllPlans	GET /plans	List all plans
findPlan	GET /plans/{code}	Retrieve a plan
updatePlan	PUT /plans/{code}	Update a plan

createPlan

Plan createPlan(planCreateInput)

Create a plan

This endpoint creates a plan with subscription and usage-based charges. It supports flexible billing cadence (in-advance or in-arrears) and allows for both recurring and metered charges.

Example

// Import classes:
import org.getlago.client.ApiClient;
import org.getlago.client.ApiException;
import org.getlago.client.Configuration;
import org.getlago.client.auth.*;
import org.getlago.client.models.*;
import org.getlago.client.api.PlansApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("https://api.getlago.com/api/v1");
        
        // Configure HTTP bearer authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        PlansApi apiInstance = new PlansApi(defaultClient);
        PlanCreateInput planCreateInput = new PlanCreateInput(); // PlanCreateInput | Plan payload
        try {
            Plan result = apiInstance.createPlan(planCreateInput);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PlansApi#createPlan");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Parameters

Name	Type	Description	Notes
planCreateInput	PlanCreateInput	Plan payload

Return type

Plan

Authorization

bearerAuth

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Plan created	-
400	Bad Request error	-
401	Unauthorized error	-
404	Not Found error	-
422	Unprocessable entity error	-

destroyPlan

Plan destroyPlan(code)

Delete a plan

This endpoint deletes a specific plan. Note that this plan could be associated with active subscriptions.

Example

// Import classes:
import org.getlago.client.ApiClient;
import org.getlago.client.ApiException;
import org.getlago.client.Configuration;
import org.getlago.client.auth.*;
import org.getlago.client.models.*;
import org.getlago.client.api.PlansApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("https://api.getlago.com/api/v1");
        
        // Configure HTTP bearer authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        PlansApi apiInstance = new PlansApi(defaultClient);
        String code = "startup"; // String | The code of the plan. It serves as a unique identifier associated with a particular plan. The code is typically used for internal or system-level identification purposes, like assigning a subscription, for instance.
        try {
            Plan result = apiInstance.destroyPlan(code);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PlansApi#destroyPlan");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Parameters

Name	Type	Description	Notes
code	String	The code of the plan. It serves as a unique identifier associated with a particular plan. The code is typically used for internal or system-level identification purposes, like assigning a subscription, for instance.

Return type

Plan

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Plan deleted	-
401	Unauthorized error	-
404	Not Found error	-

findAllPlans

PlansPaginated findAllPlans(page, perPage)

List all plans

This endpoint retrieves all existing plans.

Example

// Import classes:
import org.getlago.client.ApiClient;
import org.getlago.client.ApiException;
import org.getlago.client.Configuration;
import org.getlago.client.auth.*;
import org.getlago.client.models.*;
import org.getlago.client.api.PlansApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("https://api.getlago.com/api/v1");
        
        // Configure HTTP bearer authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        PlansApi apiInstance = new PlansApi(defaultClient);
        Integer page = 1; // Integer | Page number.
        Integer perPage = 20; // Integer | Number of records per page.
        try {
            PlansPaginated result = apiInstance.findAllPlans(page, perPage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PlansApi#findAllPlans");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Parameters

Name	Type	Description	Notes
page	Integer	Page number.	[optional]
perPage	Integer	Number of records per page.	[optional]

Return type

PlansPaginated

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Plans	-
401	Unauthorized error	-

findPlan

Plan findPlan(code)

Retrieve a plan

This endpoint retrieves a specific plan.

Example

// Import classes:
import org.getlago.client.ApiClient;
import org.getlago.client.ApiException;
import org.getlago.client.Configuration;
import org.getlago.client.auth.*;
import org.getlago.client.models.*;
import org.getlago.client.api.PlansApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("https://api.getlago.com/api/v1");
        
        // Configure HTTP bearer authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        PlansApi apiInstance = new PlansApi(defaultClient);
        String code = "startup"; // String | The code of the plan. It serves as a unique identifier associated with a particular plan. The code is typically used for internal or system-level identification purposes, like assigning a subscription, for instance.
        try {
            Plan result = apiInstance.findPlan(code);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PlansApi#findPlan");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Parameters

Name	Type	Description	Notes
code	String	The code of the plan. It serves as a unique identifier associated with a particular plan. The code is typically used for internal or system-level identification purposes, like assigning a subscription, for instance.

Return type

Plan

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Plan	-
401	Unauthorized error	-
404	Not Found error	-

updatePlan

Plan updatePlan(code, planUpdateInput)

Update a plan

This endpoint updates a specific plan with subscription and usage-based charges. It supports flexible billing cadence (in-advance or in-arrears) and allows for both recurring and metered charges.

Example

// Import classes:
import org.getlago.client.ApiClient;
import org.getlago.client.ApiException;
import org.getlago.client.Configuration;
import org.getlago.client.auth.*;
import org.getlago.client.models.*;
import org.getlago.client.api.PlansApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("https://api.getlago.com/api/v1");
        
        // Configure HTTP bearer authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        PlansApi apiInstance = new PlansApi(defaultClient);
        String code = "startup"; // String | The code of the plan. It serves as a unique identifier associated with a particular plan. The code is typically used for internal or system-level identification purposes, like assigning a subscription, for instance.
        PlanUpdateInput planUpdateInput = new PlanUpdateInput(); // PlanUpdateInput | Plan payload
        try {
            Plan result = apiInstance.updatePlan(code, planUpdateInput);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PlansApi#updatePlan");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Parameters

Name	Type	Description	Notes
code	String	The code of the plan. It serves as a unique identifier associated with a particular plan. The code is typically used for internal or system-level identification purposes, like assigning a subscription, for instance.
planUpdateInput	PlanUpdateInput	Plan payload

Return type

Plan

Authorization

bearerAuth

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Plan updated	-
400	Bad Request error	-
401	Unauthorized error	-
404	Not Found error	-
422	Unprocessable entity error	-

Files

PlansApi.md

Latest commit

History

PlansApi.md

File metadata and controls

PlansApi

createPlan

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

destroyPlan

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

findAllPlans

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

findPlan

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

updatePlan

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details