Execute subscription plan change

Use when applying a plan change (e.g. upgrade or downgrade). Executes proration and generates invoice or credit as needed.

POST /subscriptions/{id}/change/execute

Execute subscription plan change

cURL

curl --request POST \
  --url https://us.api.flexprice.io/v1/subscriptions/{id}/change/execute \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "billing_cadence": "RECURRING",
  "target_plan_id": "<string>",
  "billing_period_count": 123,
  "metadata": {}
}
'

import requests

url = "https://us.api.flexprice.io/v1/subscriptions/{id}/change/execute"

payload = {
    "billing_cadence": "RECURRING",
    "target_plan_id": "<string>",
    "billing_period_count": 123,
    "metadata": {}
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    billing_cadence: 'RECURRING',
    target_plan_id: '<string>',
    billing_period_count: 123,
    metadata: {}
  })
};

fetch('https://us.api.flexprice.io/v1/subscriptions/{id}/change/execute', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://us.api.flexprice.io/v1/subscriptions/{id}/change/execute",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'billing_cadence' => 'RECURRING',
    'target_plan_id' => '<string>',
    'billing_period_count' => 123,
    'metadata' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://us.api.flexprice.io/v1/subscriptions/{id}/change/execute"

	payload := strings.NewReader("{\n  \"billing_cadence\": \"RECURRING\",\n  \"target_plan_id\": \"<string>\",\n  \"billing_period_count\": 123,\n  \"metadata\": {}\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://us.api.flexprice.io/v1/subscriptions/{id}/change/execute")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"billing_cadence\": \"RECURRING\",\n  \"target_plan_id\": \"<string>\",\n  \"billing_period_count\": 123,\n  \"metadata\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://us.api.flexprice.io/v1/subscriptions/{id}/change/execute")

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

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"billing_cadence\": \"RECURRING\",\n  \"target_plan_id\": \"<string>\",\n  \"billing_period_count\": 123,\n  \"metadata\": {}\n}"

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

200

