get https://api.chartmogul.com/v1/plan_groups/
Retrieves a plan group
object from your ChartMogul account.
Examples
curl -X GET "https://api.chartmogul.com/v1/plan_groups/plg_eed05d54-75b4-431b-adb2-eb6b9e543206" \
-u YOUR_API_KEY: \
-H "Content-Type: application/json"
ChartMogul::PlanGroup.retrieve("plg_eed05d54-75b4-431b-adb2-eb6b9e543206")
ChartMogul.PlanGroup.retrieve(config, "plg_eed05d54-75b4-431b-adb2-eb6b9e543206");
ChartMogul\PlanGroup::retrieve("plg_eed05d54-75b4-431b-adb2-eb6b9e543206");
api.RetrievePlanGroup("plg_eed05d54-75b4-431b-adb2-eb6b9e543206")
chartmogul.PlanGroup.retrieve(config, uuid="plg_eed05d54-75b4-431b-adb2-eb6b9e543206")
Result Format
{
"name": "Growth Plans",
"uuid": "plg_eed05d54-75b4-431b-adb2-eb6b9e543206",
"plans_count": 3
}
#<ChartMogul::PlanGroup:0x007fb4993f25a0
@uuid="plg_eed05d54-75b4-431b-adb2-eb6b9e543206",
@name="Growth Plans",
@plans_count=3,
>
{
name: "Growth Plans",
uuid: "plg_eed05d54-75b4-431b-adb2-eb6b9e543206",
plans_count: 3
}
ChartMogul\PlanGroup::__set_state(array(
"uuid" => "plg_eed05d54-75b4-431b-adb2-eb6b9e543206",
"name" => "Growth Plans",
"plans_count" => 3
));
(*chartmogul.PlanGroup)(0xc04203e5a0)({
UUID: (string) (len=39) "plg_eed05d54-75b4-431b-adb2-eb6b9e543206",
Name: (string) (len=11) "Growth Plans",
PlansCount: (uint32) 3
})
<PlanGrouop{
plans_count=3,
name="Growth Plans",
uuid="plg_eed05d54-75b4-431b-adb2-eb6b9e543206"
}>
In the response, the JSON
object contains the following data:
name
- Name of this plan group, as specified by you.uuid
- The UUID of theplan group
object generated by ChartMogul.plans_count
- The number of plans in the plan group.