Create a dunning rule set

POST 
/subscriptions/dunning-rules

Create a dunning rule set

Request

application/json

Body

data DunningRuleCreaterequired

type SubscriptionDunningRuleType (string)required

Possible values: [subscription_dunning_rule]

attributes DunningRuleAttributesrequired

payment_retry_type stringrequired

Possible values: [fixed, backoff, tiered]

The strategy used to make payments.

• fixed: payments are retried on a fixed schedule as defined by the payment_retry_unit and payment_retry_interval, eg every two days
• backoff: payments are retried with an increasing delay between each attempt. The initial delay is specified as per the fixed type and the payment_retry_multiplier is applied to increase the delay for each subsequent payment, eg after a day and then two days and then four days etc (currently unsupported)
• tiered: payments are retried with customised delays between each attempt (currently unsupported)

payment_retry_interval int64

Possible values: >= 1 and <= 1024

the number of payment_interval_units to wait between each payment attempt (or for the initial repayment attempt for backoff)

payment_retry_unit string

Possible values: [day, week]

the time units to use for the delays between payments

payment_retry_multiplier double

Possible values: >= 1 and <= 1024

the multiplier than increases the delay between each payment attempt. Must only be set for backup types. For example, if the initial delay was 2 days and the multiplier was 1.5 then a second repayment attempt would happen 3 days after the first.

payment_retries_limit int64required

the number of payment retries that will occur before the action is taken

action stringrequired

Possible values: [none, pause, close, suspend]

the action taken after all payment attempts for an invoice has failed

default boolean

if set to true then this rule will be the default for the store

Responses

201

Success. The dunning rule set is created.

application/json

Schema

Schema

data DunningRule

id UUID (string)

The unique identifier.

type SubscriptionDunningRuleType (string)required

Possible values: [subscription_dunning_rule]

attributes DunningRuleAttributesrequired

payment_retry_type stringrequired

Possible values: [fixed, backoff, tiered]

The strategy used to make payments.

• fixed: payments are retried on a fixed schedule as defined by the payment_retry_unit and payment_retry_interval, eg every two days
• backoff: payments are retried with an increasing delay between each attempt. The initial delay is specified as per the fixed type and the payment_retry_multiplier is applied to increase the delay for each subsequent payment, eg after a day and then two days and then four days etc (currently unsupported)
• tiered: payments are retried with customised delays between each attempt (currently unsupported)

payment_retry_interval int64

Possible values: >= 1 and <= 1024

the number of payment_interval_units to wait between each payment attempt (or for the initial repayment attempt for backoff)

payment_retry_unit string

Possible values: [day, week]

the time units to use for the delays between payments

payment_retry_multiplier double

Possible values: >= 1 and <= 1024

the multiplier than increases the delay between each payment attempt. Must only be set for backup types. For example, if the initial delay was 2 days and the multiplier was 1.5 then a second repayment attempt would happen 3 days after the first.

payment_retries_limit int64required

the number of payment retries that will occur before the action is taken

action stringrequired

Possible values: [none, pause, close, suspend]

the action taken after all payment attempts for an invoice has failed

default boolean

if set to true then this rule will be the default for the store

meta DunningRuleMetarequired

owner stringrequired

The owner of a resource, either store or organization.

timestamps Timestampsrequired

updated_at stringrequired

The date and time a resource was updated.

created_at stringrequired

The date and time a resource was created.

Example (from schema)

{
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "type": "subscription_dunning_rule",
    "attributes": {
      "payment_retry_type": "fixed",
      "payment_retry_unit": "day",
      "payment_retry_interval": 1,
      "payment_retries_limit": 10,
      "action": "none"
    },
    "meta": {
      "owner": "store",
      "timestamps": {
        "updated_at": "2017-01-10T11:41:19.244842Z",
        "created_at": "2017-01-10T11:41:19.244842Z"
      }
    }
  }
}

400

Bad request. The request failed validation.

application/json

Schema

Schema

errors Error[]required
Array [
status stringrequired
The HTTP response code of the error.
title stringrequired
A brief summary of the error.
detail string
Optional additional detail about the error.
meta object
Additional supporting meta data for the error.
]

Example (from schema)

{
  "errors": [
    {
      "status": 500,
      "title": "Internal server error",
      "detail": "An internal error has occurred.",
      "meta": {
        "missing_ids": [
          "e7d50bd5-1833-43c0-9848-f9d325b08be8"
        ]
      }
    }
  ]
}

missing-name

{
  "errors": [
    {
      "title": "Validation Error",
      "status": "400",
      "detail": "data.attributes.name: \"name\" is required"
    }
  ]
}

500

Internal server error. There was a system failure in the platform.

application/json

Schema

Schema

errors Error[]required
Array [
status stringrequired
The HTTP response code of the error.
title stringrequired
A brief summary of the error.
detail string
Optional additional detail about the error.
meta object
Additional supporting meta data for the error.
]

Example (from schema)

{
  "errors": [
    {
      "status": 500,
      "title": "Internal server error",
      "detail": "An internal error has occurred.",
      "meta": {
        "missing_ids": [
          "e7d50bd5-1833-43c0-9848-f9d325b08be8"
        ]
      }
    }
  ]
}

internal-server-error

{
  "errors": [
    {
      "title": "Internal Server Error",
      "status": "500"
    }
  ]
}

Loading...