Skip to main content
POST
/
subscriptions
/
{id}
/
pause
Manage Subscriptions
curl --request POST \
  --url https://api-sandbox.pavewaygroup.com/v1/subscriptions/{id}/pause \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "immediately": true,
  "trigger_after_failures": 123
}
'

Documentation Index

Fetch the complete documentation index at: https://docs.pavewaygroup.com/llms.txt

Use this file to discover all available pages before exploring further.

PaveWay provides endpoints to modify, pause, or cancel active subscriptions.

​
Pause & Resume

Pause billing for a customer without canceling their plan. 
POST /subscriptions/{id}/pause 
POST /subscriptions/{id}/resume

​
Update Payment Method

Switch a customer from Mobile Money to Card, or update their billing phone number. 
PUT /subscriptions/{id}/payment-method

​
Cancel Subscription

POST /subscriptions/{id}/cancel

​
Cancellation Parameters

​
immediately
boolean
default:"false"
If true, billing stops now. If false, the subscription remains active until the end of the current period.

​
Fallback Configuration

Configure a secondary payment method (e.g., a credit card) to be tried automatically if the primary mobile money payment fails after XX attempts. 
PUT /subscriptions/{id}/fallback
​
trigger_after_failures
integer
default:"3"
Number of consecutive failures before falling back to the secondary method.