Skip to main content
POST
Bulk cancel subscriptions

Authorizations

Authorization
string
header
required

Bearer token authentication

Body

application/json
tokens
(string | number | integer | null)[] | null
Minimum array length: 1
reason_code
enum<string> | null

One cancellation reason code recorded on every cancelled subscription. A company admin or a back-office caller (a droplet or machine token) may send any code. Any other caller, including a customer or rep token, may send only the customer codes (too_expensive, too_much_product, too_frequent, not_seeing_results, did_not_like_product, switching_brand, shipping_or_delivery_issue, taking_a_break, moving_or_life_change, other). Omitted or null records merchant_initiated for a company admin or back-office caller and unknown otherwise. A code the caller may not send returns 422 and cancels nothing.

Available options:
too_expensive,
too_much_product,
too_frequent,
not_seeing_results,
did_not_like_product,
switching_brand,
shipping_or_delivery_issue,
taking_a_break,
moving_or_life_change,
other,
merchant_initiated,
support_request,
max_cycles_reached,
dunning_exhausted,
customer_deleted,
fraud,
unknown,
null
Example:

"merchant_initiated"

reason_text
string | null

Free text, allowed only with reason_code other.

Maximum string length: 500
Example:

null

Response

object | null

Success

success_tokens
(string | number | integer | null)[] | null
failed_tokens
(object | null)[] | null
meta
object | null