Unsubscribe subscriber

Stops billing one customer on a subscription. The subscriber's status becomes Unsubscribed and no further charges are made to their card. Other subscribers are not affected.

Get the subscriber ID (MPB-SUBSCRIBER-...) from Fetch subscribers.

If the subscriber is not active, the call returns 422 with ALREADY_UNSUBSCRIBED. If the subscription or subscriber doesn't exist, it returns 404.

To end the subscription for every customer, use Cancel subscription instead.

Recipes
🔁
Bill a customer every month
Open Recipe
Path Params
string
required
Defaults to MPB-SUB-2B3C4D5E6F

Subscription ID

string
required
Defaults to MPB-SUBSCRIBER-2B3C4D5E6F

Subscriber ID

Headers
string

A unique key, such as a UUID, that makes it safe to retry this request. Reuse the same key when you retry. See Idempotency.

Responses

429

Too many requests. You sent more than 100 requests in 30 seconds from one IP address. This response has no JSON body. See Rate limits.

500

Unexpected error

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json