Create a CustomPricingUnit object.
Learn more about calling API v2 endpoints.Parameters
- display_
namestringRequired Description that customers will see in the invoice line item. Maximum length of 250 characters.
- lookup_
keystring An internal key you can use to search for a particular CustomPricingUnit item. Must be unique among items. Maximum length of 200 characters.
- metadatamap
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
Returns
Response attributes
- idstring
The ID of the custom pricing unit.
- objectstring, value is "v2.billing.custom_pricing_unit"
String representing the object’s type. Objects of the same type share the same value of the object field.
- createdtimestamp
Timestamp of when the object was created.
- display_
namestring Description that customers will see in the invoice line item. Maximum length of 250 characters.
- livemodeboolean
Has the value
trueif the object exists in live mode or the valuefalseif the object exists in test mode. - lookup_
keynullable string An internal key you can use to search for a particular CustomPricingUnit item. Maximum length of 200 characters.
- metadatanullable map
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
Returned when another object of the same type already has the given lookup key.
{ "created": "2025-01-01T00:00:00.000Z", "display_name": "4242", "id": "4242", "lookup_key": "4242", "metadata": { "4242": "4242" }, "object": "4242", "livemode": true}Retrieve a CustomPricingUnit object.
Learn more about calling API v2 endpoints.Parameters
- idstringRequired
The ID of the custom pricing unit.
Returns
Response attributes
- idstring
The ID of the custom pricing unit.
- objectstring, value is "v2.billing.custom_pricing_unit"
String representing the object’s type. Objects of the same type share the same value of the object field.
- createdtimestamp
Timestamp of when the object was created.
- display_
namestring Description that customers will see in the invoice line item. Maximum length of 250 characters.
- livemodeboolean
Has the value
trueif the object exists in live mode or the valuefalseif the object exists in test mode. - lookup_
keynullable string An internal key you can use to search for a particular CustomPricingUnit item. Maximum length of 200 characters.
- metadatanullable map
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
Returned by CustomPricingUnit API when the custom pricing unit is not found.
{ "created": "2025-01-01T00:00:00.000Z", "display_name": "4242", "id": "4242", "lookup_key": "4242", "metadata": { "4242": "4242" }, "object": "4242", "livemode": true}A LicensedItem represents any item that you bill customers for based on the subscribed quantity.
A ServiceAction represents a recurring, automated action that can be applied as part of a subscription.
Rate Cards v2
A RateCard describes usage-based pricing. To bill a customer using a RateCard, create a RateCardSubscription which links it to the corresponding Cadence.
- POST/