openapi: 3.2.0 info: title: ClickFunnels Products::Price 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. ' 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: [] tags: - name: Products::Price description: Product Prices paths: /products/{product_id}/prices: get: tags: - Products::Price summary: List Prices description: List all prices for a given product. This will include all prices for all variants of the product. You can also filter by variant_id to get prices for a specific variant. operationId: listProductsPrices parameters: - name: product_id in: path required: true schema: type: string - $ref: '#/components/parameters/after' - $ref: '#/components/parameters/sort_order' - $ref: '#/components/parameters/sort_property' - name: filter in: query description: 'Filter by available properties in query params, like this: `api/v2/resources?filter[id]=value&filter[another_property]=value1,value2`. Check our Filtering guide for examples and all about filtering [here](https://developers.myclickfunnels.com/docs/filtering). ' required: false schema: type: object properties: id: type: string description: A comma-separated list of price IDs to filter by. example: 1,2,3 variant_id: type: string description: A comma-separated list of variant IDs to filter by. example: 1,2,3 visible: type: boolean description: Filter prices by visibility in the online store. example: true enum: - true - false archived: type: boolean description: Filter prices by archived state. example: true enum: - true - false style: deepObject explode: true responses: '200': description: OK headers: Pagination-Next: $ref: '#/components/headers/PaginationNext' Link: $ref: '#/components/headers/Link' content: application/json: schema: type: array items: $ref: '#/components/schemas/ProductsPriceAttributes' example: - id: 75 public_id: pLYvIn variant_id: 76 name: Example Price amount: '100.00' cost: '0.00' currency: USD duration: null interval: null trial_interval: null trial_duration: null trial_amount: '0.00' setup_amount: null self_cancel: true self_upgrade: true self_downgrade: true self_reactivate: true interval_count: null payment_type: one_time visible: true compare_at_amount: null key: null archived: false created_at: '2025-01-01T00:00:00.000Z' updated_at: '2025-01-01T00:00:00.000Z' - id: 76 public_id: eOSRMy variant_id: 77 name: Example Price amount: '100.00' cost: '0.00' currency: USD duration: null interval: null trial_interval: null trial_duration: null trial_amount: '0.00' setup_amount: null self_cancel: true self_upgrade: true self_downgrade: true self_reactivate: true interval_count: null payment_type: one_time visible: true compare_at_amount: null key: null archived: false created_at: '2025-01-01T00:00:00.000Z' updated_at: '2025-01-01T00:00:00.000Z' '401': description: Unauthorized content: application/json: schema: type: object properties: error: type: string example: error: API key missing or invalid '404': description: Not Found content: application/json: schema: type: object properties: error: type: string description: Not found - This usually happens when you try to access a record that does not exist in your account. It can also happen when the provided parent record is missing, e.g. you have put in a non-existent Workspaces parent ID. example: error: 'Not found: Record missing' /products/prices/{id}: get: tags: - Products::Price summary: Fetch Price description: Retrieve a single price operationId: getProductsPrices parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ProductsPriceAttributes' example: id: 77 public_id: UGpQZc variant_id: 78 name: Example Price amount: '100.00' cost: '0.00' currency: USD duration: null interval: null trial_interval: null trial_duration: null trial_amount: '0.00' setup_amount: null self_cancel: true self_upgrade: true self_downgrade: true self_reactivate: true interval_count: null payment_type: one_time visible: true compare_at_amount: null key: null archived: false created_at: '2025-01-01T00:00:00.000Z' updated_at: '2025-01-01T00:00:00.000Z' '401': description: Unauthorized content: application/json: schema: type: object properties: error: type: string example: error: API key missing or invalid '404': description: Not Found content: application/json: schema: type: object properties: error: type: string example: error: 'Not found: Record missing' put: tags: - Products::Price summary: Update Price description: Update a single price operationId: updateProductsPrices parameters: - $ref: '#/components/parameters/id' requestBody: description: Information about updated fields in Price required: true content: application/json: schema: type: object properties: products_price: type: object $ref: '#/components/schemas/ProductsPriceParametersUpdate' example: products_price: name: Example Price amount: '100.00' cost: '0.00' currency: USD duration: 1 interval: months trial_interval: days trial_duration: 14 trial_amount: '0.00' setup_amount: null self_cancel: true self_upgrade: true self_downgrade: true self_reactivate: true interval_count: 1 payment_type: one_time visible: true compare_at_amount: null key: null archived: false responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ProductsPriceAttributes' example: id: 78 public_id: lbeLiS variant_id: 79 name: Example Price amount: '100.00' cost: '0.00' currency: USD duration: null interval: null trial_interval: null trial_duration: null trial_amount: '0.00' setup_amount: null self_cancel: true self_upgrade: true self_downgrade: true self_reactivate: true interval_count: null payment_type: one_time visible: true compare_at_amount: null key: null archived: false created_at: '2025-01-01T00:00:00.000Z' updated_at: '2025-01-01T00:00:00.000Z' '400': description: Bad Request content: application/json: schema: type: object properties: error: type: string example: error: 'Bad request: HTTP body must be valid JSON' '401': description: Unauthorized content: application/json: schema: type: object properties: error: type: string example: error: API key missing or invalid '404': description: Not Found content: application/json: schema: type: object properties: error: type: string example: error: 'Not found: Record missing' /products/variants/{variant_id}/prices: post: tags: - Products::Price summary: Create Price description: 'Create a new price for a given variant. Note that you must set a `variant_id` in the path. ' operationId: createProductsPrices parameters: - name: variant_id in: path required: true schema: type: string requestBody: description: Information about a new Price required: true content: application/json: schema: type: object properties: products_price: type: object $ref: '#/components/schemas/ProductsPriceParameters' example: products_price: name: Example Price amount: '100.00' cost: '0.00' currency: USD duration: null interval: null trial_interval: null trial_duration: null trial_amount: '0.00' setup_amount: null self_cancel: true self_upgrade: true self_downgrade: true self_reactivate: true interval_count: null payment_type: one_time visible: true compare_at_amount: null key: null archived: false responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/ProductsPriceAttributes' example: id: 14 public_id: WpEGzF variant_id: 14 name: Example Price amount: '100.00' cost: '0.00' currency: USD duration: null interval: null trial_interval: null trial_duration: null trial_amount: '0.00' setup_amount: null self_cancel: true self_upgrade: true self_downgrade: true self_reactivate: true interval_count: null payment_type: one_time visible: true compare_at_amount: null key: null archived: false created_at: '2025-01-01T00:00:00.000Z' updated_at: '2025-01-01T00:00:00.000Z' '400': description: Bad Request content: application/json: schema: type: object properties: error: type: string example: error: 'Bad request: HTTP body must be valid JSON' '401': description: Unauthorized content: application/json: schema: type: object properties: error: type: string example: error: API key missing or invalid '422': description: Unprocessable Entity - validation failed content: application/json: schema: type: object properties: error: type: string examples: singular_interval: summary: interval given in the singular value: error: 'Request unprocessable: Interval is not included in the list' missing_amount: summary: no amount on the price value: error: 'Request unprocessable: Amount can''t be blank; Amount is not a number' components: parameters: id: name: id in: path required: true schema: type: string sort_property: name: sort_property in: query description: 'Sort property of a list response. The default is id and thus the created_at order. If you sort by other properties, we additionally sort by id implicitly as a secondary sort property, so that you can rely on the sort order to be deterministic even if the main sort property ends up with the same values. ' required: false schema: type: string enum: - id - updated_at sort_order: name: sort_order in: query description: Sort order of a list response. Use 'desc' to reverse the default 'asc' (ascending) sort order. Examples [in our guides](https://developers.myclickfunnels.com/docs/pagination). required: false schema: type: string enum: - asc - desc after: name: after in: query required: false schema: type: string description: ID of item after which the collection should be returned. More examples and info about pagination [in our guides](https://developers.myclickfunnels.com/docs/pagination). schemas: ProductsPriceParametersUpdate: type: object title: Prices description: Prices required: [] properties: name: type: - string - 'null' description: Name amount: type: string description: Amount cost: type: - string - 'null' description: Cost currency: type: string description: Currency duration: type: - integer - 'null' description: Duration interval: type: - string - 'null' description: Interval trial_interval: type: - string - 'null' description: Trial interval trial_duration: type: - integer - 'null' description: Trial duration trial_amount: type: - string - 'null' description: Trial amount setup_amount: type: - string - 'null' description: Setup amount self_cancel: type: - boolean - 'null' description: Customer can cancel self_upgrade: type: - boolean - 'null' description: Customer can upgrade self_downgrade: type: - boolean - 'null' description: Customer can downgrade self_reactivate: type: - boolean - 'null' description: Customer can reactivate interval_count: type: - integer - 'null' description: Interval count payment_type: type: - string - 'null' enum: - one_time - subscription - payment_plan - null description: Defaults to 'one_time' if left blank visible: type: - boolean - 'null' description: Visible compare_at_amount: type: - string - 'null' description: Compare at amount key: type: - string - 'null' description: Key archived: type: - boolean - 'null' description: Archived example: products_price: name: Example Price amount: '100.00' cost: '0.00' currency: USD duration: 1 interval: months trial_interval: days trial_duration: 14 trial_amount: '0.00' setup_amount: null self_cancel: true self_upgrade: true self_downgrade: true self_reactivate: true interval_count: 1 payment_type: one_time visible: true compare_at_amount: null key: null archived: false ProductsPriceAttributes: type: object title: Prices description: Prices properties: id: type: integer description: ID public_id: type: - string - 'null' description: Price public ID variant_id: type: - integer - 'null' description: Variant name: type: - string - 'null' description: Name amount: type: string description: Amount cost: type: - string - 'null' description: Cost currency: type: string description: Currency duration: type: - integer - 'null' description: Duration interval: type: - string - 'null' description: Interval trial_interval: type: - string - 'null' description: Trial interval trial_duration: type: - integer - 'null' description: Trial duration trial_amount: type: string description: Trial Amount setup_amount: type: - string - 'null' description: Setup amount self_cancel: type: - boolean - 'null' description: Customer can cancel self_upgrade: type: - boolean - 'null' description: Customer can upgrade self_downgrade: type: - boolean - 'null' description: Customer can downgrade self_reactivate: type: - boolean - 'null' description: Customer can reactivate interval_count: type: - integer - 'null' description: Interval count payment_type: type: - string - 'null' enum: - one_time - subscription - payment_plan - null description: Defaults to 'one_time' if left blank visible: type: - boolean - 'null' description: Visible compare_at_amount: type: - string - 'null' description: Compare at amount key: type: - string - 'null' description: Key archived: type: - boolean - 'null' description: Archived created_at: type: - string - 'null' format: date-time description: Added updated_at: type: - string - 'null' format: date-time description: Updated example: id: 14 public_id: WpEGzF variant_id: 14 name: Example Price amount: '100.00' cost: '0.00' currency: USD duration: null interval: null trial_interval: null trial_duration: null trial_amount: '0.00' setup_amount: null self_cancel: true self_upgrade: true self_downgrade: true self_reactivate: true interval_count: null payment_type: one_time visible: true compare_at_amount: null key: null archived: false created_at: '2025-01-01T00:00:00.000Z' updated_at: '2025-01-01T00:00:00.000Z' required: - amount - archived - compare_at_amount - cost - created_at - currency - duration - id - interval - interval_count - key - name - payment_type - public_id - self_cancel - self_downgrade - self_reactivate - self_upgrade - setup_amount - trial_amount - trial_duration - trial_interval - updated_at - variant_id - visible ProductsPriceParameters: type: object title: Prices description: Prices required: - amount - currency - duration - interval - trial_interval - trial_duration - trial_amount - interval_count properties: name: type: - string - 'null' description: Name amount: type: string description: Amount cost: type: - string - 'null' description: Cost currency: type: string description: Currency duration: type: integer description: Duration interval: type: string description: Interval trial_interval: type: string description: Trial interval trial_duration: type: integer description: Trial duration trial_amount: type: string description: Trial Amount setup_amount: type: - string - 'null' description: Setup amount self_cancel: type: - boolean - 'null' description: Customer can cancel self_upgrade: type: - boolean - 'null' description: Customer can upgrade self_downgrade: type: - boolean - 'null' description: Customer can downgrade self_reactivate: type: - boolean - 'null' description: Customer can reactivate interval_count: type: integer description: Interval count payment_type: type: - string - 'null' enum: - one_time - subscription - payment_plan - null description: Defaults to 'one_time' if left blank visible: type: - boolean - 'null' description: Visible compare_at_amount: type: - string - 'null' description: Compare at amount key: type: - string - 'null' description: Key archived: type: - boolean - 'null' description: Archived example: products_price: name: Example Price amount: '100.00' cost: '0.00' currency: USD duration: null interval: null trial_interval: null trial_duration: null trial_amount: '0.00' setup_amount: null self_cancel: true self_upgrade: true self_downgrade: true self_reactivate: true interval_count: null payment_type: one_time visible: true compare_at_amount: null key: null archived: false headers: Link: description: A direct link to the next page for the cursor-based pagination. It includes the `after` and the Pagination-Next ID value. schema: type: string PaginationNext: description: ID of the last item in the current response after which more records exist. You can use it in an `after` query parameter for cursor-based pagination to get to the next page. schema: type: string securitySchemes: BearerAuth: type: http scheme: bearer externalDocs: description: More in-depth guides and further resources url: https://developers.myclickfunnels.com