> ## Documentation Index
> Fetch the complete documentation index at: https://docs.apostra.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get billing config

> Get the billing configuration for the Seller Account: payout setup status, masked payout bank details, platform fee, additional fees, payout currency, and payment terms.



## OpenAPI

````yaml /v2/storefront-api-v2.yaml get /billing
openapi: 3.0.0
info:
  title: Scope3 Storefront API
  version: 2.0.0
  description: >-
    REST API for partners to manage Seller Accounts, inventory sources, and
    billing.


    ## Authentication


    All endpoints require a Bearer token in the Authorization header:

    ```

    Authorization: Bearer your-api-key

    ```


    ## Base URL


    `https://api.interchange.io/api/v2/storefront`


    ## For AI Agents


    AI agents can use the MCP endpoint at `/mcp/v2/storefront` with three tools:

    - `initialize`: Start an MCP session

    - `api_call`: Make REST API calls

    - `ask_about_capability`: Learn about API features
servers:
  - url: https://api.interchange.io/api/v2/storefront
    description: Production server
security: []
tags:
  - name: Account
    description: Account management, service tokens, and preferences
  - name: Asks
    description: >-
      What you are waiting on Scope3 for — support, product, and supply asks in
      one list
  - name: Storefront
    description: Manage storefront and inventory sources
  - name: Storefront Agents
    description: List and manage registered sales, signals, and outcomes agents
  - name: Storefront Activity
    description: Audit log of configuration and inventory changes on the storefront
  - name: Storefront Billing
    description: Payout bank details and billing configuration for Seller Accounts
  - name: AI Usage
    description: Seller Account AI token usage visibility by model
  - name: MCP
    description: Model Context Protocol endpoints
paths:
  /billing:
    get:
      tags:
        - Storefront Billing
      summary: Get billing config
      description: >-
        Get the billing configuration for the Seller Account: payout setup
        status, masked payout bank details, platform fee, additional fees,
        payout currency, and payment terms.
      operationId: getStorefrontBilling
      parameters:
        - in: query
          name: targetCustomerId
          schema:
            description: >-
              Direct child customer to read or update from an authorized parent
              billing organization
            type: string
            pattern: ^[1-9][0-9]*$
          description: >-
            Direct child customer to read or update from an authorized parent
            billing organization
      responses:
        '200':
          description: Get billing config
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetBillingResponse'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - bearerAuth: []
components:
  schemas:
    GetBillingResponse:
      type: object
      properties:
        billing:
          nullable: true
          allOf:
            - $ref: '#/components/schemas/StorefrontBillingResponse'
      required:
        - billing
      additionalProperties: false
    ErrorResponse:
      type: object
      properties:
        data:
          type: string
          nullable: true
          enum:
            - null
        error:
          $ref: '#/components/schemas/ApiError'
      required:
        - data
        - error
      additionalProperties: false
      description: Standard error response
    StorefrontBillingResponse:
      type: object
      properties:
        onboardingStatus:
          type: string
          enum:
            - pending
            - complete
            - restricted
          description: >-
            Payout setup status. 'complete' once payout bank details are on
            file.
        platformFeePercent:
          nullable: true
          description: Platform fee percentage
          type: number
        fees:
          nullable: true
          description: Additional fees
          type: array
          items:
            $ref: '#/components/schemas/BillingFeeOutput'
        currency:
          nullable: true
          description: Payout currency (ISO 4217 code)
          type: string
        country:
          nullable: true
          description: ISO 3166-1 alpha-2 country used for billing
          type: string
        defaultNetDays:
          nullable: true
          description: Payment terms in days
          type: number
        payoutDetails:
          nullable: true
          description: >-
            Masked payout bank details on file, or null when none have been
            added yet
          allOf:
            - $ref: '#/components/schemas/PayoutDetails'
        inherited:
          type: boolean
          description: Whether this billing config is inherited from a parent customer
        createdAt:
          type: string
          format: date-time
          pattern: >-
            ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
          description: Creation timestamp (ISO 8601)
        updatedAt:
          type: string
          format: date-time
          pattern: >-
            ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
          description: Last update timestamp (ISO 8601)
      required:
        - onboardingStatus
        - platformFeePercent
        - fees
        - currency
        - country
        - defaultNetDays
        - payoutDetails
        - inherited
        - createdAt
        - updatedAt
      additionalProperties: false
      description: >-
        Seller Account billing configuration. Seller Account billing setup is
        optional only for official Scope3 sales-adapter accounts on existing
        downstream platform settlement agreements. Third-party sales agents and
        Agent-supplied (finished-product) sources are normal Interchange-cleared
        Seller Account sources and still require payout bank details.
        Seller-cleared settlement is not yet configurable for normal Seller
        Accounts.
    ApiError:
      type: object
      properties:
        code:
          type: string
          description: Machine-readable error code
        message:
          type: string
          description: Human-readable error message
        field:
          description: Field path associated with the error
          type: string
        details:
          description: Additional error context
          type: object
          additionalProperties: {}
      required:
        - code
        - message
      additionalProperties: false
      description: Structured error object
    BillingFeeOutput:
      type: object
      properties:
        name:
          type: string
          minLength: 1
          maxLength: 255
          description: Fee label
        description:
          description: Fee description
          type: string
          maxLength: 500
        feePercent:
          type: number
          minimum: 0
          maximum: 100
          description: Fee percentage (0–100)
      required:
        - name
        - feePercent
      additionalProperties: false
      description: An additional billing fee entry
    PayoutDetails:
      type: object
      properties:
        beneficiaryName:
          type: string
          description: Payout beneficiary legal name
        addressLine1:
          type: string
          description: Beneficiary street address, line 1
        addressLine2:
          nullable: true
          description: Beneficiary street address, line 2
          type: string
        city:
          type: string
          description: Beneficiary city
        region:
          nullable: true
          description: Beneficiary state/province/region
          type: string
        postalCode:
          type: string
          description: Beneficiary postal/ZIP code
        countryCode:
          type: string
          description: Beneficiary country (ISO 3166-1 alpha-2)
        accountNumberLast4:
          type: string
          description: >-
            Last 4 characters of the account number or IBAN. The full value is
            never returned by the API.
        bankIdentifierType:
          type: string
          enum:
            - FEDWIRE_ABA
            - CHIPS_ABA
            - SWIFT_BIC
            - BANK_CODE
          description: >-
            Which bank identifier system `bankIdentifierValue` uses: FEDWIRE_ABA
            (US Fedwire/ABA routing number, 9 digits), CHIPS_ABA (CHIPS ABA
            number, 9 digits), SWIFT_BIC (SWIFT/BIC code, 8 or 11 characters),
            or BANK_CODE (a local/domestic bank code for banks without a
            SWIFT-BIC).
        bankIdentifierValue:
          type: string
          description: >-
            The bank identifier (routing number, CHIPS ABA, SWIFT-BIC, or local
            bank code)
        completedAt:
          type: string
          format: date-time
          pattern: >-
            ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
          description: When payout details were last completed (ISO 8601)
      required:
        - beneficiaryName
        - addressLine1
        - addressLine2
        - city
        - region
        - postalCode
        - countryCode
        - accountNumberLast4
        - bankIdentifierType
        - bankIdentifierValue
        - completedAt
      additionalProperties: false
      description: >-
        Payout bank details on file (masked): the account number is reduced to
        its last 4 characters.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: API key or access token

````