Cloud API - Billing and Subscriptions

Updated

Cloud API - Billing and Subscriptions

Base URL: https://public-api.loadgen.cloud

This article documents billing and subscription endpoints (payments, gateways, products, editions, invoices, and subscription lifecycle).

CreateEdition

Method: POST

Path: /api/services/app/Edition/CreateEdition

Operation ID: ApiServicesAppEditionCreateeditionPost

Tag: Edition

Authentication: Yes (Bearer token)

Scope: Host

Notes:- Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.

  • This endpoint is typically used in host context (platform administration). Use a host-level account/token and omit Abp.TenantId unless your deployment requires it.

Parameters

None

Request body

Request body schema: CreateEditionDto

Request body fields

| Field | Type | Required | Description | Notes |

|---|---|---:|---|---|

| edition | object(EditionCreateDto) | Yes | | |

| featureValues | array | Yes | | |

Example request body

`json

{

"edition": {

"displayName": "string",

"id": 0,

"dailyPrice": 0

},

"featureValues": [

{

"name": "string",

"value": "string"

}

]

}

`

Response

None

Curl

`bash

curl -X POST "https://public-api.loadgen.cloud/api/services/app/Edition/CreateEdition" \\

-H "Authorization: Bearer " \\

-H "Accept: application/json" \\

-H "Content-Type: application/json" \\

--data-raw '{"edition":{"displayName":"string","id":0,"dailyPrice":0},"featureValues":[{"name":"string","value":"string"}]}'

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/Edition/CreateEdition"

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; Accept = "application/json" }

$body = @'

{

"edition": {

"displayName": "string",

"id": 0,

"dailyPrice": 0

},

"featureValues": [

{

"name": "string",

"value": "string"

}

]

}

'@

Invoke-RestMethod -Method POST -Uri $uri -Headers $headers -ContentType "application/json" -Body $body

`

DeleteEdition

Method: DELETE

Path: /api/services/app/Edition/DeleteEdition

Operation ID: ApiServicesAppEditionDeleteeditionDelete

Tag: Edition

Authentication: Yes (Bearer token)

Scope: Host

Notes:- Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.

  • This endpoint is typically used in host context (platform administration). Use a host-level account/token and omit Abp.TenantId unless your deployment requires it.

Parameters

| Name | In | Type | Required | Default | Notes |

|---|---|---|---:|---|---|

| Id | query | integer (int32) | No | | format: int32 |

Request body

None

Response

None

Curl

`bash

curl -X DELETE "https://public-api.loadgen.cloud/api/services/app/Edition/DeleteEdition?Id=0" \\

-H "Authorization: Bearer " \\

-H "Accept: application/json"

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/Edition/DeleteEdition?Id=0"

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; Accept = "application/json" }

Invoke-RestMethod -Method DELETE -Uri $uri -Headers $headers

`

GetEditionComboboxItems

Method: GET

Path: /api/services/app/Edition/GetEditionComboboxItems

Operation ID: ApiServicesAppEditionGeteditioncomboboxitemsGet

Tag: Edition

Authentication: Yes (Bearer token)

Scope: Host

Notes:- Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.

  • This endpoint is typically used in host context (platform administration). Use a host-level account/token and omit Abp.TenantId unless your deployment requires it.

Parameters

| Name | In | Type | Required | Default | Notes |

|---|---|---|---:|---|---|

| selectedEditionId | query | integer (int32) | No | | format: int32 |

| addAllItem | query | boolean | No | false | |

| onlyFreeItems | query | boolean | No | false | |

Request body

None

Response

Response envelope: ABP

  • The actual payload is usually under the result property.
  • Success is indicated by success: true. Errors are provided via error and unAuthorizedRequest.

200 OK response schema: array

Response fields

None

Example response

`json

{

"result": [

{

"isFree": false,

"value": "string",

"displayText": "string"

}

],

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

curl -X GET "https://public-api.loadgen.cloud/api/services/app/Edition/GetEditionComboboxItems?selectedEditionId=0&addAllItem=false&onlyFreeItems=false" \\

-H "Authorization: Bearer " \\

-H "Accept: application/json"

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/Edition/GetEditionComboboxItems?selectedEditionId=0&addAllItem=false&onlyFreeItems=false"

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; Accept = "application/json" }

Invoke-RestMethod -Method GET -Uri $uri -Headers $headers

`

GetEditionForEdit

Method: GET

Path: /api/services/app/Edition/GetEditionForEdit

Operation ID: ApiServicesAppEditionGeteditionforeditGet

Tag: Edition

Authentication: Yes (Bearer token)

Scope: Host

Notes:- Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.

  • This endpoint is typically used in host context (platform administration). Use a host-level account/token and omit Abp.TenantId unless your deployment requires it.

Parameters

| Name | In | Type | Required | Default | Notes |

|---|---|---|---:|---|---|

| Id | query | integer (int32) | No | | format: int32 |

Request body

None

Response

Response envelope: ABP

  • The actual payload is usually under the result property.
  • Success is indicated by success: true. Errors are provided via error and unAuthorizedRequest.

200 OK response schema: GetEditionEditOutput

Response fields

| Field | Type | Required | Description | Notes |

|---|---|---:|---|---|

| edition | object(EditionEditDto) | No | | |

| features | array | No | | |

| featureValues | array | No | | |

Example response

`json

{

"result": {

"edition": {

"displayName": "string",

"id": 0,

"expiringEditionId": 0

},

"featureValues": [

{

"name": "string",

"value": "string"

}

],

"features": [

{

"parentName": "string",

"name": "string",

"displayName": "string"

}

]

},

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

curl -X GET "https://public-api.loadgen.cloud/api/services/app/Edition/GetEditionForEdit?Id=0" \\

-H "Authorization: Bearer " \\

-H "Accept: application/json"

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/Edition/GetEditionForEdit?Id=0"

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; Accept = "application/json" }

Invoke-RestMethod -Method GET -Uri $uri -Headers $headers

`

GetEditions

Method: GET

Path: /api/services/app/Edition/GetEditions

Operation ID: ApiServicesAppEditionGeteditionsGet

Tag: Edition

Authentication: Yes (Bearer token)

Scope: Host

Notes:- Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.

  • This endpoint is typically used in host context (platform administration). Use a host-level account/token and omit Abp.TenantId unless your deployment requires it.

Parameters

None

Request body

None

Response

Response envelope: ABP

  • The actual payload is usually under the result property.
  • Success is indicated by success: true. Errors are provided via error and unAuthorizedRequest.

200 OK response schema: EditionListDtoListResultDto

Response fields

| Field | Type | Required | Description | Notes |

|---|---|---:|---|---|

| items | array | No | | |

Example response

