put/svc/payment/api/v1/openapi/recurring_payments/plan/{id}/cancel

Cancel a plan

Cancel all recycling cycles of this recycling plan

Path parameters

idrequired

string

Header parameters

X-Skip-Signature

string

Example: TRUE

Signature

string

Example: good

Credential

string

Example: {{credential}}

x-request-id

string

Example: {{$string.uuid}}

x-i18n-lang

string

Example: zh-CN

Content-typerequired

string

Example: application/json

Request body · application/json

activate_typerequired

enum<string>

Immediate: The cycle to be added will start immediately and all previously-active recurring_cycles.state from the recurring plan will be updated to cancelled. Next Billing Date: The cycle to be added will start on the next billing date of the current recurring cycle. The recurring_cycles.state will be updated to completed, and all the succession recurring_cycles.state of it will be updated to cancelled.

immediatenext_billing_date

refund_creditrequired

boolean

Only applicable for activate_type = immediate. By default, we will refund the current recurring billing's remaining credit back to the customer

Responses

coderequired

integer

datarequired

object

messagerequired

string

Request · cURL

curl -X PUT "https://api.wonder.app/svc/payment/api/v1/openapi/recurring_payments/plan/{id}/cancel" \
  -H "Content-Type: application/json" \
  -H "X-Skip-Signature: <X-Skip-Signature>" \
  -H "Signature: <Signature>" \
  -H "Credential: <Credential>" \
  -H "x-request-id: <x-request-id>" \
  -d '{"activate_type":"immediate","refund_credit":true}'

Request body example

{
  "activate_type": "immediate",
  "refund_credit": true
}

Response 200

{
  "code": 0,
  "data": {},
  "message": "string"
}

PreviousEdit a plan Next Add plan cycles