Read Component Price Point
Returns details for a specific component price point. You can achieve this by using either the component price point ID or handle.
Authorization
BasicAuth The username is a Maxio Chargify API key. The password is x.
In: header
Path Parameters
The id or handle of the component. When using the handle, it must be prefixed with handle:. Example: 123 for an integer ID, or handle:example-product-handle for a string handle.
The id or handle of the price point. When using the handle, it must be prefixed with handle:. Example: 123 for an integer ID, or handle:example-price_point-handle for a string handle.
Query Parameters
Include an array of currency price data.
Response Body
application/json
curl -X GET "https://example.com/components/0/price_points/0.json"{ "price_point": { "id": 0, "type": "catalog", "default": true, "name": "string", "pricing_scheme": "stairstep", "component_id": 0, "handle": "string", "archived_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "prices": [ { "id": 0, "component_id": 0, "starting_quantity": 0, "ending_quantity": 0, "unit_price": "string", "price_point_id": 0, "formatted_unit_price": "string", "segment_id": 0 } ], "use_site_exchange_rate": true, "subscription_id": 0, "tax_included": true, "interval": 0, "interval_unit": "day", "currency_prices": [ { "id": 0, "currency": "string", "price": "string", "formatted_price": "string", "price_id": 0, "price_point_id": 0 } ], "overage_prices": [ { "id": 0, "component_id": 0, "starting_quantity": 0, "ending_quantity": 0, "unit_price": "string", "price_point_id": 0, "formatted_unit_price": "string", "segment_id": 0 } ], "overage_pricing_scheme": "stairstep", "renew_prepaid_allocation": true, "rollover_prepaid_remainder": true, "expiration_interval": 0, "expiration_interval_unit": "day", "currency_overage_prices": [ { "id": 0, "currency": "string", "price": "string", "formatted_price": "string", "price_id": 0, "price_point_id": 0 } ] }}Clone Component Price Point POST
Clones a component price point. Custom price points (tied to a specific subscription) cannot be cloned. The following attributes are copied from the source price point: - Pricing scheme - All price tiers (with starting/ending quantities and unit prices) - Tax included setting - Currency prices (if definitive pricing is set) - Overage pricing (for prepaid usage components) - Interval settings (if multi-frequency is enabled) - Event-based billing segments (if applicable)
Archive Component Price Point DELETE
Archives a component price point. Subscriptions using a price point that has been archived will continue using it until they're moved to another price point.