Breeze.cash

Breeze.cash Products API

The Products API from Breeze.cash — 3 operation(s) for products.

Documentation GitHub OpenAPI

Operations 4

POST /v2/products Create a product #

GET /v2/products List products #

GET /v2/products/{productId} Get a product by ID #

POST /v2/products/{productId}/price Create a price for a product #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/breezecash:breezecash-products-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Breeze Products API
  version: 1.0.0
  description: Breeze payment processing API
  contact:
    email: support@breeze.cash
    url: https://docs.breeze.cash
servers:
- url: https://api.breeze.cash
  description: Breeze API
- url: https://secure.breeze.cash
  description: Breeze Direct Payment API (production)
- url: https://secure-sandbox.breeze.cash
  description: Breeze Direct Payment API (sandbox)
security:
- basicAuth: []
tags:
- name: Products
paths:
  /v2/products:
    post:
      operationId: createProduct
      tags:
      - Products
      summary: Create a product
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                description: The created product
                properties:
                  status:
                    type: string
                    enum:
                    - SUCCEEDED
                  data:
                    $ref: '#/components/schemas/CreateProductResponse'
                required:
                - status
                - data
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              description: Product details
              oneOf:
              - $ref: '#/components/schemas/RegularProduct'
              - $ref: '#/components/schemas/SubscriptionProduct'
    get:
      operationId: listProducts
      tags:
      - Products
      summary: List products
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                description: List of products
                properties:
                  status:
                    type: string
                    enum:
                    - SUCCEEDED
                  data:
                    $ref: '#/components/schemas/ListProductsResponse'
                  hasMore:
                    type: boolean
                  nextCursorToken:
                    type: string
                    description: Pass this value as cursorToken in the next request to fetch the next page. Absent when there are no more items.
                required:
                - status
                - data
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      description: Returns a paginated list of products with their prices. Use the nextCursorToken from the response as cursorToken in the next request to page through results. When hasMore is false, you have reached the last page.
      parameters:
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          description: Number of products to return per page (1–50, default 20)
        description: Number of products to return per page (1–50, default 20)
      - name: cursorToken
        in: query
        required: false
        schema:
          type: string
          description: Value of nextCursorToken from a previous response to fetch the next page
        description: Value of nextCursorToken from a previous response to fetch the next page
  /v2/products/{productId}:
    get:
      operationId: getProduct
      tags:
      - Products
      summary: Get a product by ID
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                description: The product
                properties:
                  status:
                    type: string
                    enum:
                    - SUCCEEDED
                  data:
                    $ref: '#/components/schemas/GetProductResponse'
                required:
                - status
                - data
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      parameters:
      - name: productId
        in: path
        required: true
        schema:
          type: string
        description: Product ID
  /v2/products/{productId}/price:
    post:
      operationId: createProductPrice
      tags:
      - Products
      summary: Create a price for a product
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                description: The created price
                properties:
                  status:
                    type: string
                    enum:
                    - SUCCEEDED
                  data:
                    $ref: '#/components/schemas/CreateProductPriceResponse'
                required:
                - status
                - data
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      parameters:
      - name: productId
        in: path
        required: true
        schema:
          type: string
        description: Product ID
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateProductPriceRequest'
components:
  schemas:
    CreateProductPriceRequest:
      description: Price details
      type: object
      properties:
        currency:
          type: string
          enum:
          - USD
          - AUD
          - CAD
          - CHF
          - DKK
          - EUR
          - GBP
          - HKD
          - JPY
          - NOK
          - NZD
          - PLN
          - SEK
          - SGD
          - TWD
          - KRW
        amount:
          type: string
          deprecated: true
        unitAmount:
          type: integer
          description: 'Positive minor units / cents (e.g., currency: "USD", unitAmount: 10000 = USD 100). Mutually exclusive with amount.'
          exclusiveMinimum: 0
        type:
          type: string
          enum:
          - ONE_TIME
          - RECURRING
        billingCycleConfig:
          type: object
          properties:
            interval:
              type: string
              enum:
              - hour
              - day
              - week
              - month
              - year
            frequency:
              type: integer
              exclusiveMinimum: 0
          required:
          - interval
          - frequency
          additionalProperties: false
      required:
      - currency
      - type
      additionalProperties: false
    CreateProductResponse:
      $schema: http://json-schema.org/draft-07/schema#
      type: object
      properties:
        id:
          type: string
        createdAt:
          type: number
        updatedAt:
          type: number
        defaultPriceId:
          type: string
        clientProductId:
          type: string
        description:
          type: string
        displayName:
          type: string
        image:
          type: string
        livemode:
          type: boolean
        merchantId:
          type: string
        status:
          type: string
          enum:
          - ACTIVE
          - INACTIVE
          - PENDING
          - DELETED
        type:
          type: string
          enum:
          - SUBSCRIPTION
          - REGULAR
      required:
      - displayName
      - livemode
      - merchantId
      - status
      - type
      definitions: {}
    ListProductsResponse:
      type: array
      items:
        $schema: http://json-schema.org/draft-07/schema#
        type: object
        properties:
          id:
            type: string
          createdAt:
            type: number
          updatedAt:
            type: number
          defaultPriceId:
            type: string
          clientProductId:
            type: string
          description:
            type: string
          displayName:
            type: string
          image:
            type: string
          livemode:
            type: boolean
          merchantId:
            type: string
          status:
            type: string
            enum:
            - ACTIVE
            - INACTIVE
            - PENDING
            - DELETED
          type:
            type: string
            enum:
            - SUBSCRIPTION
            - REGULAR
          prices:
            type: array
            items:
              type: object
              properties:
                id:
                  type: string
                createdAt:
                  type: number
                updatedAt:
                  type: number
                currency:
                  type: string
                  enum:
                  - USD
                  - AUD
                  - CAD
                  - CHF
                  - DKK
                  - EUR
                  - GBP
                  - HKD
                  - JPY
                  - NOK
                  - NZD
                  - PLN
                  - SEK
                  - SGD
                  - TWD
                  - KRW
                amountStr:
                  type: string
                  deprecated: true
                status:
                  type: string
                  enum:
                  - ACTIVE
                  - INACTIVE
                  - DELETED
                productId:
                  type: string
                type:
                  type: string
                  enum:
                  - ONE_TIME
                  - RECURRING
                livemode:
                  type: boolean
                billingCycleConfig:
                  type: object
                  properties:
                    interval:
                      type: string
                      enum:
                      - hour
                      - day
                      - week
                      - month
                      - year
                    frequency:
                      type: number
                  required:
                  - interval
                  - frequency
                unitAmount:
                  type: number
              required:
              - amountStr
              - currency
              - livemode
              - productId
              - status
              - type
              - unitAmount
        required:
        - displayName
        - livemode
        - merchantId
        - prices
        - status
        - type
        definitions: {}
    ProductCurrency:
      type: string
      description: 'Three-letter ISO currency code for the product price. Supported values: USD, AUD, CAD, CHF, DKK, EUR, GBP, NOK, NZD, PLN, SEK, SGD.'
      enum:
      - USD
      - AUD
      - CAD
      - CHF
      - DKK
      - EUR
      - GBP
      - NOK
      - NZD
      - PLN
      - SEK
      - SGD
    ErrorResponse:
      type: object
      properties:
        status:
          type: string
          enum:
          - FAILED
        errorCode:
          type: string
        errorMessage:
          type: string
      required:
      - status
      - errorCode
      - errorMessage
    CreateProductPriceResponse:
      $schema: http://json-schema.org/draft-07/schema#
      type: object
      properties:
        id:
          type: string
        createdAt:
          type: number
        updatedAt:
          type: number
        currency:
          type: string
          enum:
          - USD
          - AUD
          - CAD
          - CHF
          - DKK
          - EUR
          - GBP
          - HKD
          - JPY
          - NOK
          - NZD
          - PLN
          - SEK
          - SGD
          - TWD
          - KRW
        amountStr:
          type: string
          deprecated: true
        status:
          type: string
          enum:
          - ACTIVE
          - INACTIVE
          - DELETED
        productId:
          type: string
        type:
          type: string
          enum:
          - ONE_TIME
          - RECURRING
        livemode:
          type: boolean
        billingCycleConfig:
          type: object
          properties:
            interval:
              type: string
              enum:
              - hour
              - day
              - week
              - month
              - year
            frequency:
              type: number
          required:
          - interval
          - frequency
        unitAmount:
          type: number
      required:
      - amountStr
      - currency
      - livemode
      - productId
      - status
      - type
      - unitAmount
      definitions: {}
    GetProductResponse:
      $schema: http://json-schema.org/draft-07/schema#
      type: object
      properties:
        id:
          type: string
        createdAt:
          type: number
        updatedAt:
          type: number
        defaultPriceId:
          type: string
        clientProductId:
          type: string
        description:
          type: string
        displayName:
          type: string
        image:
          type: string
        livemode:
          type: boolean
        merchantId:
          type: string
        status:
          type: string
          enum:
          - ACTIVE
          - INACTIVE
          - PENDING
          - DELETED
        type:
          type: string
          enum:
          - SUBSCRIPTION
          - REGULAR
        prices:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
              createdAt:
                type: number
              updatedAt:
                type: number
              currency:
                type: string
                enum:
                - USD
                - AUD
                - CAD
                - CHF
                - DKK
                - EUR
                - GBP
                - HKD
                - JPY
                - NOK
                - NZD
                - PLN
                - SEK
                - SGD
                - TWD
                - KRW
              amountStr:
                type: string
                deprecated: true
              status:
                type: string
                enum:
                - ACTIVE
                - INACTIVE
                - DELETED
              productId:
                type: string
              type:
                type: string
                enum:
                - ONE_TIME
                - RECURRING
              livemode:
                type: boolean
              billingCycleConfig:
                type: object
                properties:
                  interval:
                    type: string
                    enum:
                    - hour
                    - day
                    - week
                    - month
                    - year
                  frequency:
                    type: number
                required:
                - interval
                - frequency
              unitAmount:
                type: number
            required:
            - amountStr
            - currency
            - livemode
            - productId
            - status
            - type
            - unitAmount
      required:
      - displayName
      - livemode
      - merchantId
      - prices
      - status
      - type
      definitions: {}
    RegularProduct:
      description: Product details
      type: object
      properties:
        clientProductId:
          type: string
          description: 'Your unique identifier for this product. Minimum 1 character, maximum 100 characters. Allowed characters: letters (a–z, A–Z), numbers (0–9), dot (.), underscore (_), and hyphen (-). Example: ''prod_123'', ''my-product.v2''.'
          minLength: 1
          maxLength: 100
          pattern: ^[0-9a-zA-Z._-]+$
        description:
          type: string
          description: Optional description of the product shown to customers. Minimum 1 character, maximum 280 characters.
          minLength: 1
          maxLength: 280
        displayName:
          type: string
          description: The name of the product shown to customers.
          minLength: 1
          maxLength: 100
        image:
          type: string
          description: URL of the product image shown to customers.
          format: uri
        type:
          $ref: '#/components/schemas/ProductType'
        amount:
          type: string
          deprecated: true
        unitAmount:
          type: integer
          description: 'Price of the product in minor units / cents (e.g., currency: "USD", 1000 = USD 10).'
          exclusiveMinimum: 0
        currency:
          $ref: '#/components/schemas/ProductCurrency'
      required:
      - displayName
      - type
      - currency
      additionalProperties: false
      oneOf:
      - title: With unitAmount (minor units)
        required:
        - unitAmount
      - title: With amount (major units, deprecated)
        required:
        - amount
    ProductType:
      type: string
      description: The type of product.
      enum:
      - REGULAR
      - SUBSCRIPTION
    SubscriptionProduct:
      description: Product details
      type: object
      properties:
        clientProductId:
          type: string
          description: 'Your unique identifier for this product. Minimum 1 character, maximum 100 characters. Allowed characters: letters (a–z, A–Z), numbers (0–9), dot (.), underscore (_), and hyphen (-). Example: ''prod_123'', ''my-product.v2''.'
          minLength: 1
          maxLength: 100
          pattern: ^[0-9a-zA-Z._-]+$
        description:
          type: string
          description: Optional description of the product shown to customers. Minimum 1 character, maximum 280 characters.
          minLength: 1
          maxLength: 280
        displayName:
          type: string
          description: The name of the product shown to customers.
          minLength: 1
          maxLength: 100
        image:
          type: string
          description: URL of the product image shown to customers.
          format: uri
        type:
          $ref: '#/components/schemas/ProductType'
      required:
      - displayName
      - type
      additionalProperties: false
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: API key as username, empty password
x-provenance:
  method: searched
  source: https://docs.breeze.com/reference
  harvested: '2026-10-28'
  tool: harvest-readme-openapi.py
  note: Assembled verbatim from the OpenAPI definition ReadMe embeds in each operation page of the provider's developer portal; paths and components merged by API title, nothing authored.
  assembled_from:
  - https://docs.breeze.com/reference/cancelofframprequest.md
  - https://docs.breeze.com/reference/cancelpayoutpage.md
  - https://docs.breeze.com/reference/cancelsubscription.md
  - https://docs.breeze.com/reference/createcustomer.md
  - https://docs.breeze.com/reference/creategatewaypayment.md
  - https://docs.breeze.com/reference/createheadlesspayout.md
  - https://docs.breeze.com/reference/createliquidationaddress.md
  - https://docs.breeze.com/reference/createofframprequest.md
  - https://docs.breeze.com/reference/createpaymentpage.md
  - https://docs.breeze.com/reference/createpayoutpage.md
  - https://docs.breeze.com/reference/createproduct.md
  - https://docs.breeze.com/reference/createproductprice.md
  - https://docs.breeze.com/reference/createsubscription.md
  - https://docs.breeze.com/reference/deletegatewaycustomerpaymentmethod.md
  - https://docs.breeze.com/reference/downloadstatement.md
  - https://docs.breeze.com/reference/expirepaymentpage.md
  - https://docs.breeze.com/reference/getallpaymentattempts.md
  - https://docs.breeze.com/reference/getcustomerbyid.md
  - https://docs.breeze.com/reference/getcustomerbyquery.md
  - https://docs.breeze.com/reference/getfraudreport.md
  - https://docs.breeze.com/reference/getgatewaypayment.md
  - https://docs.breeze.com/reference/getheadlesskycbycustomerreferenceid.md
  - https://docs.breeze.com/reference/getheadlesskycbyid.md
  - https://docs.breeze.com/reference/getinvoice.md
  - https://docs.breeze.com/reference/getliquidationaddress.md
  - https://docs.breeze.com/reference/getliquidationaddresstransaction.md
  - https://docs.breeze.com/reference/getmerchanttaxrate.md
  - https://docs.breeze.com/reference/getofframprequest.md
  - https://docs.breeze.com/reference/getpaymentpage.md
  - https://docs.breeze.com/reference/getpayoutpage.md
  - https://docs.breeze.com/reference/getpayoutpagehistory.md
  - https://docs.breeze.com/reference/getproduct.md
  - https://docs.breeze.com/reference/getrefund.md
  - https://docs.breeze.com/reference/getriskstatus.md
  - https://docs.breeze.com/reference/getsubscription.md
  - https://docs.breeze.com/reference/getsubscriptionbyclientreferenceid.md
  - https://docs.breeze.com/reference/initiateheadlesskyctier3.md
  - https://docs.breeze.com/reference/initiaterefund.md
  - https://docs.breeze.com/reference/listdisputes.md
  - https://docs.breeze.com/reference/listfraudreports.md
  - https://docs.breeze.com/reference/listgatewaycustomerpaymentmethods.md
  - https://docs.breeze.com/reference/listliquidationaddresses.md
  - https://docs.breeze.com/reference/listliquidationaddresstransactions.md
  - https://docs.breeze.com/reference/listpaymentpages.md
  - https://docs.breeze.com/reference/listproducts.md
  - https://docs.breeze.com/reference/liststatements.md
  - https://docs.breeze.com/reference/listsubscriptions.md
  - https://docs.breeze.com/reference/offboardcustomer.md
  - https://docs.breeze.com/reference/releaseofframprequest.md
  - https://docs.breeze.com/reference/releasepayoutpage.md
  - https://docs.breeze.com/reference/resumegatewaypaymentauthentication.md
  - https://docs.breeze.com/reference/sandboxconfirmpayoutpage.md
  - https://docs.breeze.com/reference/simulatesandboxdispute.md
  - https://docs.breeze.com/reference/submitheadlesskycproofofaddresswithupload.md
  - https://docs.breeze.com/reference/submitheadlesskycproofofaddresswithurl.md
  - https://docs.breeze.com/reference/submitheadlesskycwithimageupload.md
  - https://docs.breeze.com/reference/submitheadlesskycwithimageurl.md
  - https://docs.breeze.com/reference/updatecustomer.md
  merge:
    pages: 58
    deduped: 458
    conflicts_kept_first: 0