Skip to main content
You can enable subscribers to log in to your self-care portal to view active Subscriptions, purchase history and to manage their Accounts. To support the sharing of account information between your self-care portal and Subscribe, you must use the Subscribe APIs.
  • Use Case: 2-4-01
  • Completed By: Software Developer
  • Estimated Completion Time: 1 day

​
Basic Scenario

The subscriber accesses their account through your self-care portal to view account details.

​
Design Approach

Subscribe does not manage subscriber login or security information. That information is managed by your self-care portal. Subscribe provides the ability for you to determine the Account ID that Subscribe uses to uniquely identify a given subscriber. In this way you can directly link the Account object in Subscribe to the account object in your self-care solution. For example, if your self-care solution uses the subscriber’s email address as a unique identifier for a given subscriber then you should use that same email address as the value for merchantAccountId in the Account data member. When creating the Account object in Subscribe there are other Account data members that you may want to populate:
  • Name: The subscriber’s name.
  • Email Address: Subscribe uses this value when generating emails for this account.
  • Preferred Language: Subscribe uses this value when generating emails for this account (defaults to English if not specified).
  • Tax Type and Exemptions: If the subscriber has any account level tax exemptions, specify them here.
Note: Subscribe automatically creates the account object for a given subscription when calling the subscriptions endpoint if the account object does not already exist so there is no need to create the object in advance of creating the subscription.

​
Shared Subscriber Data

Often it is necessary to store the same subscriber data in Subscribe as well as in your own account object outside of Subscribe. For example the subscriber name or email address. In this case you must implement a process whereby the data remains in sync between the two systems. Vindicia recommends that you use your own system as the system of record for any shared subscriber data between the two systems and update Subscribe (using Subscribe APIs) from your self-care solution whenever the subscribers update their information. Parent topic:Subscriber Self-Care Access to Account Information

​
Retrieve Subscribe Account Information Using Subscribe APIs

To directly link the Account object in Subscribe to the account object in your self-care solution, you must get the account information from Subscribe:
  1. Call the accounts endpoint using the merchantAccountId to GET the Account object. Sample Code https://github.com/Vindicia/CashBoxRESTCodeSamples/blob/master/Account/Account_fetchByMerchantAccountId.txt
The subscriber can view their account details. Parent topic:Enable Subscribers to Log in to Self-Care Portal