Subscriptions

Cancel Subscription

Changed on

Cancels a user's active web checkout subscription. By default, access continues until the end of the current billing period (immediate: false). Set immediate: true to revoke access immediately.

post/iap/subscriptions/cancel

Request

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

Request body

user_idstring required

The user's external ID.

product_idstring

Specific product to cancel. If omitted, cancels the user's active subscription.

immediateboolean

If true, cancels immediately and revokes access. If false, cancels at end of billing period.

Response

Subscription cancelled

statusstring

Result status.

cancelled_atstring date-time

When the cancellation was processed.

access_untilstring date-time

When the user will lose access (end of billing period for non-immediate cancellations).

Changes