{
  "credit_grants": [
    {
      "addon_id": "<string>",
      "conversion_rate": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "created_by": "<string>",
      "credit_grant_anchor": "2023-11-07T05:31:56Z",
      "credits": "<string>",
      "end_date": "2023-11-07T05:31:56Z",
      "environment_id": "<string>",
      "expiration_duration": 123,
      "id": "<string>",
      "metadata": {},
      "name": "<string>",
      "period_count": 123,
      "plan_id": "<string>",
      "priority": 123,
      "start_date": "2023-11-07T05:31:56Z",
      "subscription_id": "<string>",
      "tenant_id": "<string>",
      "topup_conversion_rate": "<string>",
      "updated_at": "2023-11-07T05:31:56Z",
      "updated_by": "<string>"
    }
  ],
  "effective_date": "2023-11-07T05:31:56Z",
  "invoice": {
    "adjustment_amount": "<string>",
    "amount_due": "<string>",
    "amount_paid": "<string>",
    "amount_remaining": "<string>",
    "billing_period": "<string>",
    "billing_reason": "<string>",
    "billing_sequence": 123,
    "coupon_applications": [
      {
        "applied_at": "2023-11-07T05:31:56Z",
        "coupon_association_id": "<string>",
        "coupon_id": "<string>",
        "coupon_snapshot": {},
        "created_at": "2023-11-07T05:31:56Z",
        "created_by": "<string>",
        "currency": "<string>",
        "discount_percentage": "<string>",
        "discounted_amount": "<string>",
        "environment_id": "<string>",
        "final_price": "<string>",
        "id": "<string>",
        "invoice_id": "<string>",
        "invoice_line_item_id": "<string>",
        "metadata": {},
        "original_price": "<string>",
        "subscription_id": "<string>",
        "tenant_id": "<string>",
        "updated_at": "2023-11-07T05:31:56Z",
        "updated_by": "<string>"
      }
    ],
    "created_at": "2023-11-07T05:31:56Z",
    "created_by": "<string>",
    "currency": "<string>",
    "customer": {
      "address_city": "<string>",
      "address_country": "<string>",
      "address_line1": "<string>",
      "address_line2": "<string>",
      "address_postal_code": "<string>",
      "address_state": "<string>",
      "contact": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "created_by": "<string>",
      "email": "<string>",
      "environment_id": "<string>",
      "external_id": "<string>",
      "id": "<string>",
      "integrations": [
        {
          "created_at": "2023-11-07T05:31:56Z",
          "created_by": "<string>",
          "entity_id": "<string>",
          "environment_id": "<string>",
          "id": "<string>",
          "metadata": {},
          "provider_entity_id": "<string>",
          "provider_type": "<string>",
          "tenant_id": "<string>",
          "updated_at": "2023-11-07T05:31:56Z",
          "updated_by": "<string>"
        }
      ],
      "metadata": {},
      "name": "<string>",
      "tenant_id": "<string>",
      "timezone": "<string>",
      "updated_at": "2023-11-07T05:31:56Z",
      "updated_by": "<string>"
    },
    "customer_id": "<string>",
    "description": "<string>",
    "due_date": "2023-11-07T05:31:56Z",
    "environment_id": "<string>",
    "finalized_at": "2023-11-07T05:31:56Z",
    "id": "<string>",
    "idempotency_key": "<string>",
    "invoice_number": "<string>",
    "invoice_pdf_url": "<string>",
    "issue_date": "2023-11-07T05:31:56Z",
    "last_computed_at": "2023-11-07T05:31:56Z",
    "line_items": [
      {
        "adjusted_entitlement_quantity": "<string>",
        "amount": "<string>",
        "commitment_info": {
          "amount": "<string>",
          "computed_commitment_utilized_amount": "<string>",
          "computed_overage_amount": "<string>",
          "computed_true_up_amount": "<string>",
          "is_windowed": true,
          "overage_factor": "<string>",
          "quantity": "<string>",
          "true_up_enabled": true
        },
        "created_at": "2023-11-07T05:31:56Z",
        "created_by": "<string>",
        "currency": "<string>",
        "customer_id": "<string>",
        "display_name": "<string>",
        "entity_id": "<string>",
        "entity_type": "<string>",
        "environment_id": "<string>",
        "id": "<string>",
        "invoice_id": "<string>",
        "invoice_level_discount": "<string>",
        "line_item_discount": "<string>",
        "metadata": {},
        "meter_display_name": "<string>",
        "meter_id": "<string>",
        "period_end": "2023-11-07T05:31:56Z",
        "period_start": "2023-11-07T05:31:56Z",
        "plan_display_name": "<string>",
        "prepaid_credits_applied": "<string>",
        "price_id": "<string>",
        "price_type": "<string>",
        "price_unit": "<string>",
        "price_unit_amount": "<string>",
        "price_unit_id": "<string>",
        "quantity": "<string>",
        "subscription_id": "<string>",
        "subscription_line_item_id": "<string>",
        "tenant_id": "<string>",
        "updated_at": "2023-11-07T05:31:56Z",
        "updated_by": "<string>",
        "usage_analytics": [
          {
            "cost": "<string>",
            "event_count": 123,
            "percentage": "<string>",
            "source": "<string>",
            "usage": "<string>"
          }
        ],
        "usage_breakdown": [
          {
            "cost": "<string>",
            "event_count": 123,
            "grouped_by": {},
            "percentage": "<string>",
            "usage": "<string>"
          }
        ]
      }
    ],
    "metadata": {},
    "overpaid_amount": "<string>",
    "paid_at": "2023-11-07T05:31:56Z",
    "period_end": "2023-11-07T05:31:56Z",
    "period_start": "2023-11-07T05:31:56Z",
    "recalculated_invoice_id": "<string>",
    "refunded_amount": "<string>",
    "subscription": {
      "active_pause_id": "<string>",
      "auto_invoice_threshold": "<string>",
      "billing_anchor": "2023-11-07T05:31:56Z",
      "billing_cadence": "RECURRING",
      "billing_period_count": 123,
      "cancel_at": "2023-11-07T05:31:56Z",
      "cancel_at_period_end": true,
      "cancelled_at": "2023-11-07T05:31:56Z",
      "collection_method": "<string>",
      "commitment_amount": "<string>",
      "coupon_associations": [
        {
          "coupon": {
            "amount_off": "<string>",
            "coupon_code": "<string>",
            "created_at": "2023-11-07T05:31:56Z",
            "created_by": "<string>",
            "currency": "<string>",
            "duration_in_periods": 123,
            "environment_id": "<string>",
            "id": "<string>",
            "max_redemptions": 123,
            "metadata": {},
            "name": "<string>",
            "percentage_off": "<string>",
            "redeem_after": "<string>",
            "redeem_before": "<string>",
            "rules": {},
            "tenant_id": "<string>",
            "total_redemptions": 123,
            "updated_at": "2023-11-07T05:31:56Z",
            "updated_by": "<string>"
          },
          "coupon_id": "<string>",
          "created_at": "2023-11-07T05:31:56Z",
          "created_by": "<string>",
          "end_date": "2023-11-07T05:31:56Z",
          "environment_id": "<string>",
          "id": "<string>",
          "metadata": {},
          "start_date": "2023-11-07T05:31:56Z",
          "subscription_id": "<string>",
          "subscription_line_item": {
            "addon_association_id": "<string>",
            "billing_period_count": 123,
            "commitment_amount": "<string>",
            "commitment_overage_factor": "<string>",
            "commitment_quantity": "<string>",
            "commitment_time_buckets": [
              {
                "commitment_value": "<string>",
                "end": {
                  "hour": 12,
                  "minute": 29
                },
                "id": "<string>",
                "overage_factor": 123,
                "price_id": "<string>",
                "start": {
                  "hour": 12,
                  "minute": 29
                },
                "true_up_enabled": true
              }
            ],
            "commitment_true_up_enabled": true,
            "commitment_windowed": true,
            "created_at": "2023-11-07T05:31:56Z",
            "created_by": "<string>",
            "currency": "<string>",
            "customer_id": "<string>",
            "display_name": "<string>",
            "end_date": "2023-11-07T05:31:56Z",
            "entity_id": "<string>",
            "environment_id": "<string>",
            "id": "<string>",
            "metadata": {},
            "meter": {
              "aggregation": {
                "expression": "<string>",
                "field": "<string>",
                "group_by": "<string>",
                "multiplier": "<string>"
              },
              "created_at": "2023-11-07T05:31:56Z",
              "created_by": "<string>",
              "environment_id": "<string>",
              "event_name": "<string>",
              "filters": [
                {
                  "key": "<string>",
                  "values": [
                    "<string>"
                  ]
                }
              ],
              "id": "<string>",
              "name": "<string>",
              "tenant_id": "<string>",
              "updated_at": "2023-11-07T05:31:56Z",
              "updated_by": "<string>"
            },
            "meter_display_name": "<string>",
            "meter_id": "<string>",
            "plan_display_name": "<string>",
            "price": {
              "addon": {
                "created_at": "2023-11-07T05:31:56Z",
                "created_by": "<string>",
                "credit_grants": [
                  {
                    "addon_id": "<string>",
                    "conversion_rate": "<string>",
                    "created_at": "2023-11-07T05:31:56Z",
                    "created_by": "<string>",
                    "credit_grant_anchor": "2023-11-07T05:31:56Z",
                    "credits": "<string>",
                    "end_date": "2023-11-07T05:31:56Z",
                    "environment_id": "<string>",
                    "expiration_duration": 123,
                    "id": "<string>",
                    "metadata": {},
                    "name": "<string>",
                    "period_count": 123,
                    "plan_id": "<string>",
                    "priority": 123,
                    "start_date": "2023-11-07T05:31:56Z",
                    "subscription_id": "<string>",
                    "tenant_id": "<string>",
                    "topup_conversion_rate": "<string>",
                    "updated_at": "2023-11-07T05:31:56Z",
                    "updated_by": "<string>"
                  }
                ],
                "description": "<string>",
                "entitlements": [
                  {
                    "addon": "<unknown>",
                    "config_value": {},
                    "created_at": "2023-11-07T05:31:56Z",
                    "created_by": "<string>",
                    "display_order": 123,
                    "end_date": "2023-11-07T05:31:56Z",
                    "entity_id": "<string>",
                    "environment_id": "<string>",
                    "feature": {
                      "alert_settings": {
                        "alert_enabled": true,
                        "critical": {
                          "threshold": "<string>"
                        },
                        "info": {
                          "threshold": "<string>"
                        },
                        "warning": {
                          "threshold": "<string>"
                        }
                      },
                      "created_at": "2023-11-07T05:31:56Z",
                      "created_by": "<string>",
                      "description": "<string>",
                      "environment_id": "<string>",
                      "group": {
                        "created_at": "2023-11-07T05:31:56Z",
                        "entity_ids": [
                          "<string>"
                        ],
                        "entity_type": "<string>",
                        "id": "<string>",
                        "lookup_key": "<string>",
                        "metadata": {},
                        "name": "<string>",
                        "status": "<string>",
                        "updated_at": "2023-11-07T05:31:56Z"
                      },
                      "group_id": "<string>",
                      "id": "<string>",
                      "lookup_key": "<string>",
                      "metadata": {},
                      "meter": {
                        "aggregation": {
                          "expression": "<string>",
                          "field": "<string>",
                          "group_by": "<string>",
                          "multiplier": "<string>"
                        },
                        "created_at": "2024-03-20T15:04:05Z",
                        "event_name": "api_request",
                        "filters": [
                          {
                            "key": "<string>",
                            "values": [
                              "<string>"
                            ]
                          }
                        ],
                        "id": "550e8400-e29b-41d4-a716-446655440000",
                        "name": "API Usage Meter",
                        "status": "published",
                        "tenant_id": "tenant123",
                        "updated_at": "2024-03-20T15:04:05Z"
                      },
                      "meter_id": "<string>",
                      "name": "<string>",
                      "reporting_unit": {
                        "conversion_rate": 123,
                        "unit_plural": "<string>",
                        "unit_singular": "<string>"
                      },
                      "tenant_id": "<string>",
                      "unit_plural": "<string>",
                      "unit_singular": "<string>",
                      "updated_at": "2023-11-07T05:31:56Z",
                      "updated_by": "<string>"
                    },
                    "feature_id": "<string>",
                    "id": "<string>",
                    "is_enabled": true,
                    "is_soft_limit": true,
                    "parent_entitlement_id": "<string>",
                    "plan": {
                      "created_at": "2023-11-07T05:31:56Z",
                      "created_by": "<string>",
                      "credit_grants": [
                        {
                          "addon_id": "<string>",
                          "conversion_rate": "<string>",
                          "created_at": "2023-11-07T05:31:56Z",
                          "created_by": "<string>",
                          "credit_grant_anchor": "2023-11-07T05:31:56Z",
                          "credits": "<string>",
                          "end_date": "2023-11-07T05:31:56Z",
                          "environment_id": "<string>",
                          "expiration_duration": 123,
                          "id": "<string>",
                          "metadata": {},
                          "name": "<string>",
                          "period_count": 123,
                          "plan_id": "<string>",
                          "priority": 123,
                          "start_date": "2023-11-07T05:31:56Z",
                          "subscription_id": "<string>",
                          "tenant_id": "<string>",
                          "topup_conversion_rate": "<string>",
                          "updated_at": "2023-11-07T05:31:56Z",
                          "updated_by": "<string>"
                        }
                      ],
                      "description": "<string>",
                      "display_order": 123,
                      "entitlements": "<array>",
                      "environment_id": "<string>",
                      "id": "<string>",
                      "lookup_key": "<string>",
                      "metadata": {},
                      "name": "<string>",
                      "prices": "<array>",
                      "tenant_id": "<string>",
                      "updated_at": "2023-11-07T05:31:56Z",
                      "updated_by": "<string>"
                    },
                    "plan_id": "<string>",
                    "start_date": "2023-11-07T05:31:56Z",
                    "static_value": "<string>",
                    "tenant_id": "<string>",
                    "updated_at": "2023-11-07T05:31:56Z",
                    "updated_by": "<string>",
                    "usage_limit": 123
                  }
                ],
                "environment_id": "<string>",
                "id": "<string>",
                "lookup_key": "<string>",
                "metadata": {},
                "name": "<string>",
                "prices": "<array>",
                "tenant_id": "<string>",
                "updated_at": "2023-11-07T05:31:56Z",
                "updated_by": "<string>"
              },
              "amount": "<string>",
              "billing_cadence": "RECURRING",
              "billing_period_count": 123,
              "conversion_rate": "<string>",
              "created_at": "2023-11-07T05:31:56Z",
              "created_by": "<string>",
              "currency": "<string>",
              "description": "<string>",
              "display_amount": "<string>",
              "display_name": "<string>",
              "display_price_unit_amount": "<string>",
              "end_date": "2023-11-07T05:31:56Z",
              "entity_id": "<string>",
              "environment_id": "<string>",
              "group": {
                "created_at": "2023-11-07T05:31:56Z",
                "entity_ids": [
                  "<string>"
                ],
                "entity_type": "<string>",
                "id": "<string>",
                "lookup_key": "<string>",
                "metadata": {},
                "name": "<string>",
                "status": "<string>",
                "updated_at": "2023-11-07T05:31:56Z"
              },
              "group_id": "<string>",
              "id": "<string>",
              "lookup_key": "<string>",
              "metadata": {},
              "meter": {
                "aggregation": {
                  "expression": "<string>",
                  "field": "<string>",
                  "group_by": "<string>",
                  "multiplier": "<string>"
                },
                "created_at": "2024-03-20T15:04:05Z",
                "event_name": "api_request",
                "filters": [
                  {
                    "key": "<string>",
                    "values": [
                      "<string>"
                    ]
                  }
                ],
                "id": "550e8400-e29b-41d4-a716-446655440000",
                "name": "API Usage Meter",
                "status": "published",
                "tenant_id": "tenant123",
                "updated_at": "2024-03-20T15:04:05Z"
              },
              "meter_id": "<string>",
              "min_quantity": "<string>",
              "parent_price_id": "<string>",
              "plan": {
                "created_at": "2023-11-07T05:31:56Z",
                "created_by": "<string>",
                "credit_grants": [
                  {
                    "addon_id": "<string>",
                    "conversion_rate": "<string>",
                    "created_at": "2023-11-07T05:31:56Z",
                    "created_by": "<string>",
                    "credit_grant_anchor": "2023-11-07T05:31:56Z",
                    "credits": "<string>",
                    "end_date": "2023-11-07T05:31:56Z",
                    "environment_id": "<string>",
                    "expiration_duration": 123,
                    "id": "<string>",
                    "metadata": {},
                    "name": "<string>",
                    "period_count": 123,
                    "plan_id": "<string>",
                    "priority": 123,
                    "start_date": "2023-11-07T05:31:56Z",
                    "subscription_id": "<string>",
                    "tenant_id": "<string>",
                    "topup_conversion_rate": "<string>",
                    "updated_at": "2023-11-07T05:31:56Z",
                    "updated_by": "<string>"
                  }
                ],
                "description": "<string>",
                "display_order": 123,
                "entitlements": "<array>",
                "environment_id": "<string>",
                "id": "<string>",
                "lookup_key": "<string>",
                "metadata": {},
                "name": "<string>",
                "prices": "<array>",
                "tenant_id": "<string>",
                "updated_at": "2023-11-07T05:31:56Z",
                "updated_by": "<string>"
              },
              "price_unit": "<string>",
              "price_unit_amount": "<string>",
              "price_unit_id": "<string>",
              "price_unit_tiers": [
                {
                  "flat_amount": "<string>",
                  "unit_amount": "<string>",
                  "up_to": 123
                }
              ],
              "pricing_unit": {
                "base_currency": "<string>",
                "code": "<string>",
                "conversion_rate": "<string>",
                "created_at": "2023-11-07T05:31:56Z",
                "created_by": "<string>",
                "environment_id": "<string>",
                "id": "<string>",
                "metadata": {},
                "name": "<string>",
                "symbol": "<string>",
                "tenant_id": "<string>",
                "updated_at": "2023-11-07T05:31:56Z",
                "updated_by": "<string>"
              },
              "sequence": 123,
              "start_date": "2023-11-07T05:31:56Z",
              "tenant_id": "<string>",
              "tiers": [
                {
                  "flat_amount": "<string>",
                  "unit_amount": "<string>",
                  "up_to": 123
                }
              ],
              "transform_quantity": {
                "divide_by": 123
              },
              "trial_period_days": 123,
              "updated_at": "2023-11-07T05:31:56Z",
              "updated_by": "<string>"
            },
            "price_id": "<string>",
            "price_unit": "<string>",
            "price_unit_id": "<string>",
            "quantity": "<string>",
            "start_date": "2023-11-07T05:31:56Z",
            "subscription_id": "<string>",
            "subscription_phase_id": "<string>",
            "tenant_id": "<string>",
            "updated_at": "2023-11-07T05:31:56Z",
            "updated_by": "<string>"
          },
          "subscription_line_item_id": "<string>",
          "subscription_phase_id": "<string>",
          "tenant_id": "<string>",
          "updated_at": "2023-11-07T05:31:56Z",
          "updated_by": "<string>"
        }
      ],
      "created_at": "2023-11-07T05:31:56Z",
      "created_by": "<string>",
      "credit_grants": [
        {
          "addon_id": "<string>",
          "conversion_rate": "<string>",
          "created_at": "2023-11-07T05:31:56Z",
          "created_by": "<string>",
          "credit_grant_anchor": "2023-11-07T05:31:56Z",
          "credits": "<string>",
          "end_date": "2023-11-07T05:31:56Z",
          "environment_id": "<string>",
          "expiration_duration": 123,
          "id": "<string>",
          "metadata": {},
          "name": "<string>",
          "period_count": 123,
          "plan_id": "<string>",
          "priority": 123,
          "start_date": "2023-11-07T05:31:56Z",
          "subscription_id": "<string>",
          "tenant_id": "<string>",
          "topup_conversion_rate": "<string>",
          "updated_at": "2023-11-07T05:31:56Z",
          "updated_by": "<string>"
        }
      ],
      "currency": "<string>",
      "current_period_end": "2023-11-07T05:31:56Z",
      "current_period_start": "2023-11-07T05:31:56Z",
      "customer": {
        "address_city": "<string>",
        "address_country": "<string>",
        "address_line1": "<string>",
        "address_line2": "<string>",
        "address_postal_code": "<string>",
        "address_state": "<string>",
        "contact": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "created_by": "<string>",
        "email": "<string>",
        "environment_id": "<string>",
        "external_id": "<string>",
        "id": "<string>",
        "integrations": [
          {
            "created_at": "2023-11-07T05:31:56Z",
            "created_by": "<string>",
            "entity_id": "<string>",
            "environment_id": "<string>",
            "id": "<string>",
            "metadata": {},
            "provider_entity_id": "<string>",
            "provider_type": "<string>",
            "tenant_id": "<string>",
            "updated_at": "2023-11-07T05:31:56Z",
            "updated_by": "<string>"
          }
        ],
        "metadata": {},
        "name": "<string>",
        "tenant_id": "<string>",
        "timezone": "<string>",
        "updated_at": "2023-11-07T05:31:56Z",
        "updated_by": "<string>"
      },
      "customer_id": "<string>",
      "enable_true_up": true,
      "end_date": "2023-11-07T05:31:56Z",
      "entitlements": [
        {
          "entitlement": {
            "config_values": [
              {}
            ],
            "is_enabled": true,
            "is_soft_limit": true,
            "static_values": [
              "<string>"
            ],
            "usage_limit": 123
          },
          "feature": {
            "alert_settings": {
              "alert_enabled": true,
              "critical": {
                "threshold": "<string>"
              },
              "info": {
                "threshold": "<string>"
              },
              "warning": {
                "threshold": "<string>"
              }
            },
            "created_at": "2023-11-07T05:31:56Z",
            "created_by": "<string>",
            "description": "<string>",
            "environment_id": "<string>",
            "group": {
              "created_at": "2023-11-07T05:31:56Z",
              "entity_ids": [
                "<string>"
              ],
              "entity_type": "<string>",
              "id": "<string>",
              "lookup_key": "<string>",
              "metadata": {},
              "name": "<string>",
              "status": "<string>",
              "updated_at": "2023-11-07T05:31:56Z"
            },
            "group_id": "<string>",
            "id": "<string>",
            "lookup_key": "<string>",
            "metadata": {},
            "meter": {
              "aggregation": {
                "expression": "<string>",
                "field": "<string>",
                "group_by": "<string>",
                "multiplier": "<string>"
              },
              "created_at": "2024-03-20T15:04:05Z",
              "event_name": "api_request",
              "filters": [
                {
                  "key": "<string>",
                  "values": [
                    "<string>"
                  ]
                }
              ],
              "id": "550e8400-e29b-41d4-a716-446655440000",
              "name": "API Usage Meter",
              "status": "published",
              "tenant_id": "tenant123",
              "updated_at": "2024-03-20T15:04:05Z"
            },
            "meter_id": "<string>",
            "name": "<string>",
            "reporting_unit": {
              "conversion_rate": 123,
              "unit_plural": "<string>",
              "unit_singular": "<string>"
            },
            "tenant_id": "<string>",
            "unit_plural": "<string>",
            "unit_singular": "<string>",
            "updated_at": "2023-11-07T05:31:56Z",
            "updated_by": "<string>"
          },
          "sources": [
            {
              "config_value": {},
              "entitlement_id": "<string>",
              "entity_id": "<string>",
              "entity_name": "<string>",
              "is_enabled": true,
              "quantity": 123,
              "static_value": "<string>",
              "subscription_id": "<string>",
              "usage_limit": 123
            }
          ]
        }
      ],
      "environment_id": "<string>",
      "gateway_payment_method_id": "<string>",
      "id": "<string>",
      "invoicing_customer_id": "<string>",
      "latest_invoice": "<unknown>",
      "line_items": [
        {
          "addon_association_id": "<string>",
          "billing_period_count": 123,
          "commitment_amount": "<string>",
          "commitment_overage_factor": "<string>",
          "commitment_quantity": "<string>",
          "commitment_time_buckets": [
            {
              "commitment_value": "<string>",
              "end": {
                "hour": 12,
                "minute": 29
              },
              "id": "<string>",
              "overage_factor": 123,
              "price_id": "<string>",
              "start": {
                "hour": 12,
                "minute": 29
              },
              "true_up_enabled": true
            }
          ],
          "commitment_true_up_enabled": true,
          "commitment_windowed": true,
          "created_at": "2023-11-07T05:31:56Z",
          "created_by": "<string>",
          "currency": "<string>",
          "customer_id": "<string>",
          "display_name": "<string>",
          "end_date": "2023-11-07T05:31:56Z",
          "entity_id": "<string>",
          "environment_id": "<string>",
          "id": "<string>",
          "metadata": {},
          "meter": {
            "aggregation": {
              "expression": "<string>",
              "field": "<string>",
              "group_by": "<string>",
              "multiplier": "<string>"
            },
            "created_at": "2023-11-07T05:31:56Z",
            "created_by": "<string>",
            "environment_id": "<string>",
            "event_name": "<string>",
            "filters": [
              {
                "key": "<string>",
                "values": [
                  "<string>"
                ]
              }
            ],
            "id": "<string>",
            "name": "<string>",
            "tenant_id": "<string>",
            "updated_at": "2023-11-07T05:31:56Z",
            "updated_by": "<string>"
          },
          "meter_display_name": "<string>",
          "meter_id": "<string>",
          "plan_display_name": "<string>",
          "price": {
            "amount": "<string>",
            "billing_cadence": "RECURRING",
            "billing_period_count": 123,
            "conversion_rate": "<string>",
            "created_at": "2023-11-07T05:31:56Z",
            "created_by": "<string>",
            "currency": "<string>",
            "description": "<string>",
            "display_amount": "<string>",
            "display_name": "<string>",
            "display_price_unit_amount": "<string>",
            "end_date": "2023-11-07T05:31:56Z",
            "entity_id": "<string>",
            "environment_id": "<string>",
            "group_id": "<string>",
            "id": "<string>",
            "lookup_key": "<string>",
            "metadata": {},
            "meter_id": "<string>",
            "min_quantity": "<string>",
            "parent_price_id": "<string>",
            "price_unit": "<string>",
            "price_unit_amount": "<string>",
            "price_unit_id": "<string>",
            "price_unit_tiers": [
              {
                "flat_amount": "<string>",
                "unit_amount": "<string>",
                "up_to": 123
              }
            ],
            "sequence": 123,
            "start_date": "2023-11-07T05:31:56Z",
            "tenant_id": "<string>",
            "tiers": [
              {
                "flat_amount": "<string>",
                "unit_amount": "<string>",
                "up_to": 123
              }
            ],
            "transform_quantity": {
              "divide_by": 123
            },
            "trial_period_days": 123,
            "updated_at": "2023-11-07T05:31:56Z",
            "updated_by": "<string>"
          },
          "price_id": "<string>",
          "price_unit": "<string>",
          "price_unit_id": "<string>",
          "quantity": "<string>",
          "start_date": "2023-11-07T05:31:56Z",
          "subscription_id": "<string>",
          "subscription_phase_id": "<string>",
          "tenant_id": "<string>",
          "updated_at": "2023-11-07T05:31:56Z",
          "updated_by": "<string>"
        }
      ],
      "lookup_key": "<string>",
      "metadata": {},
      "overage_factor": "<string>",
      "parent_subscription_id": "<string>",
      "pauses": [
        {
          "created_at": "2023-11-07T05:31:56Z",
          "created_by": "<string>",
          "environment_id": "<string>",
          "id": "<string>",
          "metadata": {},
          "original_period_end": "2023-11-07T05:31:56Z",
          "original_period_start": "2023-11-07T05:31:56Z",
          "pause_end": "2023-11-07T05:31:56Z",
          "pause_start": "2023-11-07T05:31:56Z",
          "reason": "<string>",
          "resumed_at": "2023-11-07T05:31:56Z",
          "subscription_id": "<string>",
          "tenant_id": "<string>",
          "updated_at": "2023-11-07T05:31:56Z",
          "updated_by": "<string>"
        }
      ],
      "payment_behavior": "<string>",
      "phases": [
        {
          "created_at": "2023-11-07T05:31:56Z",
          "created_by": "<string>",
          "end_date": "2023-11-07T05:31:56Z",
          "environment_id": "<string>",
          "id": "<string>",
          "metadata": {},
          "start_date": "2023-11-07T05:31:56Z",
          "subscription_id": "<string>",
          "tenant_id": "<string>",
          "updated_at": "2023-11-07T05:31:56Z",
          "updated_by": "<string>"
        }
      ],
      "plan": {
        "created_at": "2023-11-07T05:31:56Z",
        "created_by": "<string>",
        "credit_grants": [
          {
            "addon_id": "<string>",
            "conversion_rate": "<string>",
            "created_at": "2023-11-07T05:31:56Z",
            "created_by": "<string>",
            "credit_grant_anchor": "2023-11-07T05:31:56Z",
            "credits": "<string>",
            "end_date": "2023-11-07T05:31:56Z",
            "environment_id": "<string>",
            "expiration_duration": 123,
            "id": "<string>",
            "metadata": {},
            "name": "<string>",
            "period_count": 123,
            "plan_id": "<string>",
            "priority": 123,
            "start_date": "2023-11-07T05:31:56Z",
            "subscription_id": "<string>",
            "tenant_id": "<string>",
            "topup_conversion_rate": "<string>",
            "updated_at": "2023-11-07T05:31:56Z",
            "updated_by": "<string>"
          }
        ],
        "description": "<string>",
        "display_order": 123,
        "entitlements": "<array>",
        "environment_id": "<string>",
        "id": "<string>",
        "lookup_key": "<string>",
        "metadata": {},
        "name": "<string>",
        "prices": "<array>",
        "tenant_id": "<string>",
        "updated_at": "2023-11-07T05:31:56Z",
        "updated_by": "<string>"
      },
      "plan_id": "<string>",
      "start_date": "2023-11-07T05:31:56Z",
      "synced_price_sequence": 123,
      "tenant_id": "<string>",
      "timezone": "<string>",
      "trial_end": "2023-11-07T05:31:56Z",
      "trial_start": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "updated_by": "<string>",
      "version": 123
    },
    "subscription_customer_id": "<string>",
    "subscription_id": "<string>",
    "subtotal": "<string>",
    "taxes": [
      {
        "applied_at": "2023-11-07T05:31:56Z",
        "created_at": "2023-11-07T05:31:56Z",
        "created_by": "<string>",
        "currency": "<string>",
        "entity_id": "<string>",
        "environment_id": "<string>",
        "id": "<string>",
        "idempotency_key": "<string>",
        "metadata": {},
        "tax_amount": "<string>",
        "tax_association_id": "<string>",
        "tax_rate": {
          "code": "<string>",
          "created_at": "2023-11-07T05:31:56Z",
          "created_by": "<string>",
          "description": "<string>",
          "environment_id": "<string>",
          "fixed_value": "<string>",
          "id": "<string>",
          "metadata": {},
          "name": "<string>",
          "percentage_value": "<string>",
          "tenant_id": "<string>",
          "updated_at": "2023-11-07T05:31:56Z",
          "updated_by": "<string>"
        },
        "tax_rate_id": "<string>",
        "taxable_amount": "<string>",
        "tenant_id": "<string>",
        "updated_at": "2023-11-07T05:31:56Z",
        "updated_by": "<string>"
      }
    ],
    "tenant_id": "<string>",
    "total": "<string>",
    "total_discount": "<string>",
    "total_prepaid_credits_applied": "<string>",
    "total_tax": "<string>",
    "updated_at": "2023-11-07T05:31:56Z",
    "updated_by": "<string>",
    "version": 123,
    "voided_at": "2023-11-07T05:31:56Z"
  },
  "is_scheduled": true,
  "metadata": {},
  "new_subscription": {
    "archived_at": "2023-11-07T05:31:56Z",
    "billing_anchor": "2023-11-07T05:31:56Z",
    "created_at": "2023-11-07T05:31:56Z",
    "current_period_end": "2023-11-07T05:31:56Z",
    "current_period_start": "2023-11-07T05:31:56Z",
    "id": "<string>",
    "plan_id": "<string>"
  },
  "old_subscription": {
    "archived_at": "2023-11-07T05:31:56Z",
    "billing_anchor": "2023-11-07T05:31:56Z",
    "created_at": "2023-11-07T05:31:56Z",
    "current_period_end": "2023-11-07T05:31:56Z",
    "current_period_start": "2023-11-07T05:31:56Z",
    "id": "<string>",
    "plan_id": "<string>"
  },
  "proration_applied": {
    "charge_amount": "<string>",
    "charge_description": "<string>",
    "credit_amount": "<string>",
    "credit_description": "<string>",
    "currency": "<string>",
    "current_period_end": "2023-11-07T05:31:56Z",
    "current_period_start": "2023-11-07T05:31:56Z",
    "days_remaining": 123,
    "days_used": 123,
    "net_amount": "<string>",
    "proration_date": "2023-11-07T05:31:56Z"
  },
  "schedule_id": "<string>",
  "scheduled_at": "2023-11-07T05:31:56Z"
}

