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

# List the payment methods a customer can pay with

> Returns the instruments available at checkout — cards, cryptocurrency, the account balance — each with the provider behind it and the currencies it settles in.

By default only methods a customer can actually pick are returned: enabled themselves, belonging to a provider that is also enabled, and offerable at checkout. Pass `all=true` for the full list including disabled and non-checkout methods.

Pass `currency` to filter to methods that can charge it. A method whose `allowConvertCurrency` is true is included for any currency — it converts into one it settles in and bills that.

**Required API key permission:** `billing:read`



## OpenAPI

````yaml /openapi.json get /payments/methods
openapi: 3.0.0
info:
  title: Storiza API
  version: '1.0'
  description: Manage Storiza servers, apps and subscriptions programmatically.
servers:
  - url: https://api.storiza.store
security:
  - bearerAuth: []
tags:
  - name: Servers
    description: Create, order, renew and upgrade VPS servers, and read their details.
  - name: Server power & commands
    description: >-
      Start, stop, reboot and force-stop a server, check its status and run
      commands on it.
  - name: Server settings
    description: >-
      Rename a server, reinstall its operating system and follow its
      installation.
  - name: Server firewall
    description: Turn a server's firewall on or off and manage its rules.
  - name: Server metrics
    description: CPU, memory, disk and network usage, now and over time.
  - name: Server backups
    description: Order the backup add-on, and take, list and delete backups.
  - name: Server snapshots
    description: Take, list and delete snapshots of a server.
  - name: Server sharing
    description: A share link that lets someone else open the server.
  - name: Server catalog
    description: >-
      Plans, operating systems, categories, datacenters and backup plans. Public
      — no key needed.
  - name: Apps
    description: >-
      Deploy, order, renew and configure apps — game servers, databases and
      bots.
  - name: App lifecycle & console
    description: >-
      Start, stop, restart and kill an app, read its output and metrics, and
      send it commands.
  - name: App files
    description: >-
      Read, write, move and delete the files in an app's volume, and its SFTP
      access.
  - name: App backups
    description: Back up an app, download a backup, and restore from one.
  - name: App domains
    description: Your own domains for an app, and their DNS verification.
  - name: App groups
    description: Private networks that let your apps reach each other by hostname.
  - name: App catalog
    description: Templates, plans and locations for apps.
  - name: Subscriptions
    description: What you pay for, how often it renews, and stopping or resuming it.
  - name: Payments
    description: >-
      Follow a payment after an order, and the methods and currencies you can
      pay with.
  - name: Account
    description: Your profile, and a summary of everything you own.
  - name: SSH keys
    description: Public keys you can install on new Linux servers.
