How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Scope3 Storefront Billing API

Payout bank details and billing configuration for storefronts

Scope3 Storefront Billing API is one of 51 APIs that Scope3 publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Storefront Billing. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 9 operations across 7 paths, and defines 21 schemas. It is described by OpenAPI 3.2.0, at version 2.0.0.

Requests are made against a single base URL, https://api.interchange.io/api/v2/storefront.

9 operations 7 paths 21 schemas 5 GET1 POST3 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2.0.0
Base URL
https://aiapi.scope3.com
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Scope3 Storefront Billing API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth).

  • bearerAuth — API key or access token

Paths & Operations 9

Across 7 paths, the API surfaces 9 operations — 5 GET, 1 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.

Storefront Billing 9

Payout bank details and billing configuration for storefronts

GET
/billing/storefront-rate-card
Get the storefront Rate Card offer and acceptance state
getStorefrontRateCardOffer → 200400401403409500
POST
/billing/storefront-rate-card/accept
Accept an exact storefront Rate Card offer
acceptStorefrontRateCardOffer body → 200400401403409500
GET
/billing/payout-activity
Get payout activity
getPayoutActivity 1 param → 200400401500
GET
/billing
Get billing config
getStorefrontBilling 1 param → 200400401500
PUT
/billing
Update billing configuration (admin)
updateStorefrontBilling 1 param body → 200400401500
PUT
/billing/payout-details
Set payout details (admin)
setPayoutDetails 1 param body → 200400401500
GET
/billing/payees
List payout payees
listPayoutPayees 1 param → 200400401500
PUT
/billing/payees
Set payout payee (admin)
setPayoutPayee 1 param body → 200400401500
GET
/billing/accounts
List billing accounts
listBillingAccounts → 200400401500

Schemas 21

The contract defines 21 schemas that model the data the API accepts and returns. The most detailed are PayoutPayee (17 properties), PayoutDetails (11 properties), StorefrontBillingResponse (10 properties), PayoutActivityLedgerRow (9 properties). Each schema is shown below with its type and property counts.

UpdateStorefrontBillingResponse
object
1 property 1 required
StorefrontBillingResponse
object
Storefront billing configuration. Storefront billing setup is optional only for official Scope3 sales-adapter storefronts on existing downstream platform settl…
10 properties 10 required
GetStorefrontRateCardOfferResponse
object
1 property 1 required
ChildBillingStatus
object
Billing status for a child customer
5 properties 5 required
PayoutActivityLedgerRow
object
One payout-run row for a seller org. No producer exists yet — lands once payout run artifacts / the PUBLISHERPAYOUT ledger entry type exist to project.
9 properties 6 required
PayoutActivitySetupRow
object
One setup/audit row in payout activity: payout bank details were added, updated, or cleared. Projected from the payout-details audit trail — never carries payo…
5 properties 5 required
PayoutPayee
object
A payout payee — the bank account for one legal payout entity in one payout currency (masked: the account number is reduced to its last 4 characters).
17 properties 17 required
BillingFeeOutput
object
An additional billing fee entry
3 properties 2 required
IuRateCardActivityScheduleResponse
ListPayoutPayeesResponse
object
Payout payees on file (masked), one per legal entity per payout currency. The default payee on the billing config is listed separately on GET /billing.
1 property 1 required
ErrorResponse
object
Standard error response
2 properties 2 required
BillingAccountsResponse
object
Billing status for managed accounts of a parent customer
1 property 1 required
PayoutActivityRow
object
One row of payout activity for a seller org, newest first. kind: "setup" rows come from the payout-details audit trail (available now); kind: "ledger" rows com…
PayoutDetails
object
Payout bank details on file (masked): the account number is reduced to its last 4 characters.
11 properties 11 required
BillingFee
object
An additional billing fee entry
3 properties 2 required
GetBillingResponse
object
1 property 1 required
AcceptStorefrontRateCardOfferResponse
object
1 property 1 required
SetPayoutDetailsResponse
object
1 property 1 required
SetPayoutPayeeResponse
object
1 property 1 required
ApiError
object
Structured error object
4 properties 2 required
PayoutActivityResponse
object
Payout activity for the caller’s org, newest first. setup rows (payout-details changes) appear as soon as they happen; ledger rows appear once a payout run has…
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

scope3-storefront-billing-api-openapi.yml Raw ↑

Other APIs Scope3 publishes across the network.

Scope3 AI Impact Measurement API
Scope3 Benchmarks API
Scope3 Creative API
Scope3 Data API
Scope3 Gpu API
Scope3 Impact API
Scope3 Measure API
Scope3 Model API
Scope3 Node API
Scope3 Reload API
Scope3 Saved Lists API
Scope3 Segment API
Where this information came from

This is an independent, third-party profile of Scope3 Storefront Billing API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.