Rekaz Documentation
  • 鉀╋笍Introduction
  • 馃殌Quick Start
  • 馃捇API Reference
    • Subscription
      • Usage list
      • Usage
      • End usage
    • Customer
    • Invoice
      • Pay
      • Cancel
      • Print
    • Product
  • Webhooks
Powered by GitBook
On this page
  1. API Reference

Product

馃捇
get

/api/app/product/{id}

Path parameters
idstring 路 uuidrequired
Responses
cURL
JavaScript
Python
HTTP
curl -L \
  --url '/api/app/product/{id}'
200
400
401
403
404
500
501
text/plain
application/json
text/json
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "creationTime": "2025-02-20T18:59:01.687Z",
  "creatorId": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "description": "text",
  "pricing": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "internalName": "text",
      "type": 1,
      "usageType": 1,
      "isUsageBased": true,
      "usageCalculationMethod": 1,
      "model": 1,
      "billingCycle": 1,
      "trailLength": 1,
      "billingPeriod": 1,
      "billingDay": 1,
      "items": [
        {
          "amount": 1,
          "fromQuantity": 1,
          "toQuantity": 1
        }
      ]
    }
  ]
}

Success

put

/api/app/product/{id}

Path parameters
idstring 路 uuidrequired
Body
namestring | nullable
descriptionstring | nullable
pricingobject[] | nullable
Responses
cURL
JavaScript
Python
HTTP
curl -L \
  --request PUT \
  --url '/api/app/product/{id}' \
  --header 'Content-Type: application/json' \
  --data '{"pricing":[{"type":1,"usageType":1,"usageCalculationMethod":1,"model":1,"billingCycle":1,"items":[{"amount":1,"fromQuantity":1,"toQuantity":1}]}]}'
200
400
401
403
404
500
501
No body

Success

delete

/api/app/product/{id}

Path parameters
idstring 路 uuidrequired
Responses
cURL
JavaScript
Python
HTTP
curl -L \
  --request DELETE \
  --url '/api/app/product/{id}'
200
400
401
403
404
500
501
No body

Success

get

/api/app/product

Query parameters
Namestring
Sortingstring
SkipCountinteger 路 int32 路 max: 2147483647
MaxResultCountinteger 路 int32 路 min: 1 路 max: 2147483647
Responses
cURL
JavaScript
Python
HTTP
curl -L \
  --url '/api/app/product'
200
400
401
403
404
500
501
text/plain
application/json
text/json
{
  "totalCount": 1,
  "items": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "creationTime": "2025-02-20T18:59:01.687Z",
      "creatorId": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "description": "text",
      "pricing": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "name": "text",
          "internalName": "text",
          "type": 1,
          "usageType": 1,
          "isUsageBased": true,
          "usageCalculationMethod": 1,
          "model": 1,
          "billingCycle": 1,
          "trailLength": 1,
          "billingPeriod": 1,
          "billingDay": 1,
          "items": [
            {
              "amount": 1,
              "fromQuantity": 1,
              "toQuantity": 1
            }
          ]
        }
      ]
    }
  ]
}

Success

post

/api/app/product

Body
namestring | nullable
descriptionstring | nullable
pricingobject[] | nullable
Responses
cURL
JavaScript
Python
HTTP
curl -L \
  --request POST \
  --url '/api/app/product' \
  --header 'Content-Type: application/json' \
  --data '{"pricing":[{"type":1,"usageType":1,"usageCalculationMethod":1,"model":1,"billingCycle":1,"items":[{"amount":1,"fromQuantity":1,"toQuantity":1}]}]}'
200
400
401
403
404
500
501
No body

Success

  • GET/api/app/product/{id}
  • PUT/api/app/product/{id}
  • DELETE/api/app/product/{id}
  • GET/api/app/product
  • POST/api/app/product