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

# Get Partner Program access

> Returns the authenticated organization’s Partner Program entitlement decision and whether a directly authorized administrator can recover the protected OAuth connection without receiving Partner workspace access.



## OpenAPI

````yaml /v2/storefront-api-v2.yaml get /provider/partner-access
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:
  /provider/partner-access:
    servers:
      - url: /api/v2
        description: Shared customer API base URL
    get:
      tags:
        - Storefront
      summary: Get Partner Program access
      description: >-
        Returns the authenticated organization’s Partner Program entitlement
        decision and whether a directly authorized administrator can recover the
        protected OAuth connection without receiving Partner workspace access.
      operationId: getPartnerProgramAccess
      responses:
        '200':
          description: Get Partner Program access
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PartnerProgramAccessResponse'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Authentication required.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Organization account administrator required.
          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:
    PartnerProgramAccessResponse:
      type: object
      properties:
        featureKey:
          type: string
          enum:
            - partner-program-participation
        entitlementFeatureKey:
          type: string
          enum:
            - operate-agents-for-clients
        protectedOAuthRenewalActionAvailable:
          type: boolean
        state:
          type: string
          enum:
            - GRANTED
            - PENDING
            - DENIED
            - ERROR
        allowed:
          type: boolean
        purchased:
          type: boolean
        entitlementExpiresAt:
          nullable: true
          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|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
        billingCustomerId:
          type: integer
          minimum: 0
          exclusiveMinimum: true
          maximum: 9007199254740991
        standing:
          type: object
          properties:
            usable:
              type: boolean
            reason:
              nullable: true
              type: string
            authority:
              nullable: true
              type: string
              enum:
                - BETA
                - CARD
                - INVOICE_CREDIT
                - PREPAID_FUNDS
          required:
            - usable
            - reason
            - authority
          additionalProperties: false
        ownership:
          type: object
          properties:
            claimed:
              type: boolean
          required:
            - claimed
          additionalProperties: false
        registration:
          type: object
          properties:
            registered:
              type: boolean
          required:
            - registered
          additionalProperties: false
        readiness:
          type: object
          properties:
            ready:
              type: boolean
            reason:
              nullable: true
              type: string
          required:
            - ready
            - reason
          additionalProperties: false
        denialReasons:
          type: array
          items:
            type: string
        nextAction:
          type: string
          enum:
            - OPEN_PARENT_ORGANIZATION
            - ACCEPT_OFFER
            - SET_UP_PAYMENT
            - FUND_PREPAY
            - RESOLVE_BILLING_HOLD
            - CLAIM_PROVIDER
            - COMPLETE_CERTIFICATION
            - CONTACT_SALES
            - WAIT_FOR_START
            - NONE
        paymentSetupUrl:
          type: string
      required:
        - featureKey
        - entitlementFeatureKey
        - protectedOAuthRenewalActionAvailable
        - state
        - allowed
        - purchased
        - billingCustomerId
        - standing
        - ownership
        - registration
        - readiness
        - denialReasons
        - nextAction
        - paymentSetupUrl
      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
    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
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: API key or access token

````