curl --request POST \
--url https://{subscription_manager_domain}/subscriptions/recurringPayments/notifications \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--data '
{
"notificationType": "PAYMENT_SUCCESS",
"subscriptionId": "123456",
"externalReferenceId": "1234567890",
"payment": {
"totalAmount": 343.23,
"currencyCode": "USD",
"orderId": "1234567890"
}
}
'{
"description": "Request received successfully!"
}Recurring payment notifications (Global-e to Subscription Manager)
Global-e informs Subscription Manager about recurring payments’s updates.
POST
/
subscriptions
/
recurringPayments
/
notifications
curl --request POST \
--url https://{subscription_manager_domain}/subscriptions/recurringPayments/notifications \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--data '
{
"notificationType": "PAYMENT_SUCCESS",
"subscriptionId": "123456",
"externalReferenceId": "1234567890",
"payment": {
"totalAmount": 343.23,
"currencyCode": "USD",
"orderId": "1234567890"
}
}
'{
"description": "Request received successfully!"
}Part of the Subscription Connector integration guide — see it for when and how to use this endpoint.
This is the one contract in the Subscriptions set that you implement and Global-e calls. The server is the Subscription Manager, not Global-e.
Headers
Unique identifier for the request; the same value must be sent on retries so the operation is applied at most once.
Body
application/json
The notification Global-e is sending, and what the Subscription Manager is expected to do with it:
| Type | Description | Expected action |
|---|---|---|
| PAYMENT_SUCCESS | Payment completed successfully | Update subscription, create invoice |
| PAYMENT_PENDING | Payment is pending | Mark as pending, wait for final status |
| PAYMENT_DECLINED | Payment was declined | Retry logic or notify customer |
| PAYMENT_CANCELED | Payment was canceled | Cancel or reschedule |
Available options:
PAYMENT_SUCCESS, PAYMENT_PENDING, PAYMENT_DECLINED, PAYMENT_CANCELED Unique identifier subscription in the subscription manager.
Maximum string length:
100Unique identifier of external document object, like invoiceId in the subscription manager
Payment details (varies by type)
- Option 1
- Option 2
- Option 3
- Option 4
Show child attributes
Show child attributes
Response
Request accepted.
Human-readable message