Sign in

v1

latestOpenAPI 3.0.32026-07-1336286494.8 KB
api

post/api/subscriptions/{subscription_id}/components/{metric_id}/change_prepaid_units/

Path parameters

metric_idstring required

The ID of the metric to alter the prepaid usage for.

subscription_idstring required

The ID of the subscription which will have its plans switched.

Request body

unitsnumber double required

The new prepaid units for the customer.

invoice_nowboolean

Whether or not to immediately invoice the customer for the change in prepaid units.

Response

subscription_idstring required
start_datestring date-time required

The time the subscription starts. This will be a string in yyyy-mm-dd HH:mm:ss format in UTC time.

end_datestring date-time required

The time the subscription starts. This will be a string in yyyy-mm-dd HH:mm:ss format in UTC time.

auto_renewboolean required

Whether the subscription automatically renews. Defaults to true.

is_newboolean required

Whether this subscription came from a renewal or from a first-time. Defaults to true on creation.

fully_billedboolean required
metadataobject required