Skip to main content

3rd Party Payment - Subscription Management

Step 1: Get Subscription Detail Configuration​

1. Get Subscription Detail URL​

  • Enter the get subscription detail url in the "Subscription Detail Url" field. This is the endpoint for sending requests to get the current subscription details.

2. Headers (Optional)​

  • You can add any custom headers needed for your request by clicking the "+ Add Header" button. This can be useful if the API you're using requires authentication or other header-based configurations.

3. Parameters​

  • The configuration requires several parameters to be passed:
{
  "OrderID": "1234567890"
}
  • OrderID: The unique ID for the order (e.g., 1234567890).

4. Verify API​

  • After entering the get subscription detail url and parameters, click the "Verify API" button to check the configuration and initiate the verification.

5. Response​

  • Once the request is processed, the system expects a response in the following format:
{
  "Data": [{}],
  "Version": "1.0.0",
  "Success": true,
  "Code": 200,
  "Message": ""
}
  • Data: Subscription info array.
  • Success: A boolean indicating whether the payment process was successful.
  • Code: The response code, 200 means success.
  • Message: A message, typically left empty if successful.

Step 2: Cancel Subscription Configuration​

1. Cancel Subscription URL​

  • Enter the cancel subscription url in the "Cancel Subscription Url" field. This is the endpoint for sending requests to cancel the subscription.

2. Headers (Optional)​

  • You can add any custom headers needed for your request by clicking the "+ Add Header" button. This can be useful if the API you're using requires authentication or other header-based configurations.

3. Parameters​

  • The configuration requires several parameters to be passed:
{
  "SubscriptionID": "1234567890",
  "CancelAtPeriodEnd": true
}
  • SubscriptionID: The unique ID of the subscription (e.g., 100001).
  • CancelAtPeriodEnd: The cancel at period end for the subscription (e.g., true).

4. Verify API​

  • After entering the cancel subscription URL and parameters, click the "Verify API" button to check the configuration and initiate the verification.

5. Response​

  • Once the request is processed, the system expects a response in the following format:
{
  "Data": {},
  "Version": "1.0.0",
  "Success": true,
  "Code": 200,
  "Message": ""
}
  • Data: Subscription info.
  • Success: A boolean indicating whether the payment process was successful.
  • Code: The response code, 200 means success.
  • Message: A message, typically left empty if successful.

Step 3: Update Subscription Configuration​

1. Update Subscription Url​

  • Enter the update subscription url in the "Update Subscription Url" field. This is the endpoint for sending requests to update the subscription.

2. Headers (Optional)​

  • You can add any custom headers needed for your request by clicking the "+ Add Header" button. This can be useful if the API you're using requires authentication or other header-based configurations.

3. Parameters​

  • The configuration requires several parameters to be passed
{
  "OrderID": "1234567890",
  "SubscriptionID": "1234567890",
  "LookupKey": "test",
  "ProrationDate": "1739525077"
}
  • OrderID: WhiteLabel site order ID (e.g., 1234567890).
  • SubscriptionID: 3rd party payment subscription ID (e.g., 1234567890).
  • LookupKey: price lookupkey (e.g., test).
  • ProrationDate: Current time stamp (e.g., 1739525077).

4. Verify API​

  • After entering the update subscription url and parameters, click the "Verify API" button to check the configuration and initiate the verification.

5. Response​

  • Once the payment request is processed, the system expects a response in the following format:
{
  "Data": {},
  "Version": "1.0.0",
  "Success": true,
  "Code": 200,
  "Message": ""
}
  • Data: Subscription info.
  • Success: A boolean indicating whether the payment process was successful.
  • Code: The response code, 200 means success.
  • Message: A message, typically left empty if successful.