Add Item to a Subscription for Future Billing

Overview

This guide shows you how to implement Add Subscription Item endpoint to add an item without immediate billing.

No purchase is created for the new item. The subscription is updated with the new item, and in the next billing interval, the new item's price is included in the amount to be billed. You control whether your customer can access the additional item before it is billed.

Use Case

A Cloudify customer pays $6.99 per month for their subscription but has run out of storage space and wants to purchase additional storage. Cloudify offers Cloudify Extra Storage for $3.00 per billing interval.

The extra storage item is added to the customer’s existing subscription without immediate billing. On the customer’s next billing date, the Cleverbridge platform automatically bills $9.99, which includes the price of both the base subscription and the additional storage item.


Before you start

Make sure that:

  • The subscription has the status Active.
  • All items in a subscription must have the same billing interval.
  • Changes made by this function, including the price and/or quantity, apply to all future billing events unless changed subsequently.
🚧

Important

Get the customer's consent for changes to subscriptions. To avoid chargebacks and customer inquiries, it is also essential that you coordinate all price increases with Client Experience.

In the European Economic Area (EEA), Strong Customer Authentication (SCA) is required for recurring electronic payments when the amount changes. This means that some of your customers will have to authenticate their payment, which in turn might impact the renewal success rate.

For more information, see Best Practices: Obtain Customer Consent.

📘

Revisions history

When you add a subscription item, a history of revisions is created automatically.


Parameters

Parameter

Type

Required

Notes

Example

SubscriptionId

str

Yes

The unique identifier of the primary subscription.

S18577447

ProductId

int

Yes

The unique identifier of the product to be added.

97771

Quantity

int

Yes

The quantity of the new subscription item.

1

AlignmentSettings

obj

Yes

See Get Started with Subscription API > Alignment Settings.

{AlignToCurrentInterval: false GetCustomerPricePreviewOnly: false}

CustomerPrice

obj

No

See Understand Customer Price.

"CustomerPrice": { "CurrencyId": "EUR", "IsGross": true, "Value": 9.99 }

Options

Although not utilized in this use case, the following option is also available:

  • Reduce the price of the LSE subscription item by applying a discount coupon that was set up in the Cleverbridge platform.