Skip to main content
POST
cURL

Authorizations

x-api-key
string
header
required

Enter your API key in the format x-api-key <api-key>*

Body

application/json

Commitment

end_date
string<date-time>
required
measurement
enum<string>
required
Available options:
billing_period,
window
name
string
required
Maximum string length: 255
scope
object
required
start_date
string<date-time>
required
type
enum<string>
required
Available options:
amount,
quantity
active_windows
object[]
binding
boolean

default false

collection_method
enum<string>
Available options:
per_period,
billing_terms
committed_price
object
idempotency_key
string
Maximum string length: 128
invoice_description
string
Maximum string length: 500
invoice_label
string
Maximum string length: 255
metadata
object
overage_price
object
priority
integer
subscription_id
string

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

timezone
string
value
string

Response

Created

active_windows
object[]
binding
boolean
collection_method
enum<string>
Available options:
per_period,
billing_terms
commitment_status
enum<string>
Available options:
active,
ended,
terminated
commitment_value
string
committed_price_id
string
created_at
string<date-time>
created_by
string
currency
string
customer_id
string
end_date
string<date-time>
environment_id
string
id
string
idempotency_key
string
instalment_invoicing
string
invoice_description
string
invoice_label
string
measurement
enum<string>
Available options:
billing_period,
window
metadata
object
name
string
on_early_termination
enum<string>
Available options:
forfeit,
credit_note,
bill_remaining
overage_price_id
string
priority
integer
scope_entity_id
string
scope_entity_type
enum<string>
Available options:
subscription,
group,
meter,
price
start_date
string<date-time>
status
enum<string>
Available options:
published,
deleted,
archived
subscription_id
string
tenant_id
string
terminated_at
string<date-time>
termination_invoice_id
string
timezone
string
total_amount
string
type
enum<string>
Available options:
amount,
quantity
updated_at
string<date-time>
updated_by
string
value
string