Optimizely

Optimizely Subscription Products API

The Subscription Products API from Optimizely — 5 operation(s) for subscription products.

GitHub OpenAPI

Operations 9

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /api/v1/admin/SubscriptionProducts List subscription products · Returns the EntitySet SubscriptionProducts #
Ask an LLM
“Which products are bundled into my subscription products?”
“Can I filter subscription products by their parent product?”
Tell an agent
List all subscription products.
Find subscription products matching {filter}.
POST /api/v1/admin/SubscriptionProducts Add a product to a subscription · Post a new entity to EntitySet SubscriptionProducts #
Ask an LLM
“How do I add a product to a subscription parent product?”
“Can I set the quantity ordered when adding a product to a subscription?”
Tell an agent
Add product {productId} to subscription parent {parentProductId}.
Create a subscription product for {productId} with quantity {qtyOrdered}.
GET /api/v1/admin/SubscriptionProducts({id}) Get a subscription product by ID · Returns the entity with the key from SubscriptionProducts #
Ask an LLM
“What product and quantity does one subscription product record hold?”
“Can I look up a single subscription product by its ID?”
Tell an agent
Get subscription product {id}.
Show the product and quantity of subscription product {id}.
PUT /api/v1/admin/SubscriptionProducts({id}) Replace a subscription product · Replace entity in EntitySet SubscriptionProducts #
Ask an LLM
“Can I overwrite a whole subscription product record at once?”
“What happens to omitted fields on a full replace of a subscription product?”
Tell an agent
Replace subscription product {id} with product {productId}, parent {parentProductId}, quantity {qtyOrdered}.
Overwrite the entire subscription product {id} using a full PUT.
DELETE /api/v1/admin/SubscriptionProducts({id}) Remove a product from a subscription · Delete entity in EntitySet SubscriptionProducts #
Ask an LLM
“How do I take a product out of a subscription?”
“Does deleting a subscription product accept an If-Match ETag?”
Tell an agent destructive · confirm first
Delete subscription product {id}.
Delete subscription product {id} only if its ETag matches {ifMatch}.
PATCH /api/v1/admin/SubscriptionProducts({id}) Update a subscription product · Update entity in EntitySet SubscriptionProducts #
Ask an LLM
“How do I change the quantity of a product inside a subscription?”
“Can I swap the product on an existing subscription product record?”
Tell an agent
Change the quantity of subscription product {id} to {qtyOrdered}.
Swap subscription product {id} to product {productId}.
GET /api/v1/admin/SubscriptionProducts/Default.Default() Get a default subscription product template · Call operation Default #
Ask an LLM
“What default values does a new subscription product start with?”
“Is there a blank subscription product template to fetch first?”
Tell an agent
Fetch the default subscription product template.
Show me the default values for a new subscription product.
DELETE /api/v1/admin/subscriptionproducts/delete Bulk delete subscription products · Subscription products delete route #
Ask an LLM
“How do I delete several subscription products at once?”
“Can I pass a list of IDs to remove many subscription products?”
Tell an agent destructive · confirm first
Bulk delete the subscription products with IDs {ids}.
Remove all of these subscription products in one call: {ids}.
GET /api/v1/admin/subscriptionproducts({key})/customproperties({custompropertyKey}) Get a custom property on a subscription product · Subscription products get custom property by key and custompropertykey #
Ask an LLM
“Where do I read a custom property stored on a subscription product?”
“Can I fetch one extra property value from a subscription product?”
Tell an agent
Get custom property {custompropertyKey} on subscription product {key}.
Show the custom property {custompropertyKey} of subscription product {key}.

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/optimizely/refs/heads/main/openapi/optimizely-subscription-products-api-openapi.yml

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/optimizely:optimizely-subscription-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

optimizely-subscription-products-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  version: admin-v1
  title: Admin API V1 Subscription Products API
