Update dunning plan

put

https://api.frisbii.com/v1/dunning_plan/{handle}

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

handle

string

required

Dunning plan handle

Body Params

name

string

required

length ≥ 1

Dunning plan name

schedule

array of int32s

required

The schedule as list of intervals in days

schedule*

default_plan

boolean

required

If this is default plan

final_subscription_action

string

enum

required

Action to take for subscription if dunning fails, one of the following: expire, on_hold, none

Allowed:

grace_period

string

Optional grace period before starting dunning process. Also see no_grace_hard_decline. If eligible re-trying will be attempted in the grace period. The period is defined as an ISO-8601 duration. See https://en.wikipedia.org/wiki/ISO_8601#Durations

no_grace_hard_decline

boolean

If a grace period has been defined, this parameter can be used to control whether the grace period is only for soft failing invoices. That is, the used payment method is actually eligible for retrying. Default is true.

Responses

Language

Credentials

Basic

base64

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successful operation

400Invalid request, see error codes at https://api.frisbii.com/v1/error_codes

401None or invalid credentials provided in access to secured resource

403Not authorized to perform resource operation

404Resource or referenced resource not found, see error codes at https://api.frisbii.com/v1/error_codes

429Request limiting exceeded, request rate or concurrent requests, see error code 122 and 123

500Internal service error, error is reported automatically to Frisbii