Comment on page
Update an order subscription
How to update an existing order subscription via API
To update an existing order subscription, send a
PATCH
request to the /api/order_subscriptions/:id
endpoint, where id
is the ID of the resource that you want to update.Here below the list of all the possible arguments that you can pass with the request body.
PATCH https://yourdomain.commercelayer.io/api/order_subscriptions/:id
Body Parameter | Type | Required |
---|---|---|
type | string | Required |
id | string | Required |
attributes.frequency | string | Optional |
attributes.expires_at | datetime | Optional |
attributes.next_run_at | datetime | Optional |
attributes._activate | boolean | Optional |
attributes._deactivate | boolean | Optional |
attributes._cancel | boolean | Optional |
attributes.reference | string | Optional |
attributes.reference_origin | string | Optional |
attributes.metadata | object | Optional |
relationships.customer_payment_source | object | Optional |
Request
Response
The following request updates the order subscription identified by the ID "xYZkjABcde":
curl -g -X PATCH \
'https://yourdomain.commercelayer.io/api/order_subscriptions/xYZkjABcde' \
-H 'Accept: application/vnd.api+json' \
-H 'Authorization: Bearer your-access-token' \
-H 'Content-Type: application/vnd.api+json' \
-d '{
"data": {
"type": "order_subscriptions",
"id": "xYZkjABcde",
"attributes": {
"expires_at": "2018-01-02T12:00:00.000Z"
},
"relationships": {
"customer_payment_source": {
"data": {
"type": "customer_payment_sources",
"id": "ABCRtyUpBa"
}
}
}
}
}'
On success, the API responds with a
200 OK
status code, returning the updated resource object:{
"data": {
"id": "xYZkjABcde",
"type": "order_subscriptions",
"links": {
"self": "https://yourdomain.commercelayer.io/api/order_subscriptions/xYZkjABcde"
},
"attributes": {
"number": "1234",
"status": "draft",
"frequency": "monthly",
"activate_by_source_order": true,
"customer_email": "[email protected]",
"starts_at": "2018-01-01T12:00:00.000Z",
"expires_at": "2018-01-02T12:00:00.000Z",
"next_run_at": "2018-01-01T12:00:00.000Z",
"occurrencies": 2,
"errors_count": 3,
"succeeded_on_last_run": true,
"options": {
"place_target_order": 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": {
"market": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/order_subscriptions/xYZkjABcde/relationships/market",
"related": "https://yourdomain.commercelayer.io/api/order_subscriptions/xYZkjABcde/market"
}
},
"subscription_model": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/order_subscriptions/xYZkjABcde/relationships/subscription_model",
"related": "https://yourdomain.commercelayer.io/api/order_subscriptions/xYZkjABcde/subscription_model"
}
},
"source_order": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/order_subscriptions/xYZkjABcde/relationships/source_order",
"related": "https://yourdomain.commercelayer.io/api/order_subscriptions/xYZkjABcde/source_order"
}
},
"customer": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/order_subscriptions/xYZkjABcde/relationships/customer",
"related": "https://yourdomain.commercelayer.io/api/order_subscriptions/xYZkjABcde/customer"
}
},
"customer_payment_source": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/order_subscriptions/xYZkjABcde/relationships/customer_payment_source",
"related": "https://yourdomain.commercelayer.io/api/order_subscriptions/xYZkjABcde/customer_payment_source"
}
},
"order_subscription_items": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/order_subscriptions/xYZkjABcde/relationships/order_subscription_items",
"related": "https://yourdomain.commercelayer.io/api/order_subscriptions/xYZkjABcde/order_subscription_items"
}
},
"order_factories": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/order_subscriptions/xYZkjABcde/relationships/order_factories",
"related": "https://yourdomain.commercelayer.io/api/order_subscriptions/xYZkjABcde/order_factories"
}
},
"order_copies": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/order_subscriptions/xYZkjABcde/relationships/order_copies",
"related": "https://yourdomain.commercelayer.io/api/order_subscriptions/xYZkjABcde/order_copies"
}
},
"recurring_order_copies": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/order_subscriptions/xYZkjABcde/relationships/recurring_order_copies",
"related": "https://yourdomain.commercelayer.io/api/order_subscriptions/xYZkjABcde/recurring_order_copies"
}
},
"orders": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/order_subscriptions/xYZkjABcde/relationships/orders",
"related": "https://yourdomain.commercelayer.io/api/order_subscriptions/xYZkjABcde/orders"
}
},
"events": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/order_subscriptions/xYZkjABcde/relationships/events",
"related": "https://yourdomain.commercelayer.io/api/order_subscriptions/xYZkjABcde/events"
}
},
"versions": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/order_subscriptions/xYZkjABcde/relationships/versions",
"related": "https://yourdomain.commercelayer.io/api/order_subscriptions/xYZkjABcde/versions"
}
}
},
"meta": {
"mode": "test"
}
}
}
Last modified 3mo ago