POST
/
api
/
v1
/
catalogs
/
setup
curl --request POST \
  --url https://app.flowglad.com/api/v1/catalogs/setup \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "isDefault": false,
  "name": "<string>",
  "features": [
    {
      "livemode": true,
      "type": "toggle",
      "slug": "<string>",
      "name": "<string>",
      "description": "<string>",
      "active": true
    }
  ],
  "products": [
    {
      "product": {
        "name": "<string>",
        "description": "<string>",
        "imageURL": "<string>",
        "displayFeatures": [
          {
            "enabled": true,
            "label": "<string>",
            "details": "<string>"
          }
        ],
        "active": true,
        "singularQuantityLabel": "<string>",
        "pluralQuantityLabel": "<string>",
        "default": true,
        "slug": "<string>"
      },
      "prices": [
        {
          "intervalUnit": "day",
          "name": "<string>",
          "intervalCount": 123,
          "type": "subscription",
          "trialPeriodDays": 123,
          "setupFeeAmount": 123,
          "isDefault": true,
          "unitPrice": 123,
          "usageEventsPerUnit": "null",
          "active": true,
          "startsWithCreditTrial": true,
          "slug": "<string>",
          "overagePriceId": "<string>",
          "usageMeterId": "null"
        }
      ],
      "features": [
        "<string>"
      ]
    }
  ],
  "usageMeters": [
    {
      "name": "<string>",
      "slug": "<string>",
      "aggregationType": "sum"
    }
  ]
}'
{
  "catalog": {
    "id": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "createdByCommit": "<string>",
    "updatedByCommit": "<string>",
    "livemode": true,
    "organizationId": "<string>",
    "isDefault": true,
    "name": "<string>",
    "products": [
      {
        "id": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "createdByCommit": "<string>",
        "updatedByCommit": "<string>",
        "livemode": true,
        "name": "<string>",
        "description": "<string>",
        "imageURL": "<string>",
        "organizationId": "<string>",
        "displayFeatures": [
          {
            "enabled": true,
            "label": "<string>",
            "details": "<string>"
          }
        ],
        "active": true,
        "singularQuantityLabel": "<string>",
        "pluralQuantityLabel": "<string>",
        "catalogId": "<string>",
        "default": true,
        "slug": "<string>",
        "prices": [
          {
            "id": "<string>",
            "createdAt": "2023-11-07T05:31:56Z",
            "updatedAt": "2023-11-07T05:31:56Z",
            "createdByCommit": "<string>",
            "updatedByCommit": "<string>",
            "livemode": true,
            "intervalUnit": "day",
            "name": "<string>",
            "intervalCount": 123,
            "type": "subscription",
            "trialPeriodDays": 123,
            "setupFeeAmount": 123,
            "isDefault": true,
            "unitPrice": 123,
            "usageEventsPerUnit": "null",
            "productId": "<string>",
            "active": true,
            "currency": "USD",
            "startsWithCreditTrial": true,
            "slug": "<string>",
            "overagePriceId": "<string>",
            "usageMeterId": "null"
          }
        ],
        "defaultPrice": {
          "id": "<string>",
          "createdAt": "2023-11-07T05:31:56Z",
          "updatedAt": "2023-11-07T05:31:56Z",
          "createdByCommit": "<string>",
          "updatedByCommit": "<string>",
          "livemode": true,
          "intervalUnit": "day",
          "name": "<string>",
          "intervalCount": 123,
          "type": "subscription",
          "trialPeriodDays": 123,
          "setupFeeAmount": 123,
          "isDefault": true,
          "unitPrice": 123,
          "usageEventsPerUnit": "null",
          "productId": "<string>",
          "active": true,
          "currency": "USD",
          "startsWithCreditTrial": true,
          "slug": "<string>",
          "overagePriceId": "<string>",
          "usageMeterId": "null"
        }
      }
    ],
    "usageMeters": [
      {
        "id": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "createdByCommit": "<string>",
        "updatedByCommit": "<string>",
        "livemode": true,
        "organizationId": "<string>",
        "name": "<string>",
        "catalogId": "<string>",
        "slug": "<string>",
        "aggregationType": "sum"
      }
    ],
    "defaultProduct": {
      "id": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "createdByCommit": "<string>",
      "updatedByCommit": "<string>",
      "livemode": true,
      "name": "<string>",
      "description": "<string>",
      "imageURL": "<string>",
      "organizationId": "<string>",
      "displayFeatures": [
        {
          "enabled": true,
          "label": "<string>",
          "details": "<string>"
        }
      ],
      "active": true,
      "singularQuantityLabel": "<string>",
      "pluralQuantityLabel": "<string>",
      "catalogId": "<string>",
      "default": true,
      "slug": "<string>",
      "prices": [
        {
          "id": "<string>",
          "createdAt": "2023-11-07T05:31:56Z",
          "updatedAt": "2023-11-07T05:31:56Z",
          "createdByCommit": "<string>",
          "updatedByCommit": "<string>",
          "livemode": true,
          "intervalUnit": "day",
          "name": "<string>",
          "intervalCount": 123,
          "type": "subscription",
          "trialPeriodDays": 123,
          "setupFeeAmount": 123,
          "isDefault": true,
          "unitPrice": 123,
          "usageEventsPerUnit": "null",
          "productId": "<string>",
          "active": true,
          "currency": "USD",
          "startsWithCreditTrial": true,
          "slug": "<string>",
          "overagePriceId": "<string>",
          "usageMeterId": "null"
        }
      ],
      "defaultPrice": {
        "id": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "createdByCommit": "<string>",
        "updatedByCommit": "<string>",
        "livemode": true,
        "intervalUnit": "day",
        "name": "<string>",
        "intervalCount": 123,
        "type": "subscription",
        "trialPeriodDays": 123,
        "setupFeeAmount": 123,
        "isDefault": true,
        "unitPrice": 123,
        "usageEventsPerUnit": "null",
        "productId": "<string>",
        "active": true,
        "currency": "USD",
        "startsWithCreditTrial": true,
        "slug": "<string>",
        "overagePriceId": "<string>",
        "usageMeterId": "null"
      }
    }
  }
}

Authorizations

Authorization
string
header
required

Body

application/json

Response

200
application/json

Successful response

The response is of type object.