List Subscriptions By Customer

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

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

fetch('https://mapi.zbx.boomfi.xyz/v1/subscriptions/{customerID}', 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/subscriptions/{customerID}",
  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/subscriptions/{customerID}"

	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/subscriptions/{customerID}")

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": {
    "items": [
      {
        "chain_id": "<string>",
        "contract_subscription_id": "<string>",
        "created_at": "<string>",
        "customer_id": "<string>",
        "id": "<string>",
        "initial_payment_id": "<string>",
        "is_overdue": true,
        "next_payment_at": "<string>",
        "payment_currency": "<string>",
        "plan": {
          "available_quantity": 123,
          "created_at": "<string>",
          "created_by": "<string>",
          "currency": "<string>",
          "deleted_at": "<string>",
          "enabled": true,
          "expires_at": "<string>",
          "id": "<string>",
          "metadata": [
            123
          ],
          "name": "<string>",
          "org_id": "<string>",
          "price": "<string>",
          "properties": [
            123
          ],
          "recurring_interval_count": 123,
          "reference": "<string>",
          "trial_period": "<string>",
          "updated_at": "<string>"
        },
        "plan_id": "<string>",
        "started_at": "<string>",
        "terminated_at": "<string>",
        "termination_txn_hash": "<string>",
        "txn_hash": "<string>",
        "updated_at": "<string>"
      }
    ],
    "last_update": "2021-01-01T00:00:00.000Z",
    "next": 10,
    "total": 10
  },
  "error": true
}

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

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

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

GET

subscriptions

{customerID}

List Subscriptions By Customer

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

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

fetch('https://mapi.zbx.boomfi.xyz/v1/subscriptions/{customerID}', 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/subscriptions/{customerID}",
  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/subscriptions/{customerID}"

	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/subscriptions/{customerID}")

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": {
    "items": [
      {
        "chain_id": "<string>",
        "contract_subscription_id": "<string>",
        "created_at": "<string>",
        "customer_id": "<string>",
        "id": "<string>",
        "initial_payment_id": "<string>",
        "is_overdue": true,
        "next_payment_at": "<string>",
        "payment_currency": "<string>",
        "plan": {
          "available_quantity": 123,
          "created_at": "<string>",
          "created_by": "<string>",
          "currency": "<string>",
          "deleted_at": "<string>",
          "enabled": true,
          "expires_at": "<string>",
          "id": "<string>",
          "metadata": [
            123
          ],
          "name": "<string>",
          "org_id": "<string>",
          "price": "<string>",
          "properties": [
            123
          ],
          "recurring_interval_count": 123,
          "reference": "<string>",
          "trial_period": "<string>",
          "updated_at": "<string>"
        },
        "plan_id": "<string>",
        "started_at": "<string>",
        "terminated_at": "<string>",
        "termination_txn_hash": "<string>",
        "txn_hash": "<string>",
        "updated_at": "<string>"
      }
    ],
    "last_update": "2021-01-01T00:00:00.000Z",
    "next": 10,
    "total": 10
  },
  "error": true
}

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

{
  "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

customerID

string

required

Unique customer identifier (cus_... or raw UUID)

Response

data

object

Paginated payload.

Show child attributes

error

boolean

True when the request failed.

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

List Subscriptions By Customer

Authorizations

Path Parameters

Response