# Maxio Subscription Components API

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

Maxio Subscription 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 Subscription 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.

Use the Subscription Components object to allocate, adjust, and report usage for the components attached to a subscription, including quantity-based, metered, and event-based components. For more information, see [Managing Components and Usage](https://docs.maxio.com/getting-started/maxio-platform-basics/advanced-billing-overview-and-resources/subscription-summary-tabs/managing-components-and-usage).

## Operations (17)

| Method | Path | Summary |
|---|---|---|
| GET | `/subscriptions/{subscription_id}/components/{component_id}.json` | readSubscriptionComponent |
| GET | `/subscriptions/{subscription_id}/components.json` | listSubscriptionComponents |
| POST | `/subscriptions/{subscription_id}/price_points.json` | bulkUpdateSubscriptionComponentsPricePoints |
| POST | `/subscriptions/{subscription_id}/price_points/reset.json` | bulkResetSubscriptionComponentsPricePoints |
| POST | `/subscriptions/{subscription_id}/components/{component_id}/allocations.json` | allocateComponent |
| GET | `/subscriptions/{subscription_id}/components/{component_id}/allocations.json` | listAllocations |
| POST | `/subscriptions/{subscription_id}/allocations.json` | allocateComponents |
| POST | `/subscriptions/{subscription_id}/allocations/preview.json` | previewAllocations |
| PUT | `/subscriptions/{subscription_id}/components/{component_id}/allocations/{allocation_id}.json` | updatePrepaidUsageAllocationExpirationDate |
| DELETE | `/subscriptions/{subscription_id}/components/{component_id}/allocations/{allocation_id}.json` | deletePrepaidUsageAllocation |
| POST | `/subscriptions/{subscription_id_or_reference}/components/{component_id}/usages.json` | createUsage |
| GET | `/subscriptions/{subscription_id_or_reference}/components/{component_id}/usages.json` | listUsages |
| POST | `/event_based_billing/subscriptions/{subscription_id}/components/{component_id}/activate.json` | activateEventBasedComponent |
| POST | `/event_based_billing/subscriptions/{subscription_id}/components/{component_id}/deactivate.json` | deactivateEventBasedComponent |
| POST | `/events/{api_handle}.json` | recordEvent |
| POST | `/events/{api_handle}/bulk.json` | bulkRecordEvents |
| GET | `/subscriptions_components.json` | listSubscriptionComponentsForSite |

## Machine-readable artifacts (7)

- **OpenAPI** — https://artifacts.apis.io/maxio/openapi/maxio-subscription-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-subscription-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 Components API](https://apis.io/apis/maxio/maxio-components-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/)

## Tags

Subscription Components

---

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