STstreampay
Subscriptions

Update Subscription Freeze

Update an existing subscription freeze period.

Allows modifying the start and end dates of a freeze period. The subscription will remain frozen during the updated period.

put/api/v2/subscriptions/{subscription_id}/freeze/{freeze_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 (UUID) of the subscription

freeze_idstring uuid required

Unique identifier (UUID) of the freeze period to update

Request body

freeze_start_datetimestring date-time required

freeze_start_datetime is always provided even if it dont change

freeze_end_datetimestring date-time nullable required

freeze_end_datetime is optional, if provided, it must be greater than freeze_start_datetime

notesstring nullable

Optional notes explaining the reason for the freeze

Response

Successful Response

created_atstring date-time

Creation timestamp of the object.

updated_atstring date-time nullable

Last modification timestamp of the object.

idstring uuid
freeze_start_datetimestring date-time
freeze_end_datetimestring date-time nullable
notesstring nullable
subscription_idstring uuid
invoice_idstring uuid
durationinteger nullable

Changes

No recorded changes to this operation across all 15 revisions of this API.