INFO-Subscription Logo
  • Welcome to the INFO-Subscription Developer Documentation
  • Getting Started with the API
    • Obtaining Client Credentials
    • Obtaining a Tenant Id
      • Using the Tenant Id
    • Endpoint(s)
    • Building Requests
    • Handling Responses
      • Successful Responses
    • Asynchronous Processing
      • Polling for Results
      • Visual Overview
      • Error Conditions
        • Client Errors
        • Server Errors
      • Authentication and Authorization Responses
    • Rate Limiting
  • What is INFO-Subscription
    • What is it not?
      • CRM
      • Delivery, Distribution and Packaging
      • Magic
    • What INFO-Subscription does
      • Subscription Management and Billing
        • Automatic Payments
        • Automated Dunning
  • Terminology and Definitions
  • Conceptual Relationship Model
  • API Authentication and Authorization
    • Minimum Required Details
    • Token Acquisition
    • Using the token
    • Authorisation Flows or Grant Types
    • Reuse the Token
    • Authentication Libaries and SDKs
      • Microsoft Authentication Library - MSAL
      • Auth0 Authentication and Management Libraries
  • API Versioning
    • Versioning Approach
      • Path-Based Versioning
      • Independent Endpoint Versioning
      • API Documentation and OpenAPI Specification
    • Breaking vs Non-Breaking Changes
      • Breaking Changes
      • Non-Breaking Changes
    • Client Expectations for Handling Changes
      • Ignore Unknown Fields
      • Do Not Rely on Field Ordering
      • Handle New Enum Values Gracefully
      • Be Flexible with Response Validation
    • Deprecation and Sunset Policy
      • Deprecation Timeline
      • Deprecation Notice Example
      • Migration Path
      • Monitoring Deprecations
    • Best Practices
  • MCP Server
    • What is the INFO-Subscription MCP?
    • What can you do with it?
    • Prerequisites
    • Getting started — Remote server (preferred)
    • Getting started — Claude Desktop (remote MCP)
    • Getting started — Local tool (optional)
    • Authentication note
  • Integration Guides
    • Common Scenarios
    • Advanced & Conceptual Guides:

Subscribers

  • Subscribers
    • Subscriber Identity (Identifiers)
    • Subscriber Contacts
    • Customizable Subscriber Number

Subscriptions

  • Subscription Lifecycle
    • Overview
    • Key Terminology
    • The Subscription Lifecycle Timeline
    • Detailed Lifecycle Stages
      • 1. Subscription Creation via Order
      • 2. Billing Cycle Initiation
      • 3. Subscription Renewals
      • 4. Active Subscription Management
      • 5. Subscription Cancellation
    • Subscription States and Transitions
    • Integration Points for Developers
      • Webhooks and Events
      • Reporting and Analytics
      • API Endpoints
    • Common Scenarios and Best Practices
      • Tracking a Subscriber’s Full Subscription History
      • Handling Payment Failures
      • Offering Upgrades and Downgrades
      • Preventing Automatic Renewals
  • Plans and Template Plans
    • Permanent Discount
    • Automatic Stop
      • Templates, Choices and Subscription Plans (Instances)
      • Subscription Plan Changes (Upgrades and Downgrades)
    • Immediate Changes
    • Changes On Scheduled Time
    • On Renewal Changes
      • Subscription Plan Chaining (Package Chains)
    • What is Chaining?
    • How It Works
    • API Reference
    • Example of a Subscription Plan Chain
  • Creating New Subscriptions Using Orders
    • Key Benefits of Using Orders
    • Order Workflow Overview
      • Order Anatomy
    • Subscription Plan Choices and Overrides
    • Processing Payments
    • Alternate Invoice Contact/Address
      • Orders and Subscribers
      • Completing an Order
      • Cancelling an Order
    • Automatic Cancellations and Completions
    • Asynchronous Completion of Orders
  • Order Examples
    • Example: Choosing Products On A Plan
    • Example: Overriding Pre-Defined Prices
    • Example: Vipps or MobilePay as Payment Agreement
    • Example: SwedbankPay as Payment Agreement
  • Addons or Additional Products
    • What Are Additional Products?
    • Key Rules and Behaviors
    • API Usage
    • Upgrades and Downgrades with Additional Products
    • Developer Suggestions

