Create plan

Create plan

curl --request POST \
  --url https://api.lava.so/v1/plans \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Pro Plan",
  "period_amount": "49.00",
  "billing_interval": "month",
  "included_credit": "<string>",
  "default_auto_top_up_bundle_id": "<string>",
  "default_auto_top_up_bundle_index": 123,
  "meter_ids": [
    "<string>"
  ],
  "credit_bundles": [
    {
      "name": "<string>",
      "cost": "<string>",
      "credit_amount": "<string>"
    }
  ]
}
'

import requests

url = "https://api.lava.so/v1/plans"

payload = {
    "name": "Pro Plan",
    "period_amount": "49.00",
    "billing_interval": "month",
    "included_credit": "<string>",
    "default_auto_top_up_bundle_id": "<string>",
    "default_auto_top_up_bundle_index": 123,
    "meter_ids": ["<string>"],
    "credit_bundles": [
        {
            "name": "<string>",
            "cost": "<string>",
            "credit_amount": "<string>"
        }
    ]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'Pro Plan',
    period_amount: '49.00',
    billing_interval: 'month',
    included_credit: '<string>',
    default_auto_top_up_bundle_id: '<string>',
    default_auto_top_up_bundle_index: 123,
    meter_ids: ['<string>'],
    credit_bundles: [{name: '<string>', cost: '<string>', credit_amount: '<string>'}]
  })
};

fetch('https://api.lava.so/v1/plans', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.lava.so/v1/plans",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'Pro Plan',
    'period_amount' => '49.00',
    'billing_interval' => 'month',
    'included_credit' => '<string>',
    'default_auto_top_up_bundle_id' => '<string>',
    'default_auto_top_up_bundle_index' => 123,
    'meter_ids' => [
        '<string>'
    ],
    'credit_bundles' => [
        [
                'name' => '<string>',
                'cost' => '<string>',
                'credit_amount' => '<string>'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.lava.so/v1/plans"

	payload := strings.NewReader("{\n  \"name\": \"Pro Plan\",\n  \"period_amount\": \"49.00\",\n  \"billing_interval\": \"month\",\n  \"included_credit\": \"<string>\",\n  \"default_auto_top_up_bundle_id\": \"<string>\",\n  \"default_auto_top_up_bundle_index\": 123,\n  \"meter_ids\": [\n    \"<string>\"\n  ],\n  \"credit_bundles\": [\n    {\n      \"name\": \"<string>\",\n      \"cost\": \"<string>\",\n      \"credit_amount\": \"<string>\"\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.lava.so/v1/plans")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Pro Plan\",\n  \"period_amount\": \"49.00\",\n  \"billing_interval\": \"month\",\n  \"included_credit\": \"<string>\",\n  \"default_auto_top_up_bundle_id\": \"<string>\",\n  \"default_auto_top_up_bundle_index\": 123,\n  \"meter_ids\": [\n    \"<string>\"\n  ],\n  \"credit_bundles\": [\n    {\n      \"name\": \"<string>\",\n      \"cost\": \"<string>\",\n      \"credit_amount\": \"<string>\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.lava.so/v1/plans")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"Pro Plan\",\n  \"period_amount\": \"49.00\",\n  \"billing_interval\": \"month\",\n  \"included_credit\": \"<string>\",\n  \"default_auto_top_up_bundle_id\": \"<string>\",\n  \"default_auto_top_up_bundle_index\": 123,\n  \"meter_ids\": [\n    \"<string>\"\n  ],\n  \"credit_bundles\": [\n    {\n      \"name\": \"<string>\",\n      \"cost\": \"<string>\",\n      \"credit_amount\": \"<string>\"\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "plan_id": "<string>",
  "merchant_id": "<string>",
  "name": "<string>",
  "period_amount": "<string>",
  "included_credit": "<string>",
  "default_auto_top_up_bundle_id": "<string>",
  "linked_meters": [
    {
      "meter_id": "<string>",
      "name": "<string>"
    }
  ],
  "credit_bundles": [
    {
      "credit_bundle_id": "<string>",
      "name": "<string>",
      "cost": "<string>",
      "credit_amount": "<string>"
    }
  ],
  "created_at": "2023-11-07T05:31:56Z"
}

{
  "error": {
    "message": "Invalid authentication credentials",
    "code": "forward_token_json_invalid",
    "status": 400,
    "issues": [
      {
        "path": [
          "model"
        ],
        "message": "Missing required field: model"
      },
      {
        "path": [
          "messages",
          "0",
          "content"
        ],
        "message": "Invalid message content format"
      }
    ]
  }
}

{
  "error": {
    "message": "Invalid authentication credentials",
    "code": "forward_token_json_invalid",
    "status": 400,
    "issues": [
      {
        "path": [
          "model"
        ],
        "message": "Missing required field: model"
      },
      {
        "path": [
          "messages",
          "0",
          "content"
        ],
        "message": "Invalid message content format"
      }
    ]
  }
}

POST

plans

Create plan

curl --request POST \
  --url https://api.lava.so/v1/plans \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Pro Plan",
  "period_amount": "49.00",
  "billing_interval": "month",
  "included_credit": "<string>",
  "default_auto_top_up_bundle_id": "<string>",
  "default_auto_top_up_bundle_index": 123,
  "meter_ids": [
    "<string>"
  ],
  "credit_bundles": [
    {
      "name": "<string>",
      "cost": "<string>",
      "credit_amount": "<string>"
    }
  ]
}
'

