Optimizely

Optimizely User Payment Profiles API

The User Payment Profiles API from Optimizely — 5 operation(s) for user payment profiles.

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/UserPaymentProfiles List saved customer payment cards · Returns the EntitySet UserPaymentProfiles #
Ask an LLM
“How can I see the saved payment cards on file for storefront users?”
“Can I filter saved payment profiles to one user profile?”
Tell an agent
List all user payment profiles.
Show saved payment profiles matching {filter}.
POST /api/v1/admin/UserPaymentProfiles Save a payment card to a user profile · Post a new entity to EntitySet UserPaymentProfiles #
Ask an LLM
“What card and billing address details are needed to save a payment profile?”
“Can I make a newly saved card the user's default?”
Tell an agent
Save a {cardType} card for {cardHolderName} ending in {maskedCardNumber} to user profile {userProfileId}.
Add a payment profile with token {cardIdentifier} expiring {expirationDate}.
GET /api/v1/admin/UserPaymentProfiles({id}) Get one saved payment profile · Returns the entity with the key from UserPaymentProfiles #
Ask an LLM
“How do I look up one saved card by its payment profile id?”
“What billing address is stored on a saved payment profile?”
Tell an agent
Fetch user payment profile {id}.
Show the card and billing details on payment profile {id}.
PUT /api/v1/admin/UserPaymentProfiles({id}) Replace a saved payment profile · Replace entity in EntitySet UserPaymentProfiles #
Ask an LLM
“Can I overwrite every field of a saved card record at once?”
“Does replacing a payment profile require the full billing address again?”
Tell an agent
Replace payment profile {id} with card holder {cardHolderName} and postal code {postalCode}.
Overwrite the full saved card record {id}.
DELETE /api/v1/admin/UserPaymentProfiles({id}) Remove a saved payment card · Delete entity in EntitySet UserPaymentProfiles #
Ask an LLM
“How do I remove one saved card from a customer's account?”
“Can I delete a payment profile only if it hasn't been changed?”
Tell an agent destructive · confirm first
Delete payment profile {id}.
Remove saved card {id} if its ETag is {etag}.
PATCH /api/v1/admin/UserPaymentProfiles({id}) Update a saved card's expiry or default flag · Update entity in EntitySet UserPaymentProfiles #
Ask an LLM
“Can I update just the expiration date on a saved card?”
“Is there a way to set an existing saved card as the default?”
Tell an agent
Change the expiration date of payment profile {id} to {expirationDate}.
Set the default flag on payment profile {id} to {isDefault}.
GET /api/v1/admin/UserPaymentProfiles/Default.Default() Get default values for a new payment profile · Call operation Default #
Ask an LLM
“What defaults does a new user payment profile start with?”
“Is there a blank payment profile template?”
Tell an agent
Get the default values for a new user payment profile.
Show the empty payment profile record.
DELETE /api/v1/admin/userpaymentprofiles/delete Delete several saved payment profiles · User payment profiles delete route #
Ask an LLM
“How do I bulk delete saved payment cards?”
“Can I remove multiple payment profiles by id at once?”
Tell an agent destructive · confirm first
Bulk delete user payment profiles {ids}.
Permanently delete every saved card in {ids}.
GET /api/v1/admin/userpaymentprofiles({key})/customproperties({custompropertyKey}) Get a custom property on a payment profile · User payment profiles get custom property by key and custompropertykey #
Ask an LLM
“How do I read a custom property on a saved payment profile?”
“Can I fetch one custom field from a user payment profile?”
Tell an agent
Get custom property {custompropertyKey} of payment profile {key}.
Show the {custompropertyKey} custom property on user payment profile {key}.

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/optimizely/refs/heads/main/openapi/optimizely-user-payment-profiles-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-user-payment-profiles-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-user-payment-profiles-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  version: admin-v1
  title: Admin API V1 User Payment Profiles API
servers:
- url: https://dogfood.commerce.insitesandbox.com
security: []
tags:
- name: User Payment Profiles
paths:
  /api/v1/admin/UserPaymentProfiles:
    get:
      tags:
      - User Payment Profiles
      summary: Returns the EntitySet UserPaymentProfiles
      operationId: UserPaymentProfiles_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:
      - User Payment Profiles
      summary: Post a new entity to EntitySet UserPaymentProfiles
      operationId: UserPaymentProfiles_Post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Insite.Data.Entities.UserPaymentProfile'
        description: The entity to post
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/UserPaymentProfiles({id}):
    get:
      tags:
      - User Payment Profiles
      summary: Returns the entity with the key from UserPaymentProfiles
      operationId: UserPaymentProfiles_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:
      - User Payment Profiles
      summary: Replace entity in EntitySet UserPaymentProfiles
      operationId: UserPaymentProfiles_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.UserPaymentProfile'
        description: The entity to put
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
    delete:
      tags:
      - User Payment Profiles
      summary: Delete entity in EntitySet UserPaymentProfiles
      operationId: UserPaymentProfiles_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:
      - User Payment Profiles
      summary: Update entity in EntitySet UserPaymentProfiles
      operationId: UserPaymentProfiles_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.UserPaymentProfile'
        description: The entity to patch
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/UserPaymentProfiles/Default.Default():
    get:
      tags:
      - User Payment Profiles
      summary: Call operation Default
      operationId: UserPaymentProfiles_Default
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/userpaymentprofiles/delete:
    delete:
      tags:
      - User Payment Profiles
      operationId: UserPaymentProfiles_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: User payment profiles delete route
      x-summary-source: derived
  /api/v1/admin/userpaymentprofiles({key})/customproperties({custompropertyKey}):
    get:
      tags:
      - User Payment Profiles
      operationId: UserPaymentProfiles_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: User payment profiles get custom property by key and custompropertykey
      x-summary-source: derived
components:
  schemas:
    Insite.Data.Entities.UserPaymentProfile:
      required:
      - description
      - cardType
      - expirationDate
      - maskedCardNumber
      - cardIdentifier
      - cardHolderName
      - address1
      - address2
      - address3
      - address4
      - city
      - state
      - postalCode
      - country
      - tokenScheme
      - accountIdentifier
      type: object
      properties:
        id:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        userProfileId:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        description:
          maxLength: 100
          minLength: 0
          type: string
        cardType:
          maxLength: 50
          minLength: 0
          type: string
        expirationDate:
          maxLength: 50
          minLength: 0
          type: string
        maskedCardNumber:
          maxLength: 50
          minLength: 0
          type: string
        cardIdentifier:
          maxLength: 50
          minLength: 0
          type: string
        cardHolderName:
          maxLength: 50
          minLength: 0
          type: string
        address1:
          maxLength: 100
          minLength: 0
          type: string
        address2:
          maxLength: 100
          minLength: 0
          type: string
        address3:
          maxLength: 100
          minLength: 0
          type: string
        address4:
          maxLength: 100
          minLength: 0
          type: string
        city:
          maxLength: 100
          minLength: 0
          type: string
        state:
          maxLength: 50
          minLength: 0
          type: string
        postalCode:
          maxLength: 50
          minLength: 0
          type: string
        country:
          maxLength: 100
          minLength: 0
          type: string
        isDefault:
          type: boolean
        tokenScheme:
          maxLength: 50
          minLength: 0
          type: string
        accountIdentifier:
          maxLength: 200
          minLength: 0
          type: string
        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