Subscription management links now return customer portal links
Subscription management links to update payment details and cancel subscriptions now return customer portal links.
What's new?
We've updated the Paddle API so that management links against subscriptions return customer portal URLs.
How it works
When working with subscriptions using the API, management_urls
returns links that customers can use to update their payment method and cancel their subscription.
Previously, links started with sandbox-buyer-portal.paddle.com
or buyer-portal.paddle.com
, for example:
1234561{
2 "management_urls": {
3 "update_payment_method": "https://buyer-portal.paddle.com/subscriptions/sub_01hv8y5ehszzq0yv20ttx3166y/update-payment-method",
4 "cancel": "https://buyer-portal.paddle.com/subscriptions/sub_01hv8y5ehszzq0yv20ttx3166y/cancel"
5 }
6}
When we released customer portal last year, we started redirecting these links to the customer portal. The links themselves remained the same.
Now, we've replaced the links with direct links to the customer portal, starting sandbox-customer-portal.paddle.com
or customer-portal.paddle.com
, for example:
1234561{
2 "management_urls": {
3 "update_payment_method": "https://customer-portal.paddle.com/cpl_01j7zbyqs3vah3aafp4jf62qaw?action=update_subscription_payment_method&subscription_id=sub_01hv8y5ehszzq0yv20ttx3166y",
4 "cancel": "https://customer-portal.paddle.com/cpl_01j7zbyqs3vah3aafp4jf62qaw?action=cancel_subscription&subscription_id=sub_01hv8y5ehszzq0yv20ttx3166y"
5 }
6}
The behavior of the links hasn't changed. You can still return these links to customers to let them update their payment method and cancel their subscription.
Summary of changes to fields
This is a summary of the changes to responses in the Paddle API:
Entity | Field | Change | Notes |
---|---|---|---|
Subscription | management_urls . | Behavior change | Keys now return direct links to the customer portal. |
Next steps
This change is available in version 1
of the Paddle API.
It's a non-breaking change, meaning it doesn't impact existing integrations. Links have changed to sandbox-customer-portal.paddle.com
or customer-portal.paddle.com
, but the behavior of the links remains the same.