Subscriptions
The Subscriptions API provides a powerful solution for managing recurring billing and subscription-based business models.
Key Features
Flexible Billing Options
- Multiple billing intervals: Daily, weekly, monthly, or yearly billing cycles
- Custom intervals: Configure non-standard periods using intervalCount (e.g., every 3 months)
- Trial periods: Offer free trials before the first billing cycle begins
- Variable amounts: Update subscription amounts for pricing changes or upgrades
Complete Lifecycle Management
- Create subscriptions: Set up recurring billing plans with customizable parameters
- Activate subscriptions: Begin billing cycles with customer payment information
- Pause/Resume: Temporarily halt billing without cancellation
- Update subscriptions: Modify pricing, billing details, or subscription parameters
- Cancel subscriptions: End recurring billing permanently or at period end
Customer-Friendly Features
- Automated recurring payments: No manual action required for subsequent billing
- Consistent billing dates: Predictable billing on the same day of each period
- Payment retry mechanism: Automatic retries for failed payments
- Customer control: Enable customers to manage their own subscriptions
Integration Benefits
- Webhook notifications: Get real-time updates on subscription status changes
- Detailed reporting: Track subscription metrics and performance
- Simplified compliance: Handle recurring billing requirements automatically
- Reduced churn: Automatic billing helps prevent missed payments
📄️ Create Subscription
Creates a new subscription with the specified parameters.
📄️ Get Subscription
Retrieves the complete details of an existing subscription by its unique ID.
📄️ Update Subscription
Updates the configuration of an existing subscription.
📄️ Activate Subscription
Activates a subscription by attaching a payment method and initiating the billing cycle.
📄️ Cancel Subscription
Cancels an active subscription, permanently stopping the billing cycle.
📄️ Pause Subscription
Pauses an active subscription, temporarily halting the billing cycle.
📄️ Resume Subscription
Resumes a previously paused subscription, reactivating the billing cycle.
📄️ Send Subscription Link
Sends a subscription activation link to the customer through their preferred communication channel.
📄️ Send Subscription Status
Sends subscription status information to the customer through their preferred communication channel.