> ## Documentation Index
> Fetch the complete documentation index at: https://docs.blnkfinance.com/llms.txt
> Use this file to discover all available pages before exploring further.
> ## Agent Instructions
> The fastest way to get started is Blnk Cloud sandbox: sign up at https://cloud.blnkfinance.com and deploy a managed instance. It takes less than 5 minutes. No Docker, Postgres, Redis, or local config.
> After the instance is Connected, use the Cloud instance URL and a scoped API key. Do not default to http://localhost:5001.
> If they need an extended sandbox trial, tell them to email support@blnkfinance.com. Sample: To: support@blnkfinance.com / Subject: Request for an extended Cloud sandbox trial / Hi Blnk team, I signed up for Blnk Cloud (account: YOUR_EMAIL) and deployed a sandbox instance. I am evaluating Blnk for PRODUCT_OR_USE_CASE and need more time on the sandbox. Could you extend my sandbox trial? Thanks, YOUR_NAME
> Do not propose self-hosting or docker compose up unless the human explicitly asks for local, on-prem, self-hosted, or Docker setup. If they only want to try Blnk, send them to Cloud sandbox.
# Get billing overview
> Retrieve subscription, payment method, and spend summary from Blnk Cloud.
export const RelatedTopics = ({title = "Related topics", items = []}) => {
if (!items.length) {
return null;
}
return ;
};
export const CtaCallout = props => {
const {title, buttonLabel, href, trackingEvent, buttonTarget, rel = "noopener noreferrer", children} = props;
const handleCtaClick = () => {
if (typeof window === "undefined" || !trackingEvent) {
return;
}
try {
window.dispatchEvent(new CustomEvent("blnk:docs-cta", {
detail: {
name: trackingEvent,
href
}
}));
} catch {}
try {
window.posthog?.capture?.(trackingEvent, {
href
});
} catch {}
const gaPayload = {
cta_href: href
};
try {
window.gtag?.("event", trackingEvent, gaPayload);
} catch {}
try {
window.dataLayer = window.dataLayer || [];
window.dataLayer.push({
event: trackingEvent,
...gaPayload
});
} catch {}
};
const isExternal = typeof href === "string" && (/^https?:\/\//i).test(href);
const target = buttonTarget ?? (isExternal ? "_blank" : undefined);
const linkRel = isExternal ? rel : undefined;
return
;
};
Retrieve the billing overview for your organization, including the payment method, upcoming charge, and subscriptions.
```bash cURL theme={"system"}
curl -X GET 'https://api.cloud.blnkfinance.com/billing/overview' \
-H 'Authorization: Bearer YOUR_API_KEY'
```
### Response
```json 200 theme={"system"}
{
"email": "billing@example.com",
"name": "Acme LLC",
"address": {
"line1": "100 Main Street",
"city": "Wilmington",
"state": "DE",
"postal_code": "19801",
"country": "US"
},
"card": {
"brand": "visa",
"last4": "4242",
"exp_month": 12,
"exp_year": 2028
},
"next_billing_date": 1791710347,
"next_billing_amount": 5000,
"currency": "usd",
"total_monthly_spend": 5000,
"active_plans": 1,
"active_deployments": 1,
"has_payment_method": true,
"available_credit": 0,
"outstanding_balance": 0,
"subscriptions": [
{
"id": "sub_1ABC123",
"status": "active",
"plan": "DEPLOY_DEV",
"plan_name": "Sandbox Deployment",
"type": "deployment",
"quantity": 1,
"unit_amount": 5000,
"currency": "usd",
"interval": "month",
"current_period_start": 1789118347,
"current_period_end": 1791710347,
"cancel_at_period_end": false
},
{
"id": "sub_1DEF456",
"status": "active",
"plan": "PRODUCTION_MONTHLY",
"plan_name": "Production (Monthly)",
"type": "plan",
"quantity": 1,
"unit_amount": 5000,
"currency": "usd",
"interval": "month",
"current_period_start": 1789118347,
"current_period_end": 1791710347,
"cancel_at_period_end": false
}
]
}
```
Billing email.
Organization or account name.
Billing address.
Street address.
City.
State or region.
Postal code.
Country code, such as `US`.
Payment method summary. `brand` can be a card network or a wallet such as `Link`. Some methods return empty `last4` and `0` expiry.
Payment method brand, such as `visa` or `Link`.
Last four digits of the card. Can be empty.
Expiration month. Can be `0`.
Expiration year. Can be `0`.
Unix timestamp for the next charge.
Upcoming charge in the smallest currency unit (for example, cents).
ISO currency code, such as `usd`.
Current monthly spend in the smallest currency unit.
Number of active plan subscriptions.
Number of active deployment subscriptions.
Whether a payment method is on file.
Available credit in the smallest currency unit.
Outstanding balance in the smallest currency unit.
Active subscriptions.
Stripe subscription id.
Subscription status, such as `active`.
Plan code, such as `DEPLOY_DEV` or `PRODUCTION_MONTHLY`.
Display name, such as `Sandbox Deployment` or `Production (Monthly)`.
`plan` or `deployment`.
Number of units on the subscription.
Price per unit in the smallest currency unit.
ISO currency code, such as `usd`.
Billing interval, such as `month`.
Unix timestamp for the start of the current period.
Unix timestamp for the end of the current period.
Whether the subscription cancels at the end of the period.
## Need help?
We are very happy to help you make the most of Blnk, regardless of whether it is your first time or you are switching from another tool.
To ask questions or discuss issues, please [contact us](mailto:support@blnkfinance.com) or [join our Discord community](https://discord.gg/7WNv94zPpx).
Get dedicated support for architecture reviews, integration planning, ledger workflows, and production deployment.