Resource: Subscriptions (preliminary)

Topics:

Actions

  • - (Object) index

Url:

  • [GET] /rest/v1/report/subscriptions?[arguments]
Note:

This action requires admin access.

Returns the total number of subscriptions.

Arguments:

  • (String) subscription_status

    (optional) Filter by subscription status [values: ‘all’ (default), ‘active’, ‘suspended’, ‘cancelled’, ‘not_started’, ‘billing_hold’, ‘ended’, ‘expired’].

  • (Integer) offer_id

    (optional) Filter by offer id.

  • (DateTime) updated_at_from

    (optional) Filters by start of updated_at field.

  • (DateTime) updated_at_to

    (optional) Filters by end of updated_at field.

Example Request:

https://service_name.synctv.com/rest/v1/report/subscriptions?subscription_status=active

Example Response:

<ssap>
  <response>
    <code>1</code>
    <message>Successfully completed.</message>
    <count>1</count>
  </response>
  <version>0.5</version>
  <subscription_total>14</subscription_total>
</ssap>

Response Fields:

  • (Integer) subscription_total

    Total number of subscriptions.