Activate Event-Based Component
Built with APIMatic
Advanced Billing Developer Portalv1.0Advanced Billing Developer Portalv1.0Activates an event-based component for a single subscription.
In order to bill your subscribers on your Events data under the Events-Based Billing feature, the components must be activated for the subscriber.
Learn more about the role of activation in the Events-Based Billing docs.
Use this endpoint to activate an event-based component for a single subscription. Activating an event-based component causes Advanced Billing to bill for events when the subscription is renewed.
Note: it is possible to stream events for a subscription at any time, regardless of component activation status. The activation status only determines if the subscription should be billed for event-based component usage at renewal.
The username is a Maxio Chargify API key and the password is x. Basic authentication works only with the US and EU environments, which connect to chargify.com directly. The Maxio API Gateway environment does not accept Basic authentication.
In: header
The Advanced Billing id of the subscription
The Advanced Billing id of the component
application/json
TypeScript Definitions
Use the request body type in TypeScript.
curl -X POST \ --url 'https://subdomain.chargify.com/event_based_billing/subscriptions/1/components/1/activate.json' \ -H 'Content-Type: application/json' \ -H 'Authorization: Bearer ACCESS_TOKEN' \ --data-raw '{ "price_point_id": 1, "billing_schedule": { "initial_billing_at": "2022-01-01" }, "custom_price": { "tax_included": false, "pricing_scheme": "per_unit", "interval": 30, "interval_unit": "day", "prices": [ { "starting_quantity": 1, "unit_price": "5.0" } ] }}'The Chargify id of the price point
Billing schedule settings for component allocations or usages on multi-frequency subscriptions. Use this to start a component's billing period on a custom date instead of aligning with the product charge schedule.
Create or update custom pricing unique to the subscription. Used in place of price_point_id.