Sign in
AccountPlan

Update AccountPlan

Update the AccountPlan or AccountPlanGroup with the given UUID.

This endpoint updates a new AccountPlan or AccountPlanGroup for a specific Account in your Organization. The updated information should be provided in the request body.

Notes:

  • You cannot use this call to update both an AccountPlan and AccountPlanGroup for an Account at the same time. If you want to update an AccounPlan and an AccountPlanGroup attached to an Account, you must submit two separate calls.
  • If you have created Custom Fields for an AccountPlan, when you use this endpoint to update the AccountPlan use the customFields parameter to preserve those Custom Fields. If you omit them from the update request, they will be lost.
put/organizations/{orgId}/accountplans/{id}

Path parameters

orgIdstring required

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

idstring required

The unique identifier (UUID) of the AccountPlan or AccountPlanGroup to update.

Request body

versioninteger

The version number of the entity:

  • Create entity: Not valid for initial insertion of new entity - do not use for Create. On initial Create, version is set at 1 and listed in the response.
  • Update Entity: On Update, version is required and must match the existing version because a check is performed to ensure sequential versioning is preserved. Version is incremented by 1 and listed 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.

accountIdstring required

The unique identifier (UUID) for the Account.

planIdstring

The unique identifier (UUID) of the Plan to be attached to the Account to create an AccountPlan.

Note: Exclusive of the planGroupId request parameter - exactly one of planId or planGroupId must be used per call.

planGroupIdstring

The unique identifier (UUID) of the PlanGroup to be attached to the Account to create an AccountPlanGroup.

Note: Exclusive of the planId request parameter - exactly one of planId or planGroupId must be used per call.

startDatestring date-time required

The start date (in ISO-8601 format) for the AccountPlan or AccountPlanGroup becoming active for the Account.

endDatestring date-time

The end date (in ISO-8601 format) for when the AccountPlan or AccountPlanGroup ceases to be active for the Account. If not specified, the AccountPlan or AccountPlanGroup remains active indefinitely.

codestring

A unique short code for the AccountPlan or AccountPlanGroup.

billEpochstring date

Optional setting to define a billing cycle date, which acts as a reference for when in the applied billing frequency period bills are created:

  • For example, if you attach a Plan to an Account where the Plan is configured for monthly billing frequency and you've defined the period the Plan will apply to the Account to be from January 1st, 2022 until January 1st, 2023. You then set a billEpoch date of February 15th, 2022. The first Bill will be created for the Account on February 15th, and subsequent Bills created on the 15th of the months following for the remainder of the billing period - March 15th, April 15th, and so on.
  • If not defined, then the billEpoch date set for the Account will be used instead.
  • The date is in ISO-8601 format.
contractIdstring

The unique identifier (UUID) for a Contract to which you want to add the Plan or Plan Group being attached to the Account.

childBillingMode'PARENT_SUMMARY' | 'PARENT_BREAKDOWN' | 'CHILD'

If the Account is either a Parent or a Child Account, this specifies the Account hierarchy billing mode. The mode determines how billing will be handled and shown on bills for charges due on the Parent Account, and charges due on Child Accounts:

  • Parent Breakdown - a separate bill line item per Account. Default setting.

  • Parent Summary - single bill line item for all Accounts.

  • Child - the Child Account is billed.

Response

Returns the updated AccountPlan or AccountPlanGroup.

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.

accountIdstring

The unique identifier (UUID) for the Account to which the AccountPlan or AccounPlanGroup is attached.

productIdstring

The unique identifier (UUID) for the Product associated with the AccountPlan.

Note: Not present in response for AccountPlanGroup - Plan Groups can contain multiple Plans belonging to different Products.

planIdstring

The unique identifier (UUID) of the Plan that has been attached to the Account to create the AccountPlan.

planGroupIdstring

The unique identifier (UUID) of the Plan Group that has been attached to the Account to create the AccountPlanGroup.

startDatestring date-time

The start date (in ISO-8601 format) for the when the AccountPlan or AccountPlanGroup starts to be active for the Account.

endDatestring date-time

The end date (in ISO-8601 format) for when the AccountPlan or AccountPlanGroup ceases to be active for the Account. If not specified, the AccountPlan or AccountPlanGroup remains active indefinitely.

codestring

The unique short code of the AccountPlan or AccountPlanGroup.

billEpochstring date

The initial date for creating the first bill against the Account for charges due under the AccountPlan or AccountPlanGroup. All subsequent bill creation dates are calculated from this date. If left empty, the first bill date definedfor the Account is used. The date is in ISO-8601 format.

contractIdstring

The unique identifier (UUID) for the Contract to which the Plan or Plan Group attached to the Account has been added.

childBillingMode'PARENT_SUMMARY' | 'PARENT_BREAKDOWN' | 'CHILD'

If the Account is either a Parent or a Child Account, this specifies the Account hierarchy billing mode. The mode determines how billing will be handled and shown on bills for charges due on the Parent Account, and charges due on Child Accounts:

  • Parent Breakdown - a separate bill line item per Account. Default setting.

  • Parent Summary - single bill line item for all Accounts.

  • Child - the Child Account is billed.

dtCreatedstring date-time

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

dtLastModifiedstring date-time

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

createdBystring

The unique identifier (UUID) for the user who created the AccountPlan or AccountPlanGroup.

lastModifiedBystring

The unique identifier (UUID) for the user who last modified the AccountPlan or AccountPlanGroup.

Changes

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

  • 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

  • d064a12d0d9311See the full diff
    • ▲

      the allOf[AbstractRequestWithCustomFields]/allOf[subschema #2]/customFields request property type/format changed from / to object/

      request-property-type-changed

    • ●

      removed subschema #1 subschema #2 from the allOf[AbstractRequestWithCustomFields]/allOf[subschema #2]/customFields request property allOf list

      request-property-all-of-removed

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