Get billing status

GET https://app.speybooks.com/api/v1/billing/status

Returns the organisation's current subscription state including plan, trial status, days remaining, and Stripe subscription details (status, period end, cancellation flag). Fetches live subscription data from Stripe if a subscription ID exists.

Response

200 Returns current subscription status, trial info, and Stripe subscription details.
Show response fields
hasStripeCustomer boolean
Whether a Stripe customer record exists for this organisation.
hasSubscription boolean
Whether an active Stripe subscription exists.
isTrialActive boolean
Whether the trial period is still active.
plan string
Current plan identifier (trial, sole_trader, limited_company).
planName string
Human-readable plan name.
subscription object nullable
Stripe subscription details. Null if no subscription exists.
Show child attributes
cancelAtPeriodEnd boolean
Whether the subscription will cancel at the end of the current period.
currentPeriodEnd string nullable date-time
End of the current billing period.
status string
Stripe subscription status (active, trialing, past_due, canceled, unpaid).
trialDaysRemaining integer
Days remaining in the trial. Zero if trial expired or on a paid plan.
trialEndsAt string nullable date-time
ISO 8601 trial expiry timestamp.

Error codes

404 Organisation not found.