Sign in
PlanGroup

Retrieve PlanGroup

Retrieve a specific PlanGroup with the given UUID.

This endpoint retrieves detailed information about a specific PlanGroup identified by the given UUID within a specific organization.

get/organizations/{orgId}/plangroups/{id}

Path parameters

orgIdstring required

The unique identifier (UUID) of your Organization. The Organization represents your company as a direct customer of our service.

idstring required

The unique identifier (UUID) of the PlanGroup to retrieve.

Response

Returns the requested PlanGroup

idstring required

The UUID of the entity.

versioninteger

The version number:

  • Create: On initial Create to insert a new entity, the version is set at 1 in the response.
  • Update: On successful Update, the version is incremented by 1 in the response.
customFieldsobject

User defined fields enabling you to attach custom data. The value for a custom field can be either a string or a number.

If customFields can also be defined for this entity at the Organizational level,customField values defined at individual level override values of customFields with the same name defined at Organization level.

See Working with Custom Fields in the m3ter documentation for more information.

namestring

The name of the PlanGroup.

codestring

The short code representing the PlanGroup.

standingChargenumber double

Standing charge amount for the PlanGroup.

standingChargeDescriptionstring

Description of the standing charge, displayed on the bill line item.

minimumSpendnumber double

The minimum spend amount for the PlanGroup.

minimumSpendDescriptionstring

Description of the minimum spend, displayed on the bill line item.

currencystring

Currency code for the PlanGroup (For example, USD).

standingChargeBillInAdvanceboolean

A boolean flag that determines when the standing charge is billed. This flag overrides the setting at Organizational level for standing charge billing in arrears/in advance.

  • TRUE - standing charge is billed at the start of each billing period.
  • FALSE - standing charge is billed at the end of each billing period.
minimumSpendBillInAdvanceboolean

A boolean flag that determines when the minimum spend is billed. This flag overrides the setting at Organizational level for minimum spend billing in arrears/in advance.

  • TRUE - minimum spend is billed at the start of each billing period.
  • FALSE - minimum spend is billed at the end of each billing period.
accountIdstring

Optional. This PlanGroup was created as bespoke for the associated Account with this Account ID.

minimumSpendAccountingProductIdstring

Optional. Product ID to attribute the PlanGroup's minimum spend for accounting purposes.

standingChargeAccountingProductIdstring

Optional. Product ID to attribute the PlanGroup's standing charge for accounting purposes.

dtCreatedstring date-time

The date and time (in ISO 8601 format) when the PlanGroup was first created.

dtLastModifiedstring date-time

The date and time (in ISO 8601 format) when the PlanGroup was last modified.

createdBystring

The unique identifier (UUID) for the user who created the PlanGroup.

lastModifiedBystring

The unique identifier (UUID) for the user who last modified the PlanGroup.

Changes

Changed in 1 of the 10 revisions of this API.2

  • 9f9e5f3dbde72See the full diff
    • ▲

      the response property allOf[AbstractResponseWithCustomFields]/allOf[AbstractResponse]/version became optional for the status 200

      response-property-became-optional

    • ▲

      the response property allOf[AbstractResponse]/version became optional for the status 200

      response-property-became-optional

    This revision also has 53 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog