We’ve migrated our documentation to a new site, which means some URLs have changed.
Subscriptions
Subscriptions
Breadcrumbs

Conversion Types

  • "Unknown" — Unknown type. Returned when the underlying value is unrecognized. Fallback.

  • "Payment" — One-off purchase. User paid once for a non-recurring term.

  • "Subscription" — New paid recurring subscription on a Payment term. The first conversion of the billing relationship.

  • "Renewal" — Recurring billing cycle on an existing Payment-term subscription. Dynamic terms use Dynamic subscription internal renewal / Dynamic subscription external renewal.

  • "Grant access" — Manual access grant by an operator. No payment, no subscription.

  • "Gift received" — Recipient side of a gift. The user redeemed a gift the giver paid for.

  • "Gift purchased" — Giver side of a gift. Records the purchase; access goes to the recipient.

  • "Registration" — Access tied to signing up. Granted by a RegistrationTerm at user creation.

  • "Adview" — Ad-supported access. User watched/acknowledged an ad in exchange for entry.

  • "Custom" — Custom-term access. Operator-defined entitlement evaluated by custom rules.

  • "External" — Access recorded against an ExternalVerificationTerm — the entitlement is owned and verified outside Piano (e.g., a publisher's own subscriber system). Piano mirrors the external entitlement; no payment of its own.

  • "Free promo redemption" — Promo-code redemption at zero cost. Payment-term shape, but no charge.

  • "External renewal" — Renewal reported by an external system for an externally-verified entitlement (the ongoing-access counterpart of External).

  • "Provisional" — Temporary access placeholder granted while an async payment is still being confirmed.

  • "Free renewal" — Zero-cost renewal of a subscription (e.g. a free cycle granted by the publisher).

  • "Bill" — Billing-record placeholder. Tracks an invoice/bill event without granting payment-style access.

  • "Upgrade term" — Term change whose target is a Payment term. Source can be Payment or Dynamic — only the destination matters. Dynamic targets use Upgrade to dynamic term.

  • "Term conversion to wait Instant Payment Notification" — Pending state while waiting for an Instant Payment Notification webhook.

  • "Licensee contract redemption" — B2B licensing: an end-user redeems access under a corporate licensee contract.

  • "Licensee contract renewal" — B2B licensing: renewal of a licensee-contract entitlement.

  • "Shared subscription child grand access" — Group/family-plan member access derived from a parent shared subscription.

  • "Shared subscription child renew" — Renewal of a shared-subscription child member's access.

  • "Upgrade term with grace period" — Marks the start of a grace window opened when an upgrade-to-Payment-term payment fails to settle synchronously; user keeps access while the upgrade is retried/resolved. Dynamic targets use Upgrade to dynamic term with grace period.

  • "Dynamic term purchase" — New first-time purchase on a Dynamic term.

  • "Dynamic subscription internal renewal" — Renewal of a Dynamic subscription where the next billing date still falls within the current dynamic-plan period sequence (transition between periods of the same plan instance).

  • "Dynamic subscription external renewal" — Renewal of a Dynamic subscription where the dynamic plan's defined periods are exhausted; the renewal extends past the plan and starts a new iteration.

  • "Link" — Access derived from a LinkedTerm — entitlement linked to another subscription/source.

  • "Upgrade to dynamic term" — Term change whose target is a Dynamic term. Source can be Payment or Dynamic — only the destination matters.

  • "Upgrade to dynamic term with grace period" — Marks the start of a grace window opened when an upgrade-to-Dynamic payment fails to settle synchronously; user keeps access on the new Dynamic term while the upgrade is retried/resolved.

  • "Payment subscription renewal with grace period" — Marks the start of a grace window opened when a Payment-term renewal fails to settle; user keeps access while the renewal is retried/resolved. Dynamic terms use the Dynamic subscription * renewal with grace period variants.

  • "Dynamic subscription internal renewal with grace period" — Marks the start of a grace window opened when a Dynamic-subscription internal renewal (next billing date inside the current dynamic plan's periods) fails to settle.

  • "Dynamic subscription external renewal with grace period" — Marks the start of a grace window opened when a Dynamic-subscription external renewal (next billing date past the current plan's periods) fails to settle.

  • "The dynamic subscription has been created as the result of the import" — Dynamic subscription created by import; no original payment history.

  • "Subscription deferred start" — New Payment-term subscription with a future start date. Dynamic terms use Dynamic term deferred purchase.

  • "Dynamic term deferred purchase" — New Dynamic-term purchase with a future start date.

  • "Deferred payment subscription activation" — Piano Subscriptions event when a deferred Payment-term subscription finally starts. No payment at this step.

  • "Deferred dynamic subscription activation" — Piano Subscriptions event when a deferred Dynamic subscription finally starts. No payment at this step.

  • "Initiated renew with async payment method from external system" — Renewal initiated via an async payment method from an external system; awaits confirmation before becoming a real renewal.

Last updated: