2022.01.15 Release -Separate Billing & Usage Periods - Plans section for Subscriptions

This article contains changes made within our APIs related to the January 2022 release.

Separate Billing & Usage Periods - Plans section for Subscriptions

New: For POST, GET, and PUT requests under the Plans section for Subscriptions, a new attribute has been added for usage-based charges: 'usage_period' - Valid Values (Same as Billing Period or Charge Term). This attribute is only available when ‘Separate Billing and Usage Periods’ has been enabled in the Advanced Usage Settings.

Sample Payload:

    {

  "id": "S-00006",

  "customer_id": "C-00002",

  "status": "Draft",

  "contract_effective_date": "2017-01-24T00:00:00.000Z",

  "billing_start_date": "2017-02-23T00:00:00.000Z",

  "service_start_date": "2017-01-24T00:00:00.000Z",

  "order_placed_at": "2017-01-24T00:00:00.000Z",

  "cancellation_date": "2017-01-24T00:00:00.000Z",

  "auto_renew": true,

  "currency": "USD",

  "notes": "",

  "version": 1,

  "contract_term": "12",

  "renewal_term": "Evergreen",

  "separate_invoice": true,

  "renewal_increment_percent": 0,

  "plans": [

    {

      "product_id": "P-00001",

      "product_name": "Sample Product",

      "plan_id": "PLN-00001",

      "plan_name": "Bronze Plan",

      "charge_id": "CHG-00003",

      "charge_name": "Minutes Used",

      "list_price": "15",

      "quantity": 1,

      "included_units": 100,

      "discount": 0,

      "effective_price": "15",

      "type": "Usage based",

      "billing_period": "Monthly",

      "usage_period": "Charge Term",

      "renewal_increment_percent": 0,

      "override_renewal_increment_percent": false

    }

  ]

}