Stripe Customers API — Get

naftiko: 1.0.0-alpha2
info:
  label: Stripe Customers API — Get
  description: 'Stripe Customers API — Get. 22 operations. Lead operation: Stripe Get   Customers. Self-contained Naftiko
    capability covering one Stripe business surface.'
  tags:
  - Stripe
  - Get
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    STRIPE_API_KEY: STRIPE_API_KEY
capability:
  consumes:
  - type: http
    namespace: customers-get
    baseUri: https://api.stripe.com
    description: Stripe Customers API — Get business capability. Self-contained, no shared references.
    resources:
    - name: v1-customers
      path: /v1/customers
      operations:
      - name: getcustomers
        method: GET
        description: Stripe Get   Customers
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: created
          in: query
          type: string
        - name: email
          in: query
          type: string
          description: A case-sensitive filter on the list based on the customer's `email` field. The value must be a string.
        - name: ending_before
          in: query
          type: string
          description: A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list.
            For instance, if you make a list request and receive 100 ob
        - name: expand
          in: query
          type: array
          description: Specifies which fields in the response should be expanded.
        - name: limit
          in: query
          type: integer
          description: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default
            is 10.
        - name: starting_after
          in: query
          type: string
          description: A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list.
            For instance, if you make a list request and receive 100 o
        - name: test_clock
          in: query
          type: string
          description: Provides a list of customers that are associated with the specified test clock. The response will not
            include customers with test clocks if this parameter is no
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: v1-customers-search
      path: /v1/customers/search
      operations:
      - name: getcustomerssearch
        method: GET
        description: Stripe Get   Customers Search
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: expand
          in: query
          type: array
          description: Specifies which fields in the response should be expanded.
        - name: limit
          in: query
          type: integer
          description: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default
            is 10.
        - name: page
          in: query
          type: string
          description: A cursor for pagination across multiple pages of results. Don't include this parameter on the first
            call. Use the next_page value returned in a previous respons
        - name: query
          in: query
          type: string
          description: The search query string. See [search query language](https://stripe.com/docs/search#search-query-language)
            and the list of supported [query fields for customers
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: v1-customers-customer
      path: /v1/customers/{customer}
      operations:
      - name: getcustomerscustomer
        method: GET
        description: Stripe Get   Customers Customer
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: customer
          in: path
          type: string
          required: true
        - name: expand
          in: query
          type: array
          description: Specifies which fields in the response should be expanded.
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: v1-customers-customer-balance_transactions
      path: /v1/customers/{customer}/balance_transactions
      operations:
      - name: getcustomerscustomerbalancetransactions
        method: GET
        description: Stripe Get   Customers Customer Balance Transactions
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: customer
          in: path
          type: string
          required: true
        - name: ending_before
          in: query
          type: string
          description: A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list.
            For instance, if you make a list request and receive 100 ob
        - name: expand
          in: query
          type: array
          description: Specifies which fields in the response should be expanded.
        - name: limit
          in: query
          type: integer
          description: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default
            is 10.
        - name: starting_after
          in: query
          type: string
          description: A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list.
            For instance, if you make a list request and receive 100 o
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: v1-customers-customer-balance_transactions-transaction
      path: /v1/customers/{customer}/balance_transactions/{transaction}
      operations:
      - name: getcustomerscustomerbalancetransactionstransaction
        method: GET
        description: Stripe Get   Customers Customer Balance Transactions Transaction
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: customer
          in: path
          type: string
          required: true
        - name: expand
          in: query
          type: array
          description: Specifies which fields in the response should be expanded.
        - name: transaction
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: v1-customers-customer-bank_accounts
      path: /v1/customers/{customer}/bank_accounts
      operations:
      - name: getcustomerscustomerbankaccounts
        method: GET
        description: Stripe Get   Customers Customer Bank Accounts
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: customer
          in: path
          type: string
          required: true
        - name: ending_before
          in: query
          type: string
          description: A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list.
            For instance, if you make a list request and receive 100 ob
        - name: expand
          in: query
          type: array
          description: Specifies which fields in the response should be expanded.
        - name: limit
          in: query
          type: integer
          description: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default
            is 10.
        - name: starting_after
          in: query
          type: string
          description: A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list.
            For instance, if you make a list request and receive 100 o
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: v1-customers-customer-bank_accounts-id
      path: /v1/customers/{customer}/bank_accounts/{id}
      operations:
      - name: getcustomerscustomerbankaccountsid
        method: GET
        description: Stripe Get   Customers Customer Bank Accounts Id
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: customer
          in: path
          type: string
          required: true
        - name: expand
          in: query
          type: array
          description: Specifies which fields in the response should be expanded.
        - name: id
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: v1-customers-customer-cards
      path: /v1/customers/{customer}/cards
      operations:
      - name: getcustomerscustomercards
        method: GET
        description: Stripe Get   Customers Customer Cards
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: customer
          in: path
          type: string
          required: true
        - name: ending_before
          in: query
          type: string
          description: A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list.
            For instance, if you make a list request and receive 100 ob
        - name: expand
          in: query
          type: array
          description: Specifies which fields in the response should be expanded.
        - name: limit
          in: query
          type: integer
          description: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default
            is 10.
        - name: starting_after
          in: query
          type: string
          description: A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list.
            For instance, if you make a list request and receive 100 o
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: v1-customers-customer-cards-id
      path: /v1/customers/{customer}/cards/{id}
      operations:
      - name: getcustomerscustomercardsid
        method: GET
        description: Stripe Get   Customers Customer Cards Id
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: customer
          in: path
          type: string
          required: true
        - name: expand
          in: query
          type: array
          description: Specifies which fields in the response should be expanded.
        - name: id
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: v1-customers-customer-cash_balance
      path: /v1/customers/{customer}/cash_balance
      operations:
      - name: getcustomerscustomercashbalance
        method: GET
        description: Stripe Get   Customers Customer Cash Balance
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: customer
          in: path
          type: string
          required: true
        - name: expand
          in: query
          type: array
          description: Specifies which fields in the response should be expanded.
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: v1-customers-customer-cash_balance_transactions
      path: /v1/customers/{customer}/cash_balance_transactions
      operations:
      - name: getcustomerscustomercashbalancetransactions
        method: GET
        description: Stripe Get   Customers Customer Cash Balance Transactions
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: customer
          in: path
          type: string
          required: true
        - name: ending_before
          in: query
          type: string
          description: A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list.
            For instance, if you make a list request and receive 100 ob
        - name: expand
          in: query
          type: array
          description: Specifies which fields in the response should be expanded.
        - name: limit
          in: query
          type: integer
          description: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default
            is 10.
        - name: starting_after
          in: query
          type: string
          description: A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list.
            For instance, if you make a list request and receive 100 o
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: v1-customers-customer-cash_balance_transactions-transaction
      path: /v1/customers/{customer}/cash_balance_transactions/{transaction}
      operations:
      - name: getcustomerscustomercashbalancetransactionstransaction
        method: GET
        description: Stripe Get   Customers Customer Cash Balance Transactions Transaction
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: customer
          in: path
          type: string
          required: true
        - name: expand
          in: query
          type: array
          description: Specifies which fields in the response should be expanded.
        - name: transaction
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: v1-customers-customer-discount
      path: /v1/customers/{customer}/discount
      operations:
      - name: getcustomerscustomerdiscount
        method: GET
        description: Stripe Get   Customers Customer Discount
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: customer
          in: path
          type: string
          required: true
        - name: expand
          in: query
          type: array
          description: Specifies which fields in the response should be expanded.
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: v1-customers-customer-payment_methods
      path: /v1/customers/{customer}/payment_methods
      operations:
      - name: getcustomerscustomerpaymentmethods
        method: GET
        description: Stripe Get   Customers Customer Payment Methods
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: customer
          in: path
          type: string
          required: true
        - name: ending_before
          in: query
          type: string
          description: A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list.
            For instance, if you make a list request and receive 100 ob
        - name: expand
          in: query
          type: array
          description: Specifies which fields in the response should be expanded.
        - name: limit
          in: query
          type: integer
          description: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default
            is 10.
        - name: starting_after
          in: query
          type: string
          description: A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list.
            For instance, if you make a list request and receive 100 o
        - name: type
          in: query
          type: string
          description: An optional filter on the list, based on the object `type` field. Without the filter, the list includes
            all current and future payment method types. If your int
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: v1-customers-customer-payment_methods-payment_method
      path: /v1/customers/{customer}/payment_methods/{payment_method}
      operations:
      - name: getcustomerscustomerpaymentmethodspaymentmethod
        method: GET
        description: Stripe Get   Customers Customer Payment Methods Payment Method
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: customer
          in: path
          type: string
          required: true
        - name: expand
          in: query
          type: array
          description: Specifies which fields in the response should be expanded.
        - name: payment_method
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: v1-customers-customer-sources
      path: /v1/customers/{customer}/sources
      operations:
      - name: getcustomerscustomersources
        method: GET
        description: Stripe Get   Customers Customer Sources
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: customer
          in: path
          type: string
          required: true
        - name: ending_before
          in: query
          type: string
          description: A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list.
            For instance, if you make a list request and receive 100 ob
        - name: expand
          in: query
          type: array
          description: Specifies which fields in the response should be expanded.
        - name: limit
          in: query
          type: integer
          description: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default
            is 10.
        - name: object
          in: query
          type: string
          description: Filter sources according to a particular object type.
        - name: starting_after
          in: query
          type: string
          description: A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list.
            For instance, if you make a list request and receive 100 o
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: v1-customers-customer-sources-id
      path: /v1/customers/{customer}/sources/{id}
      operations:
      - name: getcustomerscustomersourcesid
        method: GET
        description: Stripe Get   Customers Customer Sources Id
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: customer
          in: path
          type: string
          required: true
        - name: expand
          in: query
          type: array
          description: Specifies which fields in the response should be expanded.
        - name: id
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: v1-customers-customer-subscriptions
      path: /v1/customers/{customer}/subscriptions
      operations:
      - name: getcustomerscustomersubscriptions
        method: GET
        description: Stripe Get   Customers Customer Subscriptions
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: customer
          in: path
          type: string
          required: true
        - name: ending_before
          in: query
          type: string
          description: A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list.
            For instance, if you make a list request and receive 100 ob
        - name: expand
          in: query
          type: array
          description: Specifies which fields in the response should be expanded.
        - name: limit
          in: query
          type: integer
          description: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default
            is 10.
        - name: starting_after
          in: query
          type: string
          description: A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list.
            For instance, if you make a list request and receive 100 o
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: v1-customers-customer-subscriptions-subscription_exposed_id
      path: /v1/customers/{customer}/subscriptions/{subscription_exposed_id}
      operations:
      - name: getcustomerscustomersubscriptionssubscriptionexposedid
        method: GET
        description: Stripe Get   Customers Customer Subscriptions Subscription Exposed Id
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: customer
          in: path
          type: string
          required: true
        - name: expand
          in: query
          type: array
          description: Specifies which fields in the response should be expanded.
        - name: subscription_exposed_id
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: v1-customers-customer-subscriptions-subscription_exposed_id-discount
      path: /v1/customers/{customer}/subscriptions/{subscription_exposed_id}/discount
      operations:
      - name: getcustomerscustomersubscriptionssubscriptionexposediddiscount
        method: GET
        description: Stripe Get   Customers Customer Subscriptions Subscription Exposed Id Discount
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: customer
          in: path
          type: string
          required: true
        - name: expand
          in: query
          type: array
          description: Specifies which fields in the response should be expanded.
        - name: subscription_exposed_id
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: v1-customers-customer-tax_ids
      path: /v1/customers/{customer}/tax_ids
      operations:
      - name: getcustomerscustomertaxids
        method: GET
        description: Stripe Get   Customers Customer Tax Ids
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: customer
          in: path
          type: string
          required: true
        - name: ending_before
          in: query
          type: string
          description: A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list.
            For instance, if you make a list request and receive 100 ob
        - name: expand
          in: query
          type: array
          description: Specifies which fields in the response should be expanded.
        - name: limit
          in: query
          type: integer
          description: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default
            is 10.
        - name: starting_after
          in: query
          type: string
          description: A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list.
            For instance, if you make a list request and receive 100 o
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: v1-customers-customer-tax_ids-id
      path: /v1/customers/{customer}/tax_ids/{id}
      operations:
      - name: getcustomerscustomertaxidsid
        method: GET
        description: Stripe Get   Customers Customer Tax Ids Id
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: customer
          in: path
          type: string
          required: true
        - name: expand
          in: query
          type: array
          description: Specifies which fields in the response should be expanded.
        - name: id
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    authentication:
      type: bearer
      token: '{{env.STRIPE_API_KEY}}'
  exposes:
  - type: rest
    namespace: customers-get-rest
    port: 8080
    description: REST adapter for Stripe Customers API — Get. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/v1/customers
      name: v1-customers
      description: REST surface for v1-customers.
      operations:
      - method: GET
        name: getcustomers
        description: Stripe Get   Customers
        call: customers-get.getcustomers
        with:
          created: rest.created
          email: rest.email
          ending_before: rest.ending_before
          expand: rest.expand
          limit: rest.limit
          starting_after: rest.starting_after
          test_clock: rest.test_clock
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/customers/search
      name: v1-customers-search
      description: REST surface for v1-customers-search.
      operations:
      - method: GET
        name: getcustomerssearch
        description: Stripe Get   Customers Search
        call: customers-get.getcustomerssearch
        with:
          expand: rest.expand
          limit: rest.limit
          page: rest.page
          query: rest.query
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/customers/{customer}
      name: v1-customers-customer
      description: REST surface for v1-customers-customer.
      operations:
      - method: GET
        name: getcustomerscustomer
        description: Stripe Get   Customers Customer
        call: customers-get.getcustomerscustomer
        with:
          customer: rest.customer
          expand: rest.expand
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/customers/{customer}/balance-transactions
      name: v1-customers-customer-balance-transactions
      description: REST surface for v1-customers-customer-balance_transactions.
      operations:
      - method: GET
        name: getcustomerscustomerbalancetransactions
        description: Stripe Get   Customers Customer Balance Transactions
        call: customers-get.getcustomerscustomerbalancetransactions
        with:
          customer: rest.customer
          ending_before: rest.ending_before
          expand: rest.expand
          limit: rest.limit
          starting_after: rest.starting_after
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/customers/{customer}/balance-transactions/{transaction}
      name: v1-customers-customer-balance-transactions-transaction
      description: REST surface for v1-customers-customer-balance_transactions-transaction.
      operations:
      - method: GET
        name: getcustomerscustomerbalancetransactionstransaction
        description: Stripe Get   Customers Customer Balance Transactions Transaction
        call: customers-get.getcustomerscustomerbalancetransactionstransaction
        with:
          customer: rest.customer
          expand: rest.expand
          transaction: rest.transaction
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/customers/{customer}/bank-accounts
      name: v1-customers-customer-bank-accounts
      description: REST surface for v1-customers-customer-bank_accounts.
      operations:
      - method: GET
        name: getcustomerscustomerbankaccounts
        description: Stripe Get   Customers Customer Bank Accounts
        call: customers-get.getcustomerscustomerbankaccounts
        with:
          customer: rest.customer
          ending_before: rest.ending_before
          expand: rest.expand
          limit: rest.limit
          starting_after: rest.starting_after
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/customers/{customer}/bank-accounts/{id}
      name: v1-customers-customer-bank-accounts-id
      description: REST surface for v1-customers-customer-bank_accounts-id.
      operations:
      - method: GET
        name: getcustomerscustomerbankaccountsid
        description: Stripe Get   Customers Customer Bank Accounts Id
        call: customers-get.getcustomerscustomerbankaccountsid
        with:
          customer: rest.customer
          expand: rest.expand
          id: rest.id
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/customers/{customer}/cards
      name: v1-customers-customer-cards
      description: REST surface for v1-customers-customer-cards.
      operations:
      - method: GET
        name: getcustomerscustomercards
        description: Stripe Get   Customers Customer Cards
        call: customers-get.getcustomerscustomercards
        with:
          customer: rest.customer
          ending_before: rest.ending_before
          expand: rest.expand
          limit: rest.limit
          starting_after: rest.starting_after
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/customers/{customer}/cards/{id}
      name: v1-customers-customer-cards-id
      description: REST surface for v1-customers-customer-cards-id.
      operations:
      - method: GET
        name: getcustomerscustomercardsid
        description: Stripe Get   Customers Customer Cards Id
        call: customers-get.getcustomerscustomercardsid
        with:
          customer: rest.customer
          expand: rest.expand
          id: rest.id
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/customers/{customer}/cash-balance
      name: v1-customers-customer-cash-bala

# --- truncated at 32 KB (51 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/stripe/refs/heads/main/capabilities/customers-get.yaml