Skip to content

Marketplace Plan Components

Operations Summary

Method Endpoint Description
GET /api/marketplace-plan-components/ List plan components
GET /api/marketplace-plan-components/{id}/ Retrieve a plan component

List plan components

Returns a paginated list of all plan components. A plan component defines the pricing and quotas for an offering component within a billing plan. The list is filtered based on the current user's access permissions and organization group memberships.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-plan-components/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_plan_components import marketplace_plan_components_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_plan_components_list.sync(client=client)

for item in response:
    print(item)
  1. API Source: marketplace_plan_components_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { marketplacePlanComponentsList } from 'waldur-js-client';

try {
  const response = await marketplacePlanComponentsList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
archived boolean Archived
offering_uuid string (uuid) Offering UUID
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
plan_uuid string (uuid) Plan UUID
shared boolean Shared

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
offering_name string
plan_name string
plan_unit any
component_name string Display name for the measured unit, for example, Floating IP.
measured_unit string Unit of measurement, for example, GB.
billing_type any
amount integer
price string (decimal)
future_price string (decimal)
discount_threshold integer Minimum amount to be eligible for discount.
discount_rate integer Discount rate in percentage.

Retrieve a plan component

Returns the details of a specific plan component, including its pricing, quotas, and associated offering and plan information.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-plan-components/123/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_plan_components import marketplace_plan_components_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_plan_components_retrieve.sync(
    id=123,
    client=client
)

print(response)
  1. API Source: marketplace_plan_components_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplacePlanComponentsRetrieve } from 'waldur-js-client';

try {
  const response = await marketplacePlanComponentsRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "id": 123
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required Description
id integer ✓ A unique integer value identifying this plan component.

200 -

Field Type Description
offering_name string
plan_name string
plan_unit any
component_name string Display name for the measured unit, for example, Floating IP.
measured_unit string Unit of measurement, for example, GB.
billing_type any
amount integer
price string (decimal)
future_price string (decimal)
discount_threshold integer Minimum amount to be eligible for discount.
discount_rate integer Discount rate in percentage.