v1

latestOpenAPI 3.0.02026-07-24212113249.1 KB
Products

Add a product

post/products

Request body

namestring required
descriptionstring required
statementDescriptorstring required
priceDescriptionstring required
paymentMethodIdstring required
unitLabelstring required
isActiveboolean required

Example request

{
  "name": "Test Product",
  "description": "the description of this product",
  "statementDescriptor": "statement descriptor",
  "priceDescription": "this is a price description",
  "paymentMethodId": "33d27eee-7dea-4fa7-a965-15150e6ef087",
  "unitLabel": "unitLabel",
  "metadata": [
    {
      "key": "key",
      "value": "value"
    }
  ],
  "isActive": true,
  "productPrices": [
    {
      "id": "4032597f-1765-44db-ad08-f6f0a096efc9",
      "unitPrice": 40.1,
      "unitPriceInstallment": 40.1,
      "pricingModelId": "8eaa8da0-be76-4e03-823f-152c5a7aa0b5",
      "billingTypesId": "73da57b8-6677-4ae2-afc5-cae76bff7d70",
      "recurringUsageTypesId": "c25c0237-1cd8-4f69-b10e-60d8e07b33ef",
      "billingPeriodId": "d211b9e5-4639-416f-b48e-bc7ccda4164f",
      "recurringMeteredUsageId": "9814ea3d-7640-4ebc-be53-eb9f34700a3b",
      "currencyId": "56ea7c95-dd22-46b4-a978-4319e6728c96",
      "internalDescription": "Sample product description",
      "recurringTrialPeriodDays": 40,
      "priceTiers": [
        {
          "id": "2031a086-7e87-47d6-8c28-b904b4951507",
          "productPricesId": "8eaa8da0-be76-4e03-823f-152c5a7aa0b5",
          "flatPrice": 40,
          "unitPrice": 40,
          "upTo": 2
        }
      ]
    }
  ]
}

Response

Product created.