COcommercelayer
subscription_models

Create a subscription model

Changed on

Create a subscription model

post/subscription_models

Request

  • Base URL
    https://{your_organization_slug}.commercelayer.io/api
  • URL
    https://{your_organization_slug}.commercelayer.io/api/subscription_models
  • Auth
    HTTP bearer

Request body

Example request

{
  "data": {
    "attributes": {
      "name": "EU Subscription Model",
      "strategy": "by_frequency",
      "frequencies": [
        "hourly",
        "10 * * * *",
        "weekly",
        "monthly",
        "two-month"
      ],
      "auto_activate": true,
      "reference": "ANY-EXTERNAL-REFEFERNCE",
      "reference_origin": "ANY-EXTERNAL-REFEFERNCE-ORIGIN",
      "metadata": {
        "foo": "bar"
      }
    }
  }
}

Response

The created subscription model object

Changes