Skip to main content
POST
Create Prepaid Commit

Authorizations

Authorization
string
header
required

Token-based authentication with required prefix "Token"

Path Parameters

contract_id
integer
required

Body

name
string
required
Maximum string length: 250
total_value
number<double>
required
Required range: -1000000000000000000 < x < 1000000000000000000
start_date
string<date>
required
entity
integer | null
product
integer | null
description
string | null
currency
string
Maximum string length: 3
exchange_rate
number<double> | null
Required range: -100000000000000 < x < 100000000000000
exchange_rate_book
number<double> | null
Required range: -100000000000000 < x < 100000000000000
discount_percentage
number<double>

Discount applied to gross usage (e.g. 20.00 for 20%)

Required range: 0 <= x <= 100
rate
number<double> | null

List price per unit. Prepaid usage = rate * (1 - discount%). Overage = rate (no discount).

Required range: 0 <= x < 100000000000000
expiration_date
string<date> | null
priority
integer

Drawdown order when multiple commits exist (lower = higher priority)

Required range: -2147483648 <= x <= 2147483647
subledger
integer | null
overage_invoice_cadence
enum<string>

How often overage/on-demand usage is invoiced

  • monthly - Monthly
  • quarterly - Quarterly
  • biannual - Bi Annualy
  • annual - Annual
  • one_time - One Time
  • custom - Custom
Available options:
monthly,
quarterly,
biannual,
annual,
one_time,
custom
auto_send_overage_invoices
boolean

Automatically send overage invoices when generated

overage_invoice_start_month
string<date> | null

Anchor date for overage billing cycles. Defaults to start_date.

department
integer | null
tags
string | null

Response

201 - application/json
id
integer
required
read-only
contract
integer
required
read-only
entity_name
string | null
required
read-only
product_name
string | null
required
read-only
name
string
required
Maximum string length: 250
total_value
number<double>
required
Required range: -1000000000000000000 < x < 1000000000000000000
remaining_value
number<double>
required
read-only
Required range: -1000000000000000000 < x < 1000000000000000000
start_date
string<date>
required
status
enum<string>
required
  • ACTIVE - Active
  • EXHAUSTED - Exhausted
  • EXPIRED - Expired
Available options:
ACTIVE,
EXHAUSTED,
EXPIRED
is_invoiced
boolean
required
read-only
invoice
integer | null
required
read-only
department_name
string | null
required
read-only
created_at
string<date-time> | null
required
read-only
last_modified_at
string<date-time> | null
required
read-only
entity
integer | null
product
integer | null
description
string | null
currency
string
Maximum string length: 3
exchange_rate
number<double> | null
Required range: -100000000000000 < x < 100000000000000
exchange_rate_book
number<double> | null
Required range: -100000000000000 < x < 100000000000000
discount_percentage
number<double>

Discount applied to gross usage (e.g. 20.00 for 20%)

Required range: 0 <= x <= 100
rate
number<double> | null

List price per unit. Prepaid usage = rate * (1 - discount%). Overage = rate (no discount).

Required range: 0 <= x < 100000000000000
expiration_date
string<date> | null
priority
integer

Drawdown order when multiple commits exist (lower = higher priority)

Required range: -2147483648 <= x <= 2147483647
subledger
integer | null
overage_invoice_cadence
enum<string>

How often overage/on-demand usage is invoiced

  • monthly - Monthly
  • quarterly - Quarterly
  • biannual - Bi Annualy
  • annual - Annual
  • one_time - One Time
  • custom - Custom
Available options:
monthly,
quarterly,
biannual,
annual,
one_time,
custom
auto_send_overage_invoices
boolean

Automatically send overage invoices when generated

overage_invoice_start_month
string<date> | null

Anchor date for overage billing cycles. Defaults to start_date.

department
integer | null
tags
string | null