Maxio Advanced Billing
HomeSDKsAPI ReferenceContext Plugin
Events-Based Billing: Segments

Bulk Create Segments

POST
/components/{component_id}/price_points/{price_point_id}/segments/bulk.json

Creates multiple segments in one request. The array of segments can contain up to 2000 records.

If any of the records contain an error the whole request would fail and none of the requested segments get created. The error response contains a message for only the one segment that failed validation, with the corresponding index in the array.

You may specify component and/or price point by using either the numeric ID or the handle:gold syntax.

Authorization

BasicAuth
AuthorizationBasic <token>

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

In: header

Path Parameters

component_id*string

ID or Handle for the Component

price_point_id*string

ID or Handle for the Price Point belonging to the Component

Request Body

application/json

segments?array<>
Itemsitems <= 2000

Response Body

application/json

application/json

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

Update Single Segment PUT

Updates a single segment for a component with a segmented metric. You can also update the pricing for the segment. You can specify component and/or price point by using either the numeric ID or the `handle:gold` syntax.

Bulk Update Segments PUT

Updates multiple segments in one request. The array of segments can contain up to `1000` records. If any of the records contain an error the whole request would fail and none of the requested segments get updated. The error response contains a message for only the one segment that failed validation, with the corresponding index in the array. You may specify component and/or price point by using either the numeric ID or the `handle:gold` syntax.