M3m3ter-com
Plan

Retrieve Plan

Changed on

Retrieve the Plan with the given UUID.

get/organizations/{orgId}/plans/{id}

Request

Path parameters

orgIdstring required

UUID of the organization. The Organization represents your company as a direct customer of the m3ter service.

idstring required

The UUID of the Plan to retrieve.

Response

Returns the Plan

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.

planTemplateIdstring

UUID of the PlanTemplate the Plan belongs to.

productIdstring

UUID of the Product the Plan belongs to.

namestring

Descriptive name for the Plan.

codestring

Unique short code reference for the Plan.

standingChargenumber double

The standing charge applied to bills for end customers. This is prorated.

(Optional). Overrides PlanTemplate value.

standingChargeDescriptionstring

Standing charge description (displayed on the bill line item).

ordinalinteger

Assigns a rank or position to the Plan in your order of pricing plans - lower numbers represent more basic pricing plans; higher numbers represent more premium pricing plans.

(Optional). Overrides PlanTemplate value.

NOTE: DEPRECATED - no longer used.

bespokeboolean

TRUE/FALSE flag indicating whether the Plan is custom/bespoke for a particular Account.

minimumSpendnumber double

The product minimum spend amount per billing cycle for end customer Accounts on a priced Plan.

(Optional). Overrides PlanTemplate value.

minimumSpendDescriptionstring

Minimum spend description (displayed on the bill line item).

standingChargeBillInAdvanceboolean

When TRUE, standing charge is billed at the start of each billing period.

When FALSE, standing charge is billed at the end of each billing period.

(Optional). Overrides the setting at PlanTemplate level for standing charge billing in arrears/in advance.

minimumSpendBillInAdvanceboolean

When TRUE, minimum spend is billed at the start of each billing period.

When FALSE, minimum spend is billed at the end of each billing period.

(Optional). Overrides the setting at PlanTemplate level for minimum spend billing in arrears/in advance.

minimumSpendAccountingProductIdstring

Optional Product ID this Plan's minimum spend should be attributed to for accounting purposes.

standingChargeAccountingProductIdstring

Optional Product ID this Plan's standing charge should be attributed to for accounting purposes.

accountIdstring

(Optional). The Account ID for which this Plan was created as custom/bespoke. A custom/bespoke Plan can only be attached to the specified Account.

dtCreatedstring date-time

The DateTime (in ISO-8601 format) when the Plan was created.

dtLastModifiedstring date-time

The DateTime (in ISO-8601 format) when the Plan was last modified.

createdBystring

The id of the user who created this plan.

lastModifiedBystring

The id of the user who last modified this Plan.

Changes

  • 85c514abc692Revision changes
    • breaking

      the //// response's property type changed from no type to object for status

    • breaking

      the response's property type changed from no type to object for status

  • 9f9e5f3dbde7Revision changes
    • breaking

      the response property //////// became optional for the status

    • breaking

      the response property //// became optional for the status