FLflexprice
Commitments

Preview commitment

Changed on

Validates a commitment and returns its computed value without creating it.

post/commitments/preview

Request

  • Base URL
    https://us.api.flexprice.io/v1
  • URL
    https://us.api.flexprice.io/v1/commitments/preview
  • Auth
    API key in header x-api-key

Request body

bindingboolean

default false

collection_method'per_period' | 'billing_terms'
end_datestring date-time

EndDate is exclusive; omit it for an open-ended commitment, which bills every period until terminated.

idempotency_keystring
invoice_descriptionstring
invoice_labelstring
measurement'billing_period' | 'window' required
metadataTypesMetadata
namestring required
priorityinteger
start_datestring date-time required
subscription_idstring

SubscriptionID is required on POST /commitments and set server-side on inline commitments.

timezonestring
type'amount' | 'quantity' required
valuestring

Response

OK

bindingboolean
collection_method'per_period' | 'billing_terms'
commitment_status'active' | 'ended' | 'terminated'
commitment_valuestring
committed_price_idstring
created_atstring date-time
created_bystring
currencystring
customer_idstring
end_datestring date-time

EndDate is exclusive; nil for an open-ended commitment, which runs until terminated.

environment_idstring
idstring
idempotency_keystring
instalment_invoicingstring
invoice_descriptionstring
invoice_labelstring
measurement'billing_period' | 'window'
metadataTypesMetadata
namestring
on_early_termination'forfeit' | 'credit_note' | 'bill_remaining'
overage_price_idstring
priorityinteger
scope_entity_idstring
scope_entity_type'subscription' | 'group' | 'meter' | 'price'
start_datestring date-time
status'published' | 'deleted' | 'archived'
subscription_idstring
tenant_idstring
terminated_atstring date-time
termination_invoice_idstring
timezonestring
total_amountstring
type'amount' | 'quantity'
updated_atstring date-time
updated_bystring
valuestring

Changes