Get prices

Get prices.

get

Query parameters

PaymentMethodIdstringOptional

The id of the payment method.

PackageIdstringOptional

The id of the package.

SubscriptionTypeIdstringOptional

The id of the subscription type.

CodestringOptional

The code of the price.

NamestringOptional

The name of the price.

DescriptionstringOptional

The description of the price.

Amountnumber · doubleOptional

The amount of the price.

CurrencystringOptional

The currency of the price.

CheckoutLinkstringOptional

The checkout link.

TagsstringOptional

The tags of the price.

ZOrderinteger · int64Optional

The z-order of the price.

SortDataFieldstringOptional

The sort data field to sort. By default, the value is ID.

SortOrderstring · enumOptional

Specifies the sorting order type for a collection.

Possible values:

PageNumberinteger · int32Optional

The page number of the pagination. Default value is 0.

PageSizeinteger · int32Optional

The page size of the pagination. Default value is 200.

Header parameters

Brand-URLstringRequired

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

Example: YOUR_BRAND_URL

Auth-KeystringRequired

Auth-Key is required to authenticate the request. If missing, the server will return 401 Unauthorized.

Example: YOUR_AUTH_KEY

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

get

HTTPcURLJavaScriptPython

GET /api/v1/prices HTTP/1.1
Host: protocol.jframework.io
Brand-URL: text
Auth-Key: text
Accept: */*

{
  "success": true,
  "statusCode": 200,
  "message": "The request was successful.",
  "data": [
    {
      "id": "sApKpllz4sAplsmzha",
      "code": "Code",
      "name": "Name",
      "amount": 10,
      "currency": "USD",
      "description": "Description",
      "checkoutLink": "CheckoutLink",
      "tags": "Tags",
      "packageName": "PackageName",
      "packageId": "PackageId",
      "subscriptionName": "SubscriptionName",
      "subscriptionTypeId": "SubscriptionTypeId",
      "zOrder": 1
    }
  ],
  "errors": []
}