v1

latestOpenAPI 3.1.02026-07-24571564.5 KB
Subscriptions

Mark subscription as failed

This endpoint is used to mark a subscription as failed.

If the subscription is in dunning, it'll be taken out of dunning.

If the shop has an actions set to trigger when a subscription is failed, they'll be triggered (example: email notifications).

post/customers/{customerId}/subscriptions/{subscriptionId}/fail

Path parameters

customerIdstring required

Customer Id

subscriptionIdstring required

Subscription Id

Response

Updated subscription

SubscriptionIdstring

Identifier

SubscriptionStatusstring

Status

NextBillingDatestring date-time

Date of the next billing