`json

{

"result": {

"items": [

{

"name": "string",

"displayName": "string",

"dailyPrice": 0

}

]

},

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

curl -X GET "https://public-api.loadgen.cloud/api/services/app/Edition/GetEditions" \\

-H "Authorization: Bearer " \\

-H "Accept: application/json"

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/Edition/GetEditions"

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; Accept = "application/json" }

Invoke-RestMethod -Method GET -Uri $uri -Headers $headers

`

GetTenantCount

Method: GET

Path: /api/services/app/Edition/GetTenantCount

Operation ID: ApiServicesAppEditionGettenantcountGet

Tag: Edition

Authentication: Yes (Bearer token)

Scope: Host

Notes:- Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.

  • This endpoint is typically used in host context (platform administration). Use a host-level account/token and omit Abp.TenantId unless your deployment requires it.

Parameters

| Name | In | Type | Required | Default | Notes |

|---|---|---|---:|---|---|

| editionId | query | integer (int32) | No | | format: int32 |

Request body

None

Response

Response envelope: ABP

  • The actual payload is usually under the result property.
  • Success is indicated by success: true. Errors are provided via error and unAuthorizedRequest.

200 OK response schema: integer (int32)

Response fields

None

Example response

`json

{

"result": 0,

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

curl -X GET "https://public-api.loadgen.cloud/api/services/app/Edition/GetTenantCount?editionId=0" \\

-H "Authorization: Bearer " \\

-H "Accept: application/json"

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/Edition/GetTenantCount?editionId=0"

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; Accept = "application/json" }

Invoke-RestMethod -Method GET -Uri $uri -Headers $headers

`

MoveTenantsToAnotherEdition

Method: POST

Path: /api/services/app/Edition/MoveTenantsToAnotherEdition

Operation ID: ApiServicesAppEditionMovetenantstoanothereditionPost

Tag: Edition

Authentication: Yes (Bearer token)

Scope: Host

Notes:- Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.

  • This endpoint is typically used in host context (platform administration). Use a host-level account/token and omit Abp.TenantId unless your deployment requires it.

Parameters

None

Request body

Request body schema: MoveTenantsToAnotherEditionDto

Request body fields

| Field | Type | Required | Description | Notes |

|---|---|---:|---|---|

| sourceEditionId | integer (int32) | No | | format: int32

min: 1

max: 2147483647 |

| targetEditionId | integer (int32) | No | | format: int32

min: 1

max: 2147483647 |

Example request body

`json

{

"sourceEditionId": 1,

"targetEditionId": 1

}

`

Response

None

Curl

`bash

curl -X POST "https://public-api.loadgen.cloud/api/services/app/Edition/MoveTenantsToAnotherEdition" \\

-H "Authorization: Bearer " \\

-H "Accept: application/json" \\

-H "Content-Type: application/json" \\

--data-raw '{"sourceEditionId":1,"targetEditionId":1}'

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/Edition/MoveTenantsToAnotherEdition"

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; Accept = "application/json" }

$body = @'

{

"sourceEditionId": 1,

"targetEditionId": 1

}

'@

Invoke-RestMethod -Method POST -Uri $uri -Headers $headers -ContentType "application/json" -Body $body

`

UpdateEdition

Method: PUT

Path: /api/services/app/Edition/UpdateEdition

Operation ID: ApiServicesAppEditionUpdateeditionPut

Tag: Edition

Authentication: Yes (Bearer token)

Scope: Host

Notes:- Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.

  • This endpoint is typically used in host context (platform administration). Use a host-level account/token and omit Abp.TenantId unless your deployment requires it.

Parameters

None

Request body

Request body schema: UpdateEditionDto

Request body fields

| Field | Type | Required | Description | Notes |

|---|---|---:|---|---|

| edition | object(EditionEditDto) | Yes | | |

| featureValues | array | Yes | | |

Example request body

`json

{

"edition": {

"displayName": "string",

"id": 0,

"expiringEditionId": 0

},

"featureValues": [

{

"name": "string",

"value": "string"

}

]

}

`

Response

None

Curl

`bash

curl -X PUT "https://public-api.loadgen.cloud/api/services/app/Edition/UpdateEdition" \\

-H "Authorization: Bearer " \\

-H "Accept: application/json" \\

-H "Content-Type: application/json" \\

--data-raw '{"edition":{"displayName":"string","id":0,"expiringEditionId":0},"featureValues":[{"name":"string","value":"string"}]}'

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/Edition/UpdateEdition"

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; Accept = "application/json" }

$body = @'

{

"edition": {

"displayName": "string",

"id": 0,

"expiringEditionId": 0

},

"featureValues": [

{

"name": "string",

"value": "string"

}

]

}

'@

Invoke-RestMethod -Method PUT -Uri $uri -Headers $headers -ContentType "application/json" -Body $body

`

CreateInvoice

Method: POST

Path: /api/services/app/Invoice/CreateInvoice

Operation ID: ApiServicesAppInvoiceCreateinvoicePost

Tag: Invoice

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

  • Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
  • This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

None

Request body

Request body schema: CreateInvoiceDto

Request body fields

| Field | Type | Required | Description | Notes |

|---|---|---:|---|---|

| subscriptionPaymentId | integer (int64) | No | | format: int64 |

Example request body

`json

{

"subscriptionPaymentId": 0

}

`

Response

None

Curl

`bash

curl -X POST "https://public-api.loadgen.cloud/api/services/app/Invoice/CreateInvoice" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json" \\

-H "Content-Type: application/json" \\

--data-raw '{"subscriptionPaymentId":0}'

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/Invoice/CreateInvoice"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

$body = @'

{

"subscriptionPaymentId": 0

}

'@

Invoke-RestMethod -Method POST -Uri $uri -Headers $headers -ContentType "application/json" -Body $body

`

GetInvoiceInfo

Method: GET

Path: /api/services/app/Invoice/GetInvoiceInfo

Operation ID: ApiServicesAppInvoiceGetinvoiceinfoGet

Tag: Invoice

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

  • Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
  • This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

| Name | In | Type | Required | Default | Notes |

|---|---|---|---:|---|---|

| Id | query | integer (int64) | No | | format: int64 |

Request body

None

Response

Response envelope: ABP

  • The actual payload is usually under the result property.
  • Success is indicated by success: true. Errors are provided via error and unAuthorizedRequest.

200 OK response schema: InvoiceDto

Response fields

| Field | Type | Required | Description | Notes |

|---|---|---:|---|---|

| amount | number (double) | No | | format: double |

| editionDisplayName | string | No | | |

| hostAddress | array | No | | |

| hostLegalName | string | No | | |

| invoiceDate | string (date-time) | No | | format: date-time |

| invoiceNo | string | No | | |

| tenantAddress | array | No | | |

| tenantLegalName | string | No | | |

| tenantTaxNo | string | No | | |

Example response

