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

# Opens the payment processor's hosted billing portal: payment methods and receipts.

> cf. AIP-136.



## OpenAPI

````yaml /http-api-reference/openapi.json post /outerproduct.billing_account.v1alpha.BillingAccountService/CreatePortalSession
openapi: 3.1.0
info:
  title: OuterProduct Control Plane API
  description: >-
    Control-plane Connect RPCs over HTTP with ProtoJSON request and response
    bodies.
  version: v1alpha
servers:
  - url: https://api.outerproduct.com
security:
  - bearerAuth: []
tags:
  - name: ApiKey
    description: |-
      Manages the current user's application-owned personal access tokens.
       External sign-in is required; personal and execution tokens cannot manage keys.
  - name: BillingAccount
    description: >-
      How a workspace pays: its prepaid balance, topped up through the payment
      processor and spent
       by its usage.
  - name: Image
    description: >-
      The image registry: OCI distribution over its storage, whose formats are
      its own. The
       control plane serves it to users, admitting each only to their workspace's repository, and
       forwards to the OCI registry. Manifests and blobs are addressed by digest and never
       replaced; tags name manifests.
  - name: ImageBuilder
    description: >-
      Builds Images from image specs, and runs their install steps, each adding
      layers to its
       parent image, and package builds, each one pinned package's layer on its base, which
       install steps merge rather than install. The control plane serves `SubmitImageBuild`
       and `WaitImageBuild` to users, and forwards them to the scheduler's, which imports each
       image spec's base through the OCI registry, places each install step and package build on a
       node that builds, and tags the image it built in its workspace's repository. Those nodes
       serve the steps to the scheduler, by the scheduler's certificate, and run each in the
       sandbox the scheduler placed it in.
  - name: Policy
    description: >-
      Resource access policies evaluated by the application's Cedar authorizer.
      A policy belongs to
       the workspace of the credential that created it and governs only that workspace and what it
       owns; deployment-wide grants belong to the operator's policy.
  - name: Run
    description: >-
      Submits and observes product Runs, their Calls, and the Calls' Attempts.
      Every Run
       owns one rooted Call tree.
  - name: Secret
  - name: User
    description: / User crud service
  - name: Volume
  - name: Workspace
    description: >-
      The workspace a request's credential is bound to, and its members. A
      session starts bound
       to its user's workspace and may switch to another the user belongs to; an API key stays bound
       to the workspace it was created in. Requests act in the bound workspace.
paths:
  /outerproduct.billing_account.v1alpha.BillingAccountService/CreatePortalSession:
    post:
      tags:
        - BillingAccount
      summary: >-
        Opens the payment processor's hosted billing portal: payment methods and
        receipts.
      description: cf. AIP-136.
      operationId: >-
        outerproduct.billing_account.v1alpha.BillingAccountService.CreatePortalSession
      parameters:
        - name: Connect-Protocol-Version
          in: header
          description: Define the version of the Connect protocol
          required: true
          schema:
            $ref: '#/components/schemas/connect-protocol-version'
          example: 1
        - name: Connect-Timeout-Ms
          in: header
          description: Define the timeout, in ms
          schema:
            $ref: '#/components/schemas/connect-timeout-header'
          example: 1000
      requestBody:
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/outerproduct.billing_account.v1alpha.CreatePortalSessionRequest
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/outerproduct.billing_account.v1alpha.CreatePortalSessionResponse
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/connect.error'
components:
  schemas:
    connect-protocol-version:
      type: number
      examples:
        - 1
      title: Connect-Protocol-Version
      description: Define the version of the Connect protocol
      const: 1
    connect-timeout-header:
      type: number
      examples:
        - 1000
      title: Connect-Timeout-Ms
      description: Define the timeout, in ms
    outerproduct.billing_account.v1alpha.CreatePortalSessionRequest:
      type: object
      properties:
        name:
          type: string
          title: name
        returnUrl:
          type: string
          title: return_url
          description: Where the portal's "return" link leads.
      title: CreatePortalSessionRequest
      additionalProperties: false
    outerproduct.billing_account.v1alpha.CreatePortalSessionResponse:
      type: object
      properties:
        url:
          type: string
          title: url
      title: CreatePortalSessionResponse
      additionalProperties: false
    connect.error:
      type: object
      properties:
        code:
          type: string
          examples:
            - not_found
          enum:
            - canceled
            - unknown
            - invalid_argument
            - deadline_exceeded
            - not_found
            - already_exists
            - permission_denied
            - resource_exhausted
            - failed_precondition
            - aborted
            - out_of_range
            - unimplemented
            - internal
            - unavailable
            - data_loss
            - unauthenticated
          description: >-
            The status code, which should be an enum value of
            [google.rpc.Code][google.rpc.Code].
        message:
          type: string
          description: >-
            A developer-facing error message, which should be in English. Any
            user-facing error message should be localized and sent in the
            [google.rpc.Status.details][google.rpc.Status.details] field, or
            localized by the client.
        details:
          type: array
          items:
            $ref: '#/components/schemas/connect.error_details.Any'
          description: >-
            A list of messages that carry the error details. There is no limit
            on the number of messages.
      title: Connect Error
      additionalProperties: true
      description: >-
        Error type returned by Connect:
        https://connectrpc.com/docs/go/errors/#http-representation
    connect.error_details.Any:
      type: object
      properties:
        type:
          type: string
          description: >-
            A URL that acts as a globally unique identifier for the type of the
            serialized message. For example:
            `type.googleapis.com/google.rpc.ErrorInfo`.
        value:
          type: string
          format: binary
          description: >-
            The Protobuf message, serialized as bytes and base64-encoded. The
            specific message type is identified by the `type` field.
        debug:
          type: object
          title: Debug
          additionalProperties: true
          description: >-
            Deserialized error detail payload. The 'type' field indicates the
            schema. This field is for easier debugging and should not be relied
            upon for application logic.
      additionalProperties: true
      description: >-
        Contains an arbitrary serialized message along with a @type that
        describes the type of the serialized message, with an additional debug
        field for ConnectRPC error details.
  securitySchemes:
    bearerAuth:
      type: http
      description: A user session token or personal API key.
      scheme: bearer

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.