Skip to main content
GET /api/v2/storefront/billing/status Returns the verification state of your connected Stripe account — whether charges and payouts are enabled, any outstanding requirements Stripe still needs, and the current available and pending balance. Poll this after onboarding to confirm the account is fully enabled before relying on payouts.

​
Request

curl "https://api.interchange.io/api/v2/storefront/billing/status" \
  -H "Authorization: Bearer $SCOPE3_API_KEY"

​
Parameters

FieldTypeRequiredNotes
targetCustomerIdnumberNoQuery param. Parent customers read a child account’s status

​
Response

{
  "accountId": "acct_1Abc2DefGhiJklMn",
  "chargesEnabled": true,
  "payoutsEnabled": true,
  "requirements": {
    "currentlyDue": [],
    "eventuallyDue": ["external_account"]
  },
  "balance": {
    "available": [{ "amount": 4250000, "currency": "usd" }],
    "pending": [{ "amount": 120000, "currency": "usd" }]
  }
}
chargesEnabled and payoutsEnabled must both be true before Scope3 can settle and pay out. requirements.currentlyDue lists fields blocking the account now; eventuallyDue lists fields needed later. Balance amount values are in the currency’s smallest unit (cents for usd).

​
Errors

  • 400 VALIDATION_ERROR — no Stripe account provisioned yet, or Stripe is not configured on the server.
See Errors for the full error contract.

Billing tasks

All billing operations

Provision Stripe Connect

Create the Express account first

Get payouts

Payouts to your bank

Billing overview

Stripe Connect concepts