Create a customer subscription

How to create a customer subscription via API

To create a new customer subscription, send a POST request to the /api/customer_subscriptions endpoint, passing the resource arguments in the request body.

Request

POST https://yourdomain.commercelayer.io/api/customer_subscriptions

Arguments

Body Parameter	Type	Required
type	string	Required
attributes.customer_email	string	Required
attributes.reference	string	Required
attributes.reference_origin	string	Optional
attributes.metadata	object	Optional

Example

Request

The following request creates a new customer subscription:

curl -g -X POST \
  'https://yourdomain.commercelayer.io/api/customer_subscriptions' \
  -H 'Accept: application/vnd.api+json' \
  -H 'Authorization: Bearer your-access-token' \
  -H 'Content-Type: application/vnd.api+json' \
  -d '{
  "data": {
    "type": "customer_subscriptions",
    "attributes": {
      "customer_email": "[email protected]",
      "reference": "ANY-EXTERNAL-REFEFERNCE"
    }
  }
}'

Response