Cancel a subscription order

1 min

DELETE

https://app.amberflo.io/payments/pricing/amberflo/customer-pricing/subscription-orders/cancel

Responses

200Successful request

payment.pricing.customer.CustomerSubscriptionOrder.out
- customerIdstringrequired
  Description
  Unique customer id.
- idstringrequired
  Description
  The id of the specific instance in time where an order was applied to a customer, this id marks a unique customer order.
- orderItemspayment.pricing.customer.SubscriptionOrderItem.out[]required
  Description
  List of individual order items that make up this order.
  - idstring
    Description
    Instance id associated with the order item.
  - quantitynumberrequired
    Description
    Quantity of units the customer is subscribing to for this order.
  - resourceIdstring
    Description
    Resource id that this order item is applied to.
  - dimensionsmap<string, string>
    Description
    Dimension key values that this order item is associated with.
  - totalPricenumber
    Description
    Price for this order item. This is the total price for the full quantity over the order's duration, not the price per unit. If the order has a fixed duration this total price is for the entire duration. If the order has no fixed duration this total price is per billing period. If null, the price will be calculated based on the subscription plan's price per unit.
- productItemIdstringrequired
  Description
  Unique product item id.
- productPlanIdstringrequired
  Description
  Unique product plan id.
- appliedTimeRangepayment.common.TimeRange.out
  Description
  Applied time range for the order. This defines when an order starts and ends.
  - startTimeInSecondsinteger<int64>
  - endTimeInSecondsinteger<int64>
- billingPeriodsinteger<int32>
  Description
  Optional field to indicate the number of billing periods for the order. If this field is not null the order's end time will be calculated as this number of billing periods from the start time, inclusive of the billing period the start time falls within.
- labelstring
  Description
  Label for the order.
- subscriptionSettingspayment.pricing.subscription_orders.SubscriptionPriceSettings.out
  Description
  Optional subscription settings to override the default subscription settings
  - cancellationRulepayment.pricing.subscription_orders.CancellationRule.outrequired
    Description
    Whether early cancellation will prorate, charge in full, or result in no charge.
  - chargeExecutionpayment.pricing.subscription_orders.ChargeExecution.outrequired
    Description
    When this order's charge will be executed.
  - purchaseRulepayment.pricing.subscription_orders.PurchaseRule.outrequired
    Description
    Whether the order will prorate or charge in full from the beginning of the billing period.
  - subscriptionRatepayment.pricing.price.UsageGranularity.outrequired
    Description
    The rate of the subscription. This controls the granularity of subscription pricing within the billing period.
  - isPricedPerRateboolean
    Description
    Whether subscription price is charged per rate or per billing period. Defaults to per billing period.
  - isCancellableboolean
    Description
    Whether order cancellation appears in the customer portal or not. Defaults to false.
- addedTimeInSecondsinteger<int64>
  Description
  Internally managed. When an order has been added to a pricing plan.
- commitmentIdstring
  Description
  Internally managed. The id of an associated commitment.
- prepaidUrisstring[]
  Description
  Internally managed. List of associated prepaid uris
- removedTimeInSecondsinteger<int64>
  Description
  Internally managed. When an order has been removed from a customer pricing plan.
- removalContextmap<string, string>
  Description
  Internally managed. Identifying metadata around who and why an order was removed.

curl

curl --request DELETE \
     --url https://app.amberflo.io/payments/pricing/amberflo/customer-pricing/subscription-orders/cancel \
     --header 'accept: application/json'

javascript

var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");

var requestOptions = {
   method: 'DELETE',
   headers: myHeaders,
   redirect: 'follow'
};

fetch("https://app.amberflo.io/payments/pricing/amberflo/customer-pricing/subscription-orders/cancel", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

ruby

require "uri"
require "json"
require "net/http"

url = URI("https://app.amberflo.io/payments/pricing/amberflo/customer-pricing/subscription-orders/cancel")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Delete.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"

response = https.request(request)
puts response.read_body

python

import requests
import json

url = "https://app.amberflo.io/payments/pricing/amberflo/customer-pricing/subscription-orders/cancel"

payload = {}
headers = {
   'accept': 'application/json',
   'content-type': 'application/json'
}

response = requests.request("DELETE", url, headers=headers, data=payload)

print(response.text)

200

// Successful request
{
  "customerId": "",
  "id": "",
  "orderItems": [
    {
      "id": "",
      "quantity": 0,
      "resourceId": "",
      "dimensions": "",
      "totalPrice": 0
    }
  ],
  "productItemId": "",
  "productPlanId": "",
  "appliedTimeRange": {
    "startTimeInSeconds": "",
    "endTimeInSeconds": ""
  },
  "billingPeriods": "",
  "label": "",
  "subscriptionSettings": {
    "cancellationRule": "",
    "chargeExecution": "",
    "purchaseRule": "",
    "subscriptionRate": "",
    "isPricedPerRate": false,
    "isCancellable": false
  },
  "addedTimeInSeconds": "",
  "commitmentId": "",
  "prepaidUris": [
    ""
  ],
  "removedTimeInSeconds": "",
  "removalContext": ""
}