プラン変更のプレビュー

import DodoPayments from 'dodopayments';

const client = new DodoPayments({
  bearerToken: process.env['DODO_PAYMENTS_API_KEY'], // This is the default and can be omitted
});

const response = await client.subscriptions.previewChangePlan('sub_Iuaq622bbmmfOGrVTqdXv', {
  product_id: 'product_id',
  proration_billing_mode: 'prorated_immediately',
  quantity: 0,
});

console.log(response.immediate_charge);

import os
from dodopayments import DodoPayments

client = DodoPayments(
    bearer_token=os.environ.get("DODO_PAYMENTS_API_KEY"),  # This is the default and can be omitted
)
response = client.subscriptions.preview_change_plan(
    subscription_id="sub_Iuaq622bbmmfOGrVTqdXv",
    product_id="product_id",
    proration_billing_mode="prorated_immediately",
    quantity=0,
)
print(response.immediate_charge)

package main

import (
	"context"
	"fmt"

	"github.com/dodopayments/dodopayments-go"
	"github.com/dodopayments/dodopayments-go/option"
)

func main() {
	client := dodopayments.NewClient(
		option.WithBearerToken("My Bearer Token"),
	)
	response, err := client.Subscriptions.PreviewChangePlan(
		context.TODO(),
		"sub_Iuaq622bbmmfOGrVTqdXv",
		dodopayments.SubscriptionPreviewChangePlanParams{
			UpdateSubscriptionPlanReq: dodopayments.UpdateSubscriptionPlanReqParam{
				ProductID:            dodopayments.F("product_id"),
				ProrationBillingMode: dodopayments.F(dodopayments.UpdateSubscriptionPlanReqProrationBillingModeProratedImmediately),
				Quantity:             dodopayments.F(int64(0)),
			},
		},
	)
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", response.ImmediateCharge)
}

package com.dodopayments.api.example;

import com.dodopayments.api.client.DodoPaymentsClient;
import com.dodopayments.api.client.okhttp.DodoPaymentsOkHttpClient;
import com.dodopayments.api.models.subscriptions.SubscriptionPreviewChangePlanParams;
import com.dodopayments.api.models.subscriptions.SubscriptionPreviewChangePlanResponse;
import com.dodopayments.api.models.subscriptions.UpdateSubscriptionPlanReq;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        DodoPaymentsClient client = DodoPaymentsOkHttpClient.fromEnv();

        SubscriptionPreviewChangePlanParams params = SubscriptionPreviewChangePlanParams.builder()
            .subscriptionId("sub_Iuaq622bbmmfOGrVTqdXv")
            .updateSubscriptionPlanReq(UpdateSubscriptionPlanReq.builder()
                .productId("product_id")
                .prorationBillingMode(UpdateSubscriptionPlanReq.ProrationBillingMode.PRORATED_IMMEDIATELY)
                .quantity(0)
                .build())
            .build();
        SubscriptionPreviewChangePlanResponse response = client.subscriptions().previewChangePlan(params);
    }
}

package com.dodopayments.api.example

import com.dodopayments.api.client.DodoPaymentsClient
import com.dodopayments.api.client.okhttp.DodoPaymentsOkHttpClient
import com.dodopayments.api.models.subscriptions.SubscriptionPreviewChangePlanParams
import com.dodopayments.api.models.subscriptions.SubscriptionPreviewChangePlanResponse
import com.dodopayments.api.models.subscriptions.UpdateSubscriptionPlanReq

fun main() {
    val client: DodoPaymentsClient = DodoPaymentsOkHttpClient.fromEnv()

    val params: SubscriptionPreviewChangePlanParams = SubscriptionPreviewChangePlanParams.builder()
        .subscriptionId("sub_Iuaq622bbmmfOGrVTqdXv")
        .updateSubscriptionPlanReq(UpdateSubscriptionPlanReq.builder()
            .productId("product_id")
            .prorationBillingMode(UpdateSubscriptionPlanReq.ProrationBillingMode.PRORATED_IMMEDIATELY)
            .quantity(0)
            .build())
        .build()
    val response: SubscriptionPreviewChangePlanResponse = client.subscriptions().previewChangePlan(params)
}

require "dodopayments"

dodo_payments = Dodopayments::Client.new(
  bearer_token: "My Bearer Token",
  environment: "test_mode" # defaults to "live_mode"
)

response = dodo_payments.subscriptions.preview_change_plan(
  "sub_Iuaq622bbmmfOGrVTqdXv",
  product_id: "product_id",
  proration_billing_mode: :prorated_immediately,
  quantity: 0
)

puts(response)

<?php

require_once dirname(__DIR__) . '/vendor/autoload.php';

use Dodopayments\Client;
use Dodopayments\Core\Exceptions\APIException;

$client = new Client(
  bearerToken: getenv('DODO_PAYMENTS_API_KEY') ?: 'My Bearer Token',
  environment: 'test_mode',
);

try {
  $response = $client->subscriptions->previewChangePlan(
    'sub_Iuaq622bbmmfOGrVTqdXv',
    productID: 'product_id',
    prorationBillingMode: 'prorated_immediately',
    quantity: 0,
    adaptiveCurrencyFeesInclusive: true,
    addons: [['addonID' => 'addon_id', 'quantity' => 0]],
    discountCode: 'discount_code',
    discountCodes: ['string'],
    effectiveAt: 'immediately',
    metadata: ['foo' => 'string'],
    onPaymentFailure: 'prevent_change',
  );

  var_dump($response);
} catch (APIException $e) {
  echo $e->getMessage();
}

using System;
using DodoPayments.Client;
using DodoPayments.Client.Models.Subscriptions;

