Balance

Get the current subscription status and transfer balance.

GEThttps://api.bringyour.com/subscription/balance

Authorization

BearerAuth

Response

200

Body

application/json

balance_byte_countinteger

current_subscriptionobject

active_transfer_balancesarray of object

pending_payout_usd_nano_centsinteger

wallet_infoobject

update_timestring

Request

JavaScriptCurlPython

const response = await fetch('https://api.bringyour.com/subscription/balance', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

200

{
  "balance_byte_count": 0,
  "current_subscription": {
    "subscription_id": "text",
    "store": "text",
    "plan": "text"
  },
  "active_transfer_balances": [
    {
      "balance_id": "text",
      "network_id": "text",
      "start_time": "text",
      "end_time": "text",
      "start_balance_byte_count": 0,
      "net_revenue_nano_cents": 0,
      "balance_byte_count": 0
    }
  ],
  "pending_payout_usd_nano_cents": 0,
  "wallet_info": {
    "wallet_id": "text",
    "token_id": "text",
    "blockchain": "Polygon",
    "blockchain_symbol": "MATIC",
    "create_date": "text",
    "balance_usdc_nano_cents": 0,
    "address": "text"
  },
  "update_time": "text"
}