STstreampay
Subscriptions

Freeze Subscription

Freeze a subscription to pause invoice generation for a specific period.

During the freeze period, no invoices will be generated for the subscription. The subscription will automatically resume after the freeze period ends.

post/api/v2/subscriptions/{subscription_id}/freeze

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 to freeze

Request body

freeze_start_datetimestring date-time required

Start date and time when the subscription freeze period begins

freeze_end_datetimestring date-time nullable

End date and time when the subscription freeze period ends. If not provided, the freeze will continue indefinitely until manually removed.

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.