Billing and Invoicing

  • Billing Overview
  • Payment Demands and Invoices
  • Billing Cycle Stages & Integration Points
  • In-Advance Billing Model
    • Understanding the Billing Timeline
    • Hybrid Billing: In-Advance + In-Arrears
  • Repeated Payment Request Flow
  • Repeated Reminder Flow
  • Billing and Dunning Timeline
  • Payment Matching, Settlement, and Billing Account Reconciliation
    • Payment Identification Before Billing Settlement
      • Matching Types
      • Matching Policy
    • Payment Matching in Billing
      • Fallback Matching
      • Unmatched Payments
    • Settlement
      • Settlement Policies
      • Settlement Outcomes
      • Reminder Fees and Auto-Crediting
      • Settlement Transactions
    • Billing Account Role
    • Enterprise Plan Behavior
    • Related Documentation
  • Proration Policies for Cancellations
    • Understanding Cancellation Proration
    • Types of Proration Policies
    • Scenario 1: Cancellation in a Paid/Settled Period
      • Visual Timeline: Proration with Financial Adjustment (Paid Period)
      • Visual Timeline: No Proration (Paid Period)
    • Scenario 2: Cancellation in an Invoiced Unpaid Period
      • Visual Timeline: Proration with Financial Adjustment (Invoiced Period)
      • Visual Timeline: No Proration (Invoiced Period)
    • Configuring Proration Policies
      • Steps to Configure
      • Policy Options Reference
    • Business Considerations
    • Integration with Events
    • Related Documentation
  • Transaction (Non-Recurring) Invoices
    • Creating an Account Payment Demand
      • Settling Outstanding Account Balance
  • Creating Reminders On Demand
    • When to Use This
    • How It Differs from Scheduled Reminders
    • Step-by-Step Example: External Debt Collector
    • reminderPolicy — Controlling Payment Consumption
    • counter — Reminder Sequence Number
    • Events

Payments and Agreements

  • Payment Agreements
    • Properties of a Payment Agreement
    • Managing Payment Agreements
      • Switching Agreements Manually
      • Out Of Band Agreements and Automatic Agreement Registration
      • Importing Agreements
  • Payment Providers (PSPs)
    • AvtaleGiro
      • Mandate Registration
        • Manually Registering Mandates
        • Connected/Interactive Mandate Registration
      • Cancelling Mandates
      • Creating Claims
    • eFaktura
      • Consignment or Mandate Registration
      • Combining with AvtaleGiro
      • Cancelling Agreements
    • PEPPOL BIS Billing (EHF/OIO)
      • Supported Countries
      • Payment Provider Types
        • EHF (Norway)
        • OIO (Denmark)
        • OIO (Sweden)
      • Registration Process
        • PEPPOL Network Lookup
        • Registration Workflow
        • Creating a PEPPOL Agreement
      • Invoice and Credit Note Distribution
      • Differences from Consumer eInvoicing
      • See Also
    • Vipps Recurring And MobilePay Recurring
      • Requirements for Vipps Recurring
      • Agreement Registration
        • Handling Terminal/Landing Page Cancellations
      • Profile Sharing
        • How Profile Sharing Works
        • API Integration
        • Primary Subscriber Contact Creation
        • Events
      • In-Shop/Non-Browser Agreement Registration (Merchant Initiated)
      • Payment Type Management
        • Manually Registering Agreements
      • Creating Charges
      • Single Payments
      • Scheduled Captures
      • Automatic Accounting/Settlement
    • Swedbank Pay (Card Payments)
      • Requirements for using Swedbank Pay
      • Agreement Registration
      • Agreement Registration Without Orders
      • Prepared Transactions
        • Manually Registering Agreements
      • Creating Payments
    • Autogiro
    • BetalingsService
      • Mandate Registration
        • Manually Registering Mandates
        • Connected/Interactive Mandate Registration
      • Cancelling Mandates
      • Creating Payments (Transactions)
    • Bring Your Own Payment Provider
      • Overview
      • Integration Steps
      • Example Workflow
      • References

