Skip to main content

Piano

ProsperStack integrates with Piano to import subscriber and subscription data, personalize retention experiences and apply supported subscription changes. This page explains how to connect and integrate Piano and summarizes the features and properties supported by the platform integration.

Connecting Piano​

To connect Piano, select your region and enter your App ID and API token. The API token must have permission to read subscriptions and terms and perform term changes.

Connect Piano

For help with Piano API credentials, see the Piano documentation.

After clicking Connect, the import process will begin automatically.

Mapping subscription properties​

Piano's term structure determines how subscription data is represented in ProsperStack. Before building your cancellation flow, review the properties available for segmentation, confirm how your Piano terms correspond to the plans your customers recognize and identify the properties you want to use for segmentation.

Use term properties instead of individual term IDs for segmentation whenever possible. Publishers often have many legacy terms, and rules based on individual IDs won't continue to match after a subscription changes terms.

Integrating Piano​

To embed the ProsperStack cancellation flow in your Piano account management area, use the ProsperStack JavaScript library.

When opening a session, pass the Piano subscription ID. After a session completes, reload the account management page so the customer sees their updated subscription state.

Feature support reference​

Solutions

Overall support for ProsperStack solutions.

Full Partial None
Cancellation flows
Winback campaigns
Revenue recovery
Conversion incentives
Customer portal
Autopilot offers

Features

Subscription platform dependent capabilities. Features supported on every platform are not listed.

Coupons

  • Coupon offer

Plan changes

  • Plan change offer

Upgrade

  • Upgrade offer
  • Upgrade at end of billing period

Downgrade

  • Downgrade offer

Modify subscription

  • Modify subscription offer

Pause subscription

  • Pause subscription offer

Trial extension

  • Trial extension offer

Product swap

  • Product swap offer

Other offers

  • Payment recovery offer
  • Free gift offer
  • One-time purchase offer
  • Reactivation offer
  • Reschedule order offer

Subscription cancellation

  • Subscription cancellation

Customer portal

  • Customer portal

Properties

Properties available for customer segmentation.

Subscriber18

  • Active offer ID
  • ARR
  • Cancel reason
  • Cancel reason code
  • Days since saved
  • Email address
  • First name
  • Last name
  • LTV
  • MRR
  • Paid invoices
  • Saved date
  • Session date
  • Session domain
  • Session start date
  • Session URL
  • Status
  • Subscription plan IDs

Subscription26

  • Active coupon ID
  • App store
  • ARR
  • Cancel reason
  • Cancel reason code
  • Deferred cancelable
  • Discount fixed amount
  • Duration (days)
  • Is auto renew
  • Is free trial
  • Is past due
  • LTV
  • MRR
  • Next billing date
  • Paid invoices
  • Paper code
  • Plan phase
  • Plan prices
  • Service type
  • Session date
  • Session domain
  • Session start date
  • Session URL
  • Status
  • Subscription plan IDs
  • Will renew

Products2

  • Product IDs
  • Product names

Plans5

  • Plan IDs
  • Plan interval counts
  • Plan intervals
  • Plan names
  • Plan quantities