Guides and Examples
...
Subscriptions
Subscriptions Overview
19 min
in the nue self service api, subscriptions represent ongoing contractual relationships between customers and your business subscriptions are created from activated orders and manage the entire lifecycle of recurring services, from initial provisioning through renewals, modifications, and eventual termination what are subscriptions? subscriptions are long term service agreements that define service delivery terms (what the customer receives) billing cycles and amounts (when and how much they pay) usage limits and entitlements (what they can access) contract duration and renewal terms (how long the agreement lasts) modification policies (how changes can be made) core subscription concepts subscription lifecycle subscriptions progress through several key phases creation generated automatically when orders are activated active service ongoing delivery of products and services modifications changes to quantity, terms, or products via change orders renewals extension of service terms and commitments termination end of service delivery (cancellation or expiration) subscription types the nue platform supports various subscription models standard subscriptions fixed term commitments with regular billing evergreen subscriptions month to month services without fixed end dates trial subscriptions time limited evaluation periods bundle subscriptions complex packages with multiple components key subscription components service definition each subscription includes product details what services are being provided quantity information how many units/licenses/seats pricing structure rate cards, volume discounts, promotional pricing billing configuration subscriptions define billing parameters billing frequency monthly, quarterly, annual cycles payment terms when payments are due tax calculations location based tax requirements contract terms legal and business terms include service start and end dates contract duration auto renewal settings automatic extension policies subscription data views current contract view the default subscription view shows complete subscription timeline with all historical and future changes current service levels and entitlements upcoming modifications scheduled for future dates full billing history and projected charges use cases customer service inquiries complete subscription management renewal planning and negotiations full contract analysis snapshot view point in time subscription views show subscription state as of a specific date what services were active at that time billing amounts and terms that were in effect changes that occurred around that period use cases live customer display of current subscription state billing dispute resolution compliance and regulatory reporting impact analysis of changes common subscription operations retrieval operations fetch customer subscriptions get all subscriptions for specific customers get subscription details retrieve complete information for individual subscriptions generate snapshots create point in time views for historical analysis include related data fetch products, pricing, and change history management operations update subscription settings modify auto renewal and custom fields create change orders request modifications to existing subscriptions generate pricing data support client side pricing engines for real time quotes monitor status changes track subscription health and lifecycle events integration patterns customer self service subscriptions power customer portal experiences subscription dashboards overview of all customer services usage monitoring track consumption against entitlements modification requests self service upgrade/downgrade capabilities billing history access to invoices and payment records business operations subscriptions support internal business processes revenue recognition financial reporting and accounting customer success monitoring subscription health and usage sales operations renewal forecasting and expansion opportunities support operations service delivery and issue resolution external system integration subscriptions synchronize with crm systems customer relationship management (salesforce) billing platforms invoice generation and payment processing service delivery provisioning and entitlement systems analytics platforms business intelligence and reporting getting started with subscriptions to effectively work with subscriptions in your application understand subscription types and lifecycle stages learn retrieval patterns for current and historical data implement subscription management operations design customer experiences around subscription data integrate with business systems for operational efficiency next steps explore the subscription implementation guides getting started with subscription management learn core retrieval and management operations subscription data reference complete field documentation and data structures advanced subscription workflows complex scenarios and integration patterns key considerations for subscriptions best practices and strategic guidance each guide builds upon the previous one, providing comprehensive coverage of subscription capabilities in the nue self service api