List Segments for a Price Point
Lists segments created for a given price point, in order of creation.
You can pass page and per_page parameters in order to access all of the segments. By default it will return 30 records. You can set per_page to 200 at most.
You may specify component and/or price point by using either the numeric ID or the handle:gold syntax.
Authorization
BasicAuth The username is a Maxio Chargify API key. The password is x.
In: header
Path Parameters
ID or Handle for the Component
ID or Handle for the Price Point belonging to the Component
Query Parameters
Result records are organized in pages. By default, the first page of results is displayed. The page parameter specifies a page number of results to fetch. You can start navigating through the pages to consume the results. You do this by passing in a page parameter. Retrieve the next page by adding ?page=2 to the query string. If there are no results to return, then an empty result set will be returned.
Use in query page=1.
1 <= value1This parameter indicates how many records to fetch in each request. Default value is 30. The maximum allowed values is 200; any per_page value over 200 will be changed to 200.
Use in query per_page=200.
value <= 20030Filter to use for List Segments for a Price Point operation
Response Body
application/json
application/json
curl -X GET "https://example.com/components/string/price_points/string/segments.json"{ "segments": [ { "id": 0, "component_id": 0, "price_point_id": 0, "event_based_billing_metric_id": 0, "pricing_scheme": "stairstep", "segment_property_1_value": "string", "segment_property_2_value": "string", "segment_property_3_value": "string", "segment_property_4_value": "string", "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 } ] } ]}Create signup proforma preview POST
Creates a signup preview in the format of a proforma invoice to preview costs before a subscription's signup. This endpoint is only available for Relationship Invoicing sites and cannot be used to create consolidated proforma invoice previews or preview prepaid subscriptions. You have the option of previewing the first renewal's costs as well. The proforma invoice preview will not be persisted. Pass a payload that resembles a subscription create or signup preview request. For example, you can specify components, coupons/a referral, offers, custom pricing, and an existing customer or payment profile to populate a shipping or billing address. A product and customer first name, last name, and email are the minimum requirements.
Create Single Segment POST
Creates a new segment for a component with a segmented metric. It allows you to specify properties to bill upon and prices for each Segment. You can only pass as many "property_values" as the related Metric has segmenting properties defined. You may specify component and/or price point by using either the numeric ID or the `handle:gold` syntax.