`json

{

"result": {

"amount": 0,

"editionDisplayName": "string",

"invoiceNo": "string"

},

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

curl -X GET "https://public-api.loadgen.cloud/api/services/app/Invoice/GetInvoiceInfo?Id=0" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/Invoice/GetInvoiceInfo?Id=0"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

Invoke-RestMethod -Method GET -Uri $uri -Headers $headers

`

BuyNowSucceed

Method: POST

Path: /api/services/app/Payment/BuyNowSucceed

Operation ID: ApiServicesAppPaymentBuynowsucceedPost

Tag: Payment

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

  • Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
  • This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

| Name | In | Type | Required | Default | Notes |

|---|---|---|---:|---|---|

| paymentId | query | integer (int64) | No | | format: int64 |

Request body

None

Response

None

Curl

`bash

curl -X POST "https://public-api.loadgen.cloud/api/services/app/Payment/BuyNowSucceed?paymentId=0" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/Payment/BuyNowSucceed?paymentId=0"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

Invoke-RestMethod -Method POST -Uri $uri -Headers $headers

`

CancelPayment

Method: POST

Path: /api/services/app/Payment/CancelPayment

Operation ID: ApiServicesAppPaymentCancelpaymentPost

Tag: Payment

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

  • Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
  • This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

None

Request body

Request body schema: CancelPaymentDto

Request body fields

| Field | Type | Required | Description | Notes |

|---|---|---:|---|---|

| gateway | enum(1 \| 2) | No | | format: int32

enum: 1, 2 |

| paymentId | string | No | | |

Example request body

`json

{

"paymentId": "string",

"gateway": 1

}

`

Response

None

Curl

`bash

curl -X POST "https://public-api.loadgen.cloud/api/services/app/Payment/CancelPayment" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json" \\

-H "Content-Type: application/json" \\

--data-raw '{"paymentId":"string","gateway":1}'

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/Payment/CancelPayment"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

$body = @'

{

"paymentId": "string",

"gateway": 1

}

'@

Invoke-RestMethod -Method POST -Uri $uri -Headers $headers -ContentType "application/json" -Body $body

`

CreatePayment (Payment)

Method: POST

Path: /api/services/app/Payment/CreatePayment

Operation ID: ApiServicesAppPaymentCreatepaymentPost

Tag: Payment

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

  • Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
  • This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

None

Request body

Request body schema: CreatePaymentDto

Request body fields

| Field | Type | Required | Description | Notes |

|---|---|---:|---|---|

| editionId | integer (int32) | No | | format: int32 |

| editionPaymentType | enum(0 \| 1 \| 2 \| 3) | No | | format: int32

enum: 0, 1, 2, 3 |

| errorUrl | string | No | | |

| paymentPeriodType | enum(1 \| 7 \| 30 \| 365) | No | | format: int32

enum: 1, 7, 30, 365 |

| recurringPaymentEnabled | boolean | No | | |

| subscriptionPaymentGatewayType | enum(1 \| 2) | No | | format: int32

enum: 1, 2 |

| successUrl | string | No | | |

Example request body

`json

{

"editionId": 0,

"editionPaymentType": 0,

"paymentPeriodType": 1

}

`

Response

Response envelope: ABP

  • The actual payload is usually under the result property.
  • Success is indicated by success: true. Errors are provided via error and unAuthorizedRequest.

200 OK response schema: integer (int64)

Response fields

None

Example response

`json

{

"result": 0,

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

curl -X POST "https://public-api.loadgen.cloud/api/services/app/Payment/CreatePayment" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json" \\

-H "Content-Type: application/json" \\

--data-raw '{"editionId":0,"editionPaymentType":0,"paymentPeriodType":1}'

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/Payment/CreatePayment"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

$body = @'

{

"editionId": 0,

"editionPaymentType": 0,

"paymentPeriodType": 1

}

'@

Invoke-RestMethod -Method POST -Uri $uri -Headers $headers -ContentType "application/json" -Body $body

`

ExtendSucceed

Method: POST

Path: /api/services/app/Payment/ExtendSucceed

Operation ID: ApiServicesAppPaymentExtendsucceedPost

Tag: Payment

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

  • Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
  • This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

| Name | In | Type | Required | Default | Notes |

|---|---|---|---:|---|---|

| paymentId | query | integer (int64) | No | | format: int64 |

Request body

None

Response

None

Curl

`bash

curl -X POST "https://public-api.loadgen.cloud/api/services/app/Payment/ExtendSucceed?paymentId=0" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/Payment/ExtendSucceed?paymentId=0"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

Invoke-RestMethod -Method POST -Uri $uri -Headers $headers

`

GetActiveGateways

Method: GET

Path: /api/services/app/Payment/GetActiveGateways

Operation ID: ApiServicesAppPaymentGetactivegatewaysGet

Tag: Payment

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

  • Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
  • This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

| Name | In | Type | Required | Default | Notes |

|---|---|---|---:|---|---|

| RecurringPaymentsEnabled | query | boolean | No | | |

Request body

None

Response

Response envelope: ABP

  • The actual payload is usually under the result property.
  • Success is indicated by success: true. Errors are provided via error and unAuthorizedRequest.

200 OK response schema: array

Response fields

None

Example response

`json

{

"result": [

{

"gatewayType": 1,

"supportsRecurringPayments": false

}

],

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

curl -X GET "https://public-api.loadgen.cloud/api/services/app/Payment/GetActiveGateways?RecurringPaymentsEnabled=false" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/Payment/GetActiveGateways?RecurringPaymentsEnabled=false"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

Invoke-RestMethod -Method GET -Uri $uri -Headers $headers

`

GetLastCompletedPayment

Method: GET

Path: /api/services/app/Payment/GetLastCompletedPayment

Operation ID: ApiServicesAppPaymentGetlastcompletedpaymentGet

Tag: Payment

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

  • Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
  • This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

None

Request body

None

Response

Response envelope: ABP

  • The actual payload is usually under the result property.
  • Success is indicated by success: true. Errors are provided via error and unAuthorizedRequest.

200 OK response schema: SubscriptionPaymentDto

Response fields

| Field | Type | Required | Description | Notes |

|---|---|---:|---|---|

| amount | number (double) | No | | format: double |

| dayCount | integer (int32) | No | | format: int32 |

| description | string | No | | |

| editionDisplayName | string | No | | |

| editionId | integer (int32) | No | | format: int32 |

| editionPaymentType | enum(0 \| 1 \| 2 \| 3) | No | | format: int32

enum: 0, 1, 2, 3 |

| errorUrl | string | No | | |

| externalPaymentId | string | No | | |

| gateway | enum(1 \| 2) | No | | format: int32

enum: 1, 2 |

| id | integer (int64) | No | | format: int64 |

| invoiceNo | integer (int64) | No | | format: int64 |

| isRecurring | boolean | No | | |

| payerId | string | No | | |

| paymentId | string | No | | |

| paymentPeriodType | enum(1 \| 7 \| 30 \| 365) | No | | format: int32

