# Maxio Components API

**Canonical:** https://apis.io/apis/maxio/maxio-components-api/  
**Provider:** Maxio — https://apis.io/providers/maxio/  
**Base URL:** https://{site}.chargify.com  
**Documentation:** https://developers.maxio.com/

Maxio Components API is one of 42 APIs that [Maxio](https://apis.io/providers/maxio/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. This API exposes 1 JSON Schema definition. Tagged areas include Components. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a getting-started guide, a support channel, authentication docs, and 1 JSON Schema.

The Component object represents an add-on item, such as a metered usage charge, quantity-based feature, or on/off toggle, that can be added to a subscription alongside the subscription's base Product. With the new catalog experience, the UI labels components as Products, while the API keeps the component name. See [Catalog terminology](https://docs.maxio.com/billing/catalog/overview/using-the-new-product-catalog#catalog-terminology). Components belong to a Product Family and are billed according to their pricing scheme and kind. Components can also grant features to subscribers through [Create Component Feature Catalog Item]($e/Component%20Features/createComponentFeature). For more information, see [Understand Products](https://docs.maxio.com/billing/catalog/products/understand-products) and [Hybrid pricing](https://docs.maxio.com/billing/catalog/products/use-product-pricing-schemes#hybrid-pricing).

## Operations (12)

| Method | Path | Summary |
|---|---|---|
| POST | `/product_families/{product_family_id}/metered_components.json` | createMeteredComponent |
| POST | `/product_families/{product_family_id}/quantity_based_components.json` | createQuantityBasedComponent |
| POST | `/product_families/{product_family_id}/on_off_components.json` | createOnOffComponent |
| POST | `/product_families/{product_family_id}/prepaid_usage_components.json` | createPrepaidUsageComponent |
| POST | `/product_families/{product_family_id}/event_based_components.json` | createEventBasedComponent |
| GET | `/components/lookup.json` | findComponent |
| GET | `/product_families/{product_family_id}/components/{component_id}.json` | readComponent |
| PUT | `/product_families/{product_family_id}/components/{component_id}.json` | updateProductFamilyComponent |
| DELETE | `/product_families/{product_family_id}/components/{component_id}.json` | archiveComponent |
| GET | `/components.json` | listComponents |
| PUT | `/components/{component_id}.json` | updateComponent |
| GET | `/product_families/{product_family_id}/components.json` | listComponentsForProductFamily |

## Machine-readable artifacts (7)

- **OpenAPI** — https://artifacts.apis.io/maxio/openapi/maxio-components-api-openapi.yml
- **Documentation** — https://developers.maxio.com/
- **GettingStarted** — https://developers.maxio.com/http/getting-started/how-to-get-started
- **Support** — https://developers.maxio.com/http/help/getting-support
- **Authentication** — https://developers.maxio.com/http/getting-started/authentication
- **API Keys** — https://docs.maxio.com/configuration/advanced-billing/advanced-billing-api-keys
- **JSONSchema** — https://artifacts.apis.io/maxio/json-schema/maxio-component-schema.json

## Other Maxio APIs (12)

- [Maxio Advance Invoice API](https://apis.io/apis/maxio/maxio-advance-invoice-api/)
- [Maxio API Exports API](https://apis.io/apis/maxio/maxio-api-exports-api/)
- [Maxio Billing Portal API](https://apis.io/apis/maxio/maxio-billing-portal-api/)
- [Maxio Component Features API](https://apis.io/apis/maxio/maxio-component-features-api/)
- [Maxio Component: Price Points API](https://apis.io/apis/maxio/maxio-component-price-points-api/)
- [Maxio Coupons API](https://apis.io/apis/maxio/maxio-coupons-api/)
- [Maxio Custom Fields API](https://apis.io/apis/maxio/maxio-custom-fields-api/)
- [Maxio Customers API](https://apis.io/apis/maxio/maxio-customers-api/)
- [Maxio Entitlements API](https://apis.io/apis/maxio/maxio-entitlements-api/)
- [Maxio Events API](https://apis.io/apis/maxio/maxio-events-api/)
- [Maxio Events-Based Billing: Segments API](https://apis.io/apis/maxio/maxio-events-based-billing-segments-api/)
- [Maxio Feature Templates API](https://apis.io/apis/maxio/maxio-feature-templates-api/)

## Tags

Components

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/maxio/maxio-components-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/maxio/.