Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Body
Create a new contract
inclusive contract start time
Prevents the creation of duplicates. If a request to create a record is made with a previously used uniqueness key, a new record will not be created and the request will fail with a 409 error.
1 - 128
Selects the rate card linked to the specified alias as of the contract's start date.
exclusive contract end time
Defaults to LOWEST_MULTIPLIER, which applies the greatest discount to list prices automatically. EXPLICIT prioritization requires specifying priorities for each multiplier; the one with the lowest priority value will be prioritized first. If tiered overrides are used, prioritization must be explicit.
LOWEST_MULTIPLIER
, lowest_multiplier
, EXPLICIT
, explicit
Determines which scheduled and commit charges to consolidate onto the Contract's usage invoice. The charge's timestamp
must match the usage invoice's ending_before
date for consolidation to occur. This field cannot be modified after a Contract has been created. If this field is omitted, charges will appear on a separate invoice from usage charges.
ALL
Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
The billing provider configuration associated with a contract. Provide either an ID or the provider and delivery method.
Optional list of subscriptions to add to the contract.
Response
Success