Overview

• SUBSCRIPTION ENTITIES
• RECOMMENDED WORKFLOW

The Subscriptions API allows you to seamlessly implement subscription-based services, offering a secure and convenient payment experience for end-customers.
By leveraging card tokenization, sensitive card data is protected, eliminating the need for customers to re-enter their payment details.
The API is based on the MIT flow, and all calculations and management can be handled via the Praxis API or Atlas UI.

SUBSCRIPTION ENTITIES

The Subscriptions API revolves around two primary entities: Subscription Plan and Subscription.

• Subscription Plan
  Represents the blueprint or template for a recurring payment setup. It defines key parameters such as:

  • Billing cycle
  • Pricing
  • Trial periods
  • Specific features or benefits

  Think of it as the predefined structure that governs how individual subscriptions are created and managed.

• Subscription
  Represents an actual instance of a customer’s enrollment in a Subscription Plan. It includes:

  • Unique identifier
  • payment method (tokenized card)
  • Billing frequency
  • Any customer-specific settings

  Each subscription is treated as an individual entity that can be independently managed or modified.

To begin using the Subscriptions API, you must first tokenize the customer’s card via one of the following methods:

• Initial MIT (Customer-Initiated Transaction)
• Zero-Authorization

This tokenization step ensures secure storage and handling of sensitive card information.
It replaces actual card data with a token — a secure reference used for all subsequent actions (including subscription creation).

Once tokenization is complete, you can proceed with creating a subscription using the tokenized card.
The Subscriptions API allows you to define subscription plan details, such as billing cycle, pricing, and other business-specific parameters.

By separating tokenization from subscription creation, you ensure that customer data remains secure and that all actions comply with industry standards.

RECOMMENDED WORKFLOW

The recommended workflow is as follows:

1. Create a Subscription Plan, defining all necessary configuration details such as billing frequency, trial period, retry policy, etc.

2. Tokenize the customer’s card by using either:

   • Initial MIT (Customer-Initiated Transaction), or
   • Zero-Authorization
     Make sure to include the MIT object in the request.

3. Receive the card token upon successful tokenization.
   You can also retrieve saved tokens by calling the /get-customer-cards API endpoint.

4. Create the customer’s subscription by passing the obtained card token into the Subscriptions API.

By following this workflow, you ensure the secure handling of customer payment information while integrating the Subscriptions API seamlessly into your platform or application.