Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Body
Create a commit
PREPAID
, prepaid
, POSTPAID
, postpaid
If multiple credits or commits are applicable, the one with the lower priority will apply first.
ID of the fixed product associated with the commit. This is required because products are used to invoice the commit amount.
Schedule for distributing the commit to the customer. For "POSTPAID" commits only one schedule item is allowed and amount must match invoice_schedule total.
COMMIT_RATE
, commit_rate
, LIST_RATE
, list_rate
displayed on invoices
1
Used only in UI/API. It is not exposed to end customers.
Required for "POSTPAID" commits: the true up invoice will be generated at this time and only one schedule item is allowed; the total must match accesss_schedule amount. Optional for "PREPAID" commits: if not provided, this will be a "complimentary" commit with no invoice.
The contract that this commit will be billed on. This is required for "POSTPAID" commits and for "PREPAID" commits unless there is no invoice schedule above (i.e., the commit is 'free').
Which products the commit applies to. If applicable_product_ids, applicable_product_tags or specifiers are not provided, the commit applies to all products.
Which tags the commit applies to. If applicable_product_ids, applicable_product_tags or specifiers are not provided, the commit applies to all products.
Which contract the commit applies to. If not provided, the commit applies to all contracts.
List of filters that determine what kind of customer usage draws down a commit or credit. A customer's usage needs to meet the condition of at least one of the specifiers to contribute to a commit's or credit's drawdown. This field cannot be used together with applicable_product_ids
or applicable_product_tags
.
Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
Prevents the creation of duplicates. If a request to create a commit or credit is made with a uniqueness key that was previously used to create a commit or credit, a new record will not be created and the request will fail with a 409 error.
1 - 128
Response
Success