ClickFunnels Products::Prices::Change Option API

> Allowed variant/price upgrade and downgrade targets for a source price. Merchant-configured rows define which variant + price combinations a subscription using a given source price may switch to. The discovery endpoint returns these grouped by target variant; each group lists the prices on that target variant the subscription may move to. Use the returned `products_price_id`s as the body's `products_price_id` on `POST /orders/line_items/:line_item_id/changes` (preview) or `POST /orders/line_items/:line_item_id/changes/perform` (commit). See [Step 1 - Discover what's allowed](https://accounts.myclickfunnels.com/.well-known/subscription-changes/skill.md#step-1---discover-whats-allowed) in the [Subscription Changes Skill](https://accounts.myclickfunnels.com/.well-known/subscription-changes/skill.md).

Operations 1

GET /products/prices/{price_id}/change_options List Upgrade/Downgrade Options #

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/clickfunnels:clickfunnels-products-prices-changeoption-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

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.

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

OpenAPI Specification

clickfunnels-products-prices-changeoption-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: ClickFunnels Products::Prices::Change Option API
  termsOfService: https://www.clickfunnels.com/terms-of-service
  contact:
    name: ClickFunnels API Team
    url: https://developers.myclickfunnels.com
  x-logo:
    url: https://statics.myclickfunnels.com/image/1126065/file/31edf05760fafe41a82f16a668ab251f.png
  description: 'The ClickFunnels REST API that powers webhooks, native integrations, and Zapier lets you manage your ClickFunnels data, automate your workflows, and recreate ClickFunnels functionality in your own apps.


    ### For AI agents


    This document is the catalogue: every operation ClickFunnels exposes over REST is described here, with a unique operationId, typed schemas, and the scopes it needs. It is served from `/openapi.json`, `/openapi.yaml`, `/api/openapi.{json,yaml}`, and `/api/v2/openapi.{json,yaml}` on the accounts host.


    Three things it does not describe, each one request away:


    - MCP server: the app-native Model Context Protocol server (Streamable HTTP, OAuth 2.1 with PKCE). Prefer it over raw REST when your client supports MCP - it describes itself at runtime.

    - Skill guides, also as an Agent Skills index: one task guide per job (pages, blogs, products, orders, workflows, emails, courses, stats, external SDK pages). Read the guide that matches your job before your first write. llms.txt covers when to use ClickFunnels at all, how to get credentials, and how to behave around rate limits.

    - Protected resource metadata (RFC 9728) and authorization server metadata (RFC 8414): the scope vocabulary and the OAuth endpoints. Dynamic client registration is for MCP clients only.


    On ClickFunnels-owned API hosts (`myclickfunnels.com` and its subdomains), the OpenAPI specification responses and API authentication failures (401, or 403 for insufficient scope) carry those links in an RFC 8288 `Link` header, so clients can discover the documentation and authentication metadata from those responses. Requests sent through a customer''s custom domain keep the Bearer challenge but omit those discovery pointers.'
  license:
    name: MIT
    url: https://opensource.org/licenses/MIT
  version: 2.0.0
servers:
- url: https://{subdomain}.myclickfunnels.com/api/v2
  description: ClickFunnels API
  variables:
    subdomain:
      default: myworkspace
security:
- BearerAuth: []
- OAuth2: []
tags:
- name: Products::Prices::ChangeOption
  description: '> Allowed variant/price upgrade and downgrade targets for a source price.


    Merchant-configured rows define which variant + price combinations a subscription using a

    given source price may switch to. The discovery endpoint returns these grouped by target

    variant; each group lists the prices on that target variant the subscription may move to.


    Use the returned `products_price_id`s as the body''s `products_price_id` on

    `POST /orders/line_items/:line_item_id/changes` (preview) or

    `POST /orders/line_items/:line_item_id/changes/perform` (commit).


    See Step 1 - Discover what''s allowed in the Subscription Changes Skill.'
paths:
  /products/prices/{price_id}/change_options:
    get:
      tags:
      - Products::Prices::ChangeOption
      summary: List Upgrade/Downgrade Options
      description: 'Returns the allowed upgrade and downgrade target variants for a price, grouped by

        target variant. Each group lists the prices on the target variant that a subscription

        using this source price may switch to. Use this to render dynamic upgrade pricing

        pages, or to source target `products_price_id` values for the line item change

        endpoints: `POST /orders/line_items/{line_item_id}/changes` (preview) and

        `POST /orders/line_items/{line_item_id}/changes/perform` (commit).


        See Step 1 - Discover what''s allowed in the Subscription Changes Skill

        for the response shape and how to treat an empty result.'
      operationId: listProductsPricesChangeOptions
      parameters:
      - name: price_id
        in: path
        required: true
        description: 'The source price for which to look up allowed upgrade/downgrade targets.

          Accepts either the integer database id or the obfuscated `public_id` string.

          '
        schema:
          oneOf:
          - type: integer
          - type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProductsPricesChangeOptionsResponse'
              example:
                products_prices_change_options:
                  upgrade:
                  - products_variant:
                      id: 124
                      public_id: k7xQzR
                      name: Pro
                      product_id: 88
                      prices:
                      - id: 456
                        public_id: aBcDeF
                        name: Pro Monthly
                        key: pro_monthly_2024
                        amount: '20.00'
                        currency: USD
                        duration: null
                        interval: months
                        interval_count: 1
                      - id: 457
                        public_id: gHiJkL
                        name: Pro Annual
                        key: pro_annual_2024
                        amount: '200.00'
                        currency: USD
                        duration: null
                        interval: years
                        interval_count: 1
                  downgrade:
                  - products_variant:
                      id: 125
                      public_id: m2qYpA
                      name: Basic
                      product_id: 88
                      prices:
                      - id: 789
                        public_id: sTuVwX
                        name: Basic Monthly
                        key: basic_monthly_2024
                        amount: '5.00'
                        currency: USD
                        duration: null
                        interval: months
                        interval_count: 1
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  hint:
                    type:
                    - string
                    - 'null'
                    description: 'The next step for the caller: how to authenticate, which scope was missing, or where the route list lives. Always present, and null when this error has no next step to offer.'
              example:
                error: API key missing or invalid
                hint: 'Send the token as `Authorization: Bearer <token>`. Create one under Account > Team > Platform Applications (a workspace API key), or obtain one with OAuth 2.1; both use the same scopes. See https://developers.myclickfunnels.com/docs/authentication, or append .md to that URL for markdown.'
        '403':
          $ref: '#/components/responses/WorkspaceGrantForbidden'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  hint:
                    type:
                    - string
                    - 'null'
                    description: 'The next step for the caller: how to authenticate, which scope was missing, or where the route list lives. Always present, and null when this error has no next step to offer.'
              example:
                error: 'Not found: Record missing'
                hint: null
components:
  responses:
    WorkspaceGrantForbidden:
      description: "Forbidden — this request's workspace is closed to it.\n\nThree cases return this:\n\n* The access token is limited to specific workspaces (see the workspace selection made when\n  the key was provisioned, or the workspaces approved on the OAuth consent screen) and the\n  request acts on a workspace outside that set.\n* The access token is limited to specific workspaces and the request's workspace could not be\n  determined at all. The gate is fail-closed, so a workspace-limited token is denied rather\n  than allowed through when the target workspace is ambiguous.\n* The workspace's team has no active ClickFunnels subscription: it was canceled, is paused,\n  or is locked out after failed payments. Reads and writes are both refused until the\n  subscription is reactivated, and the body carries `\"code\": \"subscription_inactive\"`.\n\nA token with no workspace restriction never receives the first two."
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: string
              code:
                type: string
                description: A machine-readable cause, when there is one. `subscription_inactive` means the workspace's team has no active ClickFunnels subscription.
                enum:
                - subscription_inactive
              hint:
                type:
                - string
                - 'null'
                description: 'The next step for the caller: how to authenticate, which scope was missing, or where the route list lives. Always present, and null when this error has no next step to offer.'
          examples:
            workspace_not_granted:
              summary: Token not granted this workspace
              value:
                error: 'Forbidden: This access token is limited to specific workspaces and was not granted access to this one.'
                hint: The token's workspace grant was chosen when it was provisioned (Platform Applications) or on the OAuth consent screen. Use GET /api/v2/teams/{team_id}/workspaces to list the workspaces this token can reach (GET /api/v2/teams lists the team ids).
            subscription_inactive:
              summary: Team subscription inactive
              value:
                error: 'Forbidden: This workspace''s team does not have an active ClickFunnels subscription, so API access to it is disabled until the subscription is reactivated.'
                hint: null
                code: subscription_inactive
  schemas:
    ProductsPricesChangeOptionsResponse:
      type: object
      title: Price Change Options
      description: 'Allowed upgrade and downgrade target variants for a source price.

        Each group lists a target variant alongside the prices on that variant

        a subscription using this source price may switch to.

        '
      properties:
        products_prices_change_options:
          type: object
          properties:
            upgrade:
              type: array
              items:
                $ref: '#/components/schemas/ProductsPricesChangeOptionsVariantGroup'
            downgrade:
              type: array
              items:
                $ref: '#/components/schemas/ProductsPricesChangeOptionsVariantGroup'
      example:
        products_prices_change_options:
          upgrade:
          - products_variant:
              id: 124
              public_id: k7xQzR
              name: Pro
              product_id: 88
              prices:
              - id: 456
                public_id: aBcDeF
                name: Pro Monthly
                key: pro_monthly_2024
                amount: '20.00'
                currency: USD
                duration: null
                interval: months
                interval_count: 1
              - id: 457
                public_id: gHiJkL
                name: Pro Annual
                key: pro_annual_2024
                amount: '200.00'
                currency: USD
                duration: null
                interval: years
                interval_count: 1
          downgrade:
          - products_variant:
              id: 125
              public_id: m2qYpA
              name: Basic
              product_id: 88
              prices:
              - id: 789
                public_id: sTuVwX
                name: Basic Monthly
                key: basic_monthly_2024
                amount: '5.00'
                currency: USD
                duration: null
                interval: months
                interval_count: 1
    ProductsPriceMinimal:
      type: object
      title: Products Price (Minimal)
      description: 'Minimal price representation used wherever a price appears as a nested

        attribute (line items, upgrade/downgrade discovery).

        '
      properties:
        id:
          type: integer
        public_id:
          type:
          - string
          - 'null'
        name:
          type:
          - string
          - 'null'
        key:
          type:
          - string
          - 'null'
        amount:
          type:
          - string
          - 'null'
        currency:
          type:
          - string
          - 'null'
        duration:
          type:
          - integer
          - 'null'
        interval:
          type:
          - string
          - 'null'
        interval_count:
          type:
          - integer
          - 'null'
      example:
        id: 24
        public_id: aBcDeF
        name: Pro Monthly
        key: pro_monthly_2024
        amount: '20.00'
        currency: USD
        duration: null
        interval: months
        interval_count: 1
    ProductsPricesChangeOptionsVariantGroup:
      type: object
      title: Variant Group of Upgrade/Downgrade Prices
      description: 'A target variant and the prices on that variant the source price may switch to.

        Multiple prices can share the same target variant when the underlying

        upgrade/downgrade configuration allows several billing options on the new variant.

        '
      properties:
        products_variant:
          type: object
          properties:
            id:
              type: integer
            public_id:
              type:
              - string
              - 'null'
            name:
              type:
              - string
              - 'null'
            product_id:
              type:
              - integer
              - 'null'
            prices:
              type: array
              items:
                $ref: '#/components/schemas/ProductsPriceMinimal'
      example:
        products_variant:
          id: 124
          public_id: k7xQzR
          name: Pro
          product_id: 88
          prices:
          - id: 456
            public_id: aBcDeF
            name: Pro Monthly
            key: pro_monthly_2024
            amount: '20.00'
            currency: USD
            duration: null
            interval: months
            interval_count: 1
          - id: 457
            public_id: gHiJkL
            name: Pro Annual
            key: pro_annual_2024
            amount: '200.00'
            currency: USD
            duration: null
            interval: years
            interval_count: 1
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: 'A workspace API key or an OAuth access token, sent as `Authorization: Bearer <token>`.


        Both carry the same scope vocabulary as the `OAuth2` scheme below. Category-only

        scopes restrict access to the categories they name. Coarse wildcards remain additive:

        `read contacts:read` reads every category, while `write contacts:read` can write every

        category. Omit coarse scopes when restricting access to specific categories.

        Legacy tokens with only coarse scopes retain their existing unrestricted access;

        a bare `read` scope alone does not enforce read-only access.

        '
    OAuth2:
      type: oauth2
      description: 'OAuth 2.0 authorization code flow for REST integrations. Create a Platform Application

        and follow `https://developers.myclickfunnels.com/docs/oauth-20` to connect users.

        Authorization server metadata is published at

        `https://accounts.myclickfunnels.com/.well-known/oauth-authorization-server`.

        Dynamic client registration at `/oauth/register` is for MCP clients only; MCP-scoped

        tokens must use `https://agents.myclickfunnels.com/mcp`, not the REST API.


        Scopes are least-privilege by category. Ask for the two coarse wildcards (`read`,

        `write`) only when an integration genuinely needs the whole workspace; otherwise ask

        for the `<category>:read` / `<category>:write` pairs you use. `write` implies `read`

        for the same category. Protected resource metadata (RFC 9728) for this API lives at

        `https://accounts.myclickfunnels.com/.well-known/oauth-protected-resource`.

        '
      flows:
        authorizationCode:
          authorizationUrl: https://accounts.myclickfunnels.com/oauth/authorize
          tokenUrl: https://accounts.myclickfunnels.com/oauth/token
          refreshUrl: https://accounts.myclickfunnels.com/oauth/token
          scopes:
            read: Read any resource in the granted workspaces
            write: Read and write any resource in the granted workspaces
            contacts:read: Read Contacts
            contacts:write: Read and write Contacts
            workflows:read: Read Workflows (Automations)
            workflows:write: Read and write Workflows (Automations)
            funnels:read: Read Funnels
            funnels:write: Read and write Funnels
            sites:read: Read Sites & Design
            sites:write: Read and write Sites & Design
            courses:read: Read Courses
            courses:write: Read and write Courses
            emails:read: Read Emails
            emails:write: Read and write Emails
            blog:read: Read Blog
            blog:write: Read and write Blog
            community:read: Read Community
            community:write: Read and write Community
            appointments:read: Read Appointments
            appointments:write: Read and write Appointments
            opportunities:read: Read Opportunities
            opportunities:write: Read and write Opportunities
            store:read: Read Store
            store:write: Read and write Store
            forms:read: Read Forms
            forms:write: Read and write Forms
            media:read: Read Media
            media:write: Read and write Media
            webhooks:read: Read Webhooks
            webhooks:write: Read and write Webhooks
            account:read: Read Account
            account:write: Read and write Account
            reference:read: Read Reference Data
            reference:write: Read and write Reference Data
externalDocs:
  description: More in-depth guides and further resources
  url: https://developers.myclickfunnels.com
x-provenance:
  method: harvested
  publisher: ClickFunnels
  source: https://accounts.myclickfunnels.com/openapi.json
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)