Customer — Toggle Status
Activates or deactivates a customer's token. Toggling to inactive stops all future recurring charges and prevents new tokenized charges.
When to Use
▾
Use this endpoint when:
- Customer requests to pause or cancel their subscription
- Suspending a customer due to chargeback or compliance reasons
- Re-activating a previously paused customer
Only available after the customer has successfully bound their card.
How to Use
▾
/v3/recurring-payment/{customer_id}/toggleStep 1: Identify the Customer
▾
Use the customer_id returned by Create Tokenized Customer or Create Recurring Customer.
Step 2: Send the Toggle Request
▾
POST /v3/recurring-payment/{customer_id}/toggle. The endpoint inverts the current isActive state.
Step 3: Verify the New State
▾
The response item.isActive reflects the new status.
Request Parameters
▾
Customer ID returned from Create Recurring Customer or Create Tokenized Customer
Response Parameters
▾
Response item
Customer ID
Merchant ID
Store ID
Customer card: front six and last four digits
Customer email
Customer country code
Customer phone number
Product name
Product description
Whether the token is active after toggle
Created date time
Last updated date time
Internal usage only
Redirect URL
Notify URL
Card binding URL
recurringPayment details
Recurring payment amount
Recurring payment currency
Recurring interval
Recurring target rules
Number of repetitions
"SUCCESS" if the request succeeded, otherwise an error code.
Error details
Error code if the request failed.
Error message if the request failed.
Debug message (sandbox only).