Create a price

Create a price.

post

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

This class presents the Price Command Request Data from the client.

packageIdstring · min: 1Required

The id of the package.

subscriptionTypeIdstring · min: 1Required

The id of the subscription type

codestring · min: 1Required

The code of the price.

namestring · min: 1Required

The name of the price.

amountnumber · doubleRequired

The amount of the price.

currencystring · min: 1Required

The currency code of the price. The currency must be a valid ISO 4217 currency code.

checkoutLinkstring · uri | nullableOptional

The checkout link of the price. When the user clicks on this link, they will be redirected to the checkout page.

descriptionstring | nullableOptional

The description of the price.

tagsstring | nullableOptional

The tags of the price.

zOrderinteger · int32 | nullableOptional

The order of the price. This value is used to sort into the list of prices. By default, the value is 1. If you want to change the order of the price, you can set this value to a higher number.

Responses

201

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

403

The user's access was denied.

application/json

post

HTTPcURLJavaScriptPython

POST /api/v1/prices HTTP/1.1
Host: protocol.jframework.io
Brand-URL: text
Auth-Key: text
Content-Type: application/json
Accept: */*
Content-Length: 188

{
  "packageId": "text",
  "subscriptionTypeId": "text",
  "code": "text",
  "name": "text",
  "amount": 1,
  "currency": "text",
  "checkoutLink": "https://example.com",
  "description": "text",
  "tags": "text",
  "zOrder": 1
}

application/jsontext/jsonapplication/*+json

{
  "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": []
}