Purchase to add licenses by checkout link

Generate the checkout link to purchase the license.

post

Query parameters

api-versionstringOptional

Header parameters

BrandUrlstringRequired

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

Example: YOUR_BRAND_URL

AuthkeystringRequired

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

This class is used to create a checkout link to add various licenses.

returnUrlstring | nullableOptional

The return URL. If the payment is successful, the user will be redirected to this URL.

cancelUrlstring | nullableOptional

The cancel URL. If the payment is canceled, the user will be redirected to this URL.

packageIdstring · min: 1Required

The package id of the license.

Example: Plakdiooh209sz

subscriptionTypeIdstring · min: 1Required

The subscription type id of the license.

Example: Plakdiooh209sz

startDatestring · date-timeOptional

The start date of the license.

Example: 2025-01-01

endDatestring · date-timeOptional

The end date of the license.

Example: 2025-02-01

descriptionstring | nullableOptional

The description of the license.

Example: Description of the license

tagsstring | nullableOptional

The tags of the license.

Example: #Tag

testModeboolean | nullableOptional

The test mode of the license.

Example: true

quantityinteger · int32Optional

The quantity of the license to create. By default, it is 1.

Example: 1

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 AuthKey header.

application/json

429

The user has exceeded the rate limit.

application/json

post

HTTPcURLJavaScriptPython

POST /api/v1/licenses/purchase/checkout-link HTTP/1.1
Host: protocol.jframework.dev
BrandUrl: text
Authkey: text
Content-Type: application/json
Accept: */*
Content-Length: 240

{
  "returnUrl": "text",
  "cancelUrl": "text",
  "packageId": "Plakdiooh209sz",
  "subscriptionTypeId": "Plakdiooh209sz",
  "startDate": "2025-01-01",
  "endDate": "2025-02-01",
  "description": "Description of the license",
  "tags": "#Tag",
  "testMode": true,
  "quantity": 1
}

application/jsontext/jsonapplication/*+json

{
  "success": true,
  "statusCode": 200,
  "message": "The request was successful.",
  "data": "https://api.paypal.com/v2/checkout/orders/09H88704RC448263N",
  "errors": []
}