Scope3 Buyer 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 Buyer Billing. The published artifact set on APIs.io includes an OpenAPI specification.
This API exposes
15 operations
across 14 paths,
and defines 56 schemas.
It is described by OpenAPI 3.2.0, at version 2.0.0.
Requests are made against 2 base URLs: https://api.interchange.io/api/v2/buyer, https://api.interchange.io/api/v2/storefront.
The identity and technical contract details declared by the specification.
PaymentMethodListResponse
object
1 property
1 required
UpdateBillingInfoResponse
object
1 property
1 required
SetupPaymentMethodResponse
object
Everything the client needs to mount an embedded card-capture form. The resulting payment method is NOT returned here — it appears once the card rail webhook c…
2 properties
2 required
InvoiceActivityRow
object
One row of invoice activity for a buyer (or seller) org.
10 properties
5 required
BillingHold
object
A payment hold blocking NEW paid actions (meter-first, block narrow — spec §5.4/§12 ruling 5). Never blocks read access, reporting, export, in-flight deliverin…
4 properties
4 required
BillingIntelligenceUsage
object
4 properties
4 required
CommercialOfferDocumentPdf
string
FeeInvoiceSummary
object
One fee invoice, without its lines — the list-view shape. Fetch the invoice by number for line detail.
9 properties
9 required
BillingAccountDocument
object
The consolidated commercial-account read model — GET /api/v2/billing/account.
13 properties
13 required
AcceptIuRateCardOfferResponse
object
1 property
1 required
BillingPricing
object
3 properties
3 required
CreditApplicationResponse
object
A single credit application.
14 properties
14 required
GetIuRateCardOfferV2Response
object
1 property
1 required
IuBucketBalance
object
3 properties
3 required
BuyerBillingInfo
object
Billing (payer) information for the authenticated customer, used on manually issued invoices.
11 properties
11 required
BillingRateCard
object
2 properties
2 required
BillingScope
object
2 properties
2 required
FeeInvoice
object
One fee invoice with its line items.
10 properties
10 required
IuRateCardActivityScheduleResponse
BillingIuAccount
objectnull
IU (Intelligence Unit) account snapshot (AI-3079 slice 2a) — one pool per org, storefront and buyer usage combined. Null unless iu-account-experience is on for…
12 properties
12 required
BillingPayment
object
7 properties
7 required
BillingPermissions
object
3 properties
3 required
GetBillingAccountResponse
object
1 property
1 required
PayNowResponse
object
Immediate result of a manual "pay now" retry (spec §5.4: self-serve, instant recovery). The actual state transition (recovered, or unchanged on a decline) happ…
2 properties
2 required
ErrorResponse
object
Standard error response
2 properties
2 required
FeeInvoiceListResponse
object
Fee invoices for the caller’s org, newest first. Empty until the org’s first charged billing cycle closes.
1 property
1 required
LedgerAccountBalance
object
One ledger account and its current balance for the customer.
4 properties
4 required
BillingPaymentMethod
objectnull
The org’s active card-rail payment method (AI-3078). Null until one is added — never a PAN, never a PSP token.
6 properties
6 required
BillingDeposit
object
One prepay deposit, projected read-only from the ledger’s DEPOSIT journal entries.
7 properties
7 required
BillingBillingInfo
object
13 properties
13 required
BillingEnterpriseContracts
object
The authoritative Enterprise Contract position shared by Plan & Billing and MCP: pending Offer, customer-safe Rate Card acceptance lineage, purchased product r…
4 properties
4 required
FeeInvoiceLine
object
One line item on a fee invoice.
6 properties
6 required
CaptureLinkExchangeResponse
object
Validates the capture-link token, marks it opened, and returns everything the hosted page needs to mount the embedded card form (or render the current status i…
5 properties
2 required
BillingAccountChild
object
6 properties
6 required
BillingEnterpriseContractPackage
object
One immutable accepted Enterprise Contract package with a server-derived lifecycle. Purchased rights remain visible through funding gaps, billing holds, expiry…
4 properties
4 required
BillingEnterpriseCommercialState
object
Customer-safe Enterprise Contract commercial state. The immutable customer proposal is present for human admins and principal-redacted for service tokens; free…
13 properties
13 required
NextAction
object
The single most-important action needed to become or remain paid, derived server-side — never stored.
5 properties
5 required
BillingCapabilities
object
Capability derived from the org's own role UNION its children's roles. Always present — computed server-side so no consumer decides capability from roles alone…
2 properties
2 required
BillingUsage
object
4 properties
4 required
GetIuRateCardOfferResponse
object
1 property
1 required
IuOverageStatus
object
6 properties
6 required
RemovePaymentMethodResponse
object
1 property
1 required
BillingOrgFinancialPosition
object
Org-wide rollup across the customer subtree (getOrgFinancialPosition — this read model is its first caller).
8 properties
8 required
BillingContracts
object
3 properties
3 required
InvoiceActivityResponse
object
Invoice activity for the caller’s org, newest first. Empty until the first billing period closes.
1 property
1 required
CreditBalanceSummary
object
A customer’s credit/prepay position: their ledger balance sheet plus the derived funded / owed / spendable figures, all in currency minor units.
8 properties
8 required
BillingOrganization
object
5 properties
5 required
LedgerCurrency
string
ISO 4217 currency code supported by the ledger. Mirrors the ledger.isocurrency ENUM.
GetBillingInfoResponse
object
1 property
1 required
BillingAgreement
object
7 properties
7 required
PaymentMethodResponse
object
A vaulted payment method. Never a PAN, never a raw PSP token — display-safe metadata only.
8 properties
8 required
ApiError
object
Structured error object
4 properties
2 required
BillingStanding
object
5 properties
5 required
BillingIuAccountRatingTerms
object
2 properties
2 required
BillingPlan
object
9 properties
9 required
BillingStorefrontBillingSummary
objectnull
Commercial-terms summary only — null for an org with no seller role. Payout bank details stay on their own surface (AI-2832), never duplicated here.
4 properties
4 required
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Scope3 publishes across the network.
