Users V2

Get User Subscription Summary

Changed on
get/v2/users/{app_user_id}/subscription-summary

Request

  • Base URL
    https://api.superwall.com
  • URL
    https://api.superwall.com/v2/users/{app_user_id}/subscription-summary
  • Auth
    • HTTP bearer
    • or API key in cookie accounts_superwall_token
    • or HTTP bearer

Path parameters

app_user_idstring required

App user identifier

Query parameters

application_idstring required

Response

Success

object'user_subscription_summary' required
total_spendnumber required
total_refundsnumber required
net_revenuenumber required
monthly_recurring_revenuenumber required
has_active_subscriptionboolean required
subscription_status'active' | 'expired' | 'trial' | 'cancelled' | 'none' required
auto_renew_enabledboolean required
active_product_idsstring[] required
primary_product_idstring nullable required
primary_storestring nullable required
total_renewalsnumber required
first_purchase_datestring nullable required
last_purchase_datestring nullable required
next_renewal_datestring nullable required
expiration_datestring nullable required
latest_eventstring nullable required
latest_event_tsstring nullable required
is_family_shareboolean required
integration_partnerstring nullable required
lifetime_valuenumber required
average_order_valuenumber required
debugSuperwallApiSchemaV2JsonObject

Changes

    • warning

      added the new credentials_missing enum value to the / response property for the response status

    • warning

      added the new credentials_missing enum value to the / response property for the response status

    • warning

      added the new credentials_missing enum value to the / response property for the response status

    • warning

      added the new credentials_missing enum value to the / response property for the response status

    • warning

      added the new credentials_missing enum value to the / response property for the response status

    • info

      added subschema #1 subschema #2 subschema #3 subschema #4 subschema #5 to the response body anyOf list for the response status

    • info

      removed subschema #1 subschema #2 subschema #3 subschema #4 subschema #5 from the response body anyOf list for the response status

    • breaking

      the response's property type changed from string to no type for status

    • breaking

      the response's property type changed from string to no type for status

    • breaking

      the response's property type changed from string to no type for status

    • breaking

      the response's property type changed from string to no type for status

    • breaking

      the response's property type changed from object to no type for status

    • breaking

      the response's property type changed from string to no type for status

    • breaking

      the response's property type changed from string to no type for status

    • breaking

      the // response's property type changed from string to no type for status

    • breaking

      the // response's property type changed from string to no type for status

    • breaking

      the // response's property type changed from string to no type for status

    • breaking

      the // response's property type changed from string to no type for status

    • breaking

      the // response's property type changed from string to no type for status

    • breaking

      the response's property type changed from string to no type for status

    • breaking

      the response's property type changed from string to no type for status

    • breaking

      the response's property type changed from string to no type for status

    • breaking

      the response's property type changed from string to no type for status

    • breaking

      the response's property type changed from string to no type for status

    • breaking

      the response's property type changed from string to no type for status

    • breaking

      the response's property type changed from string to no type for status

    • breaking

      the response's property type changed from number to no type for status

    • breaking

      the response's property type changed from string to no type for status

    • breaking

      the response's property type changed from string to no type for status

    • breaking

      the response's property type changed from string to no type for status

    • breaking

      the response's property type changed from string to no type for status

    This list may be incomplete.