M3m3ter-com
Commitments

Retrieve Commitment

Changed on

Retrieve a specific Commitment.

Retrieve the details of the Commitment with the given UUID. It provides comprehensive information about the Commitment, such as the agreed amount, overage surcharge percentage, and other related details.

get/organizations/{orgId}/commitments/{id}

Request

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 Commitment to retrieve.

Response

Returns the Commitment

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.
accountIdstring

The unique identifier (UUID) for the end customer Account the Commitment is added to.

billingPlanIdstring

The unique identifier (UUID) for the Product Plan used for billing Commitment fees due.

productIdsstring[]

A list of unique identifiers (UUIDs) for Products the Account consumes. Charges due for these Products will be made available for draw-down against the Commitment.

Note: If not used, then charges due for all Products the Account consumes will be made available for draw-down against the Commitment.

startDatestring date

The start date of the Commitment period in ISO-8601 format.

endDatestring date

The end date of the Commitment period in ISO-8601 format.

currencystring

The currency used for the Commitment. For example, 'USD'.

amountnumber double

The total amount that the customer has committed to pay.

amountPrePaidnumber double

The amount that the customer has already paid upfront at the start of the Commitment service period.

amountFirstBillnumber double

The amount to be billed in the first invoice.

amountSpentnumber double

The total amount of the Commitment that the customer has spent so far.

overageSurchargePercentnumber double

The percentage surcharge applied to the usage charges that exceed the Commitment amount.

separateOverageUsageboolean

A boolean value indicating whether the overage usage is billed separately or together. If overage usage is separated and a Commitment amount has been consumed by an Account, any subsequent line items on Bills against the Account for usage will show as separate "overage usage" charges, not simply as "usage" charges:

  • TRUE - billed separately.
  • FALSE - billed together.
billingIntervalinteger

How often the Commitment fees are applied to bills. For example, if the plan being used to bill for Commitment fees is set to issue bills every three months and the billingInterval is set to 2, then the Commitment fees are applied every six months.

billingOffsetinteger

The offset for when the Commitment fees are first applied to bills on the Account. For example, if bills are issued every three months and the billingOffset is 0, then the charge is applied to the first bill (at three months); if set to 1, it's applied to the next bill (at six months), and so on.

commitmentFeeDescriptionstring

A textual description of the Commitment fee.

commitmentUsageDescriptionstring

A textual description of the Commitment usage.

overageDescriptionstring

A textual description of the overage charges.

commitmentFeeBillInAdvanceboolean

A boolean value indicating whether the Commitment fee is billed in advance (start of each billing period) or arrears (end of each billing period).

  • TRUE - bill in advance (start of each billing period).
  • FALSE - bill in arrears (end of each billing period).
billEpochstring date

The starting date (in ISO-8601 date format) from which the billing cycles are calculated.

contractIdstring

The unique identifier (UUID) for a Contract you've created for the Account and to which the Commitment has been added.

accountingProductIdstring

The unique identifier (UUID) for the Product linked to the Commitment for accounting purposes.

feesAccountingProductIdstring

Optional Product ID this Commitment's fees should be attributed to for accounting purposes.

drawdownsAccountingProductIdstring

Optional Product ID this Commitment's consumptions should be attributed to for accounting purposes.

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.

lineItemTypesCommitmentLineItemType[]

Specifies the line item charge types that can draw-down at billing against the Commitment amount. Options are:

  • MINIMUM_SPEND
  • STANDING_CHARGE
  • USAGE
  • "COUNTER_RUNNING_TOTAL_CHARGE"
  • "COUNTER_ADJUSTMENT_DEBIT"
dtCreatedstring date-time

The date and time (in ISO-8601 format) when the Commitment was created.

dtLastModifiedstring date-time

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

createdBystring

The unique identifier (UUID) of the user who created this Commitment.

lastModifiedBystring

The unique identifier (UUID) of the user who last modified this Commitment.

Changes

  • 85c514abc692Revision changes
    • 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