Stripe Customers API — Customers

naftiko: 1.0.0-alpha2
info:
  label: Stripe Customers API — Customers
  description: 'Stripe Customers API — Customers. 47 operations. Lead operation: Customers. Self-contained Naftiko capability
    covering one Stripe business surface.'
  tags:
  - Stripe
  - Customers
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    STRIPE_API_KEY: STRIPE_API_KEY
capability:
  consumes:
  - type: http
    namespace: customers-customers
    baseUri: https://api.stripe.com
    description: Stripe Customers API — Customers business capability. Self-contained, no shared references.
    resources:
    - name: v1-customers
      path: /v1/customers
      operations:
      - name: getcustomers
        method: GET
        description: <p>Returns a list of your customers. The customers are returned sorted by creation date, with the most
          recent customers appearing first.</p>
        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: postcustomers
        method: POST
        description: <p>Creates a new customer object.</p>
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - 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: <p>Search for customers you’ve previously created using Stripe’s <a href="/docs/search#search-query-language">Search
          Query Language</a>.
        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: deletecustomerscustomer
        method: DELETE
        description: <p>Permanently deletes a customer. It cannot be undone. Also immediately cancels any active subscriptions
          on the customer.</p>
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: customer
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
      - name: getcustomerscustomer
        method: GET
        description: <p>Retrieves a Customer object.</p>
        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: postcustomerscustomer
        method: POST
        description: '<p>Updates the specified customer by setting the values of the parameters passed. Any parameters not
          provided will be left unchanged. For example, if you pass the <strong>source</strong> parameter, that becomes the
          customer’s active source '
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: customer
          in: path
          type: string
          required: true
        - 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: <p>Returns a list of transactions that updated the customer’s <a href="/docs/billing/customer/balance">balances</a>.</p>
        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: postcustomerscustomerbalancetransactions
        method: POST
        description: <p>Creates an immutable transaction that updates the customer’s credit <a href="/docs/billing/customer/balance">balance</a>.</p>
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: customer
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: v1-customers-customer-balance_transactions-transaction
      path: /v1/customers/{customer}/balance_transactions/{transaction}
      operations:
      - name: getcustomerscustomerbalancetransactionstransaction
        method: GET
        description: <p>Retrieves a specific customer balance transaction that updated the customer’s <a href="/docs/billing/customer/balance">balances</a>.</p>
        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: postcustomerscustomerbalancetransactionstransaction
        method: POST
        description: <p>Most credit balance transaction fields are immutable, but you may update its <code>description</code>
          and <code>metadata</code>.</p>
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: customer
          in: path
          type: string
          required: true
        - 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: <p>You can see a list of the bank accounts belonging to a Customer. Note that the 10 most recent sources
          are always available by default on the Customer. If you need more than those 10, you can use this API method and
          the <code>limit</code>
        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: postcustomerscustomerbankaccounts
        method: POST
        description: <p>When you create a new credit card, you must specify a customer or recipient on which to create it.</p>
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: customer
          in: path
          type: string
          required: true
        - 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: deletecustomerscustomerbankaccountsid
        method: DELETE
        description: <p>Delete a specified source for a given customer.</p>
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: customer
          in: path
          type: string
          required: true
        - name: id
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
      - name: getcustomerscustomerbankaccountsid
        method: GET
        description: <p>By default, you can see the 10 most recent sources stored on a Customer directly on the object, but
          you can also retrieve details about a specific bank account stored on the Stripe account.</p>
        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: postcustomerscustomerbankaccountsid
        method: POST
        description: <p>Update a specified source for a given customer.</p>
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: customer
          in: path
          type: string
          required: true
        - name: id
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: v1-customers-customer-bank_accounts-id-verify
      path: /v1/customers/{customer}/bank_accounts/{id}/verify
      operations:
      - name: postcustomerscustomerbankaccountsidverify
        method: POST
        description: <p>Verify a specified bank account for a given customer.</p>
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: customer
          in: path
          type: string
          required: true
        - 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: <p>You can see a list of the cards belonging to a customer.
        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: postcustomerscustomercards
        method: POST
        description: <p>When you create a new credit card, you must specify a customer or recipient on which to create it.</p>
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: customer
          in: path
          type: string
          required: true
        - 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: deletecustomerscustomercardsid
        method: DELETE
        description: <p>Delete a specified source for a given customer.</p>
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: customer
          in: path
          type: string
          required: true
        - name: id
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
      - name: getcustomerscustomercardsid
        method: GET
        description: <p>You can always see the 10 most recent cards directly on a customer; this method lets you retrieve
          details about a specific card stored on the customer.</p>
        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: postcustomerscustomercardsid
        method: POST
        description: <p>Update a specified source for a given customer.</p>
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: customer
          in: path
          type: string
          required: true
        - 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: <p>Retrieves a customer’s cash balance.</p>
        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: postcustomerscustomercashbalance
        method: POST
        description: <p>Changes the settings on a customer’s cash balance.</p>
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: customer
          in: path
          type: string
          required: true
        - 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: <p>Returns a list of transactions that modified the customer’s <a href="/docs/payments/customer-balance">cash
          balance</a>.</p>
        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: <p>Retrieves a specific cash balance transaction, which updated the customer’s <a href="/docs/payments/customer-balance">cash
          balance</a>.</p>
        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: deletecustomerscustomerdiscount
        method: DELETE
        description: <p>Removes the currently applied discount on a customer.</p>
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: customer
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
      - name: getcustomerscustomerdiscount
        method: GET
        description: ''
        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-funding_instructions
      path: /v1/customers/{customer}/funding_instructions
      operations:
      - name: postcustomerscustomerfundinginstructions
        method: POST
        description: <p>Retrieve funding instructions for a customer cash balance. If funding instructions do not yet exist
          for the customer, new
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: customer
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: v1-customers-customer-payment_methods
      path: /v1/customers/{customer}/payment_methods
      operations:
      - name: getcustomerscustomerpaymentmethods
        method: GET
        description: <p>Returns a list of PaymentMethods for a given Customer</p>
        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: <p>Retrieves a PaymentMethod object for a given Customer.</p>
        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: <p>List sources for a specified customer.</p>
        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: postcustomerscustomersources
        method: POST
        description: <p>When you create a new credit card, you must specify a customer or recipient on which to create it.</p>
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: customer
          in: path
          type: string
          required: true
        - 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: deletecustomerscustomersourcesid
        method: DELETE
        description: <p>Delete a specified source for a given customer.</p>
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: customer
          in: path
          type: string
          required: true
        - name: id
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
      - name: getcustomerscustomersourcesid
        method: GET
        description: <p>Retrieve a specified source for a given customer.</p>
        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: postcustomerscustomersourcesid
        method: POST
        description: <p>Update a specified source for a given customer.</p>
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: customer
          in: path
          type: string
          required: true
        - name: id
          in:

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