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

# Read the payment method

> The card pay as you go charges, or null when none is saved.



## OpenAPI

````yaml https://api.twinbay.ai/openapi.json get /organizations/current/billing/payment-method
openapi: 3.1.0
info:
  title: Twinbay
  description: Backend API
  version: 0.1.0
servers:
  - url: https://api.twinbay.ai
    description: Production
security: []
tags:
  - name: healthchecks
    description: Healthcheck endpoints
  - name: users
    description: >-
      The current user. Sign-up and sign-in happen in WorkOS AuthKit, which
      issues the access tokens this API accepts.
  - name: organizations
    description: >-
      Organizations the caller belongs to. Every authenticated request acts
      inside exactly one organization — the one its access token names — so
      these routes address it as `current`.
  - name: billing
    description: >-
      The active organization's plan, its limits, and what the current period
      has cost so far.
  - name: api-keys
    description: >-
      Long-lived credentials for callers that cannot hold an AuthKit session —
      agents, SDKs, CI. A key is accepted wherever an access token is, and acts
      with the role its creator holds when the request arrives.
  - name: environments
    description: >-
      Create and edit isolated provider environments. Each environment contains
      behavioural twins from the `twins` package.
  - name: twins
    description: Manage provisioned twins by their IDs.
  - name: catalog
    description: Browse the digital twins available for new environments.
  - name: scenarios
    description: Reusable starting setups of provider twins and optional seeds.
  - name: seeds
    description: >-
      Starting states for a twin. Describe the data you want in your own words,
      and a worker expands it into rows once; pass the seed's id when you create
      an environment to start a twin holding it.
  - name: tests
    description: >-
      Outcomes described in natural language, compiled once into request
      matchers, and evaluated deterministically against the traffic an attempt
      was served.
paths:
  /organizations/current/billing/payment-method:
    get:
      tags:
        - billing
      summary: Read the payment method
      description: The card pay as you go charges, or null when none is saved.
      operationId: read_payment_method
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentMethodResponse'
        '401':
          description: The credential is missing, malformed, expired, or not trusted
      security:
        - Access token: []
        - Organization API key: []
components:
  schemas:
    PaymentMethodResponse:
      properties:
        payment_method:
          anyOf:
            - $ref: '#/components/schemas/PaymentMethod'
            - type: 'null'
          description: The default payment method, or null when none is saved
      type: object
      required:
        - payment_method
      title: PaymentMethodResponse
    PaymentMethod:
      properties:
        brand:
          type: string
          title: Brand
          description: The card brand, or the payment method type
        last4:
          anyOf:
            - type: string
            - type: 'null'
          title: Last4
        exp_month:
          anyOf:
            - type: integer
            - type: 'null'
          title: Exp Month
        exp_year:
          anyOf:
            - type: integer
            - type: 'null'
          title: Exp Year
      type: object
      required:
        - brand
      title: PaymentMethod
  securitySchemes:
    Access token:
      type: http
      description: Access token issued by WorkOS AuthKit.
      scheme: bearer
    Organization API key:
      type: apiKey
      description: >-
        An organization API key. Create one at
        https://console.twinbay.ai/api-keys
      in: header
      name: X-API-Key

````

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