STstreampay
Metered Subscriptions

Get Metered Subscription

Changed on

Retrieve a metered subscription.

get/api/v2/metered_subscriptions/{subscription_id}

Request

  • Base URL
    https://stream-app-service.streampay.sa
  • Auth
    • HTTP bearer
    • or API key in header x-api-key

Path parameters

subscription_idstring uuid required

Unique identifier of the metered subscription to retrieve

Query parameters

include_usageboolean

Include current usage in the subscription response

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.

Changes

  • dfac786362d9Revision changes
    • warning

      removed the optional property / from the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      the response optional property // became read-only for the status

  • 7269a6d9677fRevision changes
    • info

      added the optional property / to the response with the status