Docs

Activate a trialing subscription in one API call

Use the activate a trialing subscription operation to immediately activate a trialing subscription.

Product area

  • Subscriptions

Tooling

  • API

Released

September 13, 2023

Status

Released

API version

Version 1

What's new?

We added the activate a trialing subscription operation to the Paddle API. You can use it to immediately activate a subscription that's in trial.

POST /subscriptions/{subscription_id}/activate
subscription_id string

Paddle ID of the subscription entity to work with

How it works

Making it as easy as possible for trialing customers to transition to a paid plan is a simple way to reduce your customer acquisition cost.

You can use the new activate a trialing subscription operation to bill for a subscription that's trialing, cutting any remaining trial period short. There's no need to include a date with your request — the subscription is activated immediately.

We recommend providing a way for customers to make changes to their subscription, like adding or removing users or changing their plan, before activating a subscription.

To preview charges and present them to a customer, get a subscription including the next_transaction and recurring_transaction_details objects.

GET /subscriptions/{subscription_id}?include=next_transaction,recurring_transaction_details
subscription_id string

Paddle ID of the subscription entity to work with

include array[string]

Include related entities in the response. Use a comma-separated list to specify multiple entities

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.

You can activate a trialing subscription using the API to get started.

Summary of changes

Entity Field Change Type
Subscriptions POST Activate a trialing subscription + Added API operation

Was this page helpful?