enum: 1, 7, 30, 365 |

| status | enum(1 \| 2 \| 3 \| 4 \| 5) | No | | format: int32

enum: 1, 2, 3, 4, 5 |

| successUrl | string | No | | |

| tenantId | integer (int32) | No | | format: int32 |

Example response

`json

{

"result": {

"description": "string",

"gateway": 1,

"amount": 0

},

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

curl -X GET "https://public-api.loadgen.cloud/api/services/app/Payment/GetLastCompletedPayment" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/Payment/GetLastCompletedPayment"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

Invoke-RestMethod -Method GET -Uri $uri -Headers $headers

`

GetPayment (Payment)

Method: GET

Path: /api/services/app/Payment/GetPayment

Operation ID: ApiServicesAppPaymentGetpaymentGet

Tag: Payment

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

  • Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
  • This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

| Name | In | Type | Required | Default | Notes |

|---|---|---|---:|---|---|

| paymentId | query | integer (int64) | No | | format: int64 |

Request body

None

Response

Response envelope: ABP

  • The actual payload is usually under the result property.
  • Success is indicated by success: true. Errors are provided via error and unAuthorizedRequest.

200 OK response schema: SubscriptionPaymentDto

Response fields

| Field | Type | Required | Description | Notes |

|---|---|---:|---|---|

| amount | number (double) | No | | format: double |

| dayCount | integer (int32) | No | | format: int32 |

| description | string | No | | |

| editionDisplayName | string | No | | |

| editionId | integer (int32) | No | | format: int32 |

| editionPaymentType | enum(0 \| 1 \| 2 \| 3) | No | | format: int32

enum: 0, 1, 2, 3 |

| errorUrl | string | No | | |

| externalPaymentId | string | No | | |

| gateway | enum(1 \| 2) | No | | format: int32

enum: 1, 2 |

| id | integer (int64) | No | | format: int64 |

| invoiceNo | integer (int64) | No | | format: int64 |

| isRecurring | boolean | No | | |

| payerId | string | No | | |

| paymentId | string | No | | |

| paymentPeriodType | enum(1 \| 7 \| 30 \| 365) | No | | format: int32

enum: 1, 7, 30, 365 |

| status | enum(1 \| 2 \| 3 \| 4 \| 5) | No | | format: int32

enum: 1, 2, 3, 4, 5 |

| successUrl | string | No | | |

| tenantId | integer (int32) | No | | format: int32 |

Example response

`json

{

"result": {

"description": "string",

"gateway": 1,

"amount": 0

},

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

curl -X GET "https://public-api.loadgen.cloud/api/services/app/Payment/GetPayment?paymentId=0" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/Payment/GetPayment?paymentId=0"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

Invoke-RestMethod -Method GET -Uri $uri -Headers $headers

`

GetPaymentHistory

Method: GET

Path: /api/services/app/Payment/GetPaymentHistory

Operation ID: ApiServicesAppPaymentGetpaymenthistoryGet

Tag: Payment

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

  • Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
  • This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

| Name | In | Type | Required | Default | Notes |

|---|---|---|---:|---|---|

| Sorting | query | string | No | | |

| MaxResultCount | query | integer (int32) | No | | format: int32

min: 1

max: 1000 |

| SkipCount | query | integer (int32) | No | | format: int32

min: 0

max: 2147483647 |

Request body

None

Response

Response envelope: ABP

  • The actual payload is usually under the result property.
  • Success is indicated by success: true. Errors are provided via error and unAuthorizedRequest.

200 OK response schema: SubscriptionPaymentListDtoPagedResultDto

Response fields

| Field | Type | Required | Description | Notes |

|---|---|---:|---|---|

| items | array | No | | |

| totalCount | integer (int32) | No | | format: int32 |

Example response

`json

{

"result": {

"totalCount": 0,

"items": [

{

"gateway": "string",

"amount": 0,

"editionId": 0

}

]

},

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

curl -X GET "https://public-api.loadgen.cloud/api/services/app/Payment/GetPaymentHistory?Sorting=string&MaxResultCount=1&SkipCount=0" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/Payment/GetPaymentHistory?Sorting=string&MaxResultCount=1&SkipCount=0"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

Invoke-RestMethod -Method GET -Uri $uri -Headers $headers

`

GetPaymentInfo

Method: GET

Path: /api/services/app/Payment/GetPaymentInfo

Operation ID: ApiServicesAppPaymentGetpaymentinfoGet

Tag: Payment

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

  • Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
  • This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

| Name | In | Type | Required | Default | Notes |

|---|---|---|---:|---|---|

| UpgradeEditionId | query | integer (int32) | No | | format: int32 |

Request body

None

Response

Response envelope: ABP

  • The actual payload is usually under the result property.
  • Success is indicated by success: true. Errors are provided via error and unAuthorizedRequest.

200 OK response schema: PaymentInfoDto

Response fields

| Field | Type | Required | Description | Notes |

|---|---|---:|---|---|

| additionalPrice | number (double) | No | | format: double |

| edition | object(EditionSelectDto) | No | | |

Example response

`json

{

"result": {

"edition": {

"id": 0,

"name": "string",

"displayName": "string"

},

"additionalPrice": 0

},

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

curl -X GET "https://public-api.loadgen.cloud/api/services/app/Payment/GetPaymentInfo?UpgradeEditionId=0" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/Payment/GetPaymentInfo?UpgradeEditionId=0"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

Invoke-RestMethod -Method GET -Uri $uri -Headers $headers

`

HasAnyPayment

Method: POST

Path: /api/services/app/Payment/HasAnyPayment

Operation ID: ApiServicesAppPaymentHasanypaymentPost

Tag: Payment

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

  • Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
  • This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

None

Request body

None

Response

Response envelope: ABP

  • The actual payload is usually under the result property.
  • Success is indicated by success: true. Errors are provided via error and unAuthorizedRequest.

200 OK response schema: boolean

Response fields

None

Example response

`json

{

"result": false,

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

curl -X POST "https://public-api.loadgen.cloud/api/services/app/Payment/HasAnyPayment" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json" \\

-H "Content-Type: application/json"

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/Payment/HasAnyPayment"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

Invoke-RestMethod -Method POST -Uri $uri -Headers $headers

`

NewRegistrationSucceed

Method: POST

Path: /api/services/app/Payment/NewRegistrationSucceed

Operation ID: ApiServicesAppPaymentNewregistrationsucceedPost

Tag: Payment

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

  • Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
  • This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

| Name | In | Type | Required | Default | Notes |

|---|---|---|---:|---|---|

| paymentId | query | integer (int64) | No | | format: int64 |

Request body

None

Response

None

Curl

