Sign in

v1

latestOpenAPI 3.0.02026-07-2475182625.5 KB
Products

Create or update products

Creates products or updates existing products.

If you are creating products in bulk, you can add up to 300 at a time.

post/products

Request body

Example request

{
  "products": [
    {
      "product": "premium-laptop",
      "display": {
        "en": "Premium Laptop"
      },
      "pricing": {
        "price": {
          "USD": 1999.99,
          "EUR": 1799.99
        },
        "trial": 14,
        "interval": "month",
        "intervalLength": 1,
        "quantityBehavior": "allow",
        "quantityDefault": 1,
        "paymentCollected": true,
        "trialPrice": {
          "USD": 14.95,
          "EUR": 12.99
        },
        "quantityDiscounts": {
          "30": {
            "USD": 25,
            "EUR": 15
          }
        },
        "discountReason": {
          "en": "Seasonal Promotion"
        },
        "discountDuration": 1,
        "reminderNotification": {
          "enabled": true,
          "interval": "day",
          "intervalLength": 3
        },
        "overdueNotification": {
          "enabled": true,
          "interval": "day",
          "intervalLength": 3,
          "amount": 10
        },
        "cancellation": {
          "interval": "month",
          "intervalLength": 2
        }
      }
    }
  ]
}

Response

OK

OR

Example response

{
  "products": [
    {
      "product": "premium-laptop",
      "action": "product.create",
      "created.id": "kyCJS3ovQ4qhfjA-PPzv_g",
      "result": "success"
    }
  ]
}