paths:
  /payments/methods:
    get:
      tags:
        - Payments
      summary: List the payment methods a customer can pay with
      description: >-
        Returns the instruments available at checkout — cards, cryptocurrency,
        the account balance — each with the provider behind it and the
        currencies it settles in.


        By default only methods a customer can actually pick are returned:
        enabled themselves, belonging to a provider that is also enabled, and
        offerable at checkout. Pass `all=true` for the full list including
        disabled and non-checkout methods.


        Pass `currency` to filter to methods that can charge it. A method whose
        `allowConvertCurrency` is true is included for any currency — it
        converts into one it settles in and bills that.


        **Required API key permission:** `billing:read`
      parameters:
        - schema:
            type: string
            minLength: 3
            maxLength: 3
            default: USD
            description: >-
              Currency to quote in. Filters to methods that can charge it, and
              restates each method's amount limits in it
          required: false
          description: >-
            Currency to quote in. Filters to methods that can charge it, and
            restates each method's amount limits in it
          name: currency
          in: query
      responses:
        '200':
          description: Payment methods retrieved successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    enum:
                      - true
                  message:
                    type: string
                    enum:
                      - Payment methods retrieved successfully
                  data:
                    type: object
                    properties:
                      currency:
                        type: string
                        description: The currency `minAmount` and `maxAmount` are quoted in
                      methods:
                        type: array
                        items:
                          type: object
                          properties:
                            slug:
                              type: string
                            name:
                              type: string
                            description:
                              type: string
                            isActive:
                              type: boolean
                            supportedCurrencies:
                              type: array
                              items:
                                type: string
                            allowConvertCurrency:
                              type: boolean
                            minAmount:
                              type: number
                              nullable: true
                              description: >-
                                Smallest charge, in the quoted currency. Null
                                for no floor
                            maxAmount:
                              type: number
                              nullable: true
                              description: >-
                                Largest charge, in the quoted currency. Null for
                                no ceiling
                            taxes:
                              type: array
                              items:
                                type: object
                                properties:
                                  name:
                                    type: string
                                  percent:
                                    type: number
                                required:
                                  - name
                                  - percent
                            supportsSubscriptions:
                              type: boolean
                            supportsOnetimePurchase:
                              type: boolean
                            availableAtCheckout:
                              type: boolean
                            checkoutSurface:
                              type: string
                              enum:
                                - hosted
                                - apple_pay
                              description: >-
                                How the customer pays: a provider page, or an
                                Apple Pay button on your own checkout (hide it
                                where Apple Pay is unavailable)
                            keepsSchedule:
                              type: boolean
                              description: >-
                                Whether paying with this hands the billing
                                schedule to its provider. False for the wallet
                                and for methods we charge ourselves.
                            carriesUnusedDays:
                              type: boolean
                              description: >-
                                Whether days already paid for survive a renewal
                                made with this method. False means renewing
                                early would throw them away, and the API refuses
                                it.
                            provider:
                              type: string
                            providerName:
                              type: string
                              description: >-
                                Display name of the provider, for grouping its
                                methods
                            banners:
                              type: array
                              items:
                                type: string
                          required:
                            - slug
                            - name
                            - description
                            - isActive
                            - supportedCurrencies
                            - allowConvertCurrency
                            - minAmount
                            - maxAmount
                            - taxes
                            - supportsSubscriptions
                            - supportsOnetimePurchase
                            - availableAtCheckout
                            - checkoutSurface
                            - keepsSchedule
                            - carriesUnusedDays
                            - provider
                            - providerName
                            - banners
                    required:
                      - currency
                      - methods
                required:
                  - success
                  - message
                  - data
        '400':
          description: Unknown currency
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    enum:
                      - false
                  type:
                    type: string
                  code:
                    type: string
                  error:
                    type: string
                  details:
                    nullable: true
                required:
                  - success
                  - type
                  - code
                  - error
              examples:
                unknownCurrency:
                  summary: Unknown currency
                  value:
                    success: false
                    type: API
                    code: BAD_REQUEST
                    error: Unknown currency
        '401':
          description: Authentication required | Invalid API key | API key has expired
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    enum:
                      - false
                  type:
                    type: string
                  code:
                    type: string
                  error:
                    type: string
                  details:
                    nullable: true
                required:
                  - success
                  - type
                  - code
                  - error
              examples:
                authenticationRequired:
                  summary: Authentication required
                  value:
                    success: false
                    type: API
                    code: AUTHENTICATION_ERROR
                    error: Authentication required
                invalidApiKey:
                  summary: Invalid API key
                  value:
                    success: false
                    type: API
                    code: INVALID_API_KEY
                    error: Invalid API key
                expiredApiKey:
                  summary: API key has expired
                  value:
                    success: false
                    type: API
                    code: EXPIRED_API_KEY
                    error: API key has expired
        '403':
          description: >-
            Account is banned | Account is suspended | Insufficient permissions
            | This endpoint cannot be accessed with this authentication method |
            API key lacks the permission required for this endpoint | This API
            key is not permitted from your IP address
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    enum:
                      - false
                  type:
                    type: string
                  code:
                    type: string
                  error:
                    type: string
                  details:
                    nullable: true
                required:
                  - success
                  - type
                  - code
                  - error
              examples:
                accountBanned:
                  summary: Account is banned
                  value:
                    success: false
                    type: API
                    code: ACCOUNT_BANNED
                    error: Account is banned
                accountSuspended:
                  summary: Account is suspended
                  value:
                    success: false
                    type: API
                    code: ACCOUNT_SUSPENDED
                    error: Account is suspended
                insufficientPermissions:
                  summary: Insufficient permissions
                  value:
                    success: false
                    type: API
                    code: AUTHORIZATION_ERROR
                    error: Insufficient permissions
                transportNotAllowed:
                  summary: >-
                    This endpoint cannot be accessed with this authentication
                    method
                  value:
                    success: false
                    type: API
                    code: TRANSPORT_NOT_ALLOWED
                    error: >-
                      This endpoint cannot be accessed with this authentication
                      method
                missingPermission:
                  summary: API key lacks the permission required for this endpoint
                  value:
                    success: false
                    type: API
                    code: MISSING_PERMISSION
                    error: API key lacks the permission required for this endpoint
                ipNotAllowed:
                  summary: This API key is not permitted from your IP address
                  value:
                    success: false
                    type: API
                    code: IP_NOT_ALLOWED
                    error: This API key is not permitted from your IP address
        '422':
          description: Validation error
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    enum:
                      - false
                  type:
                    type: string
                    enum:
                      - API
                  code:
                    type: string
                    enum:
                      - VALIDATION_ERROR
                  error:
                    type: string
                    enum:
                      - Validation error
                  details:
                    type: object
                    additionalProperties:
                      type: object
                      properties:
                        _errors:
                          type: array
                          items:
                            type: string
                required:
                  - success
                  - type
                  - code
                  - error
                  - details
              example:
                success: false
                type: API
                code: VALIDATION_ERROR
                error: Validation error
                details:
                  _errors:
                    - The whole schema has some validation problems
                  some_field:
                    _errors:
                      - This field has some validation problem
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    enum:
                      - false
                  type:
                    type: string
                    enum:
                      - API
                  code:
                    type: string
                    enum:
                      - INTERNAL_ERROR
                  error:
                    type: string
                    enum:
                      - Internal server error
                  details:
                    nullable: true
                required:
                  - success
                  - type
                  - code
                  - error
              example:
                success: false
                type: API
                code: INTERNAL_ERROR
                error: Internal server error
      security:
        - bearerAuth: []
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        An API key from the Storiza dashboard (API & Integrations), sent as
        `Authorization: Bearer stz_…`.

````

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