List Available Plans

Retrieves all plans for a merchant that the customer does not have an active or pending subscription for. When a customer has a subscription for any plan within a product, all plans from that product are excluded.

GET /v0/plans/available

List Available Plans

cURL

curl --request GET \
  --url https://api.paygentic.io/v0/plans/available \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.paygentic.io/v0/plans/available"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.paygentic.io/v0/plans/available', 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.paygentic.io/v0/plans/available",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.paygentic.io/v0/plans/available"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.paygentic.io/v0/plans/available")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.paygentic.io/v0/plans/available")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

200

{
  "data": [
    {
      "id": "plan_t9u0v1w2x3y4z5a6",
      "object": "plan",
      "billingCadence": "P1M",
      "billingInterval": "monthly",
      "createdAt": "2024-01-12T10:00:00Z",
      "currency": "USD",
      "defaultTaxCode": "eservice",
      "defaultTaxRate": 8.5,
      "description": "Claude API access with 500K tokens monthly allowance",
      "invoiceDisplayName": "LLM API Basic Plan",
      "merchantId": "org_b7c8d9e0f1g2h3i4",
      "name": "Basic Tier",
      "prices": [],
      "productId": "prod_j5k6l7m8n9o0p1q2",
      "taxBehavior": "exclusive",
      "updatedAt": "2024-01-12T10:00:00Z"
    }
  ],
  "pagination": {
    "limit": 10,
    "offset": 0,
    "total": 1
  }
}

{
  "message": "The requested resource was not found",
  "error": "not_found"
}

{
  "message": "The requested resource was not found",
  "error": "not_found"
}

{
  "message": "The requested resource was not found",
  "error": "not_found"
}

{
  "message": "The requested resource was not found",
  "error": "not_found"
}

{
  "message": "The requested resource was not found",
  "error": "not_found"
}

Authorizations

Authorization · string · header · required

API key authentication

Query Parameters

customerId · string · required

The customer to check subscriptions for. The merchant is derived from the customer record. Unique identifier for a customer

Pattern: ^cus_[a-zA-Z0-9]+$

productId · string

Optional filter by product ID Unique identifier for a product

Pattern: ^prod_[a-zA-Z0-9]+$

search · string

Optional search text to filter plan names (case-insensitive)

limit · integer · default: 10

Number of plans to return

Required range: 1 <= x <= 100

offset · integer · default: 0

Number of plans to skip

Required range: x >= 0

Response

200

application/json

List of available plans

data · object[]

Show child attributes

pagination · object

Show child attributes