Skip to main content

Example: Seat-based pricing

The following provides examples of how you could leverage the ecommerce platform to implement the seat-based (or user-based) pricing model. In this use case, Shieldware offers access to security software which customers pay for on a monthly basis. In their business model, the client charges 10 USD per month for every user.

Important

Notifications are an essential part of the pricing model setup. For more information about changing or adjusting your notification settings, see Manage Notifications.

Sign Up​

Under the seat-based pricing model, the customer must first sign up for a subscription and create a payment profile.

  1. Once a customer initiates a transaction, Shieldware creates a signup URL (a simple checkout link).

    tip

    Example:
    The following is a sample checkout URL:

    https://<secure.yourdomain.com>/<your client account ID>/purl-checkout?cart=<ID of the music>&firstname=Han&lastname=Solo

    When you create the session URL, you can predefine user information such as firstname, lastname, or *emailaddress. For a complete list of parameters, see Checkout Process Parameters > Customer Data.

    note

    If you want to use an existing payment profile to create the signup URL, generate a session URL and include the customer's UUID. For more information, see Single Sign-On (SSO).

  2. Shieldware redirects the customer to the link. The customer then completes the payment profile and submits the payment.

    note

    If the customer chooses an offline payment, you receive a NewOfflinePaymentPurchaseNotification. Use this to provide a visual confirmation of the transaction to the user in the Customer Self-Service portal. Provide payment instructions on the confirmation page. A link to the confirmation page is included in the CustomerConfirmationPageUrlNotification.

  3. Once cleverbridge receives a payment confirmation, cleverbridge sends Shieldware a PaidOrderNotification. For more information, see Notification Types.

  4. Shieldware entitles the customer to the product. Cleverbridge simultaneously sends the customer a confirmation email, which includes an invoice.

    note

    You can import all information for a transaction immediately, including links to the invoice. Alternatively, use the following API route to get all relevant transaction details: Get Purchase.

Auto-renew​

When a subscription is set to auto-renewal, Cleverbridge automatically processes the renewal transaction for Shieldware. During this process, the following occurs:

  1. Cleverbridge sends the customer an email reminding them that they will be charged in "x" days. Cleverbridge simultaneously sends Shieldware a SubscriptionReminderChargeNotification.

    note

    Some customer emails are optional and are not active by default. For more information, see Customer email types.

  2. On the renewal date, Cleverbridge triggers the renewal transaction using the customer's existing payment profile.

    note

    Different events occur if a customer uses an offline payment option. For more information, see Flow charts for notification events.

  3. Once cleverbridge receives a payment confirmation, cleverbridge sends Shieldware a PaidOrderNotification. For more information, see Notification Types.

  4. Shieldware entitles the customer to the product. Cleverbridge simultaneously sends the customer a confirmation email, which includes an invoice.

Add users​

To add more users to a customer's subscription, Shieldware does the following:

  1. Shieldware calls the following API route: /subscription/updatesubscriptionitem

    The API call includes:

    • Quantity (of users)
    • AlignmentSettings
      • GetCustomerPricePreviewOnly = true
      • AlignToCurrentInterval = true

  2. In the API response, Shieldware receives updated pricing details which the customer has to confirm.

    tip

    When dealing with a monthly subscription term it might be useful to renew the subscription by a full renewal term to avoid microtransactions. To do so, include the setting: TriggerImmediateRenewal = true.

  3. Once the customer has confirmed the new pricing, Shieldware triggers the transaction by calling the API route again: /subscription/updatesubscriptionitem

    This time, the API call includes:

    • Quantity (of users)
    • AlignmentSettings
      • GetCustomerPricePreviewOnly = false
      • AlignToCurrentInterval = true

  4. Once cleverbridge receives a payment confirmation, Cleverbridge sends Shieldware a PaidOrderNotification. For more information, see Notification Types.

    note

    If Cleverbridge cannot process the transaction because the customer's payment profile is invalid, forward the customer to the ContinueUrl found in the API response. The user can use the URL to update their profile and complete the transaction.

  5. Shieldware entitles the customer to the product. Cleverbridge simultaneously sends the customer a confirmation email, which includes an invoice.

    note

    You can import all information for a transaction immediately, including links to the invoice. Alternatively, use the following API route to get all relevant transaction details: Get Purchase.

Add new service​

To add an additional service to a customer's subscription, Shieldware does the following:

  1. Shieldware calls the following API route: /subscription/addsubscriptionitem

    The API call includes:

    • ProductId (Additional Service)
    • AlignmentSettings
      • GetCustomerPricePreviewOnly = true
      • AlignToCurrentInterval = true

  2. In the API response, Shieldware receives updated pricing details which the customer has to confirm.

  3. Once the customer has confirmed the new pricing, Shieldware triggers the transaction by calling the API route again: /subscription/addsubscriptionitem

    This time, the API call includes:

    • ProductId (Additional Service)
    • AlignmentSettings
      • GetCustomerPricePreviewOnly = false
      • AlignToCurrentInterval = true

  4. Once cleverbridge receives a payment confirmation, cleverbridge sends Shieldware a PaidOrderNotification. For more information, see Notification Types.

  5. Shieldware entitles the customer to the product. Cleverbridge simultaneously sends the customer a confirmation email, which includes an invoice.

    note

    You can import all information for a transaction immediately, including links to the invoice. Alternatively, use the following API route to get all relevant transaction details: Get Purchase.

Change payment profile​

To allow customers to keep their payment profile up-to-date and avoid involuntary churn, Shieldware integrates the self-service change payment process that Cleverbridge offers into their website.

Example

Example:
The following are the elements you need to create a change payment link: https://<your secure hostname>/<your client account ID>/scp/S<subscription ID>-<subscription Secret> For more information, see Permanent links.


Did you find this doc useful?