Metered Subscriptions

Get Metered Subscription

Retrieve a metered subscription.

get/api/v2/metered_subscriptions/{subscription_id}

Path parameters

subscription_idstring uuid required

Unique identifier of the metered subscription to retrieve

include_usageboolean

Include current usage in the subscription response

Successful Response

idstring uuid

product_idstring uuid

organization_consumer_idstring uuid

organization_idstring uuid

starts_atstring date-time

ends_atstring date-time nullable

created_atstring date-time

updated_atstring date-time nullable

current_period_startstring date-time

Start of the current billing period

current_period_endstring date-time

End of the current billing period

current_usagestring nullable

Current usage amount for the active billing period. Omitted unless include_usage=true.

No recorded changes to this endpoint across all 1 revision of this API.