Skip to content

Send a payment update email to the customer

POST
/api/subscriptions/{id}/payment-method/send-update-email
curl --request POST \
--url https://api.usegro.co/api/subscriptions/example/payment-method/send-update-email

Sends the customer an email with a Shopify-hosted link to update the payment method on this subscription. Uses Shopify’s customerPaymentMethodSendUpdateEmail mutation.

id
required
string

Email dispatched

Media typeapplication/json
object
success
required
boolean

Example generated

{
"success": true
}

Subscription has no Shopify contract, or Shopify rejected the request

Media typeapplication/json

Example

{
"error": "Subscription has no Shopify contract"
}