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 attributes.customer_email
attributes.reference_origin
Example
Request Response
The following request creates a new customer subscription:
Copy 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" : "john@example.com"
}
}
} '
On success, the API responds with a 201 Created
status code, returning the created resource object:
Copy {
"data" : {
"id" : "xYZkjABcde" ,
"type" : "customer_subscriptions" ,
"links" : {
"self" : "https://yourdomain.commercelayer.io/api/customer_subscriptions/xYZkjABcde"
} ,
"attributes" : {
"customer_email" : "john@example.com" ,
"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" : {
"customer" : {
"links" : {
"self" : "https://yourdomain.commercelayer.io/api/customer_subscriptions/xYZkjABcde/relationships/customer" ,
"related" : "https://yourdomain.commercelayer.io/api/customer_subscriptions/xYZkjABcde/customer"
}
} ,
"events" : {
"links" : {
"self" : "https://yourdomain.commercelayer.io/api/customer_subscriptions/xYZkjABcde/relationships/events" ,
"related" : "https://yourdomain.commercelayer.io/api/customer_subscriptions/xYZkjABcde/events"
}
} ,
"versions" : {
"links" : {
"self" : "https://yourdomain.commercelayer.io/api/customer_subscriptions/xYZkjABcde/relationships/versions" ,
"related" : "https://yourdomain.commercelayer.io/api/customer_subscriptions/xYZkjABcde/versions"
}
}
} ,
"meta" : {
"mode" : "test"
}
}
}
Last updated 7 months ago