Subscriptions

Pause Subscription

Changed on

Pauses a user's active web checkout subscription. The subscription will automatically resume after the pause duration expires.

post/iap/subscriptions/pause

Request

  • Base URL
    https://api.zerosettle.io/v1
  • URL
    https://api.zerosettle.io/v1/iap/subscriptions/pause
  • Auth
    API key in header X-ZeroSettle-Key

Request body

user_idstring required

The user's external ID.

product_idstring

Specific product to pause. If omitted, pauses the user's active subscription.

pause_duration_daysinteger

Number of days to pause the subscription. If omitted, uses the default configured in the cancel flow.

Response

Subscription paused

statusstring

Result status.

paused_atstring date-time

When the subscription was paused.

resumes_atstring date-time

When the subscription will automatically resume.

Changes