Components
Read Component
Returns information regarding a component from a specific product family.
You can read the component by either the component's id or handle. When using the handle, it must be prefixed with handle:.
Authorization
BasicAuth AuthorizationBasic <token>
The username is a Maxio Chargify API key. The password is x.
In: header
Path Parameters
product_family_id*integer
The Advanced Billing id of the product family to which the component belongs
component_id*string
Either the Advanced Billing id of the component or the handle for the component prefixed with handle:
Match
/\A(?:\d+|handle:(?:uuid:|[a-z])(?:\w|-)+)\z/Query Parameters
include_features?boolean
When true, embeds the active feature catalog items for each result in a features array. Default value is false.
Default
falseResponse Body
application/json
curl -X GET "https://example.com/product_families/0/components/string.json"{ "component": { "id": 399853, "name": "Annual Support Services", "pricing_scheme": null, "unit_name": "on/off", "unit_price": "100.0", "product_family_id": 997233, "price_per_unit_in_cents": null, "kind": "on_off_component", "archived": false, "taxable": true, "description": "Prepay for support services", "default_price_point_id": 121003, "price_point_count": 4, "price_points_url": "https://general-goods.chargify.com/components/399853/price_points", "tax_code": "D0000000", "recurring": true, "upgrade_charge": null, "downgrade_credit": null, "created_at": "2019-08-02T05:54:53-04:00", "default_price_point_name": "Original", "product_family_name": "Chargify", "product_family_handle": "chargify" }}