Sign in

v1

latestOpenAPI 3.0.32026-07-248079274.0 KB
Subscriptions

Update payment failure configuration

Updates the subscription's automated payment recovery enrolment by changing its recovery_strategy. Send none to unenrol. The auto-cancellation threshold (incomplete_bills_before_cancellation) can only be set when the subscription is created and cannot be changed here.

patch/subscriptions/{subscription_id}/payment_failure_configuration

Path parameters

subscription_idstring required
Example:01HNY4G8G5ZMAXQB8T0Z1Y1ZMW

Unique identifier for the subscription.

Request body

recovery_strategystring nullable

The name of the recovery strategy to enrol the subscription in for automated payment recovery. Send none to unenrol. Omit the field, or send null, to leave the current strategy unchanged. Valid strategy names are provided to you as part of onboarding.

Example request

{
  "recovery_strategy": "example_strategy"
}

Response

Payment Failure Configuration Updated

recovery_strategystring required

The name of the recovery strategy the subscription is enrolled in. Returns none when the subscription is not enrolled in automated payment recovery.

Example response

{
  "recovery_strategy": "example_strategy",
  "links": [
    {
      "rel": "subscription",
      "href": "/v1/subscriptions/01HNY4G8G5ZMAXQB8T0Z1Y1ZMW",
      "method": "GET"
    }
  ]
}