{
  "http_status_code": 123,
  "message": "<string>"
}

{
  "http_status_code": 123,
  "message": "<string>"
}

{
  "http_status_code": 123,
  "message": "<string>"
}

Authorizations

x-api-key · string · header · required

Enter your API key in the format x-api-key <api-key>*

Path Parameters

id · string · required

Subscription ID

Body

application/json

Subscription change request

Request object for changing a subscription plan (upgrade/downgrade)

billing_cadence · enum<string> · required

Available options: RECURRING

billing_cycle · enum<string> · required

Available options: anniversary, calendar

billing_period · enum<string> · required

Available options: MONTHLY, ANNUAL, WEEKLY, DAILY, QUARTERLY, HALF_YEARLY, ONETIME

proration_behavior · enum<string> · required

Available options: create_prorations, none

target_plan_id · string · required

target_plan_id is the ID of the new plan to change to (required)

billing_period_count · integer

billing_period_count is the billing period count for the new subscription

change_at · enum<string>

Available options: immediate, end_of_period

metadata · object

metadata contains additional key-value pairs for storing extra information

Show child attributes

Response

200

application/json

OK

Response after successfully executing a subscription plan change

change_type · enum<string>

Available options: upgrade, downgrade, lateral

credit_grants · object[]

credit_grants contains any credit grants created for proration credits

Show child attributes

effective_date · string<date-time>

effective_date is when the change took effect

invoice · object

Show child attributes

is_scheduled · boolean

is_scheduled indicates if the change was scheduled or executed immediately

metadata · object

metadata from the request

Show child attributes

new_subscription · object

Show child attributes

old_subscription · object

Show child attributes

proration_applied · object

Show child attributes

schedule_id · string

schedule_id is the ID of the created schedule (only if is_scheduled=true)

scheduled_at · string<date-time>

scheduled_at is when the change will execute (only if is_scheduled=true)