Events and Webhooks

  • Events and Webhooks
    • Enabling Webhook Event Notifications
    • Registering webhooks
      • Webhook Validation Handshake
        • Manual Validation Handshake
      • Direct Event Grid integration
    • Events Schema and Payload
      • Event Data
      • Event Headers
    • Events Philosophy
      • Lightweight Payload
      • Registration for specific events
    • Event Delivery
      • Security/Authentication
    • Available Events
      • Event: com.info-subscription.SubscriberCreated
        • Example Use cases
      • Event: com.info-subscription.SubscriberDeleted
      • Event: com.info-subscription.SubscriberContactCreated
      • Event: com.info-subscription.SubscriberContactUpdated
      • Event: com.info-subscription.SubscriberContactDeleted
      • Event: com.info-subscription.OrderProcessed
        • Example Use Case
      • Event: com.info-subscription.SubscriptionCreated
        • Example Use Case
      • Event: com.info-subscription.SubscriptionDeactivated
        • Example Use Case
      • Event: com.info-subscription.SubscriptionCancelled
        • Example Use Case
      • Event: com.info-subscription.InvoiceIssued
        • Example Use Case
      • Event: com.info-subscription.ReminderIssued
        • Example Use Case
      • Event: com.info-subscription.CreditNoteIssued
      • Event: com.info-subscription.InvoicePaid
      • Event: com.info-subscription.PaymentRequestScheduled
        • Example Use Case
      • Event: com.info-subscription.PaymentRequestProcessed
        • Example Use Case
      • Event: com.info-subscription.UserAuthorizationGranted
        • Example Use Case
      • Event: com.info-subscription.UserAuthorizationRevoked
        • Example Use Case
      • Event: com.info-subscription.EmailDomainAuthorizationGranted
      • Event: com.info-subscription.EmailDomainAuthorizationRevoked

Managed Subscriber Experience (Self-Service)

  • Managed Subcriber Experience
    • Accessing Self-Service/Subscription Management
  • Checkout
    • Journey Types in INFO-Subscription Checkout
      • Available Journey Types
    • Configuration Options
      • 1. Configuration via Query Parameters
      • 2. Configuration and Default via Merchant Options
    • Advanced customisation with the INFO-Subscription Orders SDK
  • Authentication and Authorization Quick Start
    • Example Authorization Code Flow
      • Obtaining the authorization code and id token
      • Verifying and Decoding the token
    • Authorization Alternatives
      • Alternative: API-Based Claims Retrieval
    • Implementing Signout
  • API-Based User Claims Retrieval
    • API Endpoint Overview
    • Authentication Requirements
      • Obtaining Credentials
      • Authentication Header
      • Example
    • Making the API Request
      • Request Format
      • Parameters
      • Response Format
    • Complete Example
    • Use Cases
      • Server-Side Authorization
      • Custom Identity Providers
    • Comparison with Token-Based Flow
    • Security Considerations
    • Related Documentation
  • Microsoft ADB2C
    • Handling Forgotten Password
      • Recommend Workaround
    • Single Sign-On
      • Sign-out details
    • Forced Sign-In
  • Understanding Sessions and Session Management
    • IdP/Login session
      • Persistent or Non-Persistent Sessions (Keep Me Signed In)
    • Application/Local Session
    • User Experience
    • Terminating Sessions/Logout
    • Default INFO-Subscription IdP Session Behaviour
  • Advanced Scenarios
  • Product Authorization In Depth
    • Authorization Building Blocks
    • Identity Providers
    • Users
    • Authorization Sources
      • Subscriber Authorization Source
      • Subscriber Account Authorization Source
      • External Static Authorization Source
    • Accessing Product Authorizations
      • Enriching Tokens During Sign-in
    • Scenario: Site Access
  • Custom Domain Support
    • Consequences of enabling Custom Domains

