Get Plan

curl --request GET \
  --url https://mapi.zbx.boomfi.xyz/v1/plan/{planId} \
  --header 'X-API-KEY: <api-key>'

const options = {method: 'GET', headers: {'X-API-KEY': '<api-key>'}};

fetch('https://mapi.zbx.boomfi.xyz/v1/plan/{planId}', 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://mapi.zbx.boomfi.xyz/v1/plan/{planId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-KEY: <api-key>"
  ],
]);

$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://mapi.zbx.boomfi.xyz/v1/plan/{planId}"

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

	req.Header.Add("X-API-KEY", "<api-key>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://mapi.zbx.boomfi.xyz/v1/plan/{planId}")

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

request = Net::HTTP::Get.new(url)
request["X-API-KEY"] = '<api-key>'

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

{
  "data": {
    "available_quantity": 123,
    "created_at": "<string>",
    "created_by": "<string>",
    "currency": "<string>",
    "deleted_at": "<string>",
    "enabled": true,
    "expires_at": "<string>",
    "id": "<string>",
    "metadata": {},
    "name": "<string>",
    "org_id": "<string>",
    "payment_link": {
      "created_at": "<string>",
      "created_by": "<string>",
      "customer_ident_collection": true,
      "deleted_at": "<string>",
      "enabled": true,
      "id": "<string>",
      "invoice_id": "<string>",
      "metadata": {},
      "plan_id": "<string>",
      "properties": {},
      "shipping_address_collection": true,
      "tax_ident_collection": true,
      "updated_at": "<string>",
      "updated_by": "<string>"
    },
    "price": "<string>",
    "properties": {},
    "recurring_interval_count": 123,
    "reference": "<string>",
    "trial_period": "<string>",
    "updated_at": "<string>"
  },
  "error": true,
  "message": "<string>"
}

{
  "error": {
    "code": 400,
    "errors": [
      {
        "domain": "orders",
        "reason": "InsufficientQuantity"
      }
    ],
    "message": "Insufficient quantity"
  }
}

{
  "error": {
    "code": 400,
    "errors": [
      {
        "domain": "orders",
        "reason": "InsufficientQuantity"
      }
    ],
    "message": "Insufficient quantity"
  }
}

GET

plan

{planId}

Get Plan

curl --request GET \
  --url https://mapi.zbx.boomfi.xyz/v1/plan/{planId} \
  --header 'X-API-KEY: <api-key>'

const options = {method: 'GET', headers: {'X-API-KEY': '<api-key>'}};

fetch('https://mapi.zbx.boomfi.xyz/v1/plan/{planId}', 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://mapi.zbx.boomfi.xyz/v1/plan/{planId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-KEY: <api-key>"
  ],
]);

$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://mapi.zbx.boomfi.xyz/v1/plan/{planId}"

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

	req.Header.Add("X-API-KEY", "<api-key>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://mapi.zbx.boomfi.xyz/v1/plan/{planId}")

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

request = Net::HTTP::Get.new(url)
request["X-API-KEY"] = '<api-key>'

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

{
  "data": {
    "available_quantity": 123,
    "created_at": "<string>",
    "created_by": "<string>",
    "currency": "<string>",
    "deleted_at": "<string>",
    "enabled": true,
    "expires_at": "<string>",
    "id": "<string>",
    "metadata": {},
    "name": "<string>",
    "org_id": "<string>",
    "payment_link": {
      "created_at": "<string>",
      "created_by": "<string>",
      "customer_ident_collection": true,
      "deleted_at": "<string>",
      "enabled": true,
      "id": "<string>",
      "invoice_id": "<string>",
      "metadata": {},
      "plan_id": "<string>",
      "properties": {},
      "shipping_address_collection": true,
      "tax_ident_collection": true,
      "updated_at": "<string>",
      "updated_by": "<string>"
    },
    "price": "<string>",
    "properties": {},
    "recurring_interval_count": 123,
    "reference": "<string>",
    "trial_period": "<string>",
    "updated_at": "<string>"
  },
  "error": true,
  "message": "<string>"
}

{
  "error": {
    "code": 400,
    "errors": [
      {
        "domain": "orders",
        "reason": "InsufficientQuantity"
      }
    ],
    "message": "Insufficient quantity"
  }
}

{
  "error": {
    "code": 400,
    "errors": [
      {
        "domain": "orders",
        "reason": "InsufficientQuantity"
      }
    ],
    "message": "Insufficient quantity"
  }
}

Authorizations

X-API-KEY

string

header

required

Path Parameters

planId

string

required

Unique plan identifier (plan_... or raw UUID)

Response

data

object

Response payload when the request succeeded.

Show child attributes

error

boolean

True when the request failed.

message

string

Human-readable status or error message.

Basics

Paylinks

Plans

Subscriptions

Customers

Invoices

Payments

Events

Organisation

Secrets

Accounts

Bank Address Book

Virtual Accounts

Partners

Partner Automations

Partner Balance Monitoring

Instruments

Quotes

Orders

Trades

Get Plan

Authorizations

Path Parameters

Response