List Resource Usages

curl --request GET \
  --url https://app.flowglad.com/api/v1/resource-claims/{subscriptionId}/usages \
  --header 'Authorization: <api-key>'

import requests

url = "https://app.flowglad.com/api/v1/resource-claims/{subscriptionId}/usages"

headers = {"Authorization": "<api-key>"}

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

print(response.text)

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

fetch('https://app.flowglad.com/api/v1/resource-claims/{subscriptionId}/usages', 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://app.flowglad.com/api/v1/resource-claims/{subscriptionId}/usages",
  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: <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://app.flowglad.com/api/v1/resource-claims/{subscriptionId}/usages"

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

	req.Header.Add("Authorization", "<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://app.flowglad.com/api/v1/resource-claims/{subscriptionId}/usages")

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

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

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

[
  {
    "usage": {
      "resourceSlug": "<string>",
      "resourceId": "<string>",
      "capacity": 0,
      "claimed": 0,
      "available": 0
    },
    "claims": [
      {
        "id": "<string>",
        "createdAt": 0,
        "updatedAt": 0,
        "livemode": true,
        "organizationId": "<string>",
        "resourceId": "<string>",
        "subscriptionId": "<string>",
        "pricingModelId": "<string>",
        "externalId": "<string>",
        "claimedAt": 0,
        "releaseReason": "<string>",
        "releasedAt": 0,
        "expiredAt": 0,
        "metadata": {}
      }
    ]
  }
]

{
  "code": "BAD_REQUEST",
  "message": "Invalid input data",
  "issues": []
}

{
  "code": "UNAUTHORIZED",
  "message": "Authorization not provided",
  "issues": []
}

{
  "code": "FORBIDDEN",
  "message": "Insufficient access",
  "issues": []
}

{
  "code": "NOT_FOUND",
  "message": "Not found",
  "issues": []
}

{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "issues": []
}

GET

api

resource-claims

{subscriptionId}

usages

List Resource Usages

curl --request GET \
  --url https://app.flowglad.com/api/v1/resource-claims/{subscriptionId}/usages \
  --header 'Authorization: <api-key>'

import requests

url = "https://app.flowglad.com/api/v1/resource-claims/{subscriptionId}/usages"

headers = {"Authorization": "<api-key>"}

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

print(response.text)

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

fetch('https://app.flowglad.com/api/v1/resource-claims/{subscriptionId}/usages', 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://app.flowglad.com/api/v1/resource-claims/{subscriptionId}/usages",
  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: <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://app.flowglad.com/api/v1/resource-claims/{subscriptionId}/usages"

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

	req.Header.Add("Authorization", "<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://app.flowglad.com/api/v1/resource-claims/{subscriptionId}/usages")

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

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

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

[
  {
    "usage": {
      "resourceSlug": "<string>",
      "resourceId": "<string>",
      "capacity": 0,
      "claimed": 0,
      "available": 0
    },
    "claims": [
      {
        "id": "<string>",
        "createdAt": 0,
        "updatedAt": 0,
        "livemode": true,
        "organizationId": "<string>",
        "resourceId": "<string>",
        "subscriptionId": "<string>",
        "pricingModelId": "<string>",
        "externalId": "<string>",
        "claimedAt": 0,
        "releaseReason": "<string>",
        "releasedAt": 0,
        "expiredAt": 0,
        "metadata": {}
      }
    ]
  }
]

{
  "code": "BAD_REQUEST",
  "message": "Invalid input data",
  "issues": []
}

{
  "code": "UNAUTHORIZED",
  "message": "Authorization not provided",
  "issues": []
}

{
  "code": "FORBIDDEN",
  "message": "Insufficient access",
  "issues": []
}

{
  "code": "NOT_FOUND",
  "message": "Not found",
  "issues": []
}

{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "issues": []
}

Authorizations

Authorization

string

header

required

Path Parameters

subscriptionId

string

required

Query Parameters

resourceSlugs

string[]

Maximum array length: 100

resourceIds

string[]

Response

Successful response

usage

object

required

Show child attributes

claims

object[]

required

Show child attributes

⌘I

API Documentation

Payments

Checkout Sessions

Products

Prices

Purchases

Customer

Discounts

Invoice Line Items

Invoices

Pricing Models

API Keys

Subscriptions

Payment Methods

Usage Meters

Usage Events

Webhooks

Features

Product Features

Subscription Item Features

Resources

Resource Claims

List Resource Usages

Authorizations

Path Parameters

Query Parameters

Response