Every API here is available over the APIs.io API and to AI agents over MCP.
openapi: 3.2.0
info:
x-ibm-name: consumer
version: 2.0.0
title: IBM API Connect Platform - Consumer Billing Management API
description: This API provides operations for accessing API consumer content
termsOfService: https://www.ibm.com/legal
contact:
name: IBM
url: https://www.ibm.com
email: help@ibm.com
license:
name: tbd
url: https://tbd.com
servers:
- url: ''
description: Consumer apim base path
tags:
- name: Billing Management
paths:
/payment-method-types:
description: The collection of Payment Method Type operations
get:
summary: List the Payment Method Type objects
operationId: payment_method_type_list
security:
- oauth:
- org:view
parameters:
- $ref: '#/components/parameters/fields'
- $ref: '#/components/parameters/offset'
- $ref: '#/components/parameters/limit'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/PaymentMethodTypeList'
application/yaml:
schema:
$ref: '#/components/schemas/PaymentMethodTypeList'
4XX:
$ref: '#/components/responses/Error'
5XX:
$ref: '#/components/responses/Error'
tags:
- Billing Management
/payment-method-types/{payment-method-type}:
description: Payment Method Type object operations
parameters:
- $ref: '#/components/parameters/payment-method-type'
get:
summary: Get the Payment Method Type object by name or id
operationId: payment_method_type_get
security:
- oauth:
- org:view
parameters:
- $ref: '#/components/parameters/fields'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/PaymentMethodType'
application/yaml:
schema:
$ref: '#/components/schemas/PaymentMethodType'
4XX:
$ref: '#/components/responses/Error'
5XX:
$ref: '#/components/responses/Error'
tags:
- Billing Management
components:
schemas:
Error:
type: object
additionalProperties: false
properties:
status:
type: integer
minimum: 400
maximum: 599
message:
type: array
items:
type: string
errors:
type: array
items:
type: string
PaymentMethodType:
type: object
additionalProperties: false
properties:
type:
type: string
readOnly: true
enum:
- payment_method_type
api_version:
type: string
readOnly: true
enum:
- 2.0.0
id:
type: string
readOnly: true
name:
type: string
maxLength: 255
title:
type: string
maxLength: 1023
summary:
type: string
maxLength: 65535
state:
type: string
enum:
- enabled
- disabled
integration:
$ref: '#/components/schemas/IntegrationDocument'
metadata:
type: object
additionalProperties:
type: string
created_at:
type: string
format: date-time
readOnly: true
updated_at:
type: string
format: date-time
readOnly: true
url:
type: string
readOnly: true
format: uri
InfoSection:
type: object
additionalProperties: false
required:
- title
- version
properties:
name:
type: string
version:
type: string
title:
type: string
description:
type: string
summary:
type: string
termsOfService:
type: string
contact:
type: object
additionalProperties: false
properties:
name:
type: string
url:
type: string
format: uri
email:
type: string
format: email
license:
type: object
additionalProperties: false
required:
- name
properties:
name:
type: string
url:
type: string
format: uri
x-ibm-languages:
type: object
additionalProperties: true
PaymentMethodTypeList:
type: object
additionalProperties: false
properties:
total_results:
type: integer
results:
type: array
items:
$ref: '#/components/schemas/PaymentMethodType'
IntegrationDocument:
type: object
additionalProperties: true
required:
- integration
- info
properties:
integration:
type: string
enum:
- 1.0.0
info:
$ref: '#/components/schemas/InfoSection'
configuration_schema:
type: object
additionalProperties: true
parameters:
limit:
name: limit
in: query
description: Maximum number of items to return
required: false
schema:
type: integer
fields:
name: fields
in: query
description: field name
required: false
schema:
type: string
payment-method-type:
name: payment-method-type
in: path
description: Payment Method Type name or id
required: true
schema:
type: string
offset:
name: offset
in: query
description: Offset item number from list to begin return
required: false
schema:
type: integer
responses:
Error:
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
application/yaml:
schema:
$ref: '#/components/schemas/Error'
securitySchemes:
oauth:
type: oauth2
flows:
password:
tokenUrl: /token
refreshUrl: /token
scopes:
app:manage: Create a Application object, Clear the Application objects, Update the Application object by name or id, Delete the Application object by name or id, Create a Application Credential object, Clear the Application Credential objects, Update the Application Credential object by name or id, Delete the Application Credential object by name or id, Create a Subscription object, Clear the Subscription objects, Update the Subscription object by name or id, Delete the Subscription object by name or id
app:view: List the Application objects, Get the Application object by name or id, List the Application Credential objects, Get the Application Credential object by name or id, List the Subscription objects, Get the Subscription object by name or id
my:manage: Update the Me object, Delete the Me object
my:view: Get the Me object, List the My Permission objects, List the My Organization objects
org:manage: Create a My Organization object, Update the Organization object by name or id, Delete the Organization object by name or id, Create a Member Invitation object, Clear the Member Invitation objects, Delete the Member Invitation object by name or id, Clear the Member objects, Update the Member object by name or id, Delete the Member object by name or id, Create a Payment Method object, Update the Payment Method object by name or id, Delete the Payment Method object by name or id
org:view: List all Permission objects in all collections, Get the Organization object by name or id, Get the Group object by name or id, List the Member Invitation objects, Get the Member Invitation object by name or id, List the User Registry objects, Get the User Registry object by name or id, Get the User object by name or id, List the Associate objects, Get the Associate object by name or id, List the Member objects, Get the Member object by name or id, List the Role objects, Get the Role object by name or id, Get the Billing object by name or id, List the Billing objects, List the Payment Method objects, Get the Payment Method object by name or id, List the Payment Method Type objects, Get the Payment Method Type object by name or id
authorizationCode:
authorizationUrl: /oauth2/authorize
tokenUrl: /token
refreshUrl: /token
scopes:
app:manage: Create a Application object, Clear the Application objects, Update the Application object by name or id, Delete the Application object by name or id, Create a Application Credential object, Clear the Application Credential objects, Update the Application Credential object by name or id, Delete the Application Credential object by name or id, Create a Subscription object, Clear the Subscription objects, Update the Subscription object by name or id, Delete the Subscription object by name or id
app:view: List the Application objects, Get the Application object by name or id, List the Application Credential objects, Get the Application Credential object by name or id, List the Subscription objects, Get the Subscription object by name or id
my:manage: Update the Me object, Delete the Me object
my:view: Get the Me object, List the My Permission objects, List the My Organization objects
org:manage: Create a My Organization object, Update the Organization object by name or id, Delete the Organization object by name or id, Create a Member Invitation object, Clear the Member Invitation objects, Delete the Member Invitation object by name or id, Clear the Member objects, Update the Member object by name or id, Delete the Member object by name or id, Create a Payment Method object, Update the Payment Method object by name or id, Delete the Payment Method object by name or id
org:view: List all Permission objects in all collections, Get the Organization object by name or id, Get the Group object by name or id, List the Member Invitation objects, Get the Member Invitation object by name or id, List the User Registry objects, Get the User Registry object by name or id, Get the User object by name or id, List the Associate objects, Get the Associate object by name or id, List the Member objects, Get the Member object by name or id, List the Role objects, Get the Role object by name or id, Get the Billing object by name or id, List the Billing objects, List the Payment Method objects, Get the Payment Method object by name or id, List the Payment Method Type objects, Get the Payment Method Type object by name or id
x-ibm-configuration:
testable: false