API Reference
contract.created
Triggered when a contract is created through the dashboard or through the API
Body
Show child attributes
Show child attributes
Whether the pricing row will be hidden at checkout, defaults to false
The number of minimum units for this usage-based component
The number of licenses for this license-based component
The product metric pricing ID to which this config applies.
The product pricing ID to which this config applies. If the product pricing contains multiple components, the same config will apply to all of them
The sort index
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
The description of the one-time charge
The product ID
x >= 0x >= 0x >= 0Show child attributes
Show child attributes
Show child attributes
Show child attributes
The description of the one-time charge
The product ID
Show child attributes
Show child attributes
The company ID for the product pricing
The final computed features for the product pricing
Show child attributes
Show child attributes
The date the product pricing was created
The currency for the product pricing
The description for the product pricing
The externally exposed name for the product pricing used on invoices
The ID of the product pricing in Maple
The date the product pricing was created from the import source
The import reference of the product pricing
Where the product pricing was imported from
Any additional data as key-value pairs attached to the product pricing
x >= 0The name of the product pricing
The number of subscriptions in the company with the product pricing
x >= 0The overridden features for the product pricing
Show child attributes
Show child attributes
The expanded product for the product pricing
Show child attributes
Show child attributes
The company ID of the product
The date the product was created
The description of the product
The entitlements that enable features for the product
Show child attributes
Show child attributes
The external name of the product
The ID of the product in Maple
The url for the image of the product
The date the product was created in the import source
The import reference ID for the product
Where the product is imported from
Any additional data as key-value pairs attached to the product
x >= 0The name of the product
The product prices attached to this product
The state of the product such as ACTIVE or ARCHIVED
Any tags on the product
The date the product was last updated
The product ID that the product pricing is attached to
The metric components of the product pricing plan
Show child attributes
Show child attributes
Show child attributes
Show child attributes
The company ID for the billable item
The date the billable item was created
Any description attached to the billable item
The display type of the billable item which can be one of UNITS, AMOUNT, THOUSAND_UNITS, MILLION_UNITS
Whether the billable item can be further edited
The public name of the billable item
The ID of the billable item in Maple
The name of the billable item
Whether this is a standard billable item in Maple or a custom billable item
The type of the billable item which can be one of CUSTOM_USAGE or CUSTOM_OBJ, based on usage-based item or object-based item
The date the billable item was last updated
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
2-character country code (ISO 3166-1 alpha-2)
Show child attributes
Show child attributes
Item ID of the credit
Type of credit
Units of credit
Show child attributes
Show child attributes
Show child attributes
Show child attributes
End quantity for the row
x >= 0Flat Price (in cents)
Is custom tier
Price per unit (in cents)
Start quantity for the row
x >= 0Show child attributes
Show child attributes
The company ID for the billable item
The date the billable item was created
Any description attached to the billable item
The display type of the billable item which can be one of UNITS, AMOUNT, THOUSAND_UNITS, MILLION_UNITS
Whether the billable item can be further edited
The public name of the billable item
The ID of the billable item in Maple
The name of the billable item
Whether this is a standard billable item in Maple or a custom billable item
The type of the billable item which can be one of CUSTOM_USAGE or CUSTOM_OBJ, based on usage-based item or object-based item
The date the billable item was last updated
x >= 0Show child attributes
Show child attributes
Allow pulling forward of minimum spend
Amount of period per unit (in cents)
Type of minimum spend schedule
x >= 0Show child attributes
Show child attributes
Amount of period per unit (in cents)
Type of recognition schedule
Show child attributes
Show child attributes
Flat Price (in cents)
Is custom tier
Price per unit (in cents)
End quantity for the row
x >= 0Start quantity for the row
x >= 0Show child attributes
Show child attributes
Show child attributes
Show child attributes
The state of the product pricing such as ACTIVE or ARCHIVED
Any tags on the product pricing
The type of product pricing such as recurring or one-time
The date the product pricing was last updated
The upsell product pricing ID
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Response
Return a 200 status to indicate that the data was received successfully