Update proration policy

PUT 
https://euwest.api.elasticpath.com/v2/subscriptions/proration-policies/:proration_policy_uuid

You can update a proration policy at any time. For any subscriptions that are using the updated proration policy, the changes are also applied. Specify whichever attributes you want to change. The values of the other attributes remain the same. If the attributes section is empty, the proration policy is not updated.

When updating proration policies:

• You can change the name of an existing policy.
• You can update rounding.
• You can update external_ref as long as external_ref is still unique in your store.
• You can remove external_ref as this attribute is optional.
• You cannot remove any required attributes, such as name or rounding.

Request

Responses

200

Success. The proration policy details 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.

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/proration-policies/:proration_policy_uuid");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Bearer <token>");
var content = new StringContent("{\n  \"data\": {\n    \"id\": \"11111111-2222-3333-4444-555555555555\",\n    \"type\": \"subscription_proration_policy\",\n    \"attributes\": {\n      \"external_ref\": \"abc123\",\n      \"name\": \"Main Policy\",\n      \"rounding\": \"up\"\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

proration_policy_uuid — pathrequired

Body

{
  "data": {
    "id": "11111111-2222-3333-4444-555555555555",
    "type": "subscription_proration_policy",
    "attributes": {
      "external_ref": "abc123",
      "name": "Main Policy",
      "rounding": "up"
    }
  }
}

ResponseClear

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