POST
/
subscriptions
/
{subscription_id}
/
change-plan
import DodoPayments from 'dodopayments';

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

async function main() {
  await client.subscriptions.changePlan('subscription_id', {
    product_id: 'product_id',
    proration_billing_mode: 'prorated_immediately',
    quantity: 0,
  });
}

main();

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

subscription_id
string
required

Subscription Id

Body

application/json
product_id
string
required

Unique identifier of the product to subscribe to

proration_billing_mode
enum<string>
required
Available options:
prorated_immediately
quantity
integer
required

Number of units to subscribe for. Must be at least 1.

Required range: x >= 0

Response

200

Subscription plan changed