Skip to main content
GET /api/v2/storefront/billing Returns your storefront’s billing configuration: payout setup status, platform fee percentage, any additional partner fees, payout currency, payment terms, and the payout details on file (masked — the account number is never returned after save). billing is null when no configuration exists yet. When billing is inherited from your organization, inherited is true. Also available to agents as the get_billing_info operation.

​
Request

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

​
Parameters

FieldTypeRequiredNotes
targetCustomerIdnumberNoQuery param. Organizations read a managed account’s config

​
Response

{
  "billing": {
    "onboardingStatus": "complete",
    "platformFeePercent": 12.5,
    "fees": [
      { "name": "Ad serving", "description": "Third-party ad serving", "feePercent": 2 }
    ],
    "currency": "USD",
    "country": "US",
    "defaultNetDays": 30,
    "payoutDetails": {
      "beneficiaryName": "Meridian Media Group Inc.",
      "addressLine1": "500 Harbor Blvd",
      "addressLine2": null,
      "city": "Seattle",
      "region": "WA",
      "postalCode": "98101",
      "countryCode": "US",
      "accountNumberLast4": "6789",
      "bankIdentifierType": "FEDWIRE_ABA",
      "bankIdentifierValue": "021000021",
      "completedAt": "2026-07-01T09:30:00Z"
    },
    "inherited": false,
    "createdAt": "2026-04-25T12:00:00Z",
    "updatedAt": "2026-05-01T09:30:00Z"
  }
}
FieldTypeNotes
onboardingStatusenumPayout setup status: pending, complete (payout details on file), or restricted
platformFeePercentnumber | nullPlatform fee percentage
feesarray | nullAdditional partner fees (name, description, feePercent)
currencystring | nullPayout currency (ISO 4217)
countrystring | nullISO 3166-1 alpha-2 country used for billing
defaultNetDaysnumber | nullPayment terms in days
payoutDetailsobject | nullMasked bank details on file — see below. null until saved
inheritedbooleanWhether this config is inherited from the organization
payoutDetails carries beneficiaryName, the beneficiary address fields, accountNumberLast4 (the only part of the account number ever returned), bankIdentifierType + bankIdentifierValue, and completedAt. While payoutDetails is null, media buys against your storefront cannot use Scope3-cleared (agent) billing and you bill buyers directly — save details with Set payout details.

​
Errors

  • 400 VALIDATION_ERROR — malformed request or invalid targetCustomerId.
See Errors for the full error contract.

Billing tasks

All billing operations

Set payout details

Save the bank account Scope3 pays into

Update billing config

Change fees, currency, net days (admin)

Billing overview

How payouts work and why bank details are needed