Update a plan

PUT 
https://euwest.api.elasticpath.com/v2/subscriptions/plans/:plan_uuid

Specify whichever attributes you want to change. The values of the other attributes remain the same. If the attributes section is empty, the plan is not updated.

Request

Responses

200

Success. The details of the plan are updated.

400

Bad request. The request failed validation.

403

Forbidden. The operation is forbidden on this entity.

404

Not found. The requested entity does not exist.

409

Write conflict. Unable to perform the operation at this time.

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.Put, "https://euwest.api.elasticpath.com/v2/subscriptions/plans/:plan_uuid");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Bearer <TOKEN>");
var content = new StringContent("{\n  \"data\": {\n    \"id\": \"00000000-0000-0000-0000-000000000000\",\n    \"type\": \"subscription_plan\",\n    \"attributes\": {\n      \"external_ref\": \"abc123\",\n      \"name\": \"Monthly\",\n      \"description\": \"A monthly subscription.\",\n      \"billing_interval_type\": \"month\",\n      \"billing_frequency\": 1,\n      \"trial_period\": 7,\n      \"plan_length\": 12,\n      \"end_behavior\": \"close\",\n      \"can_pause\": false,\n      \"can_resume\": false,\n      \"can_cancel\": false,\n      \"base_price_percentage\": 90,\n      \"fixed_price\": {\n        \"USD\": {\n          \"amount\": 100,\n          \"includes_tax\": false\n        },\n        \"GBP\": {\n          \"amount\": 90,\n          \"includes_tax\": true\n        }\n      }\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

plan_uuid — pathrequired

Body

{
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "type": "subscription_plan",
    "attributes": {
      "external_ref": "abc123",
      "name": "Monthly",
      "description": "A monthly subscription.",
      "billing_interval_type": "month",
      "billing_frequency": 1,
      "trial_period": 7,
      "plan_length": 12,
      "end_behavior": "close",
      "can_pause": false,
      "can_resume": false,
      "can_cancel": false,
      "base_price_percentage": 90,
      "fixed_price": {
        "USD": {
          "amount": 100,
          "includes_tax": false
        },
        "GBP": {
          "amount": 90,
          "includes_tax": true
        }
      }
    }
  }
}

ResponseClear

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