`bash

curl -X POST "https://public-api.loadgen.cloud/api/services/app/Payment/NewRegistrationSucceed?paymentId=0" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/Payment/NewRegistrationSucceed?paymentId=0"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

Invoke-RestMethod -Method POST -Uri $uri -Headers $headers

`

PaymentFailed

Method: POST

Path: /api/services/app/Payment/PaymentFailed

Operation ID: ApiServicesAppPaymentPaymentfailedPost

Tag: Payment

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

  • Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
  • This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

| Name | In | Type | Required | Default | Notes |

|---|---|---|---:|---|---|

| paymentId | query | integer (int64) | No | | format: int64 |

Request body

None

Response

None

Curl

`bash

curl -X POST "https://public-api.loadgen.cloud/api/services/app/Payment/PaymentFailed?paymentId=0" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/Payment/PaymentFailed?paymentId=0"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

Invoke-RestMethod -Method POST -Uri $uri -Headers $headers

`

SwitchBetweenFreeEditions

Method: POST

Path: /api/services/app/Payment/SwitchBetweenFreeEditions

Operation ID: ApiServicesAppPaymentSwitchbetweenfreeeditionsPost

Tag: Payment

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

  • Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
  • This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

| Name | In | Type | Required | Default | Notes |

|---|---|---|---:|---|---|

| upgradeEditionId | query | integer (int32) | No | | format: int32 |

Request body

None

Response

None

Curl

`bash

curl -X POST "https://public-api.loadgen.cloud/api/services/app/Payment/SwitchBetweenFreeEditions?upgradeEditionId=0" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/Payment/SwitchBetweenFreeEditions?upgradeEditionId=0"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

Invoke-RestMethod -Method POST -Uri $uri -Headers $headers

`

UpgradeSubscriptionCostsLessThenMinAmount

Method: POST

Path: /api/services/app/Payment/UpgradeSubscriptionCostsLessThenMinAmount

Operation ID: ApiServicesAppPaymentUpgradesubscriptioncostslessthenminamountPost

Tag: Payment

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

  • Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
  • This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

| Name | In | Type | Required | Default | Notes |

|---|---|---|---:|---|---|

| editionId | query | integer (int32) | No | | format: int32 |

Request body

None

Response

None

Curl

`bash

curl -X POST "https://public-api.loadgen.cloud/api/services/app/Payment/UpgradeSubscriptionCostsLessThenMinAmount?editionId=0" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/Payment/UpgradeSubscriptionCostsLessThenMinAmount?editionId=0"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

Invoke-RestMethod -Method POST -Uri $uri -Headers $headers

`

UpgradeSucceed

Method: POST

Path: /api/services/app/Payment/UpgradeSucceed

Operation ID: ApiServicesAppPaymentUpgradesucceedPost

Tag: Payment

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

  • Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
  • This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

| Name | In | Type | Required | Default | Notes |

|---|---|---|---:|---|---|

| paymentId | query | integer (int64) | No | | format: int64 |

Request body

None

Response

None

Curl

`bash

curl -X POST "https://public-api.loadgen.cloud/api/services/app/Payment/UpgradeSucceed?paymentId=0" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/Payment/UpgradeSucceed?paymentId=0"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

Invoke-RestMethod -Method POST -Uri $uri -Headers $headers

`

ConfirmPayment

Method: POST

Path: /api/services/app/PayPalPayment/ConfirmPayment

Operation ID: ApiServicesAppPaypalpaymentConfirmpaymentPost

Tag: PayPalPayment

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

  • Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
  • This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

| Name | In | Type | Required | Default | Notes |

|---|---|---|---:|---|---|

| paymentId | query | integer (int64) | No | | format: int64 |

| paypalOrderId | query | string | No | | |

Request body

None

Response

None

Curl

`bash

curl -X POST "https://public-api.loadgen.cloud/api/services/app/PayPalPayment/ConfirmPayment?paymentId=0&paypalOrderId=string" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/PayPalPayment/ConfirmPayment?paymentId=0&paypalOrderId=string"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

Invoke-RestMethod -Method POST -Uri $uri -Headers $headers

`

GetConfiguration (PayPalPayment)

Method: GET

Path: /api/services/app/PayPalPayment/GetConfiguration

Operation ID: ApiServicesAppPaypalpaymentGetconfigurationGet

Tag: PayPalPayment

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

  • Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
  • This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

None

Request body

None

Response

Response envelope: ABP

  • The actual payload is usually under the result property.
  • Success is indicated by success: true. Errors are provided via error and unAuthorizedRequest.

200 OK response schema: PayPalConfigurationDto

Response fields

| Field | Type | Required | Description | Notes |

|---|---|---:|---|---|

| clientId | string | No | | |

| demoPassword | string | No | | |

| demoUsername | string | No | | |

| disabledFundings | array | No | | |

Example response

`json

{

"result": {

"clientId": "string",

"demoUsername": "string",

"demoPassword": "string"

},

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

curl -X GET "https://public-api.loadgen.cloud/api/services/app/PayPalPayment/GetConfiguration" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/PayPalPayment/GetConfiguration"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

Invoke-RestMethod -Method GET -Uri $uri -Headers $headers

`

AddProduct

Method: POST

Path: /api/services/app/Product/AddProduct

Operation ID: ApiServicesAppProductAddproductPost

Tag: Product

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

  • Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
  • This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

None

Request body

Request body schema: AddProductInput

Request body fields

| Field | Type | Required | Description | Notes |

|---|---|---:|---|---|

| discriminator | string | No | | |

| isDefault | boolean | No | | |

| productId | string | No | | |

| productOption | object(ProductOptionDto) | No | | |

Example request body

`json

{

"discriminator": "string",

"productId": "string",

"productOption": {

"key": 0,

"value": "string",

"id": 0

}

}

`

Response

None

Curl

`bash

curl -X POST "https://public-api.loadgen.cloud/api/services/app/Product/AddProduct" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json" \\

-H "Content-Type: application/json" \\

--data-raw '{"discriminator":"string","productId":"string","productOption":{"key":0,"value":"string","id":0}}'

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/Product/AddProduct"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

$body = @'

{

"discriminator": "string",

"productId": "string",

"productOption": {

"key": 0,

"value": "string",

"id": 0

}

}

'@

Invoke-RestMethod -Method POST -Uri $uri -Headers $headers -ContentType "application/json" -Body $body

`

CancelSubscription

Method: POST

Path: /api/services/app/Product/CancelSubscription

Operation ID: ApiServicesAppProductCancelsubscriptionPost

Tag: Product

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

  • Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
  • This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

| Name | In | Type | Required | Default | Notes |

|---|---|---|---:|---|---|

| discriminator | query | string | No | | |

Request body

None

Response

None

Curl

`bash

curl -X POST "https://public-api.loadgen.cloud/api/services/app/Product/CancelSubscription?discriminator=string" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/Product/CancelSubscription?discriminator=string"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

Invoke-RestMethod -Method POST -Uri $uri -Headers $headers

`

