Skip to main content
POST
/
subscriptions
Create subscription
curl --request POST \
  --url https://api.lava.so/v1/subscriptions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "customer_id": "con_test_01EXAMPLE00000000000000001",
  "plan_id": "subconf_abc123"
}
'
import requests

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

payload = {
    "customer_id": "con_test_01EXAMPLE00000000000000001",
    "plan_id": "subconf_abc123"
}
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({customer_id: 'con_test_01EXAMPLE00000000000000001', plan_id: 'subconf_abc123'})
};

fetch('https://api.lava.so/v1/subscriptions', 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/subscriptions",
  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([
    'customer_id' => 'con_test_01EXAMPLE00000000000000001',
    'plan_id' => 'subconf_abc123'
  ]),
  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/subscriptions"

	payload := strings.NewReader("{\n  \"customer_id\": \"con_test_01EXAMPLE00000000000000001\",\n  \"plan_id\": \"subconf_abc123\"\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/subscriptions")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"customer_id\": \"con_test_01EXAMPLE00000000000000001\",\n  \"plan_id\": \"subconf_abc123\"\n}")
  .asString();
require 'uri'
require 'net/http'

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

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  \"customer_id\": \"con_test_01EXAMPLE00000000000000001\",\n  \"plan_id\": \"subconf_abc123\"\n}"

response = http.request(request)
puts response.read_body
{
  "subscription": "<unknown>"
}
{
  "error": {
    "message": "Only free plans can be assigned via API. Use checkout for paid plans.",
    "code": "plan_not_free",
    "status": 400
  }
}
{
  "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"
      }
    ]
  }
}
{
  "error": {
    "message": "An active subscription already exists for this customer.",
    "code": "subscription_already_exists",
    "status": 409
  }
}

Authorizations

Authorization
string
header
required

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

Body

application/json
customer_id
string
required

Customer ID (con_xxx) or your reference_id. Both are accepted interchangeably.

Example:

"con_test_01EXAMPLE00000000000000001"

plan_id
string
required

ID of the plan to assign. Must be a free plan (period_amount = 0).

Example:

"subconf_abc123"

Response

Subscription created

subscription
any
required