Change Subscription Rate Card

client.subscriptions.changeRateCard(, , ?): SubscriptionChangeRateCardResponse { result }

post/subscriptions/{subscription_id}/change-rate-card

ParametersExpand Collapse

subscriptionID: string

body: SubscriptionChangeRateCardParams { checkout_callback_urls, rate_card_id, upgrade_behavior }

checkout_callback_urls: CheckoutCallback { cancelled_url, success_url }

The URLs to redirect to after the checkout is completed or cancelled, if a checkout is required.

cancelled_url: string

The URL to redirect to after the checkout is cancelled.

minLength1

formaturi

success_url: string

The URL to redirect to after the checkout is successful.

minLength1

formaturi

rate_card_id: string

The ID of the rate card to change the subscription to.

upgrade_behavior?: "prorate" | "rate_difference"

The behavior to use when upgrading the subscription. If 'prorate', the customer will be charged for the prorated difference. If 'rate_difference', the customer will be charged for the difference in the rate cards without respect to time.

Accepts one of the following:

"prorate"

"rate_difference"

ReturnsExpand Collapse

SubscriptionChangeRateCardResponse { result }

result: ChangeSubscriptionRateCardRequiresActionResponse { action, type } | ChangeSubscriptionRateCardSuccessResponse { subscription, type }

The result of the request. If the request is successful, the subscription resource will be returned. If the request is requires action, the action to take to complete the request will be returned.

Accepts one of the following:

ChangeSubscriptionRateCardRequiresActionResponse { action, type }

action: Action { checkout_url, type }

The action to take to complete the request.

checkout_url: string

The URL of the checkout page to redirect to in order to complete the request.

type: "checkout"

Accepts one of the following:

"checkout"

type: "requires_action"

Accepts one of the following:

"requires_action"

ChangeSubscriptionRateCardSuccessResponse { subscription, type }

subscription: SubscriptionResource { id, cancels_at_end_of_cycle, current_period, 6 more }

The updated subscription resource.

id: string

The ID of the subscription.

cancels_at_end_of_cycle: boolean

Whether the subscription will be cancelled at the end of the current cycle.

current_period: CurrentPeriod | null

The current period of the subscription if it is active.

end: string

formatdate-time

start: string

formatdate-time

inclusive_end?: boolean

inclusive_start?: boolean

cycles_next_at: string | null

The date and time the next cycle of the subscription will start.

formatdate-time

effective_at: string

The date and time the subscription became effective.

formatdate-time

metadata: Record<string, string>

rate_card_id: string

The ID of the rate card of the subscription.

status: "active" | "cancelled" | "paused"

The status of the subscription.

Accepts one of the following:

"active"

"cancelled"

"paused"

subject_id: string

The ID of the subject that the subscription is for.

type: "success"

Accepts one of the following:

"success"

Change Subscription Rate Card

import Lark from 'lark-billing';

const client = new Lark({
  apiKey: 'My API Key',
});

const response = await client.subscriptions.changeRateCard('subscription_id', {
  checkout_callback_urls: {
    cancelled_url: 'https://example.com/try-again',
    success_url: 'https://example.com/completed',
  },
  rate_card_id: 'rc_jQK2n0wutCj6bBcAIrL6o07g',
  upgrade_behavior: 'prorate',
});

console.log(response.result);

{
  "result": {
    "subscription": {
      "id": "rc_sub_PuLvkNSP3IBCvjayBD3TXNQ6",
      "cancels_at_end_of_cycle": false,
      "current_period": {
        "end": "2025-11-01T00:00:00Z",
        "start": "2025-10-01T00:00:00Z",
        "inclusive_end": false,
        "inclusive_start": true
      },
      "cycles_next_at": "2025-11-01T00:00:00Z",
      "effective_at": "2025-10-01T00:00:00Z",
      "metadata": {},
      "rate_card_id": "rc_AJWMxR81jxoRlli6p13uf3JB",
      "status": "active",
      "subject_id": "subj_VyX6Q96h5avMho8O7QWlKeXE"
    },
    "type": "success"
  }
}

Returns Examples

{
  "result": {
    "subscription": {
      "id": "rc_sub_PuLvkNSP3IBCvjayBD3TXNQ6",
      "cancels_at_end_of_cycle": false,
      "current_period": {
        "end": "2025-11-01T00:00:00Z",
        "start": "2025-10-01T00:00:00Z",
        "inclusive_end": false,
        "inclusive_start": true
      },
      "cycles_next_at": "2025-11-01T00:00:00Z",
      "effective_at": "2025-10-01T00:00:00Z",
      "metadata": {},
      "rate_card_id": "rc_AJWMxR81jxoRlli6p13uf3JB",
      "status": "active",
      "subject_id": "subj_VyX6Q96h5avMho8O7QWlKeXE"
    },
    "type": "success"
  }
}