Reporting and Analytics

  • Introduction
    • General Concepts
      • 1. Near real-time
      • 2. Semi denormalized
      • 3. Pre-Aggregated KPIs
      • 4. Area or Silos of data
    • Connecting
      • Hosted Connections with Power BI
  • Datamodel
    • General Purpose
      • Organizations
      • Products
        • Noteworthy columns
      • Subscribers
        • Noteworthy columns
      • SubscriberContacts
        • Noteworthy columns
      • Tag
      • ReportingGroups
    • Economy and Billing
      • AccountTransaction
      • Invoices
      • PaymentDemands
      • PaymentDemandFees
      • PaymentDemandDetails
        • Noteworthy columns
      • PaymentDemandAllowances
      • PaymentDemandCharges
      • SubscriberLedgers
      • KPI: SubscriberAmounts
    • Orders
      • Orders (and Products)
    • Subscriptions
      • Subscriptions
      • CanceledSubscriptions
      • Contracts
      • EnterprisePlans
      • SubscriptionPackages and SubscriptionPacakgeProducts
        • Noteworthy columns
    • Payments
      • KPI: DailyPaidAmounts
      • Payments
    • Entity Relationship Diagram
  • OData Querying
    • Use Cases for the Analytics OData API
    • What is OData?
    • Exploring the API
    • Basic OData Query Structure
    • Filtering Results
    • Sorting Results
    • Paging Results
    • Selecting Fields
    • Expanding Navigation Properties
    • Discovering Entities and Properties
    • Example: Combined Query
    • Authentication
    • Supported Query Operations
    • Tips
    • References

Misc

  • Testing and Experimentation
    • Test Data and Routines
      • Tenant Information
      • Payment Provider Test Data
  • Client Libraries and SDKs
    • Autogenerate SDKs with tooling
    • Integration Platforms
  • Support and General Inqueries
    • Reporting Bugs
      • Information in Bug Reports
    • Feedback, Comments and Suggestions
  • API Reference/Swagger
  • Contributing to the Documentation
    • Want to contribute but have no idea what to write?

Changelog

  • Release June 16th
    • API and Backend
      • Added
      • Changed
      • Fixed
      • Deprecated
    • Merchant Client
      • Added
      • Changed
      • Fixed
    • Self-Service, Sales Poster and Checkout
      • Added
      • Changed
      • Fixed
  • Release May 13th
    • API and Backend
      • Added
      • Changed
      • Fixed
      • Deprecated
    • Merchant Client
      • Added
      • Changed
      • Fixed
    • Self-Service, Sales Poster and Checkout
      • Added
      • Changed
      • Fixed
  • Release April 27th
    • Checkout
      • Fixed
  • Release March 11th
    • API and Backend
      • Added
      • Changed
      • Fixed
      • Deprecated
      • Known Limitations
    • Merchant Client
      • Added
      • Changed
      • Fixed
    • Self-Service, Sales Poster and Checkout
      • Added
      • Fixed
  • Release February 2nd
    • API and Backend
      • Fixed
    • Merchant Client
      • Fixed
    • Checkout
      • Fixed
  • Release January 28th
    • API and Backend
      • Added
      • Changed
      • Fixed
    • Merchant Client
      • Added
      • Changed
      • Fixed
    • Self-Service, Sales Poster and Checkout
      • Added
      • Changed
      • Fixed
  • Release December 10th
    • API and Backend
      • Added
      • Changed
      • Fixed
    • Merchant Client
      • Added
      • Changed
      • Fixed
    • Self-Service, Sales Poster and Checkout
      • Added
      • Changed
      • Fixed
  • Release November 17th
    • API and Backend
      • Breaking Changes
      • Added
      • Changed
      • Fixed
    • Merchant Client
      • Added
      • Changed
      • Fixed
    • Self-Service, Sales Poster and Checkout
      • Changed
      • Fixed
  • Release October 27th
    • API and Backend
      • Fixed
  • Release September 23rd
    • API and Backend
      • Added
      • Changed
      • Fixed
      • Removed
    • Merchant Client
      • Added
      • Changed
      • Fixed
    • Self-Service, Sales Poster and Checkout
      • Added
      • Changed
      • Fixed
    • Developer Documentation
  • Release August 18th
    • API and Backend
      • Added
      • Changed
      • Fixed
    • Merchant Client
      • Added
      • Changed
      • Fixed
    • Self-Service, Sales Poster and Checkout
      • Added
      • Changed
      • Fixed
  • Release June 17th
    • API and Backend
      • Added
      • Changed
      • Fixed
    • Merchant Client
      • Added
      • Changed
      • Fixed
    • Self-Service, Sales Poster and Checkout
      • Added
      • Changed
  • Release May 8th
    • API and Backend
      • Added
      • Changed
      • Fixed
    • Merchant Client
      • Added
      • Changed
      • Fixed
    • Self-Service, Sales Poster and Checkout
      • Changed
      • Fixed
INFO-Subscription
  • Search