Sign in

v1

latestOpenAPI 3.0.02026-07-2475182625.5 KB
Subscriptions

Convert a subscription

Creates a session that allows a buyer to reactivate a trial subscription and convert it to a paid subscription.

Preconditions:

  • The subscription is a trial without any payment method added.
  • The subscription was deactivated because the trial period ended without a payment method being added.
  • The subscription conversion period is still active.
  • Conversion is enabled for the subscription.
  • The reactivation request is made within the allowed conversion period: Deactivation date + conversion days <= API call date.
post/subscriptions/{subscription_id}/convert

Path parameters

subscription_idstring required
Example:1abc2DE_FGhIjKLm3NoPQR

Unique identifier for the subscription.

Response

OK

idstring

Unique identifier for the reactivation session.

currencystring

The currency used for the subscription.

expiresinteger

Timestamp (in milliseconds) when the session expires.

orderstring nullable

Unique identifier for the order, if any.

accountstring

Unique identifier for the buyer's account.

subtotalnumber float

Subtotal amount for the subscription.

Example response

{
  "id": "1665462758431",
  "currency": "USD",
  "expires": 1665549158235,
  "account": "abCdE1FGH2Hij3KLMnOpqR",
  "subtotal": 14.99,
  "items": [
    {
      "product": "monthly-magazine",
      "quantity": 1
    }
  ]
}