STstreampay
Subscriptions

List Subscriptions

Changed on

List all subscriptions with pagination, filtering, and sorting options.

get/api/v2/subscriptions

Request

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

Query parameters

statusesSubscriptionStatus[] nullable

Filter by subscription status

latest_invoice_is_paidboolean nullable

Filter subscriptions based on if their latest invoice is paid or partially paid

from_datestring date-time nullable

datetime is created_at

to_datestring date-time nullable

datetime is created_at

current_period_start_from_datestring date-time nullable

Filter subscriptions with current_period_start from this date onwards

current_period_start_to_datestring date-time nullable

Filter subscriptions with current_period_start up to this date

current_period_end_from_datestring date-time nullable

Filter subscriptions with current_period_end from this date onwards

current_period_end_to_datestring date-time nullable

Filter subscriptions with current_period_end up to this date

number
OR
string
number
OR
string
organization_consumer_idstring uuid4 nullable

filter subscriptions that belongs to organization consumer

search_termstring nullable

Serach by product name or description.

product_idsstring[] nullable

Product ids that need to be in the list of subscriptions

currenciesstring nullable

Filter subscriptions by currency codes (OR). E.g. currencies=SAR,USD

pageinteger

Page number, defaults to 1.

limitinteger

Size of a page, defaults to 10. Maximum is 100.

sort_fieldstring nullable

Field to sort by, e.g., 'amount', 'scheduled_on'

sort_directionstring nullable

Sorting direction ('asc' or 'desc')

Response

Successful Response

Changes

  • dfac786362d9Revision changes
    • warning

      removed the optional property ///// from the response with the status

    • 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

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

    • info

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

  • 85261606a8eaRevision changes
    • info

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