younifyd
Menu

Update Dunning Rule

Update dunning rule policy

PUT/v2/subscriptions/dunning-rules/{dunning_rule_uuid}

Use it in a workflow

  1. Add a step and choose the Elastic Path connector.
  2. Pick the Update Dunning Rule action (under Subscriptions).
  3. Fill in the fields below, then reference the result from later steps as {{updateDunningRule.response.data}}.

Request

Path parameters

dunning_rule_uuidstring (uuid)required

The unique identifier of a dunning rule set.

Request body

Enter the body as JSON in the step's Body field.

dataobjectrequired
idstring (uuid)required

The unique identifier.

typestringrequired

One ofsubscription_dunning_rule

attributesobjectrequired7 fields
json
{
  "data": {
    "id": "11111111-2222-3333-4444-555555555555",
    "type": "subscription_dunning_rule",
    "attributes": {
      "payment_retry_type": "fixed",
      "payment_retry_interval": 1,
      "payment_retry_unit": "day",
      "payment_retry_multiplier": 1,
      "payment_retries_limit": 5,
      "action": "none",
      "default": false
    }
  }
}

Response

Returns 200 with an object. Read it in later steps with {{updateDunningRule.response.data.<field>}}.

dataobject
idstring (uuid)

The unique identifier.

typestringrequired

One ofsubscription_dunning_rule

attributesobjectrequired7 fields

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

metaobjectrequired2 fields
json
{
  "data": {
    "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"
      }
    },
    "id": "11111111-2222-3333-4444-555555555555"
  }
}

Need more? See the Elastic Path guide for connection setup and behaviour shared by every action.