Renewal or upgrade user's package(*)

Renewal or upgrade user's package.

post

Path parameters

packageIdstringRequired

The id of the package.

Header parameters

Brand-URLstringRequired

The brand URL of the request. This is used to identify the brand.

Example: YOUR_BRAND_URL

Auth-KeystringRequired

This is used to authenticate the request. If the request is not authenticated, the server will return a 401 Unauthorized response.

Example: YOUR_AUTH_KEY

Body

application/jsontext/jsonapplication/*+json

Represents a request to upgrade a package. This class extends the CalculateTotalPricePackageRequestDto to include additional properties specific to package upgrades

priceIdstring · min: 1Required

The ID of the package to calculate the total price for.

walletIdstring | nullableOptional

The ID of the app integration payment gateway to use for the calculation.

couponCodestring | nullableOptional

The coupon code to apply for the price calculation, if any.

appIntegrationIdstring | nullableOptional

The id of the app integration associated with the package upgrade. This property is optional and can be null if not applicable.

refundWalletIdstring | nullableOptional

The ID of the wallet to refund if the proration amount exceeds the upgrade price. The refund will be processed to this wallet during the package upgrade.

Responses

200

The request was successful.

application/json

401

The user is not authorized to access the requested resource. The request is missing the required Auth-Key header.

application/json

post

HTTPcURLJavaScriptPython

POST /api/v1/packages/{packageId}/upgrade/checkout HTTP/1.1
Host: protocol.jframework.io
Brand-URL: text
Auth-Key: text
Content-Type: application/json
Accept: */*
Content-Length: 106

{
  "priceId": "text",
  "walletId": "text",
  "couponCode": "text",
  "appIntegrationId": "text",
  "refundWalletId": "text"
}

application/jsontext/jsonapplication/*+json

{
  "success": true,
  "statusCode": 200,
  "message": "The request was successful.",
  "data": {
    "walletWithdrawalAmount": 10,
    "walletWithdrawalCurrency": "USD",
    "walletRefundAmount": 0,
    "walletRefundCurrency": "USD",
    "checkoutLink": "https://www.sandbox.paypal.com/checkoutnow"
  },
  "errors": []
}