Send these requests to https://api.cloud.blnkfinance.com on Blnk Cloud. On a self-hosted Enterprise deployment, send them to ENTERPRISE_PUBLIC_URL.
Pass an Enterprise API key, or an OAuth access token, in the X-blnk-key header. Create the key in Enterprise API keys, or issue a token with Enterprise OAuth.
This credential comes from the Cloud or Enterprise workspace. A Core API key belongs to the Core instance.
X-blnk-keystringrequiredheader
Enterprise API key, or an OAuth access token.
Response
emailstring
Billing email.
namestring
Organization or account name.
addressobject
Billing address.
Details
line1string
Street address.
citystring
City.
statestring
State or region.
postal_codestring
Postal code.
countrystring
Country code, such as US.
cardobject
Payment method summary. brand can be a card network or a wallet such as Link. Some methods return empty last4 and 0 expiry.
Details
brandstring
Payment method brand, such as visa or Link.
last4string
Last four digits of the card. Can be empty.
exp_monthinteger
Expiration month. Can be 0.
exp_yearinteger
Expiration year. Can be 0.
next_billing_dateinteger
Unix timestamp (seconds) for the next charge.
next_billing_amountinteger
Upcoming charge in the smallest currency unit. In the sample, 10000 is $100.00 USD across both subscriptions.
currencystring
ISO currency code, such as usd.
total_monthly_spendinteger
Current monthly spend in the smallest currency unit.
active_plansinteger
Number of active plan subscriptions (type is plan).
active_deploymentsinteger
Number of active deployment subscriptions (type is deployment).
has_payment_methodboolean
Whether a payment method is on file.
available_creditinteger
Available credit in the smallest currency unit.
outstanding_balanceinteger
Outstanding balance in the smallest currency unit.
subscriptionsarray
Active subscriptions.
Details
idstring
Subscription id (sub_...).
statusstring
Subscription status, such as active.
planstring
Plan code, such as DEPLOY_DEV or PRODUCTION_MONTHLY.
plan_namestring
Display name, such as Sandbox Deployment or Production (Monthly).
typestring
plan or deployment.
quantityinteger
Number of units on the subscription.
unit_amountinteger
Price per unit in the smallest currency unit.
currencystring
ISO currency code, such as usd.
intervalstring
Billing interval, such as month.
current_period_startinteger
Unix timestamp (seconds) for the start of the current period.
current_period_endinteger
Unix timestamp (seconds) for the end of the current period.
cancel_at_period_endboolean
Whether the subscription cancels at the end of the period.
