Get a specific plan

Route

GET

/api/v1/plans/:code

Usage

Curl

LAGO_URL="https://api.getlago.com"
API_KEY="__YOUR_API_KEY__"

curl --location --request GET "$LAGO_URL/api/v1/plans/:code" \
  --header "Authorization: Bearer $API_KEY"

Python

from lago_python_client import Client

client = Client(api_key='__YOUR_API_KEY__')

client.plans().find('code')

Ruby

require 'lago-ruby-client'

client = Lago::Api::Client.new({api_key: '__YOUR_API_KEY__'})

client.plans.get('code')

Node.js

let client = new Client('__API_KEY__')

await client.findPlan('code');

Go

  import "fmt"
  import "github.com/getlago/lago-go-client"

  func main() {
    lagoClient := lago.New().
      SetApiKey("__YOUR_API_KEY__")

    planResult, err := lagoClient.Plan().Get("__YOUR_PLAN_CODE__")
    if err != nil {
      // Error is *lago.Error
      panic(err)
    }

    // plan is *lago.Plan
    fmt.Println(plan)
  }

C#

using System.Collections.Generic;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
  public class FindPlanExample
  {
      public static void Main()
      {
          Configuration.Default.BasePath = "https://api.getlago.com/api/v1";
          // Configure HTTP bearer authorization: bearerAuth
          Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

          var apiInstance = new PlansApi(Configuration.Default);
          var code = "example_code";  // string | Code of the existing plan

          try
          {
              // Fin plan by code
              Plan result = apiInstance.FindPlan(code);
              Debug.WriteLine(result);
          }
          catch (ApiException e)
          {
              Debug.Print("Exception when calling PlansApi.FindPlan: " + e.Message );
              Debug.Print("Status Code: "+ e.ErrorCode);
              Debug.Print(e.StackTrace);
          }
      }
  }
}

PHP

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure Bearer authorization: bearerAuth
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\PlansApi(
  // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
  // This is optional, `GuzzleHttp\Client` will be used as default.
  new GuzzleHttp\Client(),
  $config
);
$code = "example_code"; // string | Code of the existing plan

try {
  $result = $apiInstance->findPlan($code);
  print_r($result);
} catch (Exception $e) {
  echo 'Exception when calling PlansApi->findPlan: ', $e->getMessage(), PHP_EOL;
}

Responses

HTTP 200

The plan was successfully found

Returns a plan object.

HTTP 401

{
  "status": 401,
  "error": "Unauthorized"
}

Access to the API endpoint is unhautorized.

Possible reasons are:

• The Authorization header is missing
• The Authorization header does not contain the API key
• The Api key is invalid or expired

HTTP 404

{
  "status": 404,
  "error": "Not Found",
  "code": "plan_not_found"
}

The plan was not found.