Rate Subscription Object

The Rate Subscription Object represents a recurring monthly charge associated with a partner's invoice. Each object defines when the subscription becomes active, its rate, quantity, and calculated total price.

Rate Subscription Object Attributes

These fields and values make up the JSON object that gets returned with successful requests.

Attribute	Data Type	Description
date_start read only	string	The date and time when this subscription becomes active, and charges start to apply. The default value is the first day of the next billing period.
date_stop read only	string	The date and time when this subscription becomes inactive and charges cease to apply. The default value is null.
display_name read only	string	The subscription name that appears on the customer invoice. The length is limited to 25 characters.
name read only	string	An internal arbitrary, human readable subscription name.
partner_sid read only	string	The secure ID of the Partner this subscription belongs to.
price read only	number	The calculated total price for this subscription: rate * quantity.
quantity read only	number	The quantity of units in this subscription.
rate read only	number	The cost in USD for 1 unit of quantity of this subscription.
subscription_sid read only	string	The subscription secure ID.
type read only	string	The subscription type. The only value returned in this field is static, which means a regular subscription type.

Sample Rate Subscription Object

{
    "date_start": "2024-07-31T00:00:00.000Z",
    "date_stop": "2024-09-31T23:59:59.000Z",
    "display_name": "Application Hosting/Maintenance",
    "name": "Application Hosting/Maintenance",
    "partner_sid": "cee93bf3-5746-43fe-b1a2-822c05fef687",
    "price": "0.01",
    "quantity": "1",
    "rate": "0.01",
    "subscription_sid": "f61a205c-8fc2-435a-9233-e27bed232b04",
    "type": "static"
}