Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Elastic Path Dunning Rules API

Dunning is the process of handling failed payment attempts. This is important for recovering revenue from failed payments, reduces customer churn and maintains cashflow. By implementing efficient dunning processes, you can enhance financial health and operational efficiency.Subscriptions enables you to create a dunning rule that allows you to configure payment retry schedules. Subscriptions retries failed payments automatically. You can customize the timing and frequency of the payment retries.Dunning is enabled by default. You can choose to disable dunning. If no dunning rule is configured, then payment is retried once a day for 10 days, in total 11 payments. You can decide what action to take after the Subscriptions has stopped retrying the payments.- Do nothing - 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.

Elastic Path Dunning Rules API is one of 100 APIs that Elastic Path publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Dunning Rules. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 5 operations across 2 paths, and defines 16 schemas. It is described by OpenAPI 3.1.0, at version 25.1126.6886238.

Requests are made against 2 base URLs: https://useast.api.elasticpath.com, https://euwest.api.elasticpath.com.

5 operations 2 paths 16 schemas 1 DELETE2 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
25.1126.6886238
Base URL
https://useast.api.elasticpath.com
Authentication
HTTP Bearer
License
Resource Areas
1

Authentication & Security 1

Elastic Path Dunning Rules API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (BearerToken). By default, every request must be authenticated.

Paths & Operations 5

Across 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Dunning Rules 5

Dunning is the process of handling failed payment attempts. This is important for recovering revenue from failed payments, reduces customer churn and maintains cashflow. By implem…

POST
/v2/subscriptions/dunning-rules
Create a dunning rule
CreateDunningRule body → 201400500
GET
/v2/subscriptions/dunning-rules
List dunning rules
ListDunningRules 3 params → 200400500
GET
/v2/subscriptions/dunning-rules/{dunning_rule_uuid}
Get dunning rule policy
GetDunningRule 1 param → 200400404500
PUT
/v2/subscriptions/dunning-rules/{dunning_rule_uuid}
Update dunning rule policy
UpdateDunningRule 1 param body → 200400403404409500
DELETE
/v2/subscriptions/dunning-rules/{dunning_rule_uuid}
Delete dunning rules
DeleteDunningRule 1 param → 204400500

Schemas 16

The contract defines 16 schemas that model the data the API accepts and returns. The most detailed are DunningRuleAttributes (7 properties), DunningRuleUpdateAttributes (7 properties), Error (4 properties), DunningRule (4 properties). Each schema is shown below with its type and property counts.

DunningRuleAttributes
object
The dunning rule attributes you can use to configure your payment retry strategy.
7 properties 3 required
SubscriptionDunningRuleType
string
Timestamps
object
2 properties 2 required
Link
Error
object
4 properties 2 required
ErrorResponse
object
1 property 1 required
Links
object
LinkObject
object
3 properties
DunningRuleMeta
object
2 properties 2 required
DunningRuleCreate
object
2 properties 2 required
DunningRuleUpdateAttributes
object
7 properties
UUID
string
The unique identifier.
LinkURI
string
OwnerMeta
string
The owner of a resource, either store or organization.
DunningRuleUpdate
object
3 properties 3 required
DunningRule
object
4 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

elastic-path-dunning-rules-api-openapi.yml Raw ↑

Other APIs Elastic Path publishes across the network.

Elastic Path GraphQL API
Elastic Path Account Addresses API
Elastic Path Account Authentication Settings API
Elastic Path Account Cart Associations API
Elastic Path Account Management Authentication API
Elastic Path Account Members API
Elastic Path Account Membership API
Elastic Path Account Membership Settings API
Elastic Path Account Tags API
Elastic Path Accounts API
Elastic Path Administrator Latest Releases Catalog API API
Elastic Path Application Keys API