Skip to main content
StoreInspect billing endpoints create short-lived links to Stripe-hosted pages. They never change a subscription or charge a customer directly. A human must open the returned URL and confirm any subscription change in Stripe.

​
Available operations

  • GET /billing/status reads the current subscription and API-access state.
  • POST /billing/subscription-link accepts a StoreInspect plan and monthly or annual cadence. It returns paid Checkout for a new subscription, an exact Stripe confirmation page for a supported higher-plan upgrade, or the billing portal when recovery is required. API-created Checkout does not include a free trial.
  • POST /billing/portal-link returns the general Stripe billing portal for invoices, payment details, cancellation, and recovery.

​
Access

API key creation remains available only on paid plans. An existing valid, non-revoked key can continue using billing endpoints if the account later becomes past due, canceled, or otherwise loses paid data access. Billing endpoints require billing:read or billing:manage. Store search, enrichment, contact search, and reveals continue to require an active paid plan.

​
Safety

  • Plans and cadences are fixed enums. Stripe Price IDs cannot be supplied.
  • Return URLs are controlled by StoreInspect.
  • Hosted URLs are bearer capabilities and should not be logged or shared.
  • Billing status is exempt from ordinary request quota and limited to 60 checks per account per hour.
  • Billing-link creation is limited to five requests per account per hour.
  • Stripe webhooks remain the source of truth for subscription state and entitlements.
After a customer confirms a change, poll GET /billing/status or GET /usage until the webhook-reconciled plan is visible.