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>",
"billing_interval": "day",
"rollover_type": "full",
"bundle_rollover_type": "full",
"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"
}
]
}
}Plans
Create plan
Create a new plan with optional meter links and credit bundles. A Stripe Price is automatically created for non-zero period amounts.
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>",
"billing_interval": "day",
"rollover_type": "full",
"bundle_rollover_type": "full",
"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
Body
application/json
Response
Plan created