Redirection from Titan control panel to Partner payment page

When the user selects to upgrade or buy more email accounts Titan will redirect the user to your payment page to complete the purchase process and do the payment. <partner-payment-url>/upgrade?jwt=<JWT_TOKEN>

<partner-payment-url> is configurable, also can be decorated with domain_name, order_id, locale.

e.g : <payment-url>/{domain_name}

Parameters

• jwt (string, required)
  • Jwt Request Body

        {
        "titanOrderId": 21312,
        "domainName": "domain.name",
        "customerId": "anson123",
        "planType": "premium",
        "noOfAccounts": 10,
        "expiryDate": "2021-05-21",
        "action":"upgradePlan",
        "trackingId": "tracking-id",
        "currency": "USD",
        "chargeAmount": 3.14
        }
    

  • titanOrderId (number, required)
    • The unique Titan order ID against which the domain is provisioned
  • domainName (string, required)
    • Customer Domain being provisioned
  • customerId (string, required)
    • The customer ID stored on your end for each customer
  • planType (string, required)
    • Current Titan plan type configured for the customer
  • noOfAccounts (number, required)
    • The current number of accounts or mailboxes configured for the customer
  • expiryDate (string, required)
    • Date on which the package is set to expire in YYYY-MM-DD
  • action (string, required)
    • Relevant action taken by the customer
      • upgradePlan
      • buyMoreAccounts
      • renewOrder
      • billing
      • buyAddon
    • This is used to signal the relevant billing option selected by the customer in the Titan control panel. Accordingly, billing and upgrade options should be shown to customers on the partner payment page
  • trackingId (string, optional)
    • This is used to identify purchase by Complete Purchase API, when user initiates a payment action (adds some addon to cart, increases mailboxes, upgrades plan) via Control Panel.
    • Experimental, see Complete Purchase API. Discuss with Titan team before using it.
  • currency (string, optional)
    • This is currency used for calculations.
    • Experimental, see Complete Purchase API. Discuss with Titan team before using it.
  • chargeAmount (number, optional)
    • This is amount to be charged.
    • Experimental, see Complete Purchase API. Discuss with Titan team before using it.