Change Subscription Rate Card

client.Subscriptions.ChangeRateCard(ctx, subscriptionID, body) (*SubscriptionChangeRateCardResponse, error)

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

ParametersExpand Collapse

subscriptionID string

body SubscriptionChangeRateCardParams

RateCardID param.Field[string]

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

CheckoutCallbackURLs param.Field[CheckoutCallback]optional

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

UpgradeBehavior param.Field[SubscriptionChangeRateCardParamsUpgradeBehavior]optional

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.

const SubscriptionChangeRateCardParamsUpgradeBehaviorProrate SubscriptionChangeRateCardParamsUpgradeBehavior = "prorate"

const SubscriptionChangeRateCardParamsUpgradeBehaviorRateDifference SubscriptionChangeRateCardParamsUpgradeBehavior = "rate_difference"

ReturnsExpand Collapse

type SubscriptionChangeRateCardResponse struct{…}

Result SubscriptionChangeRateCardResponseResultUnion

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:

type SubscriptionChangeRateCardResponseResultRequiresAction struct{…}

Action SubscriptionChangeRateCardResponseResultRequiresActionAction

The action to take to complete the request.

CheckoutURL string

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

Type Checkout

Type RequiresAction

type SubscriptionChangeRateCardResponseResultSuccess struct{…}

Subscription SubscriptionResource

The updated subscription resource.

ID string

The ID of the subscription.

CancelsAtEndOfCycle bool

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

CurrentPeriod SubscriptionResourceCurrentPeriod

The current period of the subscription if it is active.

End Time

formatdate-time

Start Time

formatdate-time

InclusiveEnd booloptional

InclusiveStart booloptional

CyclesNextAt Time

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

formatdate-time

EffectiveAt Time

The date and time the subscription became effective.

formatdate-time

FixedRateQuantities map[string, string]

The quantities of the fixed rates of the subscription.

Metadata map[string, string]

RateCardID string

The ID of the rate card of the subscription.

RatePriceMultipliers map[string, string]

The price multipliers of the rates of the subscription.

Status SubscriptionResourceStatus

The status of the subscription.

Accepts one of the following:

const SubscriptionResourceStatusActive SubscriptionResourceStatus = "active"

const SubscriptionResourceStatusCancelled SubscriptionResourceStatus = "cancelled"

const SubscriptionResourceStatusPaused SubscriptionResourceStatus = "paused"

SubjectID string

The ID of the subject that the subscription is for.

Type Success

Change Subscription Rate Card

package main

import (
  "context"
  "fmt"

  "github.com/stainless-sdks/lark-go"
  "github.com/stainless-sdks/lark-go/option"
)

func main() {
  client := lark.NewClient(
    option.WithAPIKey("My API Key"),
  )
  response, err := client.Subscriptions.ChangeRateCard(
    context.TODO(),
    "subscription_id",
    lark.SubscriptionChangeRateCardParams{
      RateCardID: "rc_jQK2n0wutCj6bBcAIrL6o07g",
      CheckoutCallbackURLs: lark.CheckoutCallbackParam{
        CancelledURL: "https://example.com/try-again",
        SuccessURL: "https://example.com/completed",
      },
      UpgradeBehavior: lark.SubscriptionChangeRateCardParamsUpgradeBehaviorProrate,
    },
  )
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", response.Result)
}

{
  "result": {
    "action": {
      "checkout_url": "https://checkout.uselark.ai/...",
      "type": "checkout"
    },
    "type": "requires_action"
  }
}

Returns Examples

{
  "result": {
    "action": {
      "checkout_url": "https://checkout.uselark.ai/...",
      "type": "checkout"
    },
    "type": "requires_action"
  }
}