Skip to main content
PUT
Set the per-period minimum commitment
Sets the subscription’s per-period minimum commitment. When a period’s subtotal (flat fee + add-ons + metered usage) falls short of the commitment, a Minimum commitment true-up line fills exactly the difference on the renewal invoice, taxed at the plan’s HSN. Usage beyond the floor bills naturally. An amount of 0 clears the commitment. The commitment is stored on the subscription as commitment_amount and returned by Get Subscription. For the concept and setup walkthrough see Set Up Minimum Commitments.

Path Parameters

Request Body

Example Request

Response

Returns the updated subscription.

Fields

Other fields are the standard subscription object — see Get Subscription.
Nothing is invoiced when the commitment is set. The true-up line, if any, is computed at renewal against that period’s actual subtotal, so the invoice always shows both the usage billed and the exact shortfall filled.

Errors

Errors use the standard envelope — see Errors.

Authorizations

Authorization
string
header
required

Tenant API key obtained from POST /auth/register or POST /v1/developer/keys.

Path Parameters

id
string<uuid>
required

Body

application/json
amount
integer<int64>
required
Required range: x >= 0

Response

The updated subscription

data
object