DodoPaymentsClient client = new();

SubscriptionPreviewChangePlanParams parameters = new()
{
    SubscriptionID = "sub_Iuaq622bbmmfOGrVTqdXv",
    ProductID = "product_id",
    ProrationBillingMode = SubscriptionPreviewChangePlanParamsProrationBillingMode.ProratedImmediately,
    Quantity = 0,
};

var response = await client.Subscriptions.PreviewChangePlan(parameters);

Console.WriteLine(response);

use dodopayments::Client;

#[tokio::main]
async fn main() -> dodopayments::Result<()> {
    let client = Client::from_env()?;
    let subscription_id = "subscription_id";
    let result = client
        .subscriptions()
        .preview_change_plan()
        .subscription_id(subscription_id)
        .body(dodopayments::models::SubscriptionsChangePlanParams {
                product_id: Some("product_id".to_string()),
                proration_billing_mode: Some("prorated_immediately".to_string()),
                quantity: Some(0),
                ..Default::default()
            })
        .await?;
    println!("{result:?}");
    Ok(())
}

curl --request POST \
  --url https://test.dodopayments.com/subscriptions/{subscription_id}/change-plan/preview \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "product_id": "<string>",
  "quantity": 1,
  "adaptive_currency_fees_inclusive": true,
  "addons": [
    {
      "addon_id": "<string>",
      "quantity": 1
    }
  ],
  "discount_code": "<string>",
  "discount_codes": [
    "<string>"
  ],
  "metadata": {}
}
'

{
  "immediate_charge": {
    "effective_at": "2023-11-07T05:31:56Z",
    "line_items": [
      {
        "id": "<string>",
        "product_id": "<string>",
        "proration_factor": 123,
        "quantity": 123,
        "tax_inclusive": true,
        "type": "subscription",
        "unit_price": 123,
        "description": "<string>",
        "name": "<string>",
        "tax": 123,
        "tax_rate": 123
      }
    ],
    "summary": {
      "customer_credits": 123,
      "settlement_amount": 123,
      "total_amount": 123,
      "settlement_tax": 123,
      "tax": 123
    }
  },
  "new_plan": {
    "addons": [
      {
        "addon_id": "<string>",
        "quantity": 123
      }
    ],
    "billing": {
      "city": "<string>",
      "state": "<string>",
      "street": "<string>",
      "zipcode": "<string>"
    },
    "brand_id": "<string>",
    "cancel_at_next_billing_date": true,
    "created_at": "2023-11-07T05:31:56Z",
    "credit_entitlement_cart": [
      {
        "credit_entitlement_id": "<string>",
        "credit_entitlement_name": "<string>",
        "credits_amount": "<string>",
        "overage_balance": "<string>",
        "overage_enabled": true,
        "product_id": "<string>",
        "remaining_balance": "<string>",
        "rollover_enabled": true,
        "unit": "<string>",
        "expires_after_days": 123,
        "low_balance_threshold_percent": 123,
        "max_rollover_count": 123,
        "overage_limit": "<string>",
        "rollover_percentage": 123,
        "rollover_timeframe_count": 123
      }
    ],
    "customer": {
      "customer_id": "<string>",
      "email": "<string>",
      "name": "<string>",
      "metadata": {},
      "phone_number": "<string>"
    },
    "metadata": {},
    "meter_credit_entitlement_cart": [
      {
        "credit_entitlement_id": "<string>",
        "meter_id": "<string>",
        "meter_name": "<string>",
        "meter_units_per_credit": "<string>",
        "product_id": "<string>"
      }
    ],
    "meters": [
      {
        "free_threshold": 123,
        "measurement_unit": "<string>",
        "meter_id": "<string>",
        "name": "<string>",
        "description": "<string>",
        "price_per_unit": "10.50"
      }
    ],
    "next_billing_date": "2023-11-07T05:31:56Z",
    "on_demand": true,
    "payment_frequency_count": 123,
    "previous_billing_date": "2023-11-07T05:31:56Z",
    "product_id": "<string>",
    "quantity": 123,
    "recurring_pre_tax_amount": 123,
    "subscription_id": "<string>",
    "subscription_period_count": 123,
    "tax_inclusive": true,
    "trial_period_days": 123,
    "cancellation_comment": "<string>",
    "cancelled_at": "2023-11-07T05:31:56Z",
    "custom_field_responses": [
      {
        "key": "<string>",
        "value": "<string>"
      }
    ],
    "customer_business_name": "<string>",
    "discount_cycles_remaining": 123,
    "discount_id": "<string>",
    "discounts": [
      {
        "amount": 123,
        "business_id": "<string>",
        "code": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "discount_id": "<string>",
        "metadata": {},
        "position": 123,
        "preserve_on_plan_change": true,
        "restricted_to": [
          "<string>"
        ],
        "times_used": 123,
        "type": "percentage",
        "cycles_remaining": 123,
        "expires_at": "2023-11-07T05:31:56Z",
        "name": "<string>",
        "subscription_cycles": 123,
        "usage_limit": 123
      }
    ],
    "expires_at": "2023-11-07T05:31:56Z",
    "payment_method_id": "<string>",
    "scheduled_change": {
      "addons": [
        {
          "addon_id": "<string>",
          "name": "<string>",
          "quantity": 123
        }
      ],
      "created_at": "2023-11-07T05:31:56Z",
      "effective_at": "2023-11-07T05:31:56Z",
      "id": "<string>",
      "product_id": "<string>",
      "quantity": 123,
      "product_description": "<string>",
      "product_name": "<string>"
    },
    "tax_id": "<string>"
  }
}