Components

Update Component

PUT
/components/{component_id}.json

Updates a component.

You may read the component by either the component's id or handle. When using the handle, it must be prefixed with handle:.

If you have the new Catalog experience enabled, taxable components must include a non-blank tax_code. Sending "tax_code": "" returns 422.

Authorization

BasicAuth
AuthorizationBasic <token>

The username is a Maxio Chargify API key. The password is x.

In: header

Path Parameters

component_id*string

The id or handle of the component

Request Body

application/json

component*

Response Body

application/json

application/json

curl -X PUT "https://example.com/components/string.json" \  -H "Content-Type: application/json" \  -d '{    "component": {}  }'
{  "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"  }}