CreatePayment (Product)

Method: POST

Path: /api/services/app/Product/CreatePayment

Operation ID: ApiServicesAppProductCreatepaymentPost

Tag: Product

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

  • Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
  • This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

| Name | In | Type | Required | Default | Notes |

|---|---|---|---:|---|---|

| discriminator | query | string | No | | |

| quantity | query | integer (int32) | No | | format: int32 |

| priceId | query | integer (int64) | No | | format: int64 |

Request body

None

Response

Response envelope: ABP

  • The actual payload is usually under the result property.
  • Success is indicated by success: true. Errors are provided via error and unAuthorizedRequest.

200 OK response schema: integer (int64)

Response fields

None

Example response

`json

{

"result": 0,

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

curl -X POST "https://public-api.loadgen.cloud/api/services/app/Product/CreatePayment?discriminator=string&quantity=0&priceId=0" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json" \\

-H "Content-Type: application/json"

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/Product/CreatePayment?discriminator=string&quantity=0&priceId=0"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

Invoke-RestMethod -Method POST -Uri $uri -Headers $headers

`

CreatePaymentSession (Product)

Method: POST

Path: /api/services/app/Product/CreatePaymentSession

Operation ID: ApiServicesAppProductCreatepaymentsessionPost

Tag: Product

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

  • Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
  • This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

None

Request body

Request body schema: LicensePaymentSessionInput

Request body fields

| Field | Type | Required | Description | Notes |

|---|---|---:|---|---|

| cancelUrl | string | No | | |

| licenseType | enum(0 \| 1) | No | | format: int32

enum: 0, 1 |

| paymentId | integer (int64) | No | | format: int64 |

| successUrl | string | No | | |

Example request body

`json

{

"paymentId": 0,

"licenseType": 0,

"successUrl": "https://example.com"

}

`

Response

Response envelope: ABP

  • The actual payload is usually under the result property.
  • Success is indicated by success: true. Errors are provided via error and unAuthorizedRequest.

200 OK response schema: string

Response fields

None

Example response

`json

{

"result": "string",

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

curl -X POST "https://public-api.loadgen.cloud/api/services/app/Product/CreatePaymentSession" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json" \\

-H "Content-Type: application/json" \\

--data-raw '{"paymentId":0,"licenseType":0,"successUrl":"https://example.com"}'

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/Product/CreatePaymentSession"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

$body = @'

{

"paymentId": 0,

"licenseType": 0,

"successUrl": "https://example.com"

}

'@

Invoke-RestMethod -Method POST -Uri $uri -Headers $headers -ContentType "application/json" -Body $body

`

DeleteProduct

Method: DELETE

Path: /api/services/app/Product/DeleteProduct

Operation ID: ApiServicesAppProductDeleteproductDelete

Tag: Product

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

  • Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
  • This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

| Name | In | Type | Required | Default | Notes |

|---|---|---|---:|---|---|

| productId | query | string | No | | |

Request body

None

Response

None

Curl

`bash

curl -X DELETE "https://public-api.loadgen.cloud/api/services/app/Product/DeleteProduct?productId=string" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/Product/DeleteProduct?productId=string"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

Invoke-RestMethod -Method DELETE -Uri $uri -Headers $headers

`

EditProduct

Method: POST

Path: /api/services/app/Product/EditProduct

Operation ID: ApiServicesAppProductEditproductPost

Tag: Product

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

  • Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
  • This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

None

Request body

Request body schema: EditProductInput

Request body fields

| Field | Type | Required | Description | Notes |

|---|---|---:|---|---|

| productOption | object(ProductOptionDto) | No | | |

Example request body

`json

{

"productOption": {

"key": 0,

"value": "string",

"id": 0

}

}

`

Response

None

Curl

`bash

curl -X POST "https://public-api.loadgen.cloud/api/services/app/Product/EditProduct" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json" \\

-H "Content-Type: application/json" \\

--data-raw '{"productOption":{"key":0,"value":"string","id":0}}'

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/Product/EditProduct"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

$body = @'

{

"productOption": {

"key": 0,

"value": "string",

"id": 0

}

}

'@

Invoke-RestMethod -Method POST -Uri $uri -Headers $headers -ContentType "application/json" -Body $body

`

GetAllPayments

Method: GET

Path: /api/services/app/Product/GetAllPayments

Operation ID: ApiServicesAppProductGetallpaymentsGet

Tag: Product

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

  • Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
  • This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

| Name | In | Type | Required | Default | Notes |

|---|---|---|---:|---|---|

| TenantNameFilter | query | string | No | | |

| ProductNameFilter | query | string | No | | |

| StatusFilter | query | enum(0 | 1 | 2 | 3 | 4) | No | | format: int32

enum: 0, 1, 2, 3, 4 |

| PaymentTypeFilter | query | enum(0 | 1) | No | | format: int32

enum: 0, 1 |

| Sorting | query | string | No | | |

| SkipCount | query | integer (int32) | No | | format: int32

min: 0

max: 2147483647 |

| MaxResultCount | query | integer (int32) | No | | format: int32

min: 1

max: 2147483647 |

Request body

None

Response

Response envelope: ABP

  • The actual payload is usually under the result property.
  • Success is indicated by success: true. Errors are provided via error and unAuthorizedRequest.

200 OK response schema: GetAllPaymentDtoPagedResultDto

Response fields

| Field | Type | Required | Description | Notes |

|---|---|---:|---|---|

| items | array | No | | |

| totalCount | integer (int32) | No | | format: int32 |

Example response

`json

{

"result": {

"totalCount": 0,

"items": [

{

"payment": {

"quantity": 0

},

"tenantName": "string",

"creationTime": "2025-01-01T00:00:00Z"

}

]

},

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

curl -X GET "https://public-api.loadgen.cloud/api/services/app/Product/GetAllPayments?TenantNameFilter=string&ProductNameFilter=string&StatusFilter=0" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/Product/GetAllPayments?TenantNameFilter=string&ProductNameFilter=string&StatusFilter=0"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

Invoke-RestMethod -Method GET -Uri $uri -Headers $headers

`

GetAllProducts

Method: GET

Path: /api/services/app/Product/GetAllProducts

Operation ID: ApiServicesAppProductGetallproductsGet

Tag: Product

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

  • Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
  • This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

None

Request body

None

Response

Response envelope: ABP

  • The actual payload is usually under the result property.
  • Success is indicated by success: true. Errors are provided via error and unAuthorizedRequest.

200 OK response schema: object

Response fields

None

Example response

`json

{

"result": {

"key": [

{

"productId": "string",

"name": "string",

"description": "string"

}

]

},

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

curl -X GET "https://public-api.loadgen.cloud/api/services/app/Product/GetAllProducts" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/Product/GetAllProducts"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

Invoke-RestMethod -Method GET -Uri $uri -Headers $headers

`