servers:
- url: https://dogfood.commerce.insitesandbox.com
security: []
tags:
- name: Subscription Products
paths:
  /api/v1/admin/SubscriptionProducts:
    get:
      tags:
      - Subscription Products
      summary: Returns the EntitySet SubscriptionProducts
      operationId: SubscriptionProducts_Get
      parameters:
      - name: $expand
        in: query
        description: Expands related entities inline.
        required: false
        schema:
          type: string
      - name: $filter
        in: query
        description: Filters the results, based on a Boolean condition.
        required: false
        schema:
          type: string
      - name: $select
        in: query
        description: Selects which properties to include in the response.
        required: false
        schema:
          type: string
      - name: $apply
        in: query
        description: Aggregates the results according to one or more transformations.
        required: false
        schema:
          type: string
      - name: $orderby
        in: query
        description: Sorts the results.
        required: false
        schema:
          type: string
      - name: $top
        in: query
        description: Returns only the first n results.
        required: false
        schema:
          type: integer
          format: int32
      - name: $skip
        in: query
        description: Skips the first n results.
        required: false
        schema:
          type: integer
          format: int32
      - name: $count
        in: query
        description: Includes a count of the matching results in the response.
        required: false
        schema:
          type: boolean
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
    post:
      tags:
      - Subscription Products
      summary: Post a new entity to EntitySet SubscriptionProducts
      operationId: SubscriptionProducts_Post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Insite.Data.Entities.SubscriptionProduct'
        description: The entity to post
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/SubscriptionProducts({id}):
    get:
      tags:
      - Subscription Products
      summary: Returns the entity with the key from SubscriptionProducts
      operationId: SubscriptionProducts_GetById
      parameters:
      - name: id
        in: path
        description: 'key: id'
        required: true
        schema:
          type: string
          format: uuid
      - name: $expand
        in: query
        description: Expands related entities inline.
        required: false
        schema:
          type: string
      - name: $select
        in: query
        description: Selects which properties to include in the response.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
    put:
      tags:
      - Subscription Products
      summary: Replace entity in EntitySet SubscriptionProducts
      operationId: SubscriptionProducts_PutById
      parameters:
      - name: id
        in: path
        description: 'key: id'
        required: true
        schema:
          type: string
          format: uuid
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Insite.Data.Entities.SubscriptionProduct'
        description: The entity to put
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
    delete:
      tags:
      - Subscription Products
      summary: Delete entity in EntitySet SubscriptionProducts
      operationId: SubscriptionProducts_DeleteById
      parameters:
      - name: id
        in: path
        description: 'key: id'
        required: true
        schema:
          type: string
          format: uuid
      - name: If-Match
        in: header
        description: If-Match header
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
    patch:
      tags:
      - Subscription Products
      summary: Update entity in EntitySet SubscriptionProducts
      operationId: SubscriptionProducts_PatchById
      parameters:
      - name: id
        in: path
        description: 'key: id'
        required: true
        schema:
          type: string
          format: uuid
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Insite.Data.Entities.SubscriptionProduct'
        description: The entity to patch
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/SubscriptionProducts/Default.Default():
    get:
      tags:
      - Subscription Products
      summary: Call operation Default
      operationId: SubscriptionProducts_Default
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/subscriptionproducts/delete:
    delete:
      tags:
      - Subscription Products
      operationId: SubscriptionProducts_DeleteRoute
      parameters:
      - name: ids
        in: query
        required: true
        explode: true
        schema:
          type: array
          items:
            type: string
            format: uuid
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
      summary: Subscription products delete route
      x-summary-source: derived
  /api/v1/admin/subscriptionproducts({key})/customproperties({custompropertyKey}):
    get:
      tags:
      - Subscription Products
      operationId: SubscriptionProducts_GetCustomPropertyByKeyAndCustompropertykey
      parameters:
      - name: key
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: custompropertyKey
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: $expand
        in: query
        description: Expands related entities inline.
        required: false
        schema:
          type: string
      - name: $select
        in: query
        description: Selects which properties to include in the response.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
      summary: Subscription products get custom property by key and custompropertykey
      x-summary-source: derived
components:
  schemas:
    Insite.Data.Entities.SubscriptionProduct:
      type: object
      properties:
        id:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        productId:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        parentProductId:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        qtyOrdered:
          format: decimal
          type: number
        createdOn:
          format: date-time
          type: string
        createdBy:
          type: string
        modifiedOn:
          format: date-time
          type: string
        modifiedBy:
          type: string
  securitySchemes:
    access_token:
      type: apiKey
      description: Token used to access storefront API.
      name: access_token
      in: query