Subscription Contracts
Update next billing date for a subscription contract
Reschedules the next billing date for an active subscription contract. This endpoint allows you to change when the next order will be created and processed.
Key Features:
- Updates the next billing date to the specified date
- Optionally reschedules all future orders based on the new date
- Syncs the updated date to Shopify
- Sends confirmation email to customer
The rescheduleFutureOrder Parameter:
- true (default): Updates the next billing date AND recalculates all future queued orders based on the new date. Use this to shift the entire billing schedule.
- false: Only updates the next billing date. Other queued orders remain unchanged. Use this for one-time date adjustments.
Important Notes:
- The new date must be in the future (with 10 minute grace period)
- Date is validated against the shop’s timezone
- If anchor days are configured, future orders may align to those anchors
Process Flow:
- Validates the contract exists and belongs to the shop
- Validates the new date is not in the past
- Updates the billing attempt to the new date
- Syncs the updated nextBillingDate to Shopify
- If rescheduleFutureOrder=true, regenerates the queue from the new date
- Sends confirmation email to customer
- Records activity log entry
Date Format:
- Must be ISO 8601 format with timezone
- Examples:
2024-03-15T12:00:00Z,2024-03-15T12:00:00+05:30 - URL encode the date when passing as query parameter
Timezone Handling:
- The provided date is used as-is for the billing attempt
- Validation (past date check) uses the shop’s configured timezone
- All dates in the response are in UTC (Z suffix)
Date Restrictions (Customer Portal Only): When called from customer portal context:
- Minimum days from today (skipDaysFromCurrentDate setting)
- Maximum days from today (billingDateRestrictToDays setting)
- External API calls bypass these restrictions
Authentication: Requires valid X-API-Key header
PUT
Update next billing date for a subscription contract
Query Parameters
Response
Billing date successfully updated. The response contains the updated subscription contract from Shopify with the new nextBillingDate.
Available options:
SUCCEEDED, FAILED, $UNKNOWN Available options:
ACTIVE, PAUSED, CANCELLED, EXPIRED, FAILED, $UNKNOWN