GetAllProductsByOption

Method: GET

Path: /api/services/app/Product/GetAllProductsByOption

Operation ID: ApiServicesAppProductGetallproductsbyoptionGet

Tag: Product

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

  • Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
  • This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

| Name | In | Type | Required | Default | Notes |

|---|---|---|---:|---|---|

| option | query | enum(0 | 1) | No | | format: int32

enum: 0, 1 |

| discriminator | query | string | No | | |

Request body

None

Response

Response envelope: ABP

  • The actual payload is usually under the result property.
  • Success is indicated by success: true. Errors are provided via error and unAuthorizedRequest.

200 OK response schema: array

Response fields

None

Example response

`json

{

"result": [

{

"productId": "string",

"name": "string",

"description": "string"

}

],

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

curl -X GET "https://public-api.loadgen.cloud/api/services/app/Product/GetAllProductsByOption?option=0&discriminator=string" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/Product/GetAllProductsByOption?option=0&discriminator=string"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

Invoke-RestMethod -Method GET -Uri $uri -Headers $headers

`

GetPaymentDto

Method: GET

Path: /api/services/app/Product/GetPaymentDto

Operation ID: ApiServicesAppProductGetpaymentdtoGet

Tag: Product

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

  • Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
  • This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

| Name | In | Type | Required | Default | Notes |

|---|---|---|---:|---|---|

| paymentId | query | integer (int64) | No | | format: int64 |

| sessionId | query | string | No | | |

Request body

None

Response

Response envelope: ABP

  • The actual payload is usually under the result property.
  • Success is indicated by success: true. Errors are provided via error and unAuthorizedRequest.

200 OK response schema: PaymentDto

Response fields

| Field | Type | Required | Description | Notes |

|---|---|---:|---|---|

| id | integer (int64) | No | | format: int64 |

| product | object(ProductDto) | No | | |

| quantity | integer (int32) | No | | format: int32 |

| status | enum(0 \| 1 \| 2 \| 3 \| 4) | No | | format: int32

enum: 0, 1, 2, 3, 4 |

| type | enum(0 \| 1) | No | | format: int32

enum: 0, 1 |

Example response

`json

{

"result": {

"quantity": 0,

"product": {

"price": 0,

"name": "string",

"description": "string"

},

"status": 0

},

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

curl -X GET "https://public-api.loadgen.cloud/api/services/app/Product/GetPaymentDto?paymentId=0&sessionId=string" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/Product/GetPaymentDto?paymentId=0&sessionId=string"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

Invoke-RestMethod -Method GET -Uri $uri -Headers $headers

`

GetProductById

Method: GET

Path: /api/services/app/Product/GetProductById

Operation ID: ApiServicesAppProductGetproductbyidGet

Tag: Product

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

  • Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
  • This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

| Name | In | Type | Required | Default | Notes |

|---|---|---|---:|---|---|

| productId | query | string | No | | |

Request body

None

Response

Response envelope: ABP

  • The actual payload is usually under the result property.
  • Success is indicated by success: true. Errors are provided via error and unAuthorizedRequest.

200 OK response schema: PricingDto

Response fields

| Field | Type | Required | Description | Notes |

|---|---|---:|---|---|

| description | string | No | | |

| name | string | No | | |

| prices | array | No | | |

| productId | string | No | | |

Example response

`json

{

"result": {

"productId": "string",

"name": "string",

"description": "string"

},

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

curl -X GET "https://public-api.loadgen.cloud/api/services/app/Product/GetProductById?productId=string" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/Product/GetProductById?productId=string"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

Invoke-RestMethod -Method GET -Uri $uri -Headers $headers

`

GetProducts

Method: GET

Path: /api/services/app/Product/GetProducts

Operation ID: ApiServicesAppProductGetproductsGet

Tag: Product

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

  • Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
  • This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

| Name | In | Type | Required | Default | Notes |

|---|---|---|---:|---|---|

| discriminator | query | string | No | | |

Request body

None

Response

Response envelope: ABP

  • The actual payload is usually under the result property.
  • Success is indicated by success: true. Errors are provided via error and unAuthorizedRequest.

200 OK response schema: array

Response fields

None

Example response

`json

{

"result": [

{

"productId": "string",

"name": "string",

"description": "string"

}

],

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

curl -X GET "https://public-api.loadgen.cloud/api/services/app/Product/GetProducts?discriminator=string" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/Product/GetProducts?discriminator=string"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

Invoke-RestMethod -Method GET -Uri $uri -Headers $headers

`

GetTenantSubscriptions

Method: GET

Path: /api/services/app/Product/GetTenantSubscriptions

Operation ID: ApiServicesAppProductGettenantsubscriptionsGet

Tag: Product

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

  • Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
  • This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

None

Request body

None

Response

Response envelope: ABP

  • The actual payload is usually under the result property.
  • Success is indicated by success: true. Errors are provided via error and unAuthorizedRequest.

200 OK response schema: object

Response fields

None

Example response

`json

{

"result": {

"key": {

"subscriptionId": "string",

"priceId": 0

}

},

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

curl -X GET "https://public-api.loadgen.cloud/api/services/app/Product/GetTenantSubscriptions" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/Product/GetTenantSubscriptions"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

Invoke-RestMethod -Method GET -Uri $uri -Headers $headers

`

UpgradeSubscription

Method: POST

Path: /api/services/app/Product/UpgradeSubscription

Operation ID: ApiServicesAppProductUpgradesubscriptionPost

Tag: Product

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

  • Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
  • This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

| Name | In | Type | Required | Default | Notes |

|---|---|---|---:|---|---|

| paymentId | query | integer (int64) | No | | format: int64 |

Request body

None

Response

None

Curl

`bash

curl -X POST "https://public-api.loadgen.cloud/api/services/app/Product/UpgradeSubscription?paymentId=0" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/Product/UpgradeSubscription?paymentId=0"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

Invoke-RestMethod -Method POST -Uri $uri -Headers $headers

`

CreatePaymentSession (StripePayment)

Method: POST

Path: /api/services/app/StripePayment/CreatePaymentSession

Operation ID: ApiServicesAppStripepaymentCreatepaymentsessionPost

Tag: StripePayment

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

  • Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
  • This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

None

Request body

Request body schema: StripeCreatePaymentSessionInput

Request body fields

| Field | Type | Required | Description | Notes |

|---|---|---:|---|---|

| cancelUrl | string | No | | |

| paymentId | integer (int64) | No | | format: int64 |

| quantity | integer (int32) | No | | format: int32 |

| successUrl | string | No | | |

Example request body

`json

{

"paymentId": 0,

"successUrl": "https://example.com",

"cancelUrl": "https://example.com"

}

`

Response

Response envelope: ABP

  • The actual payload is usually under the result property.
  • Success is indicated by success: true. Errors are provided via error and unAuthorizedRequest.