import requests

url = "https://api.lava.so/v1/plans"

payload = {
    "name": "Pro Plan",
    "period_amount": "49.00",
    "billing_interval": "month",
    "included_credit": "<string>",
    "default_auto_top_up_bundle_id": "<string>",
    "default_auto_top_up_bundle_index": 123,
    "meter_ids": ["<string>"],
    "credit_bundles": [
        {
            "name": "<string>",
            "cost": "<string>",
            "credit_amount": "<string>"
        }
    ]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'Pro Plan',
    period_amount: '49.00',
    billing_interval: 'month',
    included_credit: '<string>',
    default_auto_top_up_bundle_id: '<string>',
    default_auto_top_up_bundle_index: 123,
    meter_ids: ['<string>'],
    credit_bundles: [{name: '<string>', cost: '<string>', credit_amount: '<string>'}]
  })
};

fetch('https://api.lava.so/v1/plans', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.lava.so/v1/plans",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'Pro Plan',
    'period_amount' => '49.00',
    'billing_interval' => 'month',
    'included_credit' => '<string>',
    'default_auto_top_up_bundle_id' => '<string>',
    'default_auto_top_up_bundle_index' => 123,
    'meter_ids' => [
        '<string>'
    ],
    'credit_bundles' => [
        [
                'name' => '<string>',
                'cost' => '<string>',
                'credit_amount' => '<string>'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.lava.so/v1/plans"

	payload := strings.NewReader("{\n  \"name\": \"Pro Plan\",\n  \"period_amount\": \"49.00\",\n  \"billing_interval\": \"month\",\n  \"included_credit\": \"<string>\",\n  \"default_auto_top_up_bundle_id\": \"<string>\",\n  \"default_auto_top_up_bundle_index\": 123,\n  \"meter_ids\": [\n    \"<string>\"\n  ],\n  \"credit_bundles\": [\n    {\n      \"name\": \"<string>\",\n      \"cost\": \"<string>\",\n      \"credit_amount\": \"<string>\"\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.lava.so/v1/plans")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Pro Plan\",\n  \"period_amount\": \"49.00\",\n  \"billing_interval\": \"month\",\n  \"included_credit\": \"<string>\",\n  \"default_auto_top_up_bundle_id\": \"<string>\",\n  \"default_auto_top_up_bundle_index\": 123,\n  \"meter_ids\": [\n    \"<string>\"\n  ],\n  \"credit_bundles\": [\n    {\n      \"name\": \"<string>\",\n      \"cost\": \"<string>\",\n      \"credit_amount\": \"<string>\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.lava.so/v1/plans")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"Pro Plan\",\n  \"period_amount\": \"49.00\",\n  \"billing_interval\": \"month\",\n  \"included_credit\": \"<string>\",\n  \"default_auto_top_up_bundle_id\": \"<string>\",\n  \"default_auto_top_up_bundle_index\": 123,\n  \"meter_ids\": [\n    \"<string>\"\n  ],\n  \"credit_bundles\": [\n    {\n      \"name\": \"<string>\",\n      \"cost\": \"<string>\",\n      \"credit_amount\": \"<string>\"\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "plan_id": "<string>",
  "merchant_id": "<string>",
  "name": "<string>",
  "period_amount": "<string>",
  "included_credit": "<string>",
  "default_auto_top_up_bundle_id": "<string>",
  "linked_meters": [
    {
      "meter_id": "<string>",
      "name": "<string>"
    }
  ],
  "credit_bundles": [
    {
      "credit_bundle_id": "<string>",
      "name": "<string>",
      "cost": "<string>",
      "credit_amount": "<string>"
    }
  ],
  "created_at": "2023-11-07T05:31:56Z"
}

{
  "error": {
    "message": "Invalid authentication credentials",
    "code": "forward_token_json_invalid",
    "status": 400,
    "issues": [
      {
        "path": [
          "model"
        ],
        "message": "Missing required field: model"
      },
      {
        "path": [
          "messages",
          "0",
          "content"
        ],
        "message": "Invalid message content format"
      }
    ]
  }
}

{
  "error": {
    "message": "Invalid authentication credentials",
    "code": "forward_token_json_invalid",
    "status": 400,
    "issues": [
      {
        "path": [
          "model"
        ],
        "message": "Missing required field: model"
      },
      {
        "path": [
          "messages",
          "0",
          "content"
        ],
        "message": "Invalid message content format"
      }
    ]
  }
}

Authorizations

Authorization

string

header

required

Bearer token authentication used for standard API calls. Format: 'Bearer YOUR_API_KEY'

Body

application/json

name

string

required

Name of the plan

Example:

"Pro Plan"

period_amount

string

required

Price per billing period in USD (high precision decimal as string). Use "0" for free plans.

Example:

"49.00"

billing_interval

enum<string>

required

How often the subscription is billed

Available options:

day,

week,

month,

year

Example:

"month"

rollover_type

enum<string>

Whether unused included credit rolls over to the next billing cycle. Defaults to "none".

Available options:

full,

none

bundle_rollover_type

enum<string>

Whether unused bundle credit rolls over to the next billing cycle. Defaults to "none".

Available options:

full,

none

included_credit

string

Credit included per billing cycle in USD (high precision decimal as string). Defaults to period_amount.

default_auto_top_up_bundle_id

string | null

ID of an existing credit bundle to set as the default auto top-up bundle. When creating with new bundles, use default_auto_top_up_bundle_index instead.

default_auto_top_up_bundle_index

integer | null

Zero-based index into the credit_bundles array to set as the default auto top-up bundle. Use this when creating new bundles alongside the config.

meter_ids

string[]

Meter IDs to link to this plan

credit_bundles

object[]

Credit bundles to create with this configuration

Show child attributes

Response

Plan created

plan_id

string

required

Unique identifier for the plan

merchant_id

string

required

Merchant ID that owns this plan

name

string

required

Name of the plan

period_amount

string

required

Period amount in USD (high precision decimal as string)

included_credit

string

required

Included credit per billing cycle in USD (high precision decimal as string)

billing_interval

enum<string>

required

How often the subscription is billed

Available options:

day,

week,

month,

year

rollover_type

enum<string>

required

Cycle rollover: whether unused included credit rolls to next cycle

Available options:

full,

none

bundle_rollover_type

enum<string>

required

Bundle rollover: whether unused bundle credit rolls to next cycle

Available options:

full,

none

default_auto_top_up_bundle_id

string | null

required

ID of the credit bundle that will be auto-purchased when a subscription cycle runs out of credit. Null if auto top-up is disabled.

linked_meters

object[]

required

Meters linked to this plan

Show child attributes

credit_bundles

object[]

required

Credit bundles available for this plan

Show child attributes

created_at

string<date-time>

required

When the plan was created

List plans Get plan

⌘I

Getting Started

Core Endpoints

Models

Services

Requests

Usage

Checkout Sessions

Customers

Plans

Subscriptions

Meters

Webhooks

Secret Keys

Credit Bundles

Wallet

Payment Methods

Spend Keys

Authentication

Gateway Settings

Skills

News Data

Search

Enrich

Authorizations

Body

Response