Create a subscription state

POST 
https://euwest.api.elasticpath.com/v2/subscriptions/subscriptions/:subscription_uuid/states

The subscription lifecycle is the states that a subscription can go through when a customer subscribes to a service or a product.

A subscription can have the following states:

• pending
• canceled
• paused
• resumed For more information, see Managing the Subscription Lifecycle.

Request

Responses

204

Success. The subscription's state has changed.

400

Bad request. The request failed validation.

404

Not found. The requested entity does not exist.

500

Internal server error. There was a system failure in the platform.

Authorization: http

name: BearerTokentype: httpscheme: bearer

• csharp
• curl
• dart
• go
• http
• java
• javascript
• kotlin
• c
• nodejs
• objective-c
• ocaml
• php
• powershell
• python
• r
• ruby
• rust
• shell
• swift

• HTTPCLIENT
• RESTSHARP

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://euwest.api.elasticpath.com/v2/subscriptions/subscriptions/:subscription_uuid/states");
request.Headers.Add("Authorization", "Bearer <token>");
var content = new StringContent("{\n  \"data\": {\n    \"type\": \"subscription_state\",\n    \"attributes\": {\n      \"action\": \"cancel\"\n    }\n  }\n}", null, "application/json");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Request Collapse all

Base URL

https://euwest.api.elasticpath.com/v2

Auth

Bearer Token

Parameters

subscription_uuid — pathrequired

Body

{
  "data": {
    "type": "subscription_state",
    "attributes": {
      "action": "cancel"
    }
  }
}

ResponseClear

Click the Send API Request button above and see the response here!