200 OK response schema: string

Response fields

None

Example response

`json

{

"result": "string",

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

curl -X POST "https://public-api.loadgen.cloud/api/services/app/StripePayment/CreatePaymentSession" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json" \\

-H "Content-Type: application/json" \\

--data-raw '{"paymentId":0,"successUrl":"https://example.com","cancelUrl":"https://example.com"}'

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/StripePayment/CreatePaymentSession"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

$body = @'

{

"paymentId": 0,

"successUrl": "https://example.com",

"cancelUrl": "https://example.com"

}

'@

Invoke-RestMethod -Method POST -Uri $uri -Headers $headers -ContentType "application/json" -Body $body

`

GetConfiguration (StripePayment)

Method: GET

Path: /api/services/app/StripePayment/GetConfiguration

Operation ID: ApiServicesAppStripepaymentGetconfigurationGet

Tag: StripePayment

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

  • Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
  • This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

None

Request body

None

Response

Response envelope: ABP

  • The actual payload is usually under the result property.
  • Success is indicated by success: true. Errors are provided via error and unAuthorizedRequest.

200 OK response schema: StripeConfigurationDto

Response fields

| Field | Type | Required | Description | Notes |

|---|---|---:|---|---|

| publishableKey | string | No | | |

Example response

`json

{

"result": {

"publishableKey": "string"

},

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

curl -X GET "https://public-api.loadgen.cloud/api/services/app/StripePayment/GetConfiguration" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/StripePayment/GetConfiguration"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

Invoke-RestMethod -Method GET -Uri $uri -Headers $headers

`

GetPayment (StripePayment)

Method: GET

Path: /api/services/app/StripePayment/GetPayment

Operation ID: ApiServicesAppStripepaymentGetpaymentGet

Tag: StripePayment

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

  • Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
  • This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

| Name | In | Type | Required | Default | Notes |

|---|---|---|---:|---|---|

| StripeSessionId | query | string | No | | |

Request body

None

Response

Response envelope: ABP

  • The actual payload is usually under the result property.
  • Success is indicated by success: true. Errors are provided via error and unAuthorizedRequest.

200 OK response schema: SubscriptionPaymentDto

Response fields

| Field | Type | Required | Description | Notes |

|---|---|---:|---|---|

| amount | number (double) | No | | format: double |

| dayCount | integer (int32) | No | | format: int32 |

| description | string | No | | |

| editionDisplayName | string | No | | |

| editionId | integer (int32) | No | | format: int32 |

| editionPaymentType | enum(0 \| 1 \| 2 \| 3) | No | | format: int32

enum: 0, 1, 2, 3 |

| errorUrl | string | No | | |

| externalPaymentId | string | No | | |

| gateway | enum(1 \| 2) | No | | format: int32

enum: 1, 2 |

| id | integer (int64) | No | | format: int64 |

| invoiceNo | integer (int64) | No | | format: int64 |

| isRecurring | boolean | No | | |

| payerId | string | No | | |

| paymentId | string | No | | |

| paymentPeriodType | enum(1 \| 7 \| 30 \| 365) | No | | format: int32

enum: 1, 7, 30, 365 |

| status | enum(1 \| 2 \| 3 \| 4 \| 5) | No | | format: int32

enum: 1, 2, 3, 4, 5 |

| successUrl | string | No | | |

| tenantId | integer (int32) | No | | format: int32 |

Example response

`json

{

"result": {

"description": "string",

"gateway": 1,

"amount": 0

},

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

curl -X GET "https://public-api.loadgen.cloud/api/services/app/StripePayment/GetPayment?StripeSessionId=string" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/StripePayment/GetPayment?StripeSessionId=string"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

Invoke-RestMethod -Method GET -Uri $uri -Headers $headers

`

GetPaymentResult

Method: GET

Path: /api/services/app/StripePayment/GetPaymentResult

Operation ID: ApiServicesAppStripepaymentGetpaymentresultGet

Tag: StripePayment

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

  • Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
  • This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

| Name | In | Type | Required | Default | Notes |

|---|---|---|---:|---|---|

| PaymentId | query | integer (int64) | No | | format: int64 |

Request body

None

Response

Response envelope: ABP

  • The actual payload is usually under the result property.
  • Success is indicated by success: true. Errors are provided via error and unAuthorizedRequest.

200 OK response schema: StripePaymentResultOutput

Response fields

| Field | Type | Required | Description | Notes |

|---|---|---:|---|---|

| paymentDone | boolean | No | | |

Example response

`json

{

"result": {

"paymentDone": false

},

"targetUrl": null,

"success": true,

"error": null,

"unAuthorizedRequest": false,

"\\abp": true

}

`

Curl

`bash

curl -X GET "https://public-api.loadgen.cloud/api/services/app/StripePayment/GetPaymentResult?PaymentId=0" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/StripePayment/GetPaymentResult?PaymentId=0"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

Invoke-RestMethod -Method GET -Uri $uri -Headers $headers

`

DisableRecurringPayments

Method: POST

Path: /api/services/app/Subscription/DisableRecurringPayments

Operation ID: ApiServicesAppSubscriptionDisablerecurringpaymentsPost

Tag: Subscription

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

  • Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
  • This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

None

Request body

None

Response

None

Curl

`bash

curl -X POST "https://public-api.loadgen.cloud/api/services/app/Subscription/DisableRecurringPayments" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/Subscription/DisableRecurringPayments"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

Invoke-RestMethod -Method POST -Uri $uri -Headers $headers

`

EnableRecurringPayments

Method: POST

Path: /api/services/app/Subscription/EnableRecurringPayments

Operation ID: ApiServicesAppSubscriptionEnablerecurringpaymentsPost

Tag: Subscription

Authentication: Yes (Bearer token)

Scope: Tenant (default)

Notes:

  • Most endpoints return an ABP-style response envelope. In practice, the payload is usually available under the result property.
  • This API is multi-tenant. Even when there is no explicit TenantId query parameter, tenant context is typically derived from the JWT token and/or the Abp.TenantId header.

Parameters

None

Request body

None

Response

None

Curl

`bash

curl -X POST "https://public-api.loadgen.cloud/api/services/app/Subscription/EnableRecurringPayments" \\

-H "Authorization: Bearer " \\

-H "Abp.TenantId: 12345" \\

-H "Accept: application/json"

`

PowerShell

`powershell

$baseUrl = "https://public-api.loadgen.cloud"

$uri = "$baseUrl/api/services/app/Subscription/EnableRecurringPayments"

$tenantId = 12345

$accessToken = ""

$headers = @{ Authorization = "Bearer $accessToken"; "Abp.TenantId" = "$tenantId"; Accept = "application/json" }

Invoke-RestMethod -Method POST -Uri $uri -Headers $headers

`

Was this article helpful?
0 out of 0 found this helpful