Skip to main content
GET
/
subscriptions
List all subscriptions
curl --request GET \
  --url https://api.blink.store/v1/subscriptions \
  --header 'x-store-id: <api-key>'
import requests

url = "https://api.blink.store/v1/subscriptions"

headers = {"x-store-id": "<api-key>"}

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

print(response.text)
const options = {method: 'GET', headers: {'x-store-id': '<api-key>'}};

fetch('https://api.blink.store/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.blink.store/v1/subscriptions",
  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-store-id: <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://api.blink.store/v1/subscriptions"

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

	req.Header.Add("x-store-id", "<api-key>")

	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.blink.store/v1/subscriptions")
  .header("x-store-id", "<api-key>")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.blink.store/v1/subscriptions")

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

request = Net::HTTP::Get.new(url)
request["x-store-id"] = '<api-key>'

response = http.request(request)
puts response.read_body
{
  "meta": {
    "total": 123
  },
  "data": [
    {
      "id": "<string>",
      "store_id": "<string>",
      "product_id": "<string>",
      "variant_id": "<string>",
      "status": "<string>",
      "current_period_end": "2023-11-07T05:31:56Z",
      "cancel_at_period_end": true,
      "metadata": {},
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "stripe_subscription_id": "<string>",
      "stripe_customer_id": "<string>",
      "product": {
        "id": "<string>",
        "name": "<string>",
        "pricing_model": "<string>",
        "subscription_interval": "<string>"
      },
      "variant": {
        "id": "<string>",
        "name": "<string>",
        "price": 123,
        "subscription_interval": "<string>"
      }
    }
  ]
}

Authorizations

​
x-store-id
string
header
required

Query Parameters

​
limit
integer

Number of subscriptions to retrieve.

​
status
string

Filter subscriptions by status.

​
customer_id
string

Filter subscriptions by customer ID.

​
product_id
string

Filter subscriptions by product ID.

Response

List of subscriptions retrieved successfully.

​
meta
object
​
data
object[]