Edit Auto-Renew API
Toggle subscription auto-renewal settings for automatic billing cycle continuation
Edit Auto-Renew API
Control subscription auto-renewal settings. Enable or disable automatic renewal to manage billing cycles and ensure uninterrupted service.
Auto-Renewal
Automatically renew subscriptions at cycle end.
Easy Toggle
Simple on/off control for auto-renewal.
Billing Control
Manage when and how billing occurs.
Endpoint Overview
/graphqlToggle the auto-renewal setting for a user's subscription. When enabled, the subscription will automatically renew at the end of the current billing cycle.
Request Parameters
isActiveBoolean!RequiredSet to true to enable auto-renewal, false to disable it.
GraphQL Mutation
mutation editAutoRenew($isActive: Boolean!) {
editAutoRenew(isActive: $isActive)
}Enable Auto-Renewal:
{
"isActive": true
}Disable Auto-Renewal:
{
"isActive": false
}HTTP Request:
curl -X POST https://api.orbnet.com/graphql \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
-d '{
"query": "mutation editAutoRenew($isActive: Boolean!) { editAutoRenew(isActive: $isActive) }",
"variables": {
"isActive": true
}
}'Response
{
"data": {
"editAutoRenew": true
}
}{
"errors": [
{
"message": "No active subscription found",
"path": ["editAutoRenew"],
"extensions": {
"code": "NO_SUBSCRIPTION"
}
}
],
"data": null
}{
"errors": [
{
"message": "A valid payment method is required for auto-renewal",
"path": ["editAutoRenew"],
"extensions": {
"code": "PAYMENT_METHOD_REQUIRED"
}
}
],
"data": null
}Auto-Renewal Behavior
When Enabled
Subscription renews automatically before expiration using saved payment method.
When Disabled
Subscription expires at end of billing cycle. User must manually renew.
Failed Payments
System retries failed payments. User notified if issues persist.
Grace Period
Brief grace period may apply after failed renewal attempts.
Best Practices
Verify Payment Method
Ensure valid payment method exists before enabling auto-renewal.
Notify Users
Inform users of auto-renewal status changes via email.
Check Before Expiry
Send reminders before subscription expires if auto-renew is off.
Handle Failures
Implement retry logic and user notifications for failed renewals.
Related Endpoints
Billing Cycle
Auto-renewal occurs at the end of the current billing cycle. Users are typically charged 1-3 days before expiration to ensure uninterrupted service.
View Subscription Details
Check your current subscription status and expiration date to understand when auto-renewal will occur.