Read a safe subscription and billing-health summary

GET

/v1/mobile/billing/summary

const url = 'https://api.vocapable.com/v1/mobile/billing/summary';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api.vocapable.com/v1/mobile/billing/summary \
  --header 'Authorization: Bearer <token>'

Authorizations

MobileBearer

Responses

200

Successful Response

application/json

MobileSubscriptionHealth

The full native billing read for Admin/Manager, still safe for an app cache policy.

object

plan_label

required

Plan Label

string

>= 1 characters <= 160 characters

status

required

Status

string

Allowed values: trialing active past_due paused canceled unavailable

usage_label

Any of:

string
null

string

<= 160 characters

capacity_label

Any of:

string
null

string

<= 160 characters

payment_attention

required

Payment Attention

string

Allowed values: none attention unavailable

next_renewal_at

Any of:

string
null

string format: date-time

budget

Any of:

MobileBillingBudget
null

MobileBillingBudget

The current spend guardrails; no payment method or provider data is representable.

object

amount_minor

Any of:

integer
null

integer

>= 1

currency

required

Currency

string

>= 3 characters <= 12 characters

period

Any of:

string
null

string

Allowed values: daily monthly

low_balance_threshold_minor

Any of:

integer
null

integer

version

required

Version

integer

>= 1

updated_at

required

Updated At

string format: date-time

invoices

Invoices

Array<object>

<= 3 items

MobileBillingInvoiceSummary

A compact mirror summary. Stripe-hosted invoice links stay browser-only.

object

required

string

>= 1 characters <= 128 characters

status

required

Status

string

Allowed values: paid open past_due void unavailable

amount_minor

Any of:

integer
null

integer

currency

Any of:

string
null

string

>= 3 characters <= 12 characters

due_at

Any of:

string
null

string format: date-time

generated_at

required

Generated At

string format: date-time

Example

{
  "status": "trialing",
  "payment_attention": "none",
  "budget": {
    "period": "daily"
  },
  "invoices": [
    {
      "status": "paid"
    }
  ]
}