Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Kaltura householdPaymentMethod API

The householdPaymentMethod API from Kaltura — 5 operation(s) for householdpaymentmethod.

Kaltura householdPaymentMethod API is one of 222 APIs that Kaltura publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include householdPaymentMethod. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, and a getting-started guide.

This API exposes 5 operations across 5 paths, and defines 4 schemas. It is described by OpenAPI 2.0, at version 3.6.287.20720.

Requests are made against the base URL https://www.kaltura.com/api_v3.

5 operations 5 paths 4 schemas 5 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 2.0
API Version
3.6.287.20720
Base URL
https://www.kaltura.com/api_v3
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Kaltura householdPaymentMethod API declares 1 security scheme for authenticating requests. An API key is passed in the body as ks (ks). By default, every request must be authenticated.

  • ks — A Kaltura session ID

Paths & Operations 5

Across 5 paths, the API surfaces 5 operations — 5 POST. Each is listed below with its method, path, parameters, and response codes.

householdPaymentMethod 5
POST
/service/householdpaymentmethod/action/add
Add a new payment method for household
householdPaymentMethod.add 1 param → 200x-Errors
POST
/service/householdpaymentmethod/action/forceRemove
Force remove of a payment method of the household.
householdPaymentMethod.forceRemove 1 param → 200x-Errors
POST
/service/householdpaymentmethod/action/list
Get a list of all payment methods of the household.
householdPaymentMethod.list 1 param → 200x-Errors
POST
/service/householdpaymentmethod/action/remove
Removes a payment method of the household.
householdPaymentMethod.remove 1 param → 200x-Errors
POST
/service/householdpaymentmethod/action/setAsDefault
Set a payment method as default for the household.
householdPaymentMethod.setAsDefault 1 param → 200x-Errors

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are KalturaHouseholdPaymentMethod (6 properties), OTTRequest (2 properties), KalturaHouseholdPaymentMethodListResponse (1 property), KalturaListResponse (1 property). Each schema is shown below with its type and property counts.

KalturaListResponse
object
Base list wrapper
1 property
KalturaHouseholdPaymentMethodListResponse
object
List of household payment methods.
1 property
KalturaHouseholdPaymentMethod
object
6 properties
OTTRequest
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kaltura-householdpaymentmethod-api-openapi.yml Raw ↑

Other APIs Kaltura publishes across the network.

Kaltura accessControl API
Kaltura accessControlProfile API
Kaltura adminUser API
Kaltura analytics API
Kaltura annotation API
Kaltura announcement API
Kaltura appToken API
Kaltura aspera API
Kaltura asset API
Kaltura assetComment API
Kaltura assetFile API
Kaltura assetHistory API