Skip to content

Manually retry payment for a subscription

POST
/api/subscriptions/{id}/retry-payment
curl --request POST \
--url https://api.usegro.co/api/subscriptions/example/retry-payment \
--header 'Content-Type: application/json' \
--data '{ "next_delivery_date": "example", "slot_id": "example", "next_billing_date": "example" }'

Initiates a manual payment retry for a subscription that is in dunning or has a failed payment. The retry runs asynchronously; the response confirms the job has been dispatched.

id
required
string
Media typeapplication/json
object
next_delivery_date
string
slot_id
string
next_billing_date
string

Example generated

{
"next_delivery_date": "example",
"slot_id": "example",
"next_billing_date": "example"
}

Payment retry job dispatched

Media typeapplication/json
object
success
required
boolean
message
required
string

Example generated

{
"success": true,
"message": "example"
}

Subscription is not eligible for payment retry

Media typeapplication/json

Example

{
"success": false,
"error": "Subscription is not eligible for payment retry",
"errorCode": "NOT_ELIGIBLE",
"mode": "delivery",
"problems": [
"The delivery date for this order has passed"
]
}