Skip to main content

OpenPay

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

Connecting OpenPay​

To connect OpenPay, you'll need to know your endpoint and API key.

Connect OpenPay

Endpoint - Your OpenPay API endpoint. In most cases you won't need to change this.

API token — To create an OpenPay API token, see the OpenPay documentation.

After clicking Connect, the import process will begin automatically.

Integrating OpenPay​

To embed the ProsperStack cancellation flow in your application or website, use the ProsperStack JavaScript library.

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
  • Create new coupon
  • Percentage-based coupon
  • Fixed amount coupon
  • One-time coupon
  • Indefinite coupon
  • Monthly duration coupon
  • Billing cycle coupon
  • Custom duration coupon
  • Use existing coupon
  • Apply coupon to customer
  • Replace existing coupon
  • End trial (conversion)

Plan changes

  • Plan change offer
  • Change billing frequency
  • Disable proration on immediate changes
  • Change plan at end of billing period
  • Apply coupon with plan change
  • Remove add-ons with plan change
  • Reset billing date with plan change

Upgrade

  • Upgrade offer

Downgrade

  • Downgrade offer

Modify subscription

  • Modify subscription offer
  • Modify add-on quantity
  • Modify subscription at end of billing period
  • Apply coupon with subscription modification
  • Disable proration on immediate modifications

Pause subscription

  • Pause subscription offer
  • Specify pause length
  • Pause for a period of time
  • Pause for a number of billing cycles
  • Pause indefinitely
  • Pause at end of billing period
  • Reset billing date after pause
  • Specify pause end date

Trial extension

  • Trial extension offer
  • Extend subscriptions without an active trial
  • Prorate trial extensions

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
  • Cancel at end of billing period
  • Cancel unpaid invoices

Customer portal

  • Customer portal

Properties

Properties available for customer segmentation.

Subscriber22

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

Subscription25

  • Active coupon ID
  • ARR
  • Cancel reason
  • Cancel reason code
  • Discount fixed amount
  • Discount percentage
  • Duration (days)
  • Is free trial
  • Is past due
  • LTV
  • MRR
  • Next billing date
  • Next invoice amount due
  • Next invoice subtotal
  • Paid invoices
  • Session date
  • Session domain
  • Session start date
  • Session URL
  • Shipping location
  • Status
  • Trial days
  • Trial end date
  • Trial start date
  • Will renew

Products2

  • Product IDs
  • Product names

Plans5

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