Update dunning rule policy

PUT 
/subscriptions/dunning-rules/:dunning_rule_uuid

Specify whichever attributes you want to change. The values of the other attributes remain the same. If the attributes section is empty, the rule is not updated.

Request

Path Parameters

dunning_rule_uuid UUIDrequired

The unique identifier of a dunning rule set.

application/json

Body

data DunningRuleUpdaterequired

id UUID (string)required

The unique identifier.

type SubscriptionDunningRuleType (string)required

Possible values: [subscription_dunning_rule]

attributes DunningRuleUpdateAttributesrequired

payment_retry_type string

Possible values: [fixed, backoff, tiered]

The strategy used to make payments. Always fixed. This means payments are retried on a fixed schedule as defined by the payment_retry_unit and payment_retry_interval, for example, every two days.

payment_retry_interval int64nullable

Possible values: >= 1 and <= 1024

The number of payment_interval_units to wait between each payment retry attempt.

payment_retry_unit stringnullable

Possible values: [day, week]

The unit of time used to measure the intervals between payment attempts or retries.

payment_retry_multiplier doublenullable

Possible values: >= 1 and <= 1024

The multiplier that increases the interval between consecutive each payment attempts or retries. This is typically used to gradually extend the time between retries. Allowing more time between attempts as failures persist, helps reduce the risk of triggering multiple failures in a short period and gives the subscriber more time to resolve the issue. Must only be set for backup types.

payment_retries_limit int64

The number of times Subscriptions attempts payment retries before action is taken.

action string

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

The action to take after all payment attempts for an invoice have failed.

default boolean

Set to true if you want this rule to be the default for the store.

Responses

200

Success. The dunning rule set has been updated.

application/json

Schema

Schema

data DunningRule

id UUID (string)

The unique identifier.

type SubscriptionDunningRuleType (string)required

Possible values: [subscription_dunning_rule]

attributes DunningRuleAttributesrequired

The dunning rule attributes you can use to configure your payment retry strategy.

payment_retry_type stringrequired

Possible values: [fixed, backoff, tiered]

The strategy used to make payments. Always fixed. This means payments are retried on a fixed schedule as defined by the payment_retry_unit and payment_retry_interval, for example, every two days.

payment_retry_interval int64

Possible values: >= 1 and <= 1024

The number of payment_interval_units to wait between each payment retry attempt.

payment_retry_unit string

Possible values: [day, week]

The unit of time used to measure the intervals between payment attempts or retries.

payment_retry_multiplier double

Possible values: >= 1 and <= 1024

The multiplier that increases the interval between consecutive each payment attempts or retries. This is typically used to gradually extend the time between retries. Allowing more time between attempts as failures persist, helps reduce the risk of triggering multiple failures in a short period and gives the subscriber more time to resolve the issue. Must only be set for backup types.

payment_retries_limit int64required

The number of times Subscriptions attempts payment retries before action is taken.

action stringrequired

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

The action to take after all payment attempts for an invoice have failed.

• None - the subscription remains active and Subscriptions does not attempt to retry the payment. However, the subscription is still available for a subscriber to use.
• Suspend the subscription. Subscriptions does not attempt to retry the payment. A subscriber can choose to pay the outstanding invoice. However, a subscriber cannot renew their subscription; a merchandizer must renew the subscription on behalf of the subscriber.
• close a subscription. The subscription ends and it's status becomes inactive. However, a merchandizer can choose to resume the subscription if a subscriber pays the outstanding payment.

default boolean

Set to true if you want this rule to 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"
    }
  ]
}

403

Forbidden. The operation is forbidden on this entity.

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"
        ]
      }
    }
  ]
}

not-found

{
  "errors": [
    {
      "title": "Permission denied",
      "status": "404",
      "detail": "Permission denied: plan tenancy mismatch"
    }
  ]
}

404

Not found. The requested entity does not exist.

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"
        ]
      }
    }
  ]
}

not-found

{
  "errors": [
    {
      "title": "Not Found",
      "status": "404",
      "detail": "No plan found"
    }
  ]
}

409

Write conflict. Unable to perform the operation at this time.

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"
        ]
      }
    }
  ]
}

Example

{
  "errors": [
    {
      "title": "Write Conflict",
      "status": "409"
    }
  ]
}

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...