customer_subscriptions

Create a customer subscription

Changed on

Create a customer subscription

post/customer_subscriptions

Request

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

Request body

Example request

{
  "data": {
    "attributes": {
      "customer_email": "john@example.com",
      "reference": "ANY-EXTERNAL-REFEFERNCE",
      "reference_origin": "ANY-EXTERNAL-REFEFERNCE-ORIGIN",
      "metadata": {
        "foo": "bar"
      }
    }
  }
}

Response

The created customer subscription object

Changes

    • breaking

      request property / was restricted to a list of enum values

    • breaking

      the request property // became required

    • info

      the request property default value customer_subscriptions was removed

    • info

      added the new customer_subscriptions enum value to the request property /

    • info

      added the media type application/vnd.api+json for the response with the status