Qodex.ai

Create a subscription model

POST https://{{subdomain}}.commercelayer.io/api/subscription_models

Request Body

{"data"=>{"type"=>"subscription_models", "attributes"=>{"name"=>"{{subscription_model_name}}", "frequencies"=>"{{subscription_model_frequencies}}"}}}

HEADERS

KeyDatatypeRequiredDescription
Content-Typestring
Authorizationstring

RESPONSES

status: Created

{"data":{"id":"xYZkjABcde","type":"subscription_models","links":{"self":"https://yourdomain.commercelayer.io/api/subscription_models/xYZkjABcde"},"attributes":{"name":"EU Subscription Model","strategy":"by_frequency","frequencies":["hourly","10 * * * *","weekly","monthly","two-month"],"auto_activate":true,"auto_cancel":false,"created_at":"2018-01-01T12:00:00.000Z","updated_at":"2018-01-01T12:00:00.000Z","reference":"ANY-EXTERNAL-REFEFERNCE","reference_origin":"ANY-EXTERNAL-REFEFERNCE-ORIGIN","metadata":{"foo":"bar"}},"relationships":{"markets":{"links":{"self":"https://yourdomain.commercelayer.io/api/subscription_models/xYZkjABcde/relationships/markets","related":"https://yourdomain.commercelayer.io/api/subscription_models/xYZkjABcde/markets"}},"order_subscriptions":{"links":{"self":"https://yourdomain.commercelayer.io/api/subscription_models/xYZkjABcde/relationships/order_subscriptions","related":"https://yourdomain.commercelayer.io/api/subscription_models/xYZkjABcde/order_subscriptions"}},"attachments":{"links":{"self":"https://yourdomain.commercelayer.io/api/subscription_models/xYZkjABcde/relationships/attachments","related":"https://yourdomain.commercelayer.io/api/subscription_models/xYZkjABcde/attachments"}}},"